docs/devops/ws-agents/index.html - gerrit/www.eclipse.org/che - Git at Google



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

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

       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="current"><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=""><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-ws-agents.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-ws-agents.md"><i class="fa fa-pencil"></i> &nbsp;Improve this page</a>-->
           </div>
           <div class="doc-title">
             <h1>Workspace Agents</h1>
             <div class="doc-title-border">
             </div>
           </div>

 <p>Agents are scripts that are executed after a <a href="../../../docs/devops/runtime-machines/index.html">runtime machine</a> is created. They add additional capabilities to the machines they’re injected in - for example to allow terminal access or enhanced language services. Agents allow these services to be injected into machines built from stock Dockerfiles or Compose files.</p>

 <h1 id="adding-agents-to-a-machine">Adding Agents to a Machine</h1>
 <p>Agents are added to <a href="../../../docs/devops/runtime-machines/index.html">machines</a> through <a href="../../../docs/devops/runtime-stacks/index.html">runtime stack</a> configuration. Eclipse Che’s included stacks have been pre-configured to use certain agents. The agents needed for each pre-defined stack is determined by common tasks or file types found in <a href="../../../docs/ide/projects/index.html">projects</a>.</p>

 <p>Adding agents to your own machines can be done by editing <a href="../../../docs/devops/runtime-machines/index.html">machine information in the user dashboard</a>.</p>

 <h1 id="adding-agents-to-a-custom-stack">Adding Agents to a Custom Stack</h1>
 <p>Stacks use JSON format for configuration. Agents are included in the machines definition. Each stack requires a machine named <code class="highlighter-rouge">dev-machine</code> which always requires terminal, exec and ws-agent. Language server agents need to be added to the dev-machine if you want <a href="../../../docs/ide/intellisense/index.html">intellisense</a> features when using the workspace IDE.</p>

 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="err">.......</span><span class="w">
   </span><span class="err">workspaceConfig</span><span class="s2">": {
     "</span><span class="err">environments</span><span class="s2">": {
       "</span><span class="err">default</span><span class="s2">": {
         "</span><span class="err">recipe</span><span class="s2">": {
           "</span><span class="err">location</span><span class="s2">": "</span><span class="err">eclipse/ubuntu_jdk</span><span class="mi">8</span><span class="s2">",
           "</span><span class="err">type</span><span class="s2">": "</span><span class="err">dockerimage</span><span class="s2">"
         },
         "</span><span class="err">machines</span><span class="s2">": {
           "</span><span class="err">dev-machine</span><span class="s2">": {
             "</span><span class="err">servers</span><span class="s2">": {},
             "</span><span class="err">agents</span><span class="s2">": [
               "</span><span class="err">org.eclipse.che.terminal</span><span class="s2">",
               "</span><span class="err">org.eclipse.che.ws-agent</span><span class="s2">",
               "</span><span class="err">org.eclipse.che.ssh</span><span class="s2">",
               "</span><span class="err">org.eclipse.che.ls.php</span><span class="s2">"
             ],
             "</span><span class="err">attributes</span><span class="s2">": {
               "</span><span class="err">memoryLimitBytes</span><span class="s2">": "</span><span class="mi">2147483648</span><span class="err">"</span><span class="w">
             </span><span class="err">}</span><span class="w">
           </span><span class="err">}</span><span class="w">
         </span><span class="err">}</span><span class="w">
       </span><span class="err">}</span><span class="w">
     </span><span class="err">},</span><span class="w">
 </span><span class="err">.......</span><span class="w">
 </span></code></pre>
 </div>

 <h1 id="creating-new-agents">Creating New Agents</h1>

 <p>Currently, all agents must be pre-defined within Che. We are thinking about a public registry for agents where they can be added and removed, but this is a future activity.</p>

 <p>A new agent has to implement the <a href="https://github.com/eclipse/che/blob/master/agents/che-core-api-agent-shared/src/main/java/org/eclipse/che/api/agent/shared/model/Agent.java">Agent interface</a> and be bound into the container.</p>

 <div class="language-java highlighter-rouge"><pre class="highlight"><code><span class="kd">public</span> <span class="kd">interface</span> <span class="nc">Agent</span> <span class="o">{</span>

     <span class="cm">/**
      * Returns the id of the agent.
      */</span>
     <span class="n">String</span> <span class="nf">getId</span><span class="o">();</span>

     <span class="cm">/**
      * Returns the name of the agent.
      */</span>
     <span class="n">String</span> <span class="nf">getName</span><span class="o">();</span>

     <span class="cm">/**
      * Returns the version of the agent.
      */</span>
     <span class="n">String</span> <span class="nf">getVersion</span><span class="o">();</span>

     <span class="cm">/**
      * Returns the description of the agent.
      */</span>
     <span class="n">String</span> <span class="nf">getDescription</span><span class="o">();</span>

     <span class="cm">/**
      * Returns the depending agents, that must be applied before.
      */</span>
     <span class="n">List</span><span class="o">&lt;</span><span class="n">String</span><span class="o">&gt;</span> <span class="nf">getDependencies</span><span class="o">();</span>

     <span class="cm">/**
      * Returns the script to be applied when machine is started.
      */</span>
     <span class="n">String</span> <span class="nf">getScript</span><span class="o">();</span>

     <span class="cm">/**
      * Returns any machine specific properties.
      */</span>
     <span class="n">Map</span><span class="o">&lt;</span><span class="n">String</span><span class="o">,</span> <span class="n">String</span><span class="o">&gt;</span> <span class="nf">getProperties</span><span class="o">();</span>

     <span class="cm">/**
      * Returns Che servers in the machine.
      */</span>
     <span class="n">Map</span><span class="o">&lt;</span><span class="n">String</span><span class="o">,</span> <span class="o">?</span> <span class="kd">extends</span> <span class="n">ServerConf2</span><span class="o">&gt;</span> <span class="nf">getServers</span><span class="o">();</span>
 <span class="o">}</span>
 </code></pre>
 </div>

 <p>Agents have an unique ID, a name, a set of other agents that they depend upon, properties, and a “script” that defines how the agent’s packages have to be installed into the workspace. This script handles installation and start of the agent.</p>

 <p>The scripts that you must provide with an agent have a large <code class="highlighter-rouge">if</code> block where you provide installation logic for each Linux distribution that we support. You can follow our <a href="https://github.com/eclipse/che/blob/master/agents/ls-json/src/main/resources/org.eclipse.che.ls.json.script.sh">templates</a> for how to build agents of your own.</p>

 <h3 id="adding-agents">Adding Agents</h3>

 <ul>
   <li>Create a sub module in the <a href="https://github.com/eclipse/che/tree/master/agents">agents folder</a></li>
   <li>Create a resource file with the agent description:</li>
 </ul>

 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
   </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"org.eclipse.che.my-agent"</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">"My simple agent"</span><span class="p">,</span><span class="w">
   </span><span class="nt">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Does some stuff :)"</span><span class="p">,</span><span class="w">
   </span><span class="nt">"dependencies"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
   </span><span class="nt">"properties"</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>

 <ul>
   <li>Create resource file with agent script:</li>
 </ul>

 <div class="language-bash highlighter-rouge"><pre class="highlight"><code>...

 <span class="nb">unset </span>PACKAGES
 <span class="nb">unset </span>SUDO
 <span class="nb">command</span> -v tar &gt;/dev/null 2&gt;&amp;1 <span class="o">||</span> <span class="o">{</span> <span class="nv">PACKAGES</span><span class="o">=</span><span class="k">${</span><span class="nv">PACKAGES</span><span class="k">}</span><span class="s2">" tar"</span>; <span class="o">}</span>
 <span class="nb">command</span> -v curl &gt;/dev/null 2&gt;&amp;1 <span class="o">||</span> <span class="o">{</span> <span class="nv">PACKAGES</span><span class="o">=</span><span class="k">${</span><span class="nv">PACKAGES</span><span class="k">}</span><span class="s2">" curl"</span>; <span class="o">}</span>
 <span class="nb">test</span> <span class="s2">"</span><span class="k">$(</span>id -u<span class="k">)</span><span class="s2">"</span> <span class="o">=</span> 0 <span class="o">||</span> <span class="nv">SUDO</span><span class="o">=</span><span class="s2">"sudo"</span>

 <span class="nv">CHE_DIR</span><span class="o">=</span><span class="nv">$HOME</span>/che

 ...

 <span class="k">if </span><span class="nb">echo</span> <span class="k">${</span><span class="nv">LINUX_TYPE</span><span class="k">}</span> | grep -qi <span class="s2">"rhel"</span>; <span class="k">then</span>
     ...

 <span class="c"># Red Hat Enterprise Linux 6</span>
 <span class="c">############################</span>
 <span class="k">elif </span><span class="nb">echo</span> <span class="k">${</span><span class="nv">LINUX_TYPE</span><span class="k">}</span> | grep -qi <span class="s2">"Red Hat"</span>; <span class="k">then</span>
     ...

 <span class="c"># Ubuntu 14.04 16.04 / Linux Mint 17</span>
 <span class="c">####################################</span>
 <span class="k">elif </span><span class="nb">echo</span> <span class="k">${</span><span class="nv">LINUX_TYPE</span><span class="k">}</span> | grep -qi <span class="s2">"ubuntu"</span>; <span class="k">then</span>
     ...

 <span class="c"># Debian 8</span>
 <span class="c">##########</span>
 <span class="k">elif </span><span class="nb">echo</span> <span class="k">${</span><span class="nv">LINUX_TYPE</span><span class="k">}</span> | grep -qi <span class="s2">"debian"</span>; <span class="k">then</span>
     ...

 <span class="c"># Fedora 23</span>
 <span class="c">###########</span>
 <span class="k">elif </span><span class="nb">echo</span> <span class="k">${</span><span class="nv">LINUX_TYPE</span><span class="k">}</span> | grep -qi <span class="s2">"fedora"</span>; <span class="k">then</span>
     ...

 <span class="c"># CentOS 7.1 &amp; Oracle Linux 7.1</span>
 <span class="c">###############################</span>
 <span class="k">elif </span><span class="nb">echo</span> <span class="k">${</span><span class="nv">LINUX_TYPE</span><span class="k">}</span> | grep -qi <span class="s2">"centos"</span>; <span class="k">then</span>
     ...

 <span class="c"># openSUSE 13.2</span>
 <span class="c">###############</span>
 <span class="k">elif </span><span class="nb">echo</span> <span class="k">${</span><span class="nv">LINUX_TYPE</span><span class="k">}</span> | grep -qi <span class="s2">"opensuse"</span>; <span class="k">then</span>
     ...

 <span class="k">else</span>
     &gt;&amp;2 <span class="nb">echo</span> <span class="s2">"Unrecognized Linux Type"</span>
     &gt;&amp;2 cat <span class="nv">$FILE</span>
     <span class="nb">exit </span>1
 <span class="k">fi</span>

 ...
 </code></pre>
 </div>

 <ul>
   <li>Create your own agent class extending <a href="https://github.com/eclipse/che/blob/master/agents/che-core-api-agent-shared/src/main/java/org/eclipse/che/api/agent/shared/model/impl/BasicAgent.java">BasicAgent</a>:</li>
 </ul>

 <div class="language-java highlighter-rouge"><pre class="highlight"><code><span class="nd">@Singleton</span>
 <span class="kd">public</span> <span class="kd">class</span> <span class="nc">MyAgent</span> <span class="kd">extends</span> <span class="n">BasicAgent</span> <span class="o">{</span>
     <span class="kd">private</span> <span class="kd">static</span> <span class="kd">final</span> <span class="n">String</span> <span class="n">AGENT_DESCRIPTOR</span> <span class="o">=</span> <span class="s">"&lt;AGENT_DESCRIPTOR_RESOURCE_NAME&gt;"</span><span class="o">;</span>
     <span class="kd">private</span> <span class="kd">static</span> <span class="kd">final</span> <span class="n">String</span> <span class="n">AGENT_SCRIPT</span>     <span class="o">=</span> <span class="s">"&lt;AGENT_SCRIPT_RESOURCE_NAME&gt;"</span><span class="o">;</span>

     <span class="nd">@Inject</span>
     <span class="kd">public</span> <span class="nf">MyAgent</span><span class="o">()</span> <span class="kd">throws</span> <span class="n">IOException</span> <span class="o">{</span>
         <span class="kd">super</span><span class="o">(</span><span class="n">AGENT_DESCRIPTOR</span><span class="o">,</span> <span class="n">AGENT_SCRIPT</span><span class="o">);</span>
     <span class="o">}</span>
 <span class="o">}</span>
 </code></pre>
 </div>

 <ul>
   <li>Bind agent into the container in <a href="https://github.com/eclipse/che/blob/master/assembly/assembly-wsmaster-war/src/main/java/org/eclipse/che/api/deploy/WsMasterModule.java">WsMasterModule</a>:</li>
 </ul>

 <div class="language-java highlighter-rouge"><pre class="highlight"><code><span class="nd">@DynaModule</span>
 <span class="kd">public</span> <span class="kd">class</span> <span class="nc">WsMasterModule</span> <span class="kd">extends</span> <span class="n">AbstractModule</span> <span class="o">{</span>
     <span class="nd">@Override</span>
     <span class="kd">protected</span> <span class="kt">void</span> <span class="nf">configure</span><span class="o">()</span> <span class="o">{</span>
         <span class="o">...</span>

         <span class="n">Multibinder</span><span class="o">&lt;</span><span class="n">Agent</span><span class="o">&gt;</span> <span class="n">agents</span> <span class="o">=</span> <span class="n">Multibinder</span><span class="o">.</span><span class="na">newSetBinder</span><span class="o">(</span><span class="n">binder</span><span class="o">(),</span> <span class="n">Agent</span><span class="o">.</span><span class="na">class</span><span class="o">);</span>
         <span class="n">agents</span><span class="o">.</span><span class="na">addBinding</span><span class="o">().</span><span class="na">to</span><span class="o">(</span><span class="n">MyAgent</span><span class="o">.</span><span class="na">class</span><span class="o">);</span>

         <span class="o">...</span>
     <span class="o">}</span>
 <span class="o">}</span>
 </code></pre>
 </div>

 <p>Have a look at our example of the <a href="https://github.com/eclipse/che/tree/master/agents/ls-json">JSON language server agent</a> for more ideas.</p>

         </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="current"><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=""><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>