docs/stacks.html - gerrit/www.eclipse.org/che - Git at Google

 <!DOCTYPE html>
 <html>
 <head>
     <meta charset="utf-8">
 <meta http-equiv="X-UA-Compatible" content="IE=edge">
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta name="description" content="">
 <meta name="keywords" content="workspaceruntimedockerkubernetes,  workspace, runtime, recipe, docker, stack">
 <title>Stacks | Eclipse Che Documentation</title>
 <link rel="stylesheet" href="css/syntax.css">

 <link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" crossorigin="anonymous">
 <!--<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">-->
 <link rel="stylesheet" href="css/modern-business.css">
 <!-- Latest compiled and minified CSS -->
 <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
 <link rel="stylesheet" href="css/customstyles.css">
 <link rel="stylesheet" href="css/boxshadowproperties.css">
 <!-- most color styles are extracted out to here -->
 <link rel="stylesheet" href="css/theme-che.css">


     <link rel="stylesheet" href="/css/coderay.css" media="screen" type="text/css">

 <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js" crossorigin="anonymous"></script>

 <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-cookie/1.4.1/jquery.cookie.min.js" crossorigin="anonymous"></script>
 <script src="js/jquery.navgoco.min.js"></script>


 <!-- Latest compiled and minified JavaScript -->
 <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
 <!-- Anchor.js -->
 <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/2.0.0/anchor.min.js" crossorigin="anonymous"></script>
 <script src="js/toc.js"></script>
 <script src="js/customscripts.js"></script>

 <link rel="shortcut icon" href="che/docs/images/favicon.ico">

 <!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
 <!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
 <!--[if lt IE 9]>
 <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
 <script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
 <![endif]-->

 <link rel="alternate" type="application/rss+xml" title="che" href="http://0.0.0.0:4000/feed.xml">

     <script>
         $(document).ready(function() {
             // Initialize navgoco with default options
             $("#mysidebar").navgoco({
                 caretHtml: '',
                 accordion: true,
                 openClass: 'active', // open
                 save: false, // leave false or nav highlighting doesn't work right
                 cookie: {
                     name: 'navgoco',
                     expires: false,
                     path: '/'
                 },
                 slide: {
                     duration: 400,
                     easing: 'swing'
                 }
             });

             $("#collapseAll").click(function(e) {
                 e.preventDefault();
                 $("#mysidebar").navgoco('toggle', false);
             });

             $("#expandAll").click(function(e) {
                 e.preventDefault();
                 $("#mysidebar").navgoco('toggle', true);
             });

         });

     </script>
     <script>
         $(function () {
             $('[data-toggle="tooltip"]').tooltip()
         })
     </script>
     <script>
         $(document).ready(function() {
             $("#tg-sb-link").click(function() {
                 $("#tg-sb-sidebar").toggle();
                 $("#tg-sb-content").toggleClass('col-md-9');
                 $("#tg-sb-content").toggleClass('col-md-12');
                 $("#tg-sb-icon").toggleClass('fa-toggle-on');
                 $("#tg-sb-icon").toggleClass('fa-toggle-off');
             });
         });
     </script>


 </head>
 <body>
 <!-- Navigation -->
 <nav class="navbar navbar-inverse navbar-static-top">
     <div class="container topnavlinks">
         <div class="navbar-header">
             <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
                 <span class="sr-only">Toggle navigation</span>
                 <span class="icon-bar"></span>
                 <span class="icon-bar"></span>
                 <span class="icon-bar"></span>
             </button>
             <a class="fa fa-home fa-lg navbar-brand" href="index.html">&nbsp;<span class="projectTitle"> Eclipse Che Documentation</span></a>
         </div>
         <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
             <ul class="nav navbar-nav navbar-right">
                 <!-- toggle sidebar button -->
                 <li><a id="tg-sb-link" href="#"><i id="tg-sb-icon" class="fa fa-toggle-on"></i> Nav</a></li>
                 <!-- entries without drop-downs appear here -->


                 <li><a href="https://medium.com/eclipse-che-blog/" target="_blank">Blog</a></li>


                 <li><a href="https://github.com/eclipse/che" target="_blank">Source Code</a></li>


                 <!-- entries with drop-downs appear here -->
                 <!-- conditional logic to control which topnav appears for the audience defined in the configuration file.-->


                 <li class="dropdown">
                     <a href="#" class="dropdown-toggle" data-toggle="dropdown">Get Support<b class="caret"></b></a>
                     <ul class="dropdown-menu">


                         <li><a href="https://github.com/eclipse/che/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Akind%2Fbug" target="_blank">Known Bugs</a></li>


                         <li><a href="https://github.com/eclipse/che/issues/new" target="_blank">File an Issue</a></li>


                         <li><a href="https://stackoverflow.com/questions/tagged/eclipse-che" target="_blank">Che on StackOverflow</a></li>


                     </ul>
                 </li>


                 <!--
 			<li>


   <a class="email" title="Submit feedback" href="#" onclick="javascript:window.location='mailto:?subject= feedback&body=I have some feedback about the Stacks page: ' + window.location.href;"><i class="fa fa-envelope-o"></i> Feedback</a>

 </li>
  -->

                 <!--comment out this block if you want to hide search-->
                 <li>
                     <!--start search-->
                     <div id="search-demo-container">
                         <input type="text" id="search-input" placeholder="search...">
                         <ul id="results-container"></ul>
                     </div>
                     <script src="js/jekyll-search.js" type="text/javascript"></script>
                     <script type="text/javascript">
                             SimpleJekyllSearch.init({
                                 searchInput: document.getElementById('search-input'),
                                 resultsContainer: document.getElementById('results-container'),
                                 dataSource: 'search.json',
                                 searchResultTemplate: '<li><a href="{url}" title="Stacks">{title}</a></li>',
                     noResultsText: 'No results found.',
                             limit: 10,
                             fuzzy: true,
                     })
                     </script>
                     <!--end search-->
                 </li>
             </ul>
         </div>
         </div>
         <!-- /.container -->
 </nav>

 <!-- Page Content -->
 <div class="container">
   <div id="main">
     <!-- Content Row -->
     <div class="row">


             <!-- Sidebar Column -->
             <div class="col-md-3" id="tg-sb-sidebar">


 <ul id="mysidebar" class="nav">
   <li class="sidebarTitle"> </li>


   <li>
       <a href="#">Overview</a>
       <ul>


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


           <li><a href="quick-start.html">Getting Started</a></li>


           <li><a href="single-multi-user.html">Single and Multi-User Flavors</a></li>


           <li><a href="infra-support.html">Supported Infrastructures</a></li>


       </ul>
    </li>


   <li>
       <a href="#">Che on Docker</a>
       <ul>


           <li><a href="docker-single-user.html">Docker - Single User</a></li>


           <li><a href="docker-multi-user.html">Docker - Multi User</a></li>


           <li><a href="docker-config.html">Docker - Configuration</a></li>


           <li><a href="docker-cli.html">Docker - CLI Reference</a></li>


       </ul>
    </li>


   <li>
       <a href="#">Che on Kubernetes</a>
       <ul>


           <li><a href="kubernetes-single-user.html">Kubernetes - Single User</a></li>


           <li><a href="kubernetes-multi-user.html">Kubernetes - Multi User</a></li>


           <li><a href="kubernetes-config.html">Kubernetes - Configuration</a></li>


           <li><a href="kubernetes-admin-guide.html">Kubernetes - Admin Guide</a></li>


       </ul>
    </li>


   <li>
       <a href="#">Che on OpenShift</a>
       <ul>


           <li><a href="openshift-single-user.html">OpenShift - Single User</a></li>


           <li><a href="openshift-multi-user.html">OpenShift - Multi User</a></li>


           <li><a href="openshift-config.html">OpenShift - Configuration</a></li>


           <li><a href="openshift-admin-guide.html">OpenShift - Admin Guide</a></li>


       </ul>
    </li>


   <li>
       <a href="#">User Management</a>
       <ul>


           <li><a href="user-management.html">Authentication and Authorization</a></li>


           <li><a href="authentication.html">Security Model</a></li>


           <li><a href="permissions.html">Permissions</a></li>


           <li><a href="organizations.html">Organizations in UD</a></li>


           <li><a href="resource-management.html">Resource Management</a></li>


       </ul>
    </li>


   <li>
       <a href="#">User Guides</a>
       <ul>


           <li><a href="creating-starting-workspaces.html">Creating and starting Workspaces</a></li>


           <li><a href="ide-projects.html">Projects</a></li>


           <li><a href="editor-code-assistance.html">Editor and Code-Assistance</a></li>


           <li><a href="dependency-management.html">Dependency Management</a></li>


           <li><a href="commands-ide-macro.html">Commands and IDE Macros</a></li>


           <li><a href="version-control.html">Version Control</a></li>


           <li><a href="debug.html">Debug</a></li>


       </ul>
    </li>


   <li>
       <a href="#">Workspace Administration</a>
       <ul>


           <li><a href="what-are-workspaces.html">Workspace Overview</a></li>


           <li class="active"><a href="stacks.html">Workspace - Stacks</a></li>


           <li><a href="recipes.html">Workspace - Recipes</a></li>


           <li><a href="servers.html">Workspace - Servers</a></li>


           <li><a href="installers.html">Workspace - Installers</a></li>


           <li><a href="volumes.html">Workspace - Volumes Mount</a></li>


           <li><a href="env-variables.html">Workspace - Environment Variables</a></li>


           <li><a href="projects.html">Workspace - Projects</a></li>


           <li><a href="workspaces-troubleshooting.html">Workspace - Troubleshooting</a></li>


           <li><a href="workspace-data-model.html">Workspace Data Model</a></li>


       </ul>
    </li>


   <li>
       <a href="#">Portable Workspaces</a>
       <ul>


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


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


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


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


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


           <li><a href="chefile.html">Chedir - Chefile</a></li>


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


           <li><a href="factories-getting-started.html">Factory - Getting Started</a></li>


           <li><a href="creating-factories.html">Factory - Creating</a></li>


           <li><a href="factories_json_reference.html">Factory - JSON Reference</a></li>


       </ul>
    </li>


   <li>
       <a href="#">Developer Guides</a>
       <ul>


           <li><a href="framework-overview.html">Overview</a></li>


           <li><a href="rest-api.html">SDK - REST API</a></li>


           <li><a href="che-in-che-quickstart.html">SDK - Your First Plugin</a></li>


           <li><a href="build-reqs.html">SDK - Building Che</a></li>


           <li><a href="assemblies.html">SDK - Assemblies</a></li>


           <li><a href="logging.html">SDK - Logging</a></li>


           <li><a href="ide-extensions-gwt.html">SDK - GWT IDE Extensions</a></li>


           <li><a href="server-side-extensions.html">SDK - Server Side Extensions</a></li>


           <li><a href="custom-installers.html">SDK - Installers</a></li>


           <li><a href="project-types.html">SDK - Project Types</a></li>


           <li><a href="language-servers.html">SDK - Language Support</a></li>


           <li><a href="parts.html">IDE UI&#58 Parts</a></li>


           <li><a href="actions.html">IDE UI&#58 Actions</a></li>


       </ul>
    </li>


   <li>
       <a href="#">Dev Essentials</a>
       <ul>


           <li><a href="guice.html">Dependency Injection</a></li>


           <li><a href="dto.html">Transport&#58 DTO</a></li>


           <li><a href="json-rpc.html">Communication&#58 JSON-RPC</a></li>


           <li><a href="handling-projects-in-plugins.html">Handling Projects in Plugins</a></li>


           <li><a href="dao.html">Persistence, DAO</a></li>


           <li><a href="properties.html">Properties</a></li>


       </ul>
    </li>


   <li>
       <a href="#">Infrastructure and SPI</a>
       <ul>


           <li><a href="spi_overview.html">Overview</a></li>


           <li><a href="spi-implementation.html">Implementation Notes</a></li>


       </ul>
    </li>


       <!-- if you aren't using the accordion, uncomment this block:
          <p class="external">
              <a href="#" id="collapseAll">Collapse All</a> | <a href="#" id="expandAll">Expand All</a>
          </p>
          -->
 </ul>

 <!-- this highlights the active parent class in the navgoco sidebar. this is critical so that the parent expands when you're viewing a page. This must appear below the sidebar code above. Otherwise, if placed inside customscripts.js, the script runs before the sidebar code runs and the class never gets inserted.-->
 <script>$("li.active").parents('li').toggleClass("active");</script>

             </div>


         <!-- Content Column -->
         <div class="col-md-9" id="tg-sb-content">
             <div class="post-header">
    <h1 class="post-title-main">Stacks</h1>
 </div>


 <div class="post-content">


 <!-- this handles the automatic toc. use ## for subheads to auto-generate the on-page minitoc. if you use html tags, you must supply an ID for the heading element in order for it to appear in the minitoc. -->
 <script>
 $( document ).ready(function() {
   // Handler for .ready() called.
 $('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2' });
 /* this offset helps account for the space taken up by the floating toolbar. */
 $('#toc').on('click', 'a', function() {
   var target = $(this.getAttribute('href'))
     , scroll_target = target.offset().top
   $(window).scrollTop(scroll_target - 10);
   return false
 })

 });
 </script>

 <div id="toc"></div>


     <!--


      -->

   <div class="sect1">
 <h2 id="what-are-stacks">What Are Stacks</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>A stack is a template of <a href="workspace-data-model.html">workspace configuration</a> and some meta-information like scope, tags, components, description, name and ID. Stacks are used by User Dashboard to make it easy to create workspaces and well as filter sample projects compatible with a chosen stack.</p>
 </div>
 <div class="paragraph">
 <p>Stacks are displayed in User Dashboard on Create a workspace page. You can filter them by type (single vs multi machine), scope (the ones displayed by default vs others), as well as search for a stack by keyword.</p>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="how-stacks-are-used">How Stacks Are Used?</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>As stacks are workspace templates, they are used to create workspace when in User Dashboard. See: <a href="creating-starting-workspaces.html">User Guide: Creating and Starting Workspaces</a>.</p>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="community-supported-stacks">Community Supported Stacks</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>The list of stacks Che offers out of the box references tested stacks and sample applications with commands on how to build, run and debug them. There are also stacks contributed by the community which work fine with Che but do not go through daily tests. It is possible however that sample applications may be incompatible with certain stacks.</p>
 </div>
 <div class="paragraph">
 <p>Community supported stacks and sample apps (if any) are located in <a href="https://github.com/che-samples/community-stacks">Community stacks GitHub repo</a>.</p>
 </div>
 <div class="paragraph">
 <p>Each directory has <code>${technology}-stack.json</code> and <code>${technology}-samples.json</code>. If you want to import a chosen stack, follow the below instructions:</p>
 </div>
 <div class="olist arabic">
 <ol class="arabic">
 <li>
 <p>Copy content of a chosen json</p>
 </li>
 <li>
 <p>Go to <code>${CHE_HOST}/swagger/#!/stack/createStack</code>, paste JSON content to request body field</p>
 </li>
 <li>
 <p>Hit <strong>Try it out</strong> button.</p>
 </li>
 </ol>
 </div>
 <div class="paragraph">
 <p>If there’s a conflict with stack ID or name, use a different name or ID (make sure it is unique).</p>
 </div>
 <div class="paragraph">
 <p>For a multi-user setup, you may want to make your stack available for a particular user or all users in the system. If this is the case, see <a href="#stack-sharing-and-system-stacks">stack sharing</a>.</p>
 </div>
 <div class="paragraph">
 <p>To import <strong>sample applications</strong>, move chosen <code>*-stacks.json</code> files to:</p>
 </div>
 <div class="ulist">
 <ul>
 <li>
 <p><code>${LOCAL_STORAGE}/instance/data/templates</code> for Docker infra</p>
 </li>
 <li>
 <p><code>${mount-path-of-che-data-volume}/templates</code> for OpenShift/K8S infra. You will need admin privileges to get PV details (host path) and access to host directory. Also, make sure the new jsons have the same permissions as the original <code>samples.json</code> that you will find there.</p>
 </li>
 </ul>
 </div>
 <div class="paragraph">
 <p>You can find Dockerfiles for all stacks in <a href="https://github.com/eclipse/che-dockerfiles">Che Dockerfiles repository</a>.</p>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="stack-sharing-and-system-stacks">Stack Sharing and System Stacks</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>Stacks that a user creates are available only for this user. Che users with system privileges can share created stacks with selected users or all users in the system. Currently, there are no UI controls for that, so a couple of REST calls need to be made:</p>
 </div>
 <div class="ulist">
 <ul>
 <li>
 <p>Log in as admin</p>
 </li>
 <li>
 <p>Find your stack ID: go to <code>/swagger/#!/stack/searchStacks</code> to get a list of all stacks (you may filter search by tags). Find your stack my name and get its ID.</p>
 </li>
 <li>
 <p>The next API to use is: <code>/swagger/#!/permissions</code></p>
 </li>
 <li>
 <p>Find the below POST method:</p>
 </li>
 </ul>
 </div>
 <div class="imageblock">
 <div class="content">
 <img src="/che/docs/images/workspaces/stack_permissions.png" alt="stack permissions">
 </div>
 </div>
 <div class="ulist">
 <ul>
 <li>
 <p>use the following JSON (replace <code>${STACK_ID}</code> with an actual ID)</p>
 </li>
 </ul>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="CodeRay highlight"><code data-lang="json">{
 <span class="key"><span class="delimiter">&quot;</span><span class="content">userId</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">*</span><span class="delimiter">&quot;</span></span>,
   <span class="key"><span class="delimiter">&quot;</span><span class="content">domainId</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">stack</span><span class="delimiter">&quot;</span></span>,
   <span class="key"><span class="delimiter">&quot;</span><span class="content">instanceId</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">${STACK_ID}</span><span class="delimiter">&quot;</span></span>,
   <span class="key"><span class="delimiter">&quot;</span><span class="content">actions</span><span class="delimiter">&quot;</span></span>: [
     <span class="string"><span class="delimiter">&quot;</span><span class="content">read</span><span class="delimiter">&quot;</span></span>,
     <span class="string"><span class="delimiter">&quot;</span><span class="content">search</span><span class="delimiter">&quot;</span></span>
   ]
 }</code></pre>
 </div>
 </div>
 <div class="paragraph">
 <p>If you get 204, all users in the system will be able to see this stack. If you want to share a stack with a particular user, get its ID and use it instead of <code>*</code> in JSON.</p>
 </div>
 <div class="paragraph">
 <p>Similarly, an admin can remove permissions from stacks or remove out of the box stacks to replace them with custom ones. Stacks can be created wither in User Dashboard or using any REST client, for instance Swagger (<code>$CHE_HOST:$CHE_PORT/swagger</code>) bundled with Che.</p>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="stacks-loading">Stacks Loading</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>Stacks are loaded from a JSON file that is packaged into resources of a special component deployed with a workspace master. This JSON isn’t exposed to users and stack management is performed in User Dashboard (that uses REST API).</p>
 </div>
 <div class="paragraph">
 <p>Stacks are loaded from a JSON file only when the database is initialized, i.e. when a user first stats Che. This is the default policy that can be changed. To keep getting updates with new Che stacks, set <code>CHE_PREDEFINED_STACKS_RELOAD<em>ON</em>START=true</code> in <code>che.env</code>. When set to true, <code>stacks.json</code> will be used to update Che database, each time Che server starts. This means Che will get all stacks in stacks.json and upload them to a DB. This way, you may make sure that you keep existing custom stacks (user-created) and get stack updates from new Che releases. New and edited stacks (for example those with fixes in stack definition) will be merged in. Conflicts are possible though, since for example, if a new Che version provides a new stack with the name "My Cool Stack" and a stack with this name somehow exists in a database, such a stack won’t be saved to a DB.</p>
 </div>
 </div>
 </div>

     <div class="tags">

         <b>Tags: </b>


         <a href="tag_workspace.html" class="btn btn-default navbar-btn cursorNorm" role="button">workspace</a>


         <a href="tag_runtime.html" class="btn btn-default navbar-btn cursorNorm" role="button">runtime</a>


         <a href="tag_docker.html" class="btn btn-default navbar-btn cursorNorm" role="button">docker</a>


         <a href="tag_kubernetes.html" class="btn btn-default navbar-btn cursorNorm" role="button">kubernetes</a>


     </div>

 <!--
  -->

 </div>

 <hr class="shaded"/>

 <footer>
             <div class="row">
                 <div class="col-lg-12 footer">
                     Eclipse Che - Documentation <br/>
                     Site last generated: Sep 13, 2018 <br/>
                     <hr>
                     <a href="http://www.eclipse.org" target="_blank">Eclipse Foundation</a><br/>
                     <a href="http://www.eclipse.org/legal/privacy.php" target="_blank">Privacy Policy</a><br/>
                     <a href="http://www.eclipse.org/legal/termsofuse.php" target="_blank">Terms of Use</a><br/>
                     <a href="https://www.eclipse.org/legal/epl-2.0/" target="_blank">Eclipse Public License</a><br/>
                     <a href="http://www.eclipse.org/legal" target="_blank">Legal Resources</a><br/>
                 </div>
             </div>
 </footer>


     <!-- /.row -->
 </div>
 <!-- /.container -->
 </div>
 <!-- /#main -->
     </div>

 </body>

 </html>