docs/devops/workspaces-data-model/index.html - gerrit/www.eclipse.org/che - Git at Google



 <!-- jQuery Eclipse IP approval https://dev.eclipse.org/ipzilla/show_bug.cgi?id=10801 -->
 <script type="text/javascript" charset="utf8" src="../../../docs/assets/scripts/jquery-1.8.1.min.js"></script>

 <script type="text/javascript" charset="utf8">
   $(document).ready(function(){
     var images = document.getElementsByTagName('img');
     for (var i = 0; i < images.length; i++) {
       var image = images[i];
       var parentElement = image.parentElement;
       var a = document.createElement('a');
       if (! image.getAttribute('src').includes("logo-codenvy.svg") && ! image.getAttribute('src').includes("codenvy-contribute.svg") ){
           a.href = image.getAttribute('src');
           a.target = "_blank";
           a.appendChild(image);
           parentElement.appendChild(a);
       }
     }
   });
 </script>
 <!DOCTYPE HTML>
 <html lang="en-US">
 <head>
   <title>Workspace Data Model -

       Docs
      - Eclipse Che</title>
   <meta charset="UTF-8">
   <meta name="viewport" content="width=device-width,initial-scale=1">
   <meta name="generator" content="Jekyll v3.5.1">
   <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
   <link rel="stylesheet" href="../../../docs/assets/css/screen.css">
   <link rel="icon" type="image/x-icon" href="../../../docs/assets/imgs/favicon.ico">
   <!--[if lt IE 9]>
   <script src="/js/html5shiv.min.js"></script>
   <script src="/js/respond.min.js"></script>
   <![endif]-->
 </head>


 <body class="wrap">


 <header>
   <nav class="mobile-nav show-on-mobiles">
     <ul>

   <li class="current">
     <a href="../../../docs/index.html">Docs</a>
   </li>
   <li class="">
     <a href="../../../docs/tutorials/multi-machine/index.html">Tutorials</a>
   </li>
   <li class="">
     <a href="../../../docs/openshift/config/index.html">OpenShift</a>
   </li>
   <li>
     <a href="https://github.com/eclipse/che-docs/tree/master/src/main">GitHub</a>
   </li>
 </ul>

   </nav>
   <div class="grid">
     <div class="unit one-third center-on-mobiles">
         <a href="https://eclipse.org/che/">
           <span class="sr-only">Eclipse Che</span>
           <img src="../../../docs/assets/imgs/logo-eclipseche.svg" alt="Eclipse Che Logo"  width="249" height="115">
         </a>
     </div>
     <nav class="main-nav unit two-thirds hide-on-mobiles">
       <ul>

   <li class="current">
     <a href="../../../docs/index.html">Docs</a>
   </li>
   <li class="">
     <a href="../../../docs/tutorials/multi-machine/index.html">Tutorials</a>
   </li>
   <li class="">
     <a href="../../../docs/openshift/config/index.html">OpenShift</a>
   </li>
   <li>
     <a href="https://github.com/eclipse/che-docs/tree/master/src/main">GitHub</a>
   </li>
 </ul>

     </nav>
   </div>
 </header>


     <section class="docs">
     <div class="grid">

       <div class="docs-nav-mobile unit whole show-on-mobiles">
   <select onchange="if (this.value) window.location.href=this.value">
     <option value="">Navigate the docs…</option>


     <optgroup label="SETUP">


 <ul>


     <option value="../../../docs/index.html">Introduction</option>


     <option value="../../../docs/setup/getting-started/index.html">Getting Started&#58 Local</option>


     <option value="../../../docs/setup/getting-started-saas-cloud/index.html">Getting Started&#58 SaaS Cloud</option>


     <option value="../../../docs/setup/configuration/index.html">Configuration</option>


     <option value="../../../docs/setup/managing/index.html">Managing</option>


     <option value="../../../docs/setup/cli/index.html">CLI Reference</option>


     <option value="../../../docs/setup/glossary/index.html">Glossary</option>


     <option value="../../../docs/setup/docker/index.html">Docker Installation</option>


     <option value="../../../docs/setup/openshift/index.html">OpenShift Installation</option>


     <option value="../../../docs/setup/selenium/index.html">How to run selenium tests</option>


 </ul>


 <ul>


     <li class=""><a href="../../../docs/index.html">Introduction</a></li>


     <li class=""><a href="../../../docs/setup/getting-started/index.html">Getting Started&#58 Local</a></li>


     <li class=""><a href="../../../docs/setup/getting-started-saas-cloud/index.html">Getting Started&#58 SaaS Cloud</a></li>


     <li class=""><a href="../../../docs/setup/configuration/index.html">Configuration</a></li>


     <li class=""><a href="../../../docs/setup/managing/index.html">Managing</a></li>


     <li class=""><a href="../../../docs/setup/cli/index.html">CLI Reference</a></li>


     <li class=""><a href="../../../docs/setup/glossary/index.html">Glossary</a></li>


     <li class=""><a href="../../../docs/setup/docker/index.html">Docker Installation</a></li>


     <li class=""><a href="../../../docs/setup/openshift/index.html">OpenShift Installation</a></li>


     <li class=""><a href="../../../docs/setup/selenium/index.html">How to run selenium tests</a></li>


 </ul>


     </optgroup>


     <optgroup label="WORKSPACE ADMINISTRATION">


 <ul>


     <option value="../../../docs/devops/intro/index.html">Introduction</option>


     <option value="../../../docs/devops/runtime-stacks/index.html">Runtime Stacks</option>


     <option value="../../../docs/devops/runtime-recipes/index.html">Runtime Recipes</option>


     <option value="../../../docs/devops/project-samples/index.html">Project Samples</option>


     <option value="../../../docs/devops/runtime-machines/index.html">Runtime Machines</option>


     <option value="../../../docs/devops/volume-mounts/index.html">Volume Mounts</option>


     <option value="../../../docs/devops/ws-agents/index.html">Workspace Agents</option>


     <option value="../../../docs/devops/workspaces-data-model/index.html">Workspace Data Model</option>


     <option value="../../../docs/devops/runtime-stacks-data-model/index.html">Runtime Stacks Data Model</option>


     <option value="../../../docs/devops/project-samples-data-model/index.html">Project Samples Data Model</option>


 </ul>


 <ul>


     <li class=""><a href="../../../docs/devops/intro/index.html">Introduction</a></li>


     <li class=""><a href="../../../docs/devops/runtime-stacks/index.html">Runtime Stacks</a></li>


     <li class=""><a href="../../../docs/devops/runtime-recipes/index.html">Runtime Recipes</a></li>


     <li class=""><a href="../../../docs/devops/project-samples/index.html">Project Samples</a></li>


     <li class=""><a href="../../../docs/devops/runtime-machines/index.html">Runtime Machines</a></li>


     <li class=""><a href="../../../docs/devops/volume-mounts/index.html">Volume Mounts</a></li>


     <li class=""><a href="../../../docs/devops/ws-agents/index.html">Workspace Agents</a></li>


     <li class="current"><a href="../../../docs/devops/workspaces-data-model/index.html">Workspace Data Model</a></li>


     <li class=""><a href="../../../docs/devops/runtime-stacks-data-model/index.html">Runtime Stacks Data Model</a></li>


     <li class=""><a href="../../../docs/devops/project-samples-data-model/index.html">Project Samples Data Model</a></li>


 </ul>


     </optgroup>


     <optgroup label="USER GUIDE">


 <ul>


     <option value="../../../docs/ide/projects/index.html">Projects</option>


     <option value="../../../docs/ide/import-a-project/index.html">Import</option>


     <option value="../../../docs/ide/ssh/index.html">SSH</option>


     <option value="../../../docs/ide/sync/index.html">Local IDE Sync</option>


     <option value="../../../docs/ide/editor-settings/index.html">Editor</option>


     <option value="../../../docs/ide/intellisense/index.html">Intellisense</option>


     <option value="../../../docs/ide/commands/index.html">Commands</option>


     <option value="../../../docs/ide/git-svn/index.html">Git and SVN</option>


     <option value="../../../docs/ide/previews/index.html">Previews</option>


     <option value="../../../docs/ide/build/index.html">Build</option>


     <option value="../../../docs/ide/run/index.html">Run</option>


     <option value="../../../docs/ide/sharing/index.html">Share</option>


     <option value="../../../docs/ide/debug/index.html">Debug</option>


     <option value="../../../docs/ide/docker/index.html">Docker</option>


     <option value="../../../docs/ide/electron/index.html">Install Che Desktop Client</option>


 </ul>


 <ul>


     <li class=""><a href="../../../docs/ide/projects/index.html">Projects</a></li>


     <li class=""><a href="../../../docs/ide/import-a-project/index.html">Import</a></li>


     <li class=""><a href="../../../docs/ide/ssh/index.html">SSH</a></li>


     <li class=""><a href="../../../docs/ide/sync/index.html">Local IDE Sync</a></li>


     <li class=""><a href="../../../docs/ide/editor-settings/index.html">Editor</a></li>


     <li class=""><a href="../../../docs/ide/intellisense/index.html">Intellisense</a></li>


     <li class=""><a href="../../../docs/ide/commands/index.html">Commands</a></li>


     <li class=""><a href="../../../docs/ide/git-svn/index.html">Git and SVN</a></li>


     <li class=""><a href="../../../docs/ide/previews/index.html">Previews</a></li>


     <li class=""><a href="../../../docs/ide/build/index.html">Build</a></li>


     <li class=""><a href="../../../docs/ide/run/index.html">Run</a></li>


     <li class=""><a href="../../../docs/ide/sharing/index.html">Share</a></li>


     <li class=""><a href="../../../docs/ide/debug/index.html">Debug</a></li>


     <li class=""><a href="../../../docs/ide/docker/index.html">Docker</a></li>


     <li class=""><a href="../../../docs/ide/electron/index.html">Install Che Desktop Client</a></li>


 </ul>


     </optgroup>


     <optgroup label="PORTABLE WORKSPACES">


 <ul>


     <option value="../../../docs/chedir/getting-started/index.html">Chedir - Getting Started</option>


     <option value="../../../docs/chedir/why/index.html">Chedir - Why Chedir?</option>


     <option value="../../../docs/chedir/installation/index.html">Chedir - Installation</option>


     <option value="../../../docs/chedir/project-setup/index.html">Chedir - Project Setup</option>


     <option value="../../../docs/chedir/up-and-down/index.html">Chedir - Up and Down</option>


     <option value="../../../docs/chedir/chefiles/index.html">Chedir - Chefile</option>


     <option value="../../../docs/chedir/ssh/index.html">Chedir - SSH</option>


     <option value="../../../docs/chedir/factories/index.html">Chedir - Factories</option>


     <option value="">Error Generating Page Link. Contact Maintainer./docs/factory-getting-started/</option>


     <option value="">Error Generating Page Link. Contact Maintainer./docs/factory-creating/</option>


     <option value="">Error Generating Page Link. Contact Maintainer./docs/factory-json-reference/</option>


 </ul>


 <ul>


     <li class=""><a href="../../../docs/chedir/getting-started/index.html">Chedir - Getting Started</a></li>


     <li class=""><a href="../../../docs/chedir/why/index.html">Chedir - Why Chedir?</a></li>


     <li class=""><a href="../../../docs/chedir/installation/index.html">Chedir - Installation</a></li>


     <li class=""><a href="../../../docs/chedir/project-setup/index.html">Chedir - Project Setup</a></li>


     <li class=""><a href="../../../docs/chedir/up-and-down/index.html">Chedir - Up and Down</a></li>


     <li class=""><a href="../../../docs/chedir/chefiles/index.html">Chedir - Chefile</a></li>


     <li class=""><a href="../../../docs/chedir/ssh/index.html">Chedir - SSH</a></li>


     <li class=""><a href="../../../docs/chedir/factories/index.html">Chedir - Factories</a></li>


     <li class=""><a href="../../../docs/factory/getting-started/index.html">Factory - Getting Started</a></li>


     <li class=""><a href="../../../docs/factory/creating/index.html">Factory - Creating</a></li>


     <li class=""><a href="../../../docs/factory/json-reference/index.html">Factory - JSON Reference</a></li>


 </ul>


     </optgroup>


     <optgroup label="DEVELOPER GUIDE - REST API">


 <ul>


     <option value="../../../docs/assemblies/intro/index.html">Introduction</option>


     <option value="../../../docs/assemblies/archetype/index.html">Archetype</option>


     <option value="../../../docs/assemblies/assembly-lifecycle/index.html">Assembly Dev Lifecycle</option>


     <option value="../../../docs/assemblies/plugin-lifecycle/index.html">Plugin Lifecycle</option>


     <option value="../../../docs/assemblies/sdk-rest-apis/index.html">SDK REST APIs</option>


     <option value="../../../docs/assemblies/sdk-class-reference/index.html">SDK Class Reference</option>


     <option value="../../../docs/assemblies/sdk-dependency-injection/index.html">SDK Dependency Injection</option>


     <option value="../../../docs/assemblies/sdk-dto/index.html">SDK DTOs</option>


     <option value="../../../docs/assemblies/sdk-properties/index.html">SDK Properties</option>


     <option value="../../../docs/assemblies/sdk-code-editors/index.html">SDK Editors</option>


     <option value="../../../docs/assemblies/sdk-embed-htmljs/index.html">SDK Embedded JavaScript</option>


     <option value="../../../docs/assemblies/sdk-project-types/index.html">SDK Project Types</option>


     <option value="../../../docs/assemblies/sdk-actions/index.html">SDK Actions</option>


     <option value="../../../docs/assemblies/sdk-services/index.html">SDK Services</option>


     <option value="../../../docs/assemblies/sdk-parts/index.html">SDK Parts</option>


     <option value="../../../docs/assemblies/sdk-themes/index.html">SDK Themes</option>


     <option value="../../../docs/assemblies/sdk-custom-agents/index.html">SDK Custom Agents</option>


     <option value="../../../docs/assemblies/sdk-language-server-protocol/index.html">SDK Language Server Protocol</option>


     <option value="../../../docs/assemblies/sdk-workspace/index.html">SDK Workspace</option>


 </ul>


 <ul>


     <li class=""><a href="../../../docs/assemblies/intro/index.html">Introduction</a></li>


     <li class=""><a href="../../../docs/assemblies/archetype/index.html">Archetype</a></li>


     <li class=""><a href="../../../docs/assemblies/assembly-lifecycle/index.html">Assembly Dev Lifecycle</a></li>


     <li class=""><a href="../../../docs/assemblies/plugin-lifecycle/index.html">Plugin Lifecycle</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-rest-apis/index.html">SDK REST APIs</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-class-reference/index.html">SDK Class Reference</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-dependency-injection/index.html">SDK Dependency Injection</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-dto/index.html">SDK DTOs</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-properties/index.html">SDK Properties</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-code-editors/index.html">SDK Editors</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-embed-htmljs/index.html">SDK Embedded JavaScript</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-project-types/index.html">SDK Project Types</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-actions/index.html">SDK Actions</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-services/index.html">SDK Services</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-parts/index.html">SDK Parts</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-themes/index.html">SDK Themes</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-custom-agents/index.html">SDK Custom Agents</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-language-server-protocol/index.html">SDK Language Server Protocol</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-workspace/index.html">SDK Workspace</a></li>


 </ul>


     </optgroup>


   </select>
 </div>


       <div class="unit four-fifths">
         <article>
           <div class="improve right hide-on-mobiles">
             <a href="https://github.com/codenvy/che-docs/blob/master/src/main/_docs/devops/devops-workspaces-data-model.md"><i class="fa fa-pencil"></i> &nbsp;Improve this page</a>
             <!--<a href="https://github.com/eclipse/che/blob/master/docs/_docs/devops/devops-workspaces-data-model.md"><i class="fa fa-pencil"></i> &nbsp;Improve this page</a>-->
           </div>
           <div class="doc-title">
             <h1>Workspace Data Model</h1>
             <div class="doc-title-border">
             </div>
           </div>

 <p>JSON workspace object defines the contents and structure of a workspace. A workspace configuration is used to define the workspace to be generated.</p>

 <h2 id="workspace-object">Workspace Object</h2>
 <p>Workspace object representation in JSON format:</p>
 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
   </span><span class="nt">"id"</span><span class="w">          </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w">         </span><span class="err">//</span><span class="w"> </span><span class="err">The</span><span class="w"> </span><span class="err">workspace</span><span class="w"> </span><span class="err">Id</span><span class="w">
   </span><span class="nt">"namespace"</span><span class="w">   </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w">         </span><span class="err">//</span><span class="w"> </span><span class="err">The</span><span class="w"> </span><span class="err">namespace</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">workspace.</span><span class="w"> </span><span class="err">Workspace</span><span class="w"> </span><span class="err">name</span><span class="w"> </span><span class="err">is</span><span class="w"> </span><span class="err">unique</span><span class="w"> </span><span class="err">per</span><span class="w"> </span><span class="err">namespace</span><span class="w">
   </span><span class="nt">"isTemporary"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="kc">true</span><span class="w"> </span><span class="err">|</span><span class="w"> </span><span class="kc">false</span><span class="p">],</span><span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">Indicates</span><span class="w"> </span><span class="err">that</span><span class="w"> </span><span class="err">workspace</span><span class="w"> </span><span class="err">is</span><span class="w"> </span><span class="err">temporary,</span><span class="w"> </span><span class="err">i.e</span><span class="w"> </span><span class="err">exists</span><span class="w"> </span><span class="err">only</span><span class="w"> </span><span class="err">in</span><span class="w"> </span><span class="err">runtime</span><span class="w">
   </span><span class="nt">"status"</span><span class="w">      </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w">         </span><span class="err">//</span><span class="w"> </span><span class="err">The</span><span class="w"> </span><span class="err">status</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">workspace</span><span class="w">
   </span><span class="nt">"config"</span><span class="w">      </span><span class="p">:</span><span class="w"> </span><span class="p">{},</span><span class="w">             </span><span class="err">//</span><span class="w"> </span><span class="err">Configuration</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">workspace</span><span class="w">
   </span><span class="nt">"runtime"</span><span class="w">     </span><span class="p">:</span><span class="w"> </span><span class="p">{},</span><span class="w">             </span><span class="err">//</span><span class="w"> </span><span class="err">The</span><span class="w"> </span><span class="err">runtime</span><span class="w"> </span><span class="err">used</span><span class="w"> </span><span class="err">by</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">workspace</span><span class="w">
   </span><span class="nt">"attributes"</span><span class="w">  </span><span class="p">:</span><span class="w"> </span><span class="p">{}</span><span class="w">              </span><span class="err">//</span><span class="w"> </span><span class="err">The</span><span class="w"> </span><span class="err">workspace</span><span class="w"> </span><span class="err">attributes</span><span class="w">
 </span><span class="p">}</span><span class="w">
 </span></code></pre>
 </div>
 <p>Possible <code class="highlighter-rouge">status</code> values are: <code class="highlighter-rouge">STARTING</code>,<code class="highlighter-rouge">RUNNING</code>, <code class="highlighter-rouge">SNAPSHOTTING</code>, <code class="highlighter-rouge">STOPPING</code> and <code class="highlighter-rouge">STOPPED</code>.</p>

 <h2 id="workspaceconfig-object">WorkspaceConfig Object</h2>

 <p>WorkspaceConfig JSON:</p>

 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="s2">"workspaceConfig"</span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w">
   </span><span class="nt">"name"</span><span class="w">         </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w">    </span><span class="err">//</span><span class="w"> </span><span class="err">The</span><span class="w"> </span><span class="err">name</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">workspace</span><span class="w">
   </span><span class="nt">"description"</span><span class="w">  </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w">    </span><span class="err">//</span><span class="w"> </span><span class="err">The</span><span class="w"> </span><span class="err">workspace</span><span class="w"> </span><span class="err">description</span><span class="w">
   </span><span class="nt">"defaultEnv"</span><span class="w">   </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w">    </span><span class="err">//</span><span class="w"> </span><span class="err">The</span><span class="w"> </span><span class="err">name</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">env</span><span class="w"> </span><span class="err">that</span><span class="w"> </span><span class="err">powers</span><span class="w"> </span><span class="err">this</span><span class="w"> </span><span class="err">workspace</span><span class="w">
   </span><span class="nt">"environments"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{},</span><span class="w">        </span><span class="err">//</span><span class="w"> </span><span class="err">Map</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">runtime</span><span class="w"> </span><span class="err">envs</span><span class="w"> </span><span class="err">this</span><span class="w"> </span><span class="err">workspace</span><span class="w"> </span><span class="err">uses</span><span class="w">
   </span><span class="nt">"projects"</span><span class="w">     </span><span class="p">:</span><span class="w"> </span><span class="p">[{}],</span><span class="w">      </span><span class="err">//</span><span class="w"> </span><span class="err">List</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">projects</span><span class="w"> </span><span class="err">included</span><span class="w"> </span><span class="err">in</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">workspace</span><span class="w">
   </span><span class="nt">"commands"</span><span class="w">     </span><span class="p">:</span><span class="w"> </span><span class="p">[{}]</span><span class="w">       </span><span class="err">//</span><span class="w"> </span><span class="err">List</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">commands</span><span class="w"> </span><span class="err">configured</span><span class="w"> </span><span class="err">in</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">workspace</span><span class="w">
 </span><span class="p">}</span><span class="w">
 </span></code></pre>
 </div>

 <p>Every workspace can have one or more environments which are used to run the code against a stack of technology. Every workspace has exactly one environment which acts as a special “development environment”, for which projects are synchronized into and developer services are injected, such as intellisense, workspace agents, SSH, and plug-ins.</p>

 <p>Set <code class="highlighter-rouge">defaultEnv</code> to the name of the environment that should act as the Docker-powered environment that powers the workspace when it boots. This name must match the name given to an object in the <code class="highlighter-rouge">environments</code> array. Che will create a container off of this environment when the workspace is launched.</p>

 <h2 id="environments">Environments</h2>
 <p>Each environments are constructed of one or more machines, each one is an individual container. An environment can be comprised of multiple machines that are linked together, such as when you want a database running on a different machine than your debugger.</p>
 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
   </span><span class="nt">"environments"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
     </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
       </span><span class="nt">"machines"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{},</span><span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">Map</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">machines</span><span class="w"> </span><span class="err">configurations</span><span class="w">
       </span><span class="nt">"recipe"</span><span class="w">   </span><span class="p">:</span><span class="w"> </span><span class="p">{}</span><span class="w">  </span><span class="err">//</span><span class="w"> </span><span class="err">The</span><span class="w"> </span><span class="err">recipe</span><span class="w"> </span><span class="err">(the</span><span class="w"> </span><span class="err">main</span><span class="w"> </span><span class="err">script)</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">define</span><span class="w"> </span><span class="err">this</span><span class="w"> </span><span class="err">environment</span><span class="w">
     </span><span class="p">}</span><span class="w">
   </span><span class="p">}</span><span class="w">
 </span><span class="p">}</span><span class="w">
 </span></code></pre>
 </div>

 <h3 id="recipe-object">Recipe object</h3>

 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="w"> </span><span class="p">{</span><span class="w">
    </span><span class="nt">"recipe"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
      </span><span class="nt">"contentType"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w"> </span><span class="err">//</span><span class="w">  </span><span class="err">Content</span><span class="w"> </span><span class="err">type</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">environment</span><span class="w"> </span><span class="err">recipe</span><span class="w">
      </span><span class="nt">"type"</span><span class="w">        </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w"> </span><span class="err">//</span><span class="w">  </span><span class="err">Type</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">environment</span><span class="w">
      </span><span class="nt">"content"</span><span class="w">     </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w"> </span><span class="err">//</span><span class="w">  </span><span class="err">Content</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">an</span><span class="w"> </span><span class="err">environment</span><span class="w"> </span><span class="err">recipe</span><span class="w">
      </span><span class="nt">"location"</span><span class="w">    </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="w">  </span><span class="err">//</span><span class="w">  </span><span class="err">Location</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">an</span><span class="w"> </span><span class="err">environment</span><span class="w"> </span><span class="err">recipe</span><span class="w">
    </span><span class="p">}</span><span class="w">
  </span><span class="p">}</span><span class="w">
 </span></code></pre>
 </div>
 <p>Content and location fields are mutually exclusive, i.e. only one can be present.
  The source of a machine configuration object is supporting several types when using <code class="highlighter-rouge">docker</code> as machine configuration type, here are the supported source options:</p>
 <ul>
   <li><code class="highlighter-rouge">dockerfile</code>: to provide a link to a Dockerfile recipe or directly the content of a Dockerfile.</li>
   <li><code class="highlighter-rouge">composetype</code>: to provide link to a Composefile or directly the content of the Composefile recipe.</li>
   <li><code class="highlighter-rouge">dockerimage</code>: to provide a built Docker image.</li>
 </ul>

 <p>See more details below.</p>

 <h4 id="dockerfile-type">Dockerfile type</h4>
 <p>It provides a docker runtime. The Dockerfile recipe can be provided by a link, using <code class="highlighter-rouge">location</code> field or by providing directly the content of the Dockerfile, using <code class="highlighter-rouge">content</code> field.</p>
 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="w"> </span><span class="p">{</span><span class="w">
    </span><span class="nt">"recipe"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
      </span><span class="p">{</span><span class="w">
        </span><span class="nt">"content"</span><span class="w">     </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w">
        </span><span class="nt">"type"</span><span class="w">        </span><span class="p">:</span><span class="w"> </span><span class="s2">"dockerfile"</span><span class="p">,</span><span class="w">
        </span><span class="nt">"contentType"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"application/x-dockerfile"</span><span class="w">
      </span><span class="p">}</span><span class="w">
    </span><span class="p">]</span><span class="w">
  </span><span class="p">}</span><span class="w">
 </span></code></pre>
 </div>

 <p>Examples:</p>
 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="s2">"recipe"</span><span class="w"> </span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w">
     </span><span class="nt">"type"</span><span class="w">    </span><span class="p">:</span><span class="w"> </span><span class="s2">"dockerfile"</span><span class="p">,</span><span class="w">
     </span><span class="nt">"location"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://codenvy.io/api/recipe/recipec0v4ta2uz6jok0bn/script"</span><span class="w">
 </span><span class="p">}</span><span class="w">
 </span></code></pre>
 </div>
 <p>or</p>
 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="s2">"recipe"</span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w">
     </span><span class="nt">"type"</span><span class="w">   </span><span class="p">:</span><span class="w"> </span><span class="s2">"dockerfile"</span><span class="p">,</span><span class="w">
     </span><span class="nt">"content"</span><span class="p">:</span><span class="w"> </span><span class="s2">"FROM eclipse/ubuntu_jdk8
                 RUN echo hello world
                 ENV MYCUSTOM=VALUE"</span><span class="w">
 </span><span class="p">}</span><span class="w">
 </span></code></pre>
 </div>

 <h4 id="compose-type">Compose type</h4>
 <p>It provides a multi-machine runtime from a compose definition that need to be built into image(s) or reference already-built image(s) docker runtime.</p>

 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="w"> </span><span class="p">{</span><span class="w">
    </span><span class="nt">"recipe"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
       </span><span class="nt">"content"</span><span class="w">     </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w">
       </span><span class="nt">"contentType"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"application/x-yaml"</span><span class="p">,</span><span class="w">
       </span><span class="nt">"type"</span><span class="w">        </span><span class="p">:</span><span class="w"> </span><span class="s2">"compose"</span><span class="w">
    </span><span class="p">}</span><span class="w">
  </span><span class="p">}</span><span class="w">
 </span></code></pre>
 </div>

 <p>Examples:</p>
 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="s2">"recipe"</span><span class="w"> </span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w">
     </span><span class="nt">"type"</span><span class="w">    </span><span class="p">:</span><span class="w"> </span><span class="s2">"compose"</span><span class="p">,</span><span class="w">
     </span><span class="nt">"location"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://beta.codenvy.com/api/recipe/recipec0v4ta2uz6jok0bn/script"</span><span class="w">
 </span><span class="p">}</span><span class="w">
 </span></code></pre>
 </div>
 <p>or</p>
 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="s2">"recipe"</span><span class="w"> </span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w">
         </span><span class="nt">"contentType"</span><span class="p">:</span><span class="w"> </span><span class="s2">"application/x-yaml"</span><span class="p">,</span><span class="w">
         </span><span class="nt">"type"</span><span class="w">       </span><span class="p">:</span><span class="w"> </span><span class="s2">"compose"</span><span class="p">,</span><span class="w">
         </span><span class="nt">"content"</span><span class="w">    </span><span class="p">:</span><span class="w"> </span><span class="s2">"services:\n  db:\n    image: mysql\n    environment:\n      MYSQL_ROOT_PASSWORD: password\n      MYSQL_DATABASE: petclinic\n      MYSQL_USER: petclinic\n      MYSQL_PASSWORD: password\n    mem_limit: 1073741824\n  dev-machine:\n    image: eclipse/ubuntu_jdk8\n    mem_limit: 2147483648\n    depends_on:\n      - db\n"</span><span class="w">
       </span><span class="p">}</span><span class="w">
 </span><span class="err">}</span><span class="w">
 </span></code></pre>
 </div>

 <h4 id="dockerimage-type">Dockerimage type</h4>
 <p>Use <code class="highlighter-rouge">dockerimage</code> to provide use a Docker image.</p>

 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="w"> </span><span class="p">{</span><span class="w">
    </span><span class="nt">"recipe"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
       </span><span class="nt">"location"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"eclipse/ubuntu_jdk8"",
       "</span><span class="err">type</span><span class="s2">"     : "</span><span class="err">dockerimage"</span><span class="w">
    </span><span class="p">}</span><span class="w">
  </span><span class="p">}</span><span class="w">
 </span></code></pre>
 </div>

 <h3 id="machines-map">Machines map</h3>
 <p>Additional information about machine(s) which is needed for purposes of Che.
 MUST contain one machine with name <code class="highlighter-rouge">dev-machine</code>, and, optionally, additional machines.</p>
 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="w"> </span><span class="p">{</span><span class="w">
    </span><span class="nt">"machines"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
       </span><span class="nt">"db"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
         </span><span class="nt">"servers"</span><span class="w">    </span><span class="p">:</span><span class="w"> </span><span class="p">{},</span><span class="w">
         </span><span class="nt">"agents"</span><span class="w">     </span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="err">STRING</span><span class="p">]</span><span class="w">
         </span><span class="s2">"attributes"</span><span class="w"> </span><span class="err">:</span><span class="w"> </span><span class="p">{}</span><span class="w">
       </span><span class="p">},</span><span class="w">
       </span><span class="nt">"dev-machine"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
         </span><span class="nt">"servers"</span><span class="w">    </span><span class="p">:</span><span class="w"> </span><span class="p">{},</span><span class="w">
         </span><span class="nt">"agents"</span><span class="w">     </span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="err">STRING</span><span class="p">],</span><span class="w">
         </span><span class="nt">"attributes"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{}</span><span class="w">
       </span><span class="p">}</span><span class="w">
     </span><span class="p">}</span><span class="w">
    </span><span class="p">}</span><span class="w">
  </span><span class="err">}</span><span class="w">
 </span></code></pre>
 </div>

 <h4 id="server-object">Server Object</h4>
 <p>Describes configuration of servers that can be started inside of machine.</p>
 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
  </span><span class="nt">"servers"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
     </span><span class="nt">"myserver"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
      </span><span class="nt">"port"</span><span class="w">       </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">Port</span><span class="w"> </span><span class="err">description</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">this</span><span class="w"> </span><span class="err">server.</span><span class="w"> </span><span class="err">Example</span><span class="p">:</span><span class="w"> </span><span class="s2">"9090/udp"</span><span class="w">
      </span><span class="s2">"protocol"</span><span class="w">   </span><span class="err">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">Protocol</span><span class="w"> </span><span class="err">for</span><span class="w"> </span><span class="err">configuring</span><span class="w"> </span><span class="err">preview</span><span class="w"> </span><span class="err">url</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">this</span><span class="w"> </span><span class="err">server.</span><span class="w">
      </span><span class="nt">"properties"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{}</span><span class="w">      </span><span class="err">//</span><span class="w"> </span><span class="err">Server</span><span class="w"> </span><span class="err">properties</span><span class="w">
      </span><span class="p">}</span><span class="w">
   </span><span class="p">}</span><span class="w">
 </span><span class="p">}</span><span class="w">
 </span></code></pre>
 </div>

 <p>Example:</p>
 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="s2">"servers"</span><span class="err">:</span><span class="p">{</span><span class="w">
   </span><span class="nt">"8080/tcp"</span><span class="p">:{</span><span class="w">
      </span><span class="nt">"url"</span><span class="p">:</span><span class="s2">"http://172.17.0.1:32832"</span><span class="p">,</span><span class="w">
      </span><span class="nt">"ref"</span><span class="p">:</span><span class="s2">"tomcat8"</span><span class="p">,</span><span class="w">
      </span><span class="nt">"properties"</span><span class="p">:{</span><span class="w">
        </span><span class="nt">"internalUrl"</span><span class="p">:</span><span class="s2">"http://172.17.0.1:32832"</span><span class="p">,</span><span class="w">
        </span><span class="nt">"internalAddress"</span><span class="p">:</span><span class="s2">"172.17.0.1:32832"</span><span class="w">
      </span><span class="p">},</span><span class="w">
      </span><span class="nt">"address"</span><span class="p">:</span><span class="s2">"172.17.0.1:32832"</span><span class="p">,</span><span class="w">
      </span><span class="nt">"protocol"</span><span class="p">:</span><span class="s2">"http"</span><span class="w">
   </span><span class="p">},</span><span class="w">
   </span><span class="nt">"9876/tcp"</span><span class="p">:{</span><span class="w">
      </span><span class="nt">"url"</span><span class="p">:</span><span class="s2">"http://172.17.0.1:32831"</span><span class="p">,</span><span class="w">
      </span><span class="nt">"ref"</span><span class="p">:</span><span class="s2">"codeserver"</span><span class="p">,</span><span class="w">
      </span><span class="nt">"properties"</span><span class="p">:{</span><span class="w">
        </span><span class="nt">"internalUrl"</span><span class="p">:</span><span class="s2">"http://172.17.0.1:32831"</span><span class="p">,</span><span class="w">
        </span><span class="nt">"internalAddress"</span><span class="p">:</span><span class="s2">"172.17.0.1:32831"</span><span class="w">
      </span><span class="p">},</span><span class="w">
      </span><span class="nt">"address"</span><span class="p">:</span><span class="s2">"172.17.0.1:32831"</span><span class="p">,</span><span class="w">
      </span><span class="nt">"protocol"</span><span class="p">:</span><span class="s2">"http"</span><span class="w">
    </span><span class="p">}</span><span class="w">
 </span><span class="p">}</span><span class="w">
 </span></code></pre>
 </div>

 <h2 id="runtime-object">Runtime Object</h2>
 <p>Present only in workspaces which state is <code class="highlighter-rouge">RUNNING</code>.</p>
 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
   </span><span class="nt">"runtime"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
      </span><span class="nt">"activeEnv"</span><span class="w">  </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">Active</span><span class="w"> </span><span class="err">environment</span><span class="w"> </span><span class="err">name</span><span class="w">
      </span><span class="nt">"rootFolder"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">The</span><span class="w"> </span><span class="err">base</span><span class="w"> </span><span class="err">folder</span><span class="w"> </span><span class="err">for</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">workspace</span><span class="w"> </span><span class="err">projects</span><span class="w">
      </span><span class="nt">"devMachine"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{},</span><span class="w">     </span><span class="err">//</span><span class="w"> </span><span class="err">Describes</span><span class="w"> </span><span class="err">development</span><span class="w"> </span><span class="err">machine</span><span class="w"> </span><span class="err">only</span><span class="w"> </span><span class="err">if</span><span class="w"> </span><span class="err">its</span><span class="w"> </span><span class="err">status</span><span class="w"> </span><span class="err">is</span><span class="w"> </span><span class="err">`RUNNING`</span><span class="w">
      </span><span class="nt">"machines"</span><span class="w">   </span><span class="p">:</span><span class="w"> </span><span class="p">[{}]</span><span class="w">    </span><span class="err">//</span><span class="w"> </span><span class="err">All</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">machines</span><span class="w"> </span><span class="err">which</span><span class="w"> </span><span class="err">statuses</span><span class="w"> </span><span class="err">are</span><span class="w"> </span><span class="err">`RUNNING`</span><span class="w">
   </span><span class="p">}</span><span class="w">
 </span><span class="p">}</span><span class="w">
 </span></code></pre>
 </div>

 <h3 id="devmachine-object">DevMachine object</h3>
 <p>Represents running machine configuration.</p>
 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
   </span><span class="nt">"devMachine"</span><span class="p">:{</span><span class="w">
      </span><span class="nt">"envName"</span><span class="w">     </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">Name</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">environment</span><span class="w"> </span><span class="err">that</span><span class="w"> </span><span class="err">started</span><span class="w"> </span><span class="err">this</span><span class="w"> </span><span class="err">machine</span><span class="w">
      </span><span class="nt">"id"</span><span class="w">          </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">Machine</span><span class="w"> </span><span class="err">identifier</span><span class="w">
      </span><span class="nt">"owner"</span><span class="w">       </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">Machine</span><span class="w"> </span><span class="err">owner</span><span class="w"> </span><span class="err">(user</span><span class="w"> </span><span class="err">identifier)</span><span class="w">
      </span><span class="nt">"status"</span><span class="w">      </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">Runtime</span><span class="w"> </span><span class="err">status</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">machine</span><span class="w">
      </span><span class="nt">"runtime"</span><span class="w">     </span><span class="p">:</span><span class="w"> </span><span class="p">{},</span><span class="w">     </span><span class="err">//</span><span class="w"> </span><span class="err">Runtime</span><span class="w"> </span><span class="err">information</span><span class="w"> </span><span class="err">about</span><span class="w"> </span><span class="err">machine</span><span class="w">
      </span><span class="nt">"config"</span><span class="w">      </span><span class="p">:</span><span class="w"> </span><span class="p">{},</span><span class="w">     </span><span class="err">//</span><span class="w"> </span><span class="err">Configuration</span><span class="w"> </span><span class="err">used</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">create</span><span class="w"> </span><span class="err">this</span><span class="w"> </span><span class="err">machine</span><span class="w">
      </span><span class="nt">"workspaceId"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="w">  </span><span class="err">//</span><span class="w"> </span><span class="err">ID</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">workspace</span><span class="w"> </span><span class="err">this</span><span class="w"> </span><span class="err">machine</span><span class="w"> </span><span class="err">belongs</span><span class="w"> </span><span class="err">to</span><span class="w">
   </span><span class="p">}</span><span class="w">
 </span><span class="p">}</span><span class="w">
 </span></code></pre>
 </div>

 <h4 id="machineruntimeinfo-object">MachineRuntimeInfo object</h4>
 <p>Represents running machine properties and variables.</p>
 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="w"> </span><span class="p">{</span><span class="w">
    </span><span class="nt">"runtime"</span><span class="p">:{</span><span class="w">
       </span><span class="nt">"projectsRoot"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">Projects</span><span class="w"> </span><span class="err">root</span><span class="w"> </span><span class="err">path</span><span class="w">
       </span><span class="nt">"properties"</span><span class="w">   </span><span class="p">:</span><span class="w"> </span><span class="p">{},</span><span class="w">     </span><span class="err">//</span><span class="w"> </span><span class="err">Machine</span><span class="w"> </span><span class="err">specific</span><span class="w"> </span><span class="err">properties</span><span class="w"> </span><span class="err">map</span><span class="w">
       </span><span class="nt">"envVariables"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{},</span><span class="w">     </span><span class="err">//</span><span class="w"> </span><span class="err">Map</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">environment</span><span class="w"> </span><span class="err">variables</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">machine</span><span class="w">
       </span><span class="nt">"servers"</span><span class="w">      </span><span class="p">:</span><span class="w"> </span><span class="p">{}</span><span class="w">      </span><span class="err">//</span><span class="w"> </span><span class="err">Mapping</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">exposed</span><span class="w"> </span><span class="err">ports.</span><span class="w">
    </span><span class="p">}</span><span class="w">
 </span><span class="p">}</span><span class="w">
 </span></code></pre>
 </div>

 <h4 id="runtime-servers-object-map">Runtime Servers object map</h4>
 <p>Describes configuration of servers that is started inside of machine.</p>
 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
  </span><span class="nt">"servers"</span><span class="p">:{</span><span class="w">
     </span><span class="nt">"4401/tcp"</span><span class="p">:{</span><span class="w">
       </span><span class="nt">"url"</span><span class="w">        </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w">   </span><span class="err">//</span><span class="w"> </span><span class="err">Full</span><span class="w"> </span><span class="err">url</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">this</span><span class="w"> </span><span class="err">server.</span><span class="w"> </span><span class="err">Example</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://172.17.0.1:32836/api"</span><span class="w">
       </span><span class="s2">"ref"</span><span class="w">        </span><span class="err">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w">   </span><span class="err">//</span><span class="w"> </span><span class="err">Ref</span><span class="w"> </span><span class="err">string</span><span class="w">
       </span><span class="nt">"properties"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{},</span><span class="w">       </span><span class="err">//</span><span class="w"> </span><span class="err">Properties</span><span class="w">
       </span><span class="nt">"address"</span><span class="w">    </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w">  </span><span class="err">//</span><span class="w"> </span><span class="err">Adress.</span><span class="w"> </span><span class="err">Example</span><span class="p">:</span><span class="w"> </span><span class="s2">"172.17.0.1:32836"</span><span class="w">
       </span><span class="s2">"protocol"</span><span class="w">   </span><span class="err">:</span><span class="w"> </span><span class="err">STRING</span><span class="w">   </span><span class="err">//</span><span class="w"> </span><span class="err">Server</span><span class="w"> </span><span class="err">protocol.</span><span class="w"> </span><span class="err">Example:</span><span class="w"> </span><span class="s2">"http"</span><span class="w">
     </span><span class="p">},</span><span class="w">
     </span><span class="nt">"8080/tcp"</span><span class="p">:{</span><span class="w">
        </span><span class="nt">"url"</span><span class="w">       </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w">
        </span><span class="nt">"ref"</span><span class="w">       </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="w">
        </span><span class="err">...</span><span class="w">
    </span><span class="p">}</span><span class="w">
 </span><span class="p">}</span><span class="w">
 </span></code></pre>
 </div>

         </article>
       </div>

       <div class="unit one-fifth hide-on-mobiles">
   <aside>


     <h4>SETUP</h4>


 <ul>


     <li class=""><a href="../../../docs/index.html">Introduction</a></li>


     <li class=""><a href="../../../docs/setup/getting-started/index.html">Getting Started&#58 Local</a></li>


     <li class=""><a href="../../../docs/setup/getting-started-saas-cloud/index.html">Getting Started&#58 SaaS Cloud</a></li>


     <li class=""><a href="../../../docs/setup/configuration/index.html">Configuration</a></li>


     <li class=""><a href="../../../docs/setup/managing/index.html">Managing</a></li>


     <li class=""><a href="../../../docs/setup/cli/index.html">CLI Reference</a></li>


     <li class=""><a href="../../../docs/setup/glossary/index.html">Glossary</a></li>


     <li class=""><a href="../../../docs/setup/docker/index.html">Docker Installation</a></li>


     <li class=""><a href="../../../docs/setup/openshift/index.html">OpenShift Installation</a></li>


     <li class=""><a href="../../../docs/setup/selenium/index.html">How to run selenium tests</a></li>


 </ul>


     <h4>WORKSPACE ADMINISTRATION</h4>


 <ul>


     <li class=""><a href="../../../docs/devops/intro/index.html">Introduction</a></li>


     <li class=""><a href="../../../docs/devops/runtime-stacks/index.html">Runtime Stacks</a></li>


     <li class=""><a href="../../../docs/devops/runtime-recipes/index.html">Runtime Recipes</a></li>


     <li class=""><a href="../../../docs/devops/project-samples/index.html">Project Samples</a></li>


     <li class=""><a href="../../../docs/devops/runtime-machines/index.html">Runtime Machines</a></li>


     <li class=""><a href="../../../docs/devops/volume-mounts/index.html">Volume Mounts</a></li>


     <li class=""><a href="../../../docs/devops/ws-agents/index.html">Workspace Agents</a></li>


     <li class="current"><a href="../../../docs/devops/workspaces-data-model/index.html">Workspace Data Model</a></li>


     <li class=""><a href="../../../docs/devops/runtime-stacks-data-model/index.html">Runtime Stacks Data Model</a></li>


     <li class=""><a href="../../../docs/devops/project-samples-data-model/index.html">Project Samples Data Model</a></li>


 </ul>


     <h4>USER GUIDE</h4>


 <ul>


     <li class=""><a href="../../../docs/ide/projects/index.html">Projects</a></li>


     <li class=""><a href="../../../docs/ide/import-a-project/index.html">Import</a></li>


     <li class=""><a href="../../../docs/ide/ssh/index.html">SSH</a></li>


     <li class=""><a href="../../../docs/ide/sync/index.html">Local IDE Sync</a></li>


     <li class=""><a href="../../../docs/ide/editor-settings/index.html">Editor</a></li>


     <li class=""><a href="../../../docs/ide/intellisense/index.html">Intellisense</a></li>


     <li class=""><a href="../../../docs/ide/commands/index.html">Commands</a></li>


     <li class=""><a href="../../../docs/ide/git-svn/index.html">Git and SVN</a></li>


     <li class=""><a href="../../../docs/ide/previews/index.html">Previews</a></li>


     <li class=""><a href="../../../docs/ide/build/index.html">Build</a></li>


     <li class=""><a href="../../../docs/ide/run/index.html">Run</a></li>


     <li class=""><a href="../../../docs/ide/sharing/index.html">Share</a></li>


     <li class=""><a href="../../../docs/ide/debug/index.html">Debug</a></li>


     <li class=""><a href="../../../docs/ide/docker/index.html">Docker</a></li>


     <li class=""><a href="../../../docs/ide/electron/index.html">Install Che Desktop Client</a></li>


 </ul>


     <h4>PORTABLE WORKSPACES</h4>


 <ul>


     <li class=""><a href="../../../docs/chedir/getting-started/index.html">Chedir - Getting Started</a></li>


     <li class=""><a href="../../../docs/chedir/why/index.html">Chedir - Why Chedir?</a></li>


     <li class=""><a href="../../../docs/chedir/installation/index.html">Chedir - Installation</a></li>


     <li class=""><a href="../../../docs/chedir/project-setup/index.html">Chedir - Project Setup</a></li>


     <li class=""><a href="../../../docs/chedir/up-and-down/index.html">Chedir - Up and Down</a></li>


     <li class=""><a href="../../../docs/chedir/chefiles/index.html">Chedir - Chefile</a></li>


     <li class=""><a href="../../../docs/chedir/ssh/index.html">Chedir - SSH</a></li>


     <li class=""><a href="../../../docs/chedir/factories/index.html">Chedir - Factories</a></li>


     <li class=""><a href="../../../docs/factory/getting-started/index.html">Factory - Getting Started</a></li>


     <li class=""><a href="../../../docs/factory/creating/index.html">Factory - Creating</a></li>


     <li class=""><a href="../../../docs/factory/json-reference/index.html">Factory - JSON Reference</a></li>


 </ul>


     <h4>DEVELOPER GUIDE - REST API</h4>


 <ul>


     <li class=""><a href="../../../docs/assemblies/intro/index.html">Introduction</a></li>


     <li class=""><a href="../../../docs/assemblies/archetype/index.html">Archetype</a></li>


     <li class=""><a href="../../../docs/assemblies/assembly-lifecycle/index.html">Assembly Dev Lifecycle</a></li>


     <li class=""><a href="../../../docs/assemblies/plugin-lifecycle/index.html">Plugin Lifecycle</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-rest-apis/index.html">SDK REST APIs</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-class-reference/index.html">SDK Class Reference</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-dependency-injection/index.html">SDK Dependency Injection</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-dto/index.html">SDK DTOs</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-properties/index.html">SDK Properties</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-code-editors/index.html">SDK Editors</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-embed-htmljs/index.html">SDK Embedded JavaScript</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-project-types/index.html">SDK Project Types</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-actions/index.html">SDK Actions</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-services/index.html">SDK Services</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-parts/index.html">SDK Parts</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-themes/index.html">SDK Themes</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-custom-agents/index.html">SDK Custom Agents</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-language-server-protocol/index.html">SDK Language Server Protocol</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-workspace/index.html">SDK Workspace</a></li>


 </ul>


   </aside>
 </div>


       <div class="clear"></div>

     </div>
   </section>


   <script>
   var anchorForId = function (id) {
     var anchor = document.createElement("a");
     anchor.className = "header-link";
     anchor.href      = "#" + id;
     anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
     anchor.title = "Permalink";
     return anchor;
   };

   var linkifyAnchors = function (level, containingElement) {
     var headers = containingElement.getElementsByTagName("h" + level);
     for (var h = 0; h < headers.length; h++) {
       var header = headers[h];

       if (typeof header.id !== "undefined" && header.id !== "") {
         header.appendChild(anchorForId(header.id));
       }
     }
   };

   document.onreadystatechange = function () {
     if (this.readyState === "complete") {
       var contentBlock = document.getElementsByClassName("artik")[0] || document.getElementsByClassName("openshift")[0] || document.getElementsByClassName("tutorials")[0] || document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
       if (!contentBlock) {
         return;
       }
       for (var level = 1; level <= 6; level++) {
         linkifyAnchors(level, contentBlock);
       }
     }
   };
 </script>


 </body>
 </html>