Google Git
Sign in
eclipse/gerrit/www.eclipse.org/che/refs/heads/CheConf18/./docs/devops/runtime-stacks-data-model/index.html
blob: b4868e06a3a88a7d140579dd1ad4dd03e8e75e43 [file]
<!-- 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>Runtime Stacks 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=""><a href="../../../docs/devops/workspaces-data-model/index.html">Workspace Data Model</a></li>
<li class="current"><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-runtime-stacks-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-runtime-stacks-data-model.md"><i class="fa fa-pencil"></i> &nbsp;Improve this page</a>-->
</div>
<div class="doc-title">
<h1>Runtime Stacks Data Model</h1>
<div class="doc-title-border">
</div>
</div>
<p>Admins and users typically use our graphical dashboard for adding and configuring stacks within the product. However, you can also add these directly with REST or in the product using a JSON data model.</p>
<h1 id="stack-object">Stack Object</h1>
<p>Stacks are referenced 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">"description"</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">//Description</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">stack</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">appear</span><span class="w"> </span><span class="err">on</span><span class="w"> </span><span class="err">dashboard</span><span class="w">
</span><span class="nt">"scope"</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">"source"</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">Information</span><span class="w"> </span><span class="err">on</span><span class="w"> </span><span class="err">dev-machine</span><span class="w"> </span><span class="err">type</span><span class="w"> </span><span class="err">and</span><span class="w"> </span><span class="err">origin</span><span class="w">
</span><span class="nt">"tags"</span><span class="p">:</span><span class="w"> </span><span class="err">ARRAY</span><span class="p">,</span><span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">Values</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">filter</span><span class="w"> </span><span class="err">stacks</span><span class="w"> </span><span class="err">in</span><span class="w"> </span><span class="err">dashboard</span><span class="w">
</span><span class="nt">"workspaceConfig"</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">for</span><span class="w"> </span><span class="err">workspace</span><span class="w"> </span><span class="err">environment</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="err">//</span><span class="w"> </span><span class="err">Configuration</span><span class="w"> </span><span class="err">for</span><span class="w"> </span><span class="err">workspace</span><span class="w"> </span><span class="err">environment</span><span class="w">
</span><span class="nt">"default"</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">for</span><span class="w"> </span><span class="err">workspace</span><span class="w"> </span><span class="err">environment</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="err">//</span><span class="w"> </span><span class="err">Recipe</span><span class="w"> </span><span class="err">for</span><span class="w"> </span><span class="err">workspace</span><span class="w"> </span><span class="err">environment</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="err">//</span><span class="w"> </span><span class="err">Resources</span><span class="w"> </span><span class="err">for</span><span class="w"> </span><span class="err">each</span><span class="w"> </span><span class="err">machine</span><span class="w"> </span><span class="err">defined</span><span class="w"> </span><span class="err">in</span><span class="w"> </span><span class="err">recipe</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="err">//</span><span class="w"> </span><span class="err">Required</span><span class="w"> </span><span class="err">machine</span><span class="w"> </span><span class="err">for</span><span class="w"> </span><span class="err">workspace</span><span class="w">
</span><span class="nt">"agents"</span><span class="p">:</span><span class="w"> </span><span class="err">ARRAY</span><span class="p">,</span><span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">Agents</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">inject</span><span class="w"> </span><span class="err">into</span><span class="w"> </span><span class="err">machine</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">"attributes"</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">Define</span><span class="w"> </span><span class="err">memory</span><span class="w"> </span><span class="err">allocation</span><span class="w"> </span><span class="err">for</span><span class="w"> </span><span class="err">machine</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nt">"machine2"</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">Additional</span><span class="w"> </span><span class="err">optional</span><span class="w"> </span><span class="err">machine(s)</span><span class="w"> </span><span class="err">for</span><span class="w"> </span><span class="err">workspace</span><span class="w">
</span><span class="nt">"agents"</span><span class="p">:</span><span class="w"> </span><span class="err">ARRAY</span><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">"attributes"</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="p">},</span><span class="w">
</span><span class="nt">"commands"</span><span class="p">:</span><span class="w"> </span><span class="err">ARRAY</span><span class="p">,</span><span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">Set</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">commands</span><span class="w"> </span><span class="err">available</span><span class="w"> </span><span class="err">for</span><span class="w"> </span><span class="err">machine(s)</span><span class="w">
</span><span class="nt">"projects"</span><span class="p">:</span><span class="w"> </span><span class="err">ARRAY</span><span class="p">,</span><span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">Project</span><span class="w"> </span><span class="err">source</span><span class="w"> </span><span class="err">code</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">import</span><span class="w">
</span><span class="nt">"defaultEnv"</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">Environment</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">use</span><span class="w"> </span><span class="err">and</span><span class="w"> </span><span class="err">set</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="nt">"default"</span><span class="w"> </span><span class="err">most</span><span class="w"> </span><span class="err">often</span><span class="w">
</span><span class="nt">"name"</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">enfironment</span><span class="w"> </span><span class="err">and</span><span class="w"> </span><span class="err">set</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="nt">"default"</span><span class="w"> </span><span class="err">most</span><span class="w"> </span><span class="err">often</span><span class="w">
</span><span class="nt">"links"</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">"components"</span><span class="p">:</span><span class="w"> </span><span class="err">ARRAY</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">components</span><span class="w"> </span><span class="err">and</span><span class="w"> </span><span class="err">versions</span><span class="w"> </span><span class="err">used</span><span class="w"> </span><span class="err">in</span><span class="w"> </span><span class="err">stack</span><span class="w"> </span><span class="err">library</span><span class="w">
</span><span class="nt">"creator"</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">stack</span><span class="w"> </span><span class="err">creator</span><span class="w">
</span><span class="nt">"name"</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">workspace</span><span class="w"> </span><span class="err">configuration</span><span class="w">
</span><span class="nt">"id"</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">configuration</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
<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">this</span><span class="w"> </span><span class="err">workspace</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">Array</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">Array</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">that</span><span class="w"> </span><span class="err">build</span><span class="w"> </span><span class="err">&amp;</span><span class="w"> </span><span class="err">run</span><span class="w"> </span><span class="err">projects</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 environment is 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="s2">"environment"</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">Identifier</span><span class="w"> </span><span class="err">and</span><span class="w"> </span><span class="err">pretty</span><span class="w"> </span><span class="err">name</span><span class="w"> </span><span class="err">for</span><span class="w"> </span><span class="err">environment</span><span class="w">
</span><span class="nt">"recipe"</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">Define</span><span class="w"> </span><span class="err">engine</span><span class="w"> </span><span class="err">for</span><span class="w"> </span><span class="err">composing</span><span class="w"> </span><span class="err">machines</span><span class="w"> </span><span class="err">network</span><span class="w"> </span><span class="err">runtimes</span><span class="w"> </span><span class="err">(compose,</span><span class="w"> </span><span class="err">kubernetes</span><span class="w"> </span><span class="err">pod)</span><span class="w">
</span><span class="nt">"machineConfigs"</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">Instructions</span><span class="w"> </span><span class="err">for</span><span class="w"> </span><span class="err">how</span><span class="w"> </span><span class="err">Che</span><span class="w"> </span><span class="err">builds</span><span class="w"> </span><span class="err">a</span><span class="w"> </span><span class="err">runtime</span><span class="w">
</span><span class="err">}</span><span class="w">
</span></code></pre>
</div>
<h3 id="machineconfigs-object">MachineConfigs Object</h3>
<p>MachineConfigs JSON:</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="err">environment.machineConfigs</span><span class="w"> </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">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">machine</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">What</span><span class="w"> </span><span class="err">kind</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="err">-</span><span class="w"> </span><span class="err">set</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">`docker`</span><span class="w"> </span><span class="err">for</span><span class="w"> </span><span class="err">containers</span><span class="w">
</span><span class="nt">"limits"</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">Limits</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">machine</span><span class="w">
</span><span class="nt">"ram"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="err">INT</span><span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">Memory</span><span class="w"> </span><span class="err">in</span><span class="w"> </span><span class="err">MB</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">will</span><span class="w"> </span><span class="err">be</span><span class="w"> </span><span class="err">allocated</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nt">"dev"</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">If</span><span class="w"> </span><span class="err">true,</span><span class="w"> </span><span class="err">injects</span><span class="w"> </span><span class="err">dev</span><span class="w"> </span><span class="err">services</span><span class="w"> </span><span class="err">into</span><span class="w"> </span><span class="err">machine</span><span class="w">
</span><span class="nt">"source"</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">configure</span><span class="w"> </span><span class="err">workspace</span><span class="w"> </span><span class="err">agent</span><span class="w"> </span><span class="err">runtime</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
<p>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>
<h4 id="dockerfile-type">dockerfile type</h4>
<p>It provides a docker runtime. Link to 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="s2">"source"</span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"type"</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">"http://beta.codenvy.com/api/recipe/recipec0v4ta2uz6jok0bn/script"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="s2">"source"</span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"type"</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="image-type">image type</h4>
<p>location can include the dockerhub image name</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="s2">"source"</span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"image"</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">"eclipse/ubuntu_jdk8"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
<p>or for example include a registry url with a custom tag or a custom digest</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="s2">"source"</span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"image"</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">"myregistry:5000/eclipse/ubuntu_jdk8:myCustomTag"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
<h3 id="mixins">Mixins</h3>
<p>Mixins:</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="err">project.mixins</span><span class="w"> </span><span class="err">:</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="p">]</span><span class="w">
</span></code></pre>
</div>
<p>A mixin adds additional behaviors to a project as a set of new project type attributes. Mixins are reusable across any project type. You define the mixins to add to a project by specifying an array of strings, with each string containing the identifier for the mixin. For example, <code class="highlighter-rouge">"mixins" : [ "git", "tour", "pullrequest" ]</code>.</p>
<table>
<thead>
<tr>
<th>Mixin ID</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code class="highlighter-rouge">git</code></td>
<td>Initiates the project with a git repository. Adds git menu functionality to the IDE. If a user in the IDE creates a new project and then initializes a git repository, then this mixin is added to that project.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">tour</code></td>
<td>Enables walk-me style guided tour functionality. You can author custom step by step tours that execute when users create a new workspace. See Tour for specification and examples.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">pullrequest</code></td>
<td>Enables pull request workflow where server handles local &amp; remote branching, forking, and pull request issuance. Pull requests generated from within server have another Factory placed into the comments of pull requests that a PR reviewer can consume. Adds contribution panel to the IDE. If this mixin is set, then it uses attribute values for <code class="highlighter-rouge">project.attributes.local_branch</code> and <code class="highlighter-rouge">project.attributes.contribute_to_branch</code>.</td>
</tr>
</tbody>
</table>
<p>The <code class="highlighter-rouge">pullrequest</code> mixin requires additional configuration from the <code class="highlighter-rouge">attributes</code> object of the project.</p>
<h3 id="attributes">Attributes</h3>
<p>Project attributes alter the behavior of the IDE or workspace.</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="err">project.attributes</span><span class="w"> </span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="err">KEY</span><span class="w"> </span><span class="err">:</span><span class="w"> </span><span class="err">[VALUES],</span><span class="w"> </span><span class="err">...</span><span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">Each</span><span class="w"> </span><span class="err">attribute</span><span class="w"> </span><span class="err">and</span><span class="w"> </span><span class="err">value</span><span class="w"> </span><span class="err">is</span><span class="w"> </span><span class="err">a</span><span class="w"> </span><span class="err">String.</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
<p>Different Eclipse Che plug-ins can add their own attributes to affect the behavior for the system. Attribute configuration is always optional and if not provided within a workspace definition, the system will set itself.</p>
<h4 id="pull-request-attributes">Pull Request Attributes</h4>
<table>
<thead>
<tr>
<th>Known Attribute</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code class="highlighter-rouge">local_branch</code></td>
<td>Used in conjunction with the <code class="highlighter-rouge">pullrequest</code> mixin. If provided, the local branch for the project is set with this value. If not provided, then the local branch is set with the value of <code class="highlighter-rouge">project.source.parameters.branch</code> (the name of the branch from the remote). If <code class="highlighter-rouge">local_branch</code> and <code class="highlighter-rouge">project.source.parameters.branch</code> are both not provided, then the local branch is set to the name of the checked out branch.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">contribute_to_branch</code></td>
<td>Name of the branch that a pull request will be contributed to. Default is the value of <code class="highlighter-rouge">project.source.parameters.branch</code>, which is the name of the branch this project was cloned from.</td>
</tr>
</tbody>
</table>
<p>Here is a snippet that demonstrates full configuration of the contribution mixin.</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="err">factory.workspace.project</span><span class="w"> </span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"mixins"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="s2">"pullrequest"</span><span class="w"> </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="nt">"local_branch"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="s2">"timing"</span><span class="w"> </span><span class="p">],</span><span class="w">
</span><span class="nt">"contribute_to_branch"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="s2">"master"</span><span class="w"> </span><span class="p">]</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nt">"source"</span><span class="w"> </span><span class="p">:</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">"git"</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">"https://github.com/eclipse/che.git"</span><span class="p">,</span><span class="w">
</span><span class="nt">"parameters"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"keepVcs"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"true"</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>
<h2 id="projects">Projects</h2>
<p>Project object:</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="s2">"project"</span><span class="w"> </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">project</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">The</span><span class="w"> </span><span class="err">project</span><span class="w"> </span><span class="err">type</span><span class="w"> </span><span class="err">defines</span><span class="w"> </span><span class="err">plug-ins</span><span class="w"> </span><span class="err">&amp;</span><span class="w"> </span><span class="err">behaviors</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">Pretty</span><span class="w"> </span><span class="err">description</span><span class="w"> </span><span class="err">for</span><span class="w"> </span><span class="err">display</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">users</span><span class="w">
</span><span class="nt">"path"</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">Location</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="err">where</span><span class="w"> </span><span class="err">this</span><span class="w"> </span><span class="err">project</span><span class="w"> </span><span class="err">lives</span><span class="w">
</span><span class="nt">"source"</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">source</span><span class="w"> </span><span class="err">code</span><span class="w"> </span><span class="err">repo</span><span class="w"> </span><span class="err">for</span><span class="w"> </span><span class="err">this</span><span class="w"> </span><span class="err">project</span><span class="w">
</span><span class="nt">"mixins"</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="err">//</span><span class="w"> </span><span class="err">Adds</span><span class="w"> </span><span class="err">behaviors</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">project,</span><span class="w"> </span><span class="err">such</span><span class="w"> </span><span class="err">as</span><span class="w"> </span><span class="err">enabling</span><span class="w"> </span><span class="err">a</span><span class="w"> </span><span class="err">pull</span><span class="w"> </span><span class="err">request</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">Varies</span><span class="w"> </span><span class="err">by</span><span class="w"> </span><span class="err">project</span><span class="w"> </span><span class="err">type</span><span class="w">
</span><span class="nt">"modules"</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">Modules</span><span class="w"> </span><span class="err">are</span><span class="w"> </span><span class="err">project</span><span class="w"> </span><span class="err">sub-units</span><span class="w"> </span><span class="err">with</span><span class="w"> </span><span class="err">type</span><span class="w"> </span><span class="err">that</span><span class="w"> </span><span class="err">can</span><span class="w"> </span><span class="err">build</span><span class="w"> </span><span class="err">&amp;</span><span class="w"> </span><span class="err">run</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
<p>A project has a type which causes special services to be added to the IDE and the default environment that is powering the workspace. Additionally, each project type has a specialized set of additional attributes that can alter the behavior of the project. The icon next to your project name in the IDE explorer changes based upon the project type that it has. You can also change project type in <code class="highlighter-rouge">Project &gt; Configuration</code> in the IDE.</p>
<table>
<thead>
<tr>
<th>Project Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code class="highlighter-rouge">blank</code></td>
<td>A no-op project type. Inherits basic IDE functionality.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">maven</code></td>
<td>Installs a number of plug-ins including maven, Java, and ant. The maven project type provides a wizard for configuring projects, special editors for <code class="highlighter-rouge">pom.xml</code>, dozens of types of Java intellisense, and maven command types, which help developers write maven processes.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">node-js</code></td>
<td>Installs a number of plug-ins for JavaScript. Code completion for HTML, JavaScript and CSS actived.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">python</code></td>
<td>Inherits basic IDE functionality for Python.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">javac</code></td>
<td>Installs a number of plug-ins for Java. Enable classpath configuration, and Java Intellisense features.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">c</code></td>
<td>Inherits basic IDE functionality for C and GDB debugger.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">cpp</code></td>
<td>Inherits basic IDE functionality for C and GDB debugger.</td>
</tr>
</tbody>
</table>
<p>Set <code class="highlighter-rouge">project.path</code> to the relative location from the repository that contains the root of your project. Your workspace will have a root directory named <code class="highlighter-rouge">/projects</code> and this field is a relative path from that directory.</p>
<p>For example, let’s take an example to create a workspace with three projects from three repositories: <code class="highlighter-rouge">project1</code>, <code class="highlighter-rouge">project2</code>, and <code class="highlighter-rouge">project3</code>. These projects will be stored in <code class="highlighter-rouge">/projects/project1</code>, <code class="highlighter-rouge">/projects/project2</code>, and <code class="highlighter-rouge">/projects/project3</code>. The <code class="highlighter-rouge">path</code> attribute would be set to <code class="highlighter-rouge">/project1</code>, <code class="highlighter-rouge">/project2</code>, and <code class="highlighter-rouge">/project3</code>.</p>
<p>Every project belongs to a single version control repository. If you want the project within the workspace to have its code populated as a clone from a remote repository, then fill in the <code class="highlighter-rouge">projects.source</code> object with configuration information.</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="err">project.source</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="p">[</span><span class="err">git</span><span class="w"> </span><span class="err">|</span><span class="w"> </span><span class="err">svn</span><span class="w"> </span><span class="err">|</span><span class="w"> </span><span class="err">dockerfile</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="err">URL</span><span class="p">,</span><span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">Repo</span><span class="w"> </span><span class="err">location</span><span class="w">
</span><span class="nt">"parameters"</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">(OPTIONAL)</span><span class="w"> </span><span class="err">Attributes</span><span class="w"> </span><span class="err">for</span><span class="w"> </span><span class="err">version</span><span class="w"> </span><span class="err">control</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="err">project.source.parameters</span><span class="w"> </span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"branch"</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">Clone</span><span class="w"> </span><span class="err">from</span><span class="w"> </span><span class="err">this</span><span class="w"> </span><span class="err">branch</span><span class="w">
</span><span class="nt">"startPoint"</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">Branch</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">start</span><span class="w"> </span><span class="err">at</span><span class="w"> </span><span class="err">if</span><span class="w"> </span><span class="err">value</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">'branch'</span><span class="w"> </span><span class="err">param</span><span class="w"> </span><span class="err">isn't</span><span class="w"> </span><span class="err">a</span><span class="w"> </span><span class="err">valid</span><span class="w"> </span><span class="err">branch</span><span class="w">
</span><span class="nt">"keepVcs"</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">Keep</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">.git</span><span class="w"> </span><span class="err">folder</span><span class="w"> </span><span class="err">after</span><span class="w"> </span><span class="err">clone.</span><span class="w">
</span><span class="nt">"commitId"</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">Clone</span><span class="w"> </span><span class="err">from</span><span class="w"> </span><span class="err">a</span><span class="w"> </span><span class="err">commit</span><span class="w"> </span><span class="err">point.</span><span class="w"> </span><span class="err">Branch</span><span class="w"> </span><span class="err">precedes</span><span class="w"> </span><span class="err">this</span><span class="w"> </span><span class="err">property</span><span class="w">
</span><span class="nt">"keepDir"</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">Clone</span><span class="w"> </span><span class="err">all,</span><span class="w"> </span><span class="err">but</span><span class="w"> </span><span class="err">display</span><span class="w"> </span><span class="err">only</span><span class="w"> </span><span class="err">this</span><span class="w"> </span><span class="err">subdir</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">repo</span><span class="w">
</span><span class="nt">"fetch"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="err">REF-SPEC</span><span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">Clone</span><span class="w"> </span><span class="err">from</span><span class="w"> </span><span class="err">patch</span><span class="w"> </span><span class="err">set</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">provided</span><span class="w"> </span><span class="err">ref-spec</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
<p>Depending upon the type of version control system selected, you can configure the recipe to clone different repositories, branches, ref-specs. The <code class="highlighter-rouge">dockerfile</code> option is used by environments to reference a Dockerfile that will be used to build an image dynamically when the workspace is being constructed. The <code class="highlighter-rouge">git</code> and <code class="highlighter-rouge">svn</code> options are for cloning and synchronizing with Git and Subversion repositories.</p>
<p>Here is a simple example:</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="s2">"source"</span><span class="w"> </span><span class="err">:</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">"https://github.com/eclise/che.git"</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">"git"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
<p>This example clones a git repository hosted by Codenvy with a specific commit ID.</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="s2">"source"</span><span class="w"> </span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"project"</span><span class="w"> </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">"http://codenvy.com/git/31/eb/be/workspace3u0vri1qaptw0vmr/spring"</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">"git"</span><span class="p">,</span><span class="w">
</span><span class="nt">"parameters"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"commitId"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"db97e186e07ba881f23651d6238479cb2b1c3fcb"</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="modules">Modules</h3>
<p>A module is a directory in a project that can be independently built and run. Modules have their own project type and attributes, which can affect how the command behavior works for that directory apart from others or the project as a whole. Modules can be nested.</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="err">project.modules</span><span class="w"> </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">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">module</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">(OPTIONAL)</span><span class="w"> </span><span class="err">Pretty</span><span class="w"> </span><span class="err">description</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">show</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">users</span><span class="w">
</span><span class="nt">"path"</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">Relative</span><span class="w"> </span><span class="err">path</span><span class="w"> </span><span class="err">from</span><span class="w"> </span><span class="err">workspace</span><span class="w"> </span><span class="err">root</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">module</span><span class="w"> </span><span class="err">root</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">Same</span><span class="w"> </span><span class="err">as</span><span class="w"> </span><span class="err">workspace.projects.type</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">(OPTIONAL)</span><span class="w"> </span><span class="err">Same</span><span class="w"> </span><span class="err">as</span><span class="w"> </span><span class="err">workspace.projects.attributes</span><span class="w">
</span><span class="nt">"mixins"</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="err">//</span><span class="w"> </span><span class="err">(OPTIONAL)</span><span class="w"> </span><span class="err">Same</span><span class="w"> </span><span class="err">as</span><span class="w"> </span><span class="err">workspace.projects.mixins</span><span class="w">
</span><span class="p">}]</span><span class="w">
</span></code></pre>
</div>
<h2 id="commands">Commands</h2>
<p>When authoring a project template we recommend to predefine commands to register build and run actions. <a href="../../../docs/ide/commands/index.html">Learn more about commands.</a></p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="s2">"commands"</span><span class="w"> </span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"commandLine"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">Command</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">run</span><span class="w"> </span><span class="err">on</span><span class="w"> </span><span class="err">target</span><span class="w"> </span><span class="err">machine</span><span class="w">
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">Unique</span><span class="w"> </span><span class="err">Command</span><span class="w"> </span><span class="err">name</span><span class="w"> </span><span class="err">displayed</span><span class="w"> </span><span class="err">in</span><span class="w"> </span><span class="err">IDE</span><span class="w">
</span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"custom"</span><span class="err">|</span><span class="s2">"maven"</span><span class="err">|</span><span class="s2">"java"</span><span class="err">|</span><span class="s2">"gwt"</span><span class="err">|</span><span class="s2">"gwt_sdm_che"</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">will</span><span class="w"> </span><span class="err">filter</span><span class="w"> </span><span class="err">and</span><span class="w"> </span><span class="err">provide</span><span class="w"> </span><span class="err">different</span><span class="w"> </span><span class="err">interface</span><span class="w"> </span><span class="err">in</span><span class="w"> </span><span class="err">IDE</span><span class="w">
</span><span class="nt">"attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"goal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Build"</span><span class="err">|</span><span class="s2">"Run"</span><span class="err">|</span><span class="s2">"Debug"</span><span class="err">|</span><span class="s2">"Test"</span><span class="err">|</span><span class="s2">"Deploy"</span><span class="err">|</span><span class="s2">"Common"</span><span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">Assign</span><span class="w"> </span><span class="err">goal</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">filter</span><span class="w"> </span><span class="err">and</span><span class="w"> </span><span class="err">associate</span><span class="w"> </span><span class="err">with</span><span class="w"> </span><span class="err">interface</span><span class="w"> </span><span class="err">components</span><span class="w"> </span><span class="err">in</span><span class="w"> </span><span class="err">IDE</span><span class="w">
</span><span class="s2">"previewUrl"</span><span class="err">:</span><span class="w"> </span><span class="s2">"http://${server.port.8080}/${current.project.relpath}"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="s2">"command"</span><span class="w"> </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">Identifier</span><span class="w"> </span><span class="err">and</span><span class="w"> </span><span class="err">pretty</span><span class="w"> </span><span class="err">name</span><span class="w"> </span><span class="err">for</span><span class="w"> </span><span class="err">command</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">Command</span><span class="w"> </span><span class="err">type,</span><span class="w"> </span><span class="err">such</span><span class="w"> </span><span class="err">as</span><span class="w"> </span><span class="nt">"mvn"</span><span class="w">
</span><span class="nt">"commandLine"</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">Process</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">execute</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">"workingDir"</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">(Optional)</span><span class="w"> </span><span class="err">Location</span><span class="w"> </span><span class="err">in</span><span class="w"> </span><span class="err">workpace</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">execute</span><span class="w"> </span><span class="err">command</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="nt">"goal"</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">(Optional)</span><span class="w"> </span><span class="err">Associate</span><span class="w"> </span><span class="err">a</span><span class="w"> </span><span class="err">goal</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">command</span><span class="w">
</span><span class="s2">"previewUrl"</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">(Optional)</span><span class="w"> </span><span class="err">Refer</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="p">}</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
<p>Each commands have a type and get translated into a process that is executed on the command line within the machine’s environment. Some commands can be derived, such as <code class="highlighter-rouge">maven</code> commands where Che will apply the location and necessary flags for execution. Other commands can be custom, where the command line is executed within the environment as you have specified it.</p>
<p>The command line can use <a href="../../../docs/ide/commands/index.html#macros">Macros</a>.
See <a href="../../../docs/ide/commands/index.html">Command</a> reference.</p>
<h3 id="previewurl">PreviewURL</h3>
<p>Preview objects are stored as part of command. Che will generate the preview URL during the command execution and present the URL to the user as part of the command output. You can add a preview URL of any format within the command editor.</p>
<p>The previewURL can use <a href="../../../docs/ide/commands/index.html#macros">Macros</a>.</p>
<h3 id="command-sample">Command Sample</h3>
<p>Sample:</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="s2">"command"</span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"commandLine"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"mvn clean install -f ${project.current.path} -Dmaven.test.skip=true"</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="s2">"MCI"</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">"mvn"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
<p>This example will create an entry into the <code class="highlighter-rouge">CMD</code> drop down named <code class="highlighter-rouge">MCI</code> that will perform a <code class="highlighter-rouge">mvn clean install</code> command against the project or module that is selected in the project tree.</p>
<h2 id="tags">Tags</h2>
<p>Tags are used for stacks and sample objects. Those values are used to determine if a sample is compatible with a stack.</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="s2">"tags"</span><span class="w"> </span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"tag1"</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">strings</span><span class="w"> </span><span class="err">representing</span><span class="w"> </span><span class="err">tags</span><span class="w">
</span><span class="nt">"tag2"</span><span class="err">,</span><span class="w">
</span><span class="nt">"..."</span><span class="w">
</span><span class="err">}</span><span class="w">
</span></code></pre>
</div>
<h2 id="sample-reference">Sample Reference</h2>
<p>JSON:</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="nt">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Default Java Stack with JDK 8, Maven and Tomcat."</span><span class="p">,</span><span class="w">
</span><span class="nt">"scope"</span><span class="p">:</span><span class="w"> </span><span class="s2">"general"</span><span class="p">,</span><span class="w">
</span><span class="nt">"source"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"origin"</span><span class="p">:</span><span class="w"> </span><span class="s2">"eclipse/ubuntu_jdk8"</span><span class="p">,</span><span class="w">
</span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"image"</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nt">"tags"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
</span><span class="s2">"Java"</span><span class="p">,</span><span class="w">
</span><span class="s2">"JDK"</span><span class="p">,</span><span class="w">
</span><span class="s2">"Maven"</span><span class="p">,</span><span class="w">
</span><span class="s2">"Tomcat"</span><span class="p">,</span><span class="w">
</span><span class="s2">"Subversion"</span><span class="p">,</span><span class="w">
</span><span class="s2">"Ubuntu"</span><span class="p">,</span><span class="w">
</span><span class="s2">"Git"</span><span class="w">
</span><span class="p">],</span><span class="w">
</span><span class="nt">"workspaceConfig"</span><span class="p">:</span><span class="w"> </span><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">"default"</span><span class="p">:</span><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="p">:</span><span class="w"> </span><span class="s2">"eclipse/ubuntu_jdk8"</span><span class="p">,</span><span class="w">
</span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"dockerimage"</span><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">"dev-machine"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"agents"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
</span><span class="s2">"org.eclipse.che.terminal"</span><span class="p">,</span><span class="w">
</span><span class="s2">"org.eclipse.che.ws-agent"</span><span class="p">,</span><span class="w">
</span><span class="s2">"org.eclipse.che.ssh"</span><span class="w">
</span><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">"attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"memoryLimitBytes"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2147483648"</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="nt">"commands"</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">"commandLine"</span><span class="p">:</span><span class="w"> </span><span class="s2">"mvn clean install -f ${current.project.path}"</span><span class="p">,</span><span class="w">
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"build"</span><span class="p">,</span><span class="w">
</span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"mvn"</span><span class="p">,</span><span class="w">
</span><span class="nt">"attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"goal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Build"</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="nt">"commandLine"</span><span class="p">:</span><span class="w"> </span><span class="s2">"mvn -f /projects/console-java-simple clean install"</span><span class="p">,</span><span class="w">
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"console-java-simple: build"</span><span class="p">,</span><span class="w">
</span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"mvn"</span><span class="p">,</span><span class="w">
</span><span class="nt">"attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"goal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Build"</span><span class="p">,</span><span class="w">
</span><span class="nt">"previewUrl"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="nt">"commandLine"</span><span class="p">:</span><span class="w"> </span><span class="s2">"mvn -f /projects/console-java-simple clean install &amp;&amp; java -jar /projects/console-java-simple/target/*.jar"</span><span class="w">
</span><span class="s2">"name"</span><span class="err">:</span><span class="w"> </span><span class="s2">"console-java-simple: run"</span><span class="p">,</span><span class="w">
</span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"mvn"</span><span class="p">,</span><span class="w">
</span><span class="nt">"attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"goal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Run"</span><span class="p">,</span><span class="w">
</span><span class="nt">"previewUrl"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="nt">"projects"</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">"source"</span><span class="p">:</span><span class="w"> </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://github.com/che-samples/console-java-simple.git"</span><span class="p">,</span><span class="w">
</span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"git"</span><span class="p">,</span><span class="w">
</span><span class="nt">"parameters"</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">"problems"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
</span><span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
</span><span class="nt">"mixins"</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="s2">"console-java-simple"</span><span class="p">,</span><span class="w">
</span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"maven"</span><span class="p">,</span><span class="w">
</span><span class="nt">"path"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/console-java-simple"</span><span class="p">,</span><span class="w">
</span><span class="nt">"attributes"</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="nt">"defaultEnv"</span><span class="p">:</span><span class="w"> </span><span class="s2">"default"</span><span class="p">,</span><span class="w">
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"default"</span><span class="p">,</span><span class="w">
</span><span class="nt">"links"</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">"components"</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">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.8.0_45"</span><span class="p">,</span><span class="w">
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"JDK"</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="p">{</span><span class="w">
</span><span class="nt">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"3.2.2"</span><span class="p">,</span><span class="w">
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Maven"</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="p">{</span><span class="w">
</span><span class="nt">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"8.0.24"</span><span class="p">,</span><span class="w">
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tomcat"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">],</span><span class="w">
</span><span class="nt">"creator"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ide"</span><span class="p">,</span><span class="w">
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Java"</span><span class="p">,</span><span class="w">
</span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"java-default"</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=""><a href="../../../docs/devops/workspaces-data-model/index.html">Workspace Data Model</a></li>
<li class="current"><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>