You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@slider.apache.org by bu...@apache.org on 2014/07/22 20:17:30 UTC
svn commit: r917125 [14/18] - in /websites/staging/slider/trunk/content: ./
css/ design/ design/registry/ design/specification/ developing/ docs/
docs/configuration/ docs/slider_specs/ downloads/ fonts/ images/ js/
release_notes/
Added: websites/staging/slider/trunk/content/docs/getting_started.html
==============================================================================
--- websites/staging/slider/trunk/content/docs/getting_started.html (added)
+++ websites/staging/slider/trunk/content/docs/getting_started.html Tue Jul 22 18:17:12 2014
@@ -0,0 +1,632 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+ <link href="/css/bootstrap.min.css" rel="stylesheet">
+ <link href="/css/bootstrap-theme.min.css" rel="stylesheet">
+ <!-- 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]-->
+ <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
+ <script src="/js/bootstrap.min.js"></script>
+ <link href="/css/slider.css" rel="stylesheet" type="text/css">
+ <link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet">
+ <title></title>
+
+</head>
+
+<body>
+<nav class="navbar navbar-default navbar-fixed-top" role="navigation">
+<div class="container-fluid">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-items">
+ <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="navbar-brand" href="/index.html">Slider</a>
+ </div>
+ <div class="collapse navbar-collapse" id="navbar-items">
+ <ul class="nav navbar-nav">
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="#">
+ Project <span class="caret"></span>
+ </a>
+<ul class="dropdown-menu">
+<li id="nav_index"><a href="/index.html">Home</a></li>
+<li id="nav_downloads"><a href="/downloads">Downloads</a></li>
+<li id="nav_source"><a href="https://git-wip-us.apache.org/repos/asf/incubator-slider.git"><i class="fa fa-external-link"></i> Source</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0"><i class="fa fa-external-link"></i> License</a></li>
+<li class="divider"></li>
+<li class="dropdown-header">Community</li>
+<li id="nav_team"><a href="/team.html">Team</a></li>
+<li id="nav_mailinglists"><a href="/mailing_lists.html">Mailing Lists</a></li>
+<li class="divider"></li>
+<li class="dropdown-header">Tools</li>
+<li id="nav_jira"><a href="https://issues.apache.org/jira/browse/SLIDER"><i class="fa fa-external-link"></i> Issues</a></li>
+<li id="nav_builds"><a href="https://builds.apache.org/job/Slider-develop"><i class="fa fa-external-link"></i> Builds</a></li>
+</ul>
+</li>
+
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="/design">
+ Design <span class="caret"></span>
+ </a>
+<ul class="dropdown-menu">
+<li id="nav_design_overview"><a href="/design/architecture.html">Overview</a></li>
+<li id="nav_app_needs"><a href="/docs/slider_specs/application_needs.html">Application Needs</a></li>
+<li id="nav_spec"><a href="/design/specification/index.html">Expected Behavior</a></li>
+<li id="nav_registry"><a href="/design/registry/index.html">Service Registry</a></li>
+<li id="nav_ssl_impl"><a href="/design/ssl_implementation.html">SSL Implementation</a></li>
+<li id="nav_role_history"><a href="/design/rolehistory.html">Role History</a></li>
+</ul>
+</li>
+
+
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="/developing">
+ Developing <span class="caret"></span>
+ </a>
+<ul class="dropdown-menu">
+<li id="nav_dev_building"><a href="/developing/building.html">Building</a></li>
+<li id="nav_dev_debugging"><a href="/docs/debugging.html">Debugging</a></li>
+<li id="nav_dev_testing"><a href="/developing/testing.html">Testing</a></li>
+<li id="nav_dev_funtesting"><a href="/developing/functional_tests.html">Functional Testing</a></li>
+<li id="nav_dev_manual_testing"><a href="/developing/manual_testing.html">Manual Testing</a></li>
+<li id="nav_releasing"><a href="/developing/releasing.html">Releasing</a></li>
+</ul>
+</li>
+
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="#">
+ Using <span class="caret"></span>
+ </a>
+<ul class="dropdown-menu">
+<li id="nav_use_getting_started"><a href="/docs/getting_started.html">Getting Started</a></li>
+<li id="nav_use_manpage"><a href="/docs/manpage.html">Man Page</a></li>
+<li id="nav_use_examples"><a href="/docs/examples.html">Examples</a></li>
+<li id="nav_use_client_config"><a href="/docs/client-configuration.html">Client Configuration</a></li>
+<li id="nav_use_exitcodes"><a href="/docs/exitcodes.html">Client Exit Codes</a></li>
+<li id="nav_use_security"><a href="/docs/security.html">Security</a></li>
+<li id="nav_am_agent_ssl"><a href="/docs/ssl.html">Agent to AM SSL</a></li>
+<li id="nav_use_app_package"><a href="/docs/slider_specs/index.html">Creating App Packages</a></li>
+<li id="nav_use_app_configuration"><a href="/docs/configuration/index.html">App Configuration Model</a></li>
+<li id="nav_use_debugging"><a href="/docs/debugging.html">Debugging</a></li>
+<li id="nav_use_troubleshooting"><a href="/docs/troubleshooting.html">Troubleshooting</a></li>
+</ul>
+</li>
+
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="#">
+ ASF Links <span class="caret"></span>
+ </a>
+<ul class="dropdown-menu">
+<li><a href="http://www.apache.org"><i class="fa fa-external-link"></i> Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html"><i class="fa fa-external-link"></i> Sponsorship</a></li>
+<li><a href="http://www.apache.org/security/"><i class="fa fa-external-link"></i> Security</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html"><i class="fa fa-external-link"></i> Thanks</a></li>
+</ul>
+</li>
+</ul>
+
+ </div>
+
+</div>
+</nav>
+
+
+<div class="container-fluid">
+<div class="row">
+ <div class="col-md-2" id="sidebar">
+ <div style="text-align: center">
+ <h1><a href="/index.html">Apache Slider (incubating)</a></h1>
+ <hr>
+Latest release: <strong>0.40-incubating</strong><br>
+ <br>
+ <a id="download-button-sidebar" class="btn btn-success btn-block" href="/downloads/" role="button">Download</a>
+ </div>
+ <hr>
+ <a href="http://incubator.apache.org"><img id="logo" alt="Apache Incubator ™" class="img-responsive" src="http://incubator.apache.org/images/apache-incubator-logo.png"/></a>
+ </div>
+ <div class="col-md-8 col-md-offset-1">
+
+ <div id="content">
+
+ <h1 class="title"></h1>
+
+ <!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<h1 id="apache-slider-getting-started">Apache Slider: Getting Started</h1>
+<h2 id="introduction">Introduction</h2>
+<p>The following provides the steps required for setting up a cluster and deploying a YARN hosted application using Slider.</p>
+<ul>
+<li>
+<p><a href="#sysreqs">System Requirements</a></p>
+</li>
+<li>
+<p><a href="#setup">Setup the Cluster</a></p>
+</li>
+<li>
+<p><a href="#download">Download Slider Packages</a></p>
+</li>
+<li>
+<p><a href="#build">Build Slider</a></p>
+</li>
+<li>
+<p><a href="#install">Install Slider</a></p>
+</li>
+<li>
+<p><a href="#deploy">Deploy Slider Resources</a></p>
+</li>
+<li>
+<p><a href="#downsample">Create Application Packages</a></p>
+</li>
+<li>
+<p><a href="#installapp">Install, Configure, Start and Verify Sample Application</a></p>
+</li>
+</ul>
+<h2 id="wzxhzdk23wzxhzdk24system-requirements"><a name="sysreqs"></a>System Requirements</h2>
+<p>The Slider deployment has the following minimum system requirements:</p>
+<ul>
+<li>
+<p>Hadoop 2.4+</p>
+</li>
+<li>
+<p>Required Services: HDFS, YARN, MapReduce2 and ZooKeeper</p>
+</li>
+<li>
+<p>Oracle JDK 1.7 (64-bit)</p>
+</li>
+<li>
+<p>Python 2.7</p>
+</li>
+</ul>
+<h2 id="wzxhzdk25wzxhzdk26setup-the-cluster"><a name="setup"></a>Setup the Cluster</h2>
+<p>After setting up your Hadoop cluster (using Ambari or other means) with the
+services listed above, modify your YARN configuration to allow for multiple
+containers on a single host. In <code>yarn-site.xml</code> make the following modifications:</p>
+<table>
+ <tr>
+ <td>Property</td>
+ <td>Value</td>
+ </tr>
+ <tr>
+ <td>yarn.scheduler.minimum-allocation-mb</td>
+ <td>>= 256 (ensure that YARN can allocate sufficient number of containers)</td>
+ </tr>
+ <tr>
+ <td>yarn.nodemanager.delete.debug-delay-sec</td>
+ <td>>= 3600 (to retain for an hour)</td>
+ </tr>
+</table>
+
+<p>There are other options detailed in the Troubleshooting file available <a href="/docs/troubleshooting.html">here</a>.</p>
+<h2 id="wzxhzdk27wzxhzdk28download-slider-packages"><a name="download"></a>Download Slider Packages</h2>
+<p>Slider releases are available at
+<a href="https://www.apache.org/dyn/closer.cgi/incubator/slider">https://www.apache.org/dyn/closer.cgi/incubator/slider</a>.</p>
+<p><em>Or, you can build it as described below.</em></p>
+<h2 id="wzxhzdk29wzxhzdk30build-slider"><a name="build"></a>Build Slider</h2>
+<ul>
+<li>From the top level directory, execute <code>mvn clean site:site site:stage package -DskipTests</code></li>
+<li>Use the generated compressed tar file in slider-assembly/target directory (e.g. slider-0.30.0-all.tar.gz) for the subsequent steps</li>
+</ul>
+<h2 id="wzxhzdk31wzxhzdk32install-slider"><a name="install"></a>Install Slider</h2>
+<p>Slider is installed on a client machine that can access the hadoop cluster. Follow the following steps to expand/install Slider:</p>
+<div class="codehilite"><pre>mkdir <span class="cp">${</span><span class="n">slider</span><span class="o">-</span><span class="n">install</span><span class="o">-</span><span class="nb">dir</span><span class="o">*</span><span class="p">;</span>
+
+<span class="n">cd</span> <span class="err">$</span><span class="p">{</span><span class="n">slider</span><span class="o">-</span><span class="n">install</span><span class="o">-</span><span class="nb">dir</span><span class="cp">}</span>
+</pre></div>
+
+
+<p>Login as the "yarn" user (assuming this is a host associated with the installed cluster). E.g., <code>su yarn</code>
+<em>This assumes that all apps are being run as âyarnâ user. Any other user can be used to run the apps - ensure that file permission is granted as required.</em></p>
+<p>Expand the tar file: <code>tar -xvf slider-0.30.0-all.tar.gz</code></p>
+<p>Browse to the Slider directory: <code>cd slider-0.30.0/bin</code></p>
+<p><em>Add java to the PATH.</em></p>
+<div class="codehilite"><pre> <span class="n">export</span> <span class="n">PATH</span><span class="p">=</span>$<span class="n">PATH</span><span class="p">:</span><span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">jdk64</span><span class="o">/</span><span class="n">jdk1</span><span class="p">.</span>7<span class="p">.</span>0<span class="n">_45</span><span class="o">/</span><span class="n">bin</span>
+</pre></div>
+
+
+<p>(or the path to the JDK bin directory)</p>
+<p>Modify Slider configuration file <code>${slider-install-dir}/slider-0.30.0/conf/slider-client.xml</code> to add the following properties:</p>
+<div class="codehilite"><pre> <span class="nt"><property></span>
+ <span class="nt"><name></span>yarn.application.classpath<span class="nt"></name></span>
+ <span class="nt"><value></span>/etc/hadoop/conf,/usr/lib/hadoop/*,/usr/lib/hadoop/lib/*,/usr/lib/hadoop-hdfs/*,/usr/lib/hadoop-hdfs/lib/*,/usr/lib/hadoop-yarn/*,/usr/lib/hadoop-yarn/lib/*,/usr/lib/hadoop-mapreduce/*,/usr/lib/hadoop-mapreduce/lib/*<span class="nt"></value></span>
+ <span class="nt"></property></span>
+
+ <span class="nt"><property></span>
+ <span class="nt"><name></span>slider.zookeeper.quorum<span class="nt"></name></span>
+ <span class="nt"><value></span>yourZooKeeperHost:port<span class="nt"></value></span>
+ <span class="nt"></property></span>
+</pre></div>
+
+
+<p>In addition, specify the scheduler and HDFS addresses as follows:</p>
+<div class="codehilite"><pre><span class="nt"><property></span>
+ <span class="nt"><name></span>yarn.resourcemanager.address<span class="nt"></name></span>
+ <span class="nt"><value></span>yourResourceManagerHost:8050<span class="nt"></value></span>
+<span class="nt"></property></span>
+<span class="nt"><property></span>
+ <span class="nt"><name></span>yarn.resourcemanager.scheduler.address<span class="nt"></name></span>
+ <span class="nt"><value></span>yourResourceManagerHost:8030<span class="nt"></value></span>
+<span class="nt"></property></span>
+<span class="nt"><property></span>
+ <span class="nt"><name></span>fs.defaultFS<span class="nt"></name></span>
+ <span class="nt"><value></span>hdfs://yourNameNodeHost:8020<span class="nt"></value></span>
+<span class="nt"></property></span>
+</pre></div>
+
+
+<p>Execute:</p>
+<div class="codehilite"><pre><span class="cp">${</span><span class="n">slider</span><span class="o">-</span><span class="n">install</span><span class="o">-</span><span class="nb">dir</span><span class="cp">}</span>/slider-0.30.0/bin/slider version
+</pre></div>
+
+
+<p>Ensure there are no errors and you can see "Compiled against Hadoop 2.4.0". <strong>This ensures that Slider is installed correctly.</strong></p>
+<h2 id="wzxhzdk33wzxhzdk34deploy-slider-resources"><a name="deploy"></a>Deploy Slider Resources</h2>
+<p>Ensure that all file folders are accessible to the user creating the application instance. The example assumes "yarn" to be that user. The HDFS folder "/slider" is a suggestion and the default application packages and associated configurations assume this path while accessing the slider-agent tarball.</p>
+<h3 id="create-hdfs-root-folder-for-slider">Create HDFS root folder for Slider</h3>
+<p>Perform the following steps to create the Slider root folder with the appropriate permissions:</p>
+<div class="codehilite"><pre><span class="n">su</span> <span class="n">hdfs</span>
+
+<span class="n">hdfs</span> <span class="n">dfs</span> <span class="o">-</span><span class="n">mkdir</span> <span class="o">/</span><span class="n">slider</span>
+
+<span class="n">hdfs</span> <span class="n">dfs</span> <span class="o">-</span><span class="n">chown</span> <span class="n">yarn</span><span class="p">:</span><span class="n">hdfs</span> <span class="o">/</span><span class="n">slider</span>
+
+<span class="n">hdfs</span> <span class="n">dfs</span> <span class="o">-</span><span class="n">mkdir</span> <span class="o">/</span><span class="n">user</span><span class="o">/</span><span class="n">yarn</span>
+
+<span class="n">hdfs</span> <span class="n">dfs</span> <span class="o">-</span><span class="n">chown</span> <span class="n">yarn</span><span class="p">:</span><span class="n">hdfs</span> <span class="o">/</span><span class="n">user</span><span class="o">/</span><span class="n">yarn</span>
+</pre></div>
+
+
+<h3 id="load-slider-agent">Load Slider Agent</h3>
+<div class="codehilite"><pre>su yarn
+
+hdfs dfs -mkdir /slider/agent
+
+hdfs dfs -copyFromLocal <span class="cp">${</span><span class="n">slider</span><span class="o">-</span><span class="n">install</span><span class="o">-</span><span class="nb">dir</span><span class="cp">}</span>/slider-0.30.0/agent/slider-agent.tar.gz /slider/agent
+</pre></div>
+
+
+<h2 id="wzxhzdk35wzxhzdk36create-application-packages"><a name="downsample"></a>Create Application Packages</h2>
+<p>Few pre-created application packages are available at: TBD</p>
+<p>Slider "master" branch has three sample application packages available for use with Slider:</p>
+<ul>
+<li>
+<p>app-packages/hbase: The README.txt file describes how to create a Slider Application Package for HBase. By default it will create a package for HBase 0.98.3 but you can create the same for other versions.</p>
+</li>
+<li>
+<p>app-packages/accumulo: The README.txt file describes how to create a Slider Application Package for Accumulo.</p>
+</li>
+<li>
+<p>app-packages/storm: The README.txt describes how to create the Slider Application package for Storm.</p>
+</li>
+</ul>
+<p>Create one or more Slider application packages and follow the steps below to install them.</p>
+<h2 id="wzxhzdk37wzxhzdk38install-configure-start-and-verify-sample-application"><a name="installapp"></a>Install, Configure, Start and Verify Sample Application</h2>
+<ul>
+<li>
+<p><a href="#load">Load Sample Application Package</a></p>
+</li>
+<li>
+<p><a href="#create">Create Application Specifications</a></p>
+</li>
+<li>
+<p><a href="#start">Start the Application</a></p>
+</li>
+<li>
+<p><a href="#verify">Verify the Application</a></p>
+</li>
+<li>
+<p><a href="#manage">Manage the Application Lifecycle</a></p>
+</li>
+</ul>
+<h3 id="wzxhzdk39wzxhzdk40load-sample-application-package"><a name="load"></a>Load Sample Application Package</h3>
+<div class="codehilite"><pre><span class="n">hdfs</span> <span class="n">dfs</span> <span class="o">-</span><span class="n">copyFromLocal</span> <span class="o">*</span><span class="n">sample</span><span class="o">-</span><span class="n">application</span><span class="o">-</span><span class="n">package</span><span class="o">*</span> <span class="o">/</span><span class="n">slider</span>
+</pre></div>
+
+
+<h3 id="wzxhzdk41wzxhzdk42create-application-specifications"><a name="create"></a>Create Application Specifications</h3>
+<p>Configuring a Slider application consists of two parts: the <a href="#resspec">Resource Specification</a>,
+ and the *<a href="#appconfig">Application Configuration</a>. Below are guidelines for creating these files.</p>
+<p><em>Note: There are sample Resource Specifications (<strong>resources.json</strong>) and Application Configuration
+(<strong>appConfig.json</strong>) files in the root directory of the
+Sample Applications packages (e.g. /<strong>resources.json</strong> and /<strong>appConfig.json</strong>). The Slider git repo also contains sample appConfig.json and resources.json in the application packages directory (e.g. app-packages/hbase/appConfig.json)</em></p>
+<h4 id="wzxhzdk43wzxhzdk44resource-specification"><a name="resspec"></a>Resource Specification</h4>
+<p>Slider needs to know what components (and how many components) are in an application package to deploy. For example, in HBase, the components are <strong><em>master</em></strong> and <strong><em>worker</em></strong> -- the latter hosting <strong>HBase RegionServers</strong>, and the former hosting the <strong>HBase Master</strong>. </p>
+<p>As Slider creates each instance of a component in its own YARN container, it also needs to know what to ask YARN for in terms of <strong>memory</strong> and <strong>CPU</strong> for those containers. </p>
+<p>All this information goes into the <strong>Resources Specification</strong> file ("Resource Spec") named <code>resources.json</code>. The Resource Spec tells Slider how many instances of each component in the application (such as an HBase RegionServer) to deploy and the parameters for YARN.</p>
+<p>Store the Resource Spec file on your local disk (e.g. <code>/tmp/resources.json</code>).</p>
+<p><a href="#appendixb">Appendix B</a> provides some sample resources.json files.</p>
+<h4 id="wzxhzdk45wzxhzdk46application-configuration"><a name="appconfig"></a>Application Configuration</h4>
+<p>Alongside the Resource Spec there is the <strong>Application Configuration</strong> file ("App Config") which includes parameters that are specific to the application, rather than YARN. The App Config is a file that contains all application configuration. This configuration is applied to the default configuration provided by the application definition and then handed off to the associated component agent.</p>
+<p>For example, the heap sizes of the JVMs, The App Config defines the configuration details <strong>specific to the application and component</strong> instances. For HBase, this includes any values for the <em>to-be-generated </em>hbase-site.xml file, as well as options for individual components, such as their heap size.</p>
+<p><a href="#appendixc">Appendix C</a> provides a sample appConfig.json file.</p>
+<h3 id="wzxhzdk47wzxhzdk48start-the-application"><a name="start"></a>Start the Application</h3>
+<p>Once the steps above are completed, the application can be started through the <strong>Slider Command Line Interface (CLI)</strong>.</p>
+<p>Change directory to the "bin" directory under the slider installation</p>
+<div class="codehilite"><pre>cd <span class="cp">${</span><span class="n">slider</span><span class="o">-</span><span class="n">install</span><span class="o">-</span><span class="nb">dir</span><span class="cp">}</span>/slider-0.30.0/bin
+</pre></div>
+
+
+<p>Execute the following command:</p>
+<div class="codehilite"><pre><span class="o">./</span><span class="n">slider</span> <span class="n">create</span> <span class="n">cl1</span> <span class="o">--</span><span class="n">image</span> <span class="n">hdfs</span><span class="p">:</span><span class="o">//</span><span class="n">yourNameNodeHost</span><span class="p">:</span>8020<span class="o">/</span><span class="n">slider</span><span class="o">/</span><span class="n">agent</span><span class="o">/</span><span class="n">slider</span><span class="o">-</span><span class="n">agent</span><span class="p">.</span><span class="n">tar</span><span class="p">.</span><span class="n">gz</span> <span class="o">--</span><span class="n">template</span> <span class="n">appConfig</span><span class="p">.</span><span class="n">json</span> <span class="o">--</span><span class="n">resources</span> <span class="n">resources</span><span class="p">.</span><span class="n">json</span>
+</pre></div>
+
+
+<h3 id="wzxhzdk49wzxhzdk50verify-the-application"><a name="verify"></a>Verify the Application</h3>
+<p>The successful launch of the application can be verified via the YARN Resource Manager Web UI. In most instances, this UI is accessible via a web browser at port 8088 of the Resource Manager Host:</p>
+<p><img alt="image alt text" src="../images/image_1_apps_rm_ui-lrg.png" /></p>
+<p>The specific information for the running application is accessible via the "ApplicationMaster" link that can be seen in the far right column of the row associated with the running application (probably the top row):</p>
+<p><img alt="image alt text" src="../images/image_0_app_master_ui_lrg.png" /></p>
+<h3 id="wzxhzdk51wzxhzdk52obtain-client-config"><a name="client-config"></a>Obtain client config</h3>
+<p>An application publishes several useful details that can be used to manage and communicate with the application instance.</p>
+<p><strong>All published data</strong></p>
+<p>All published data are available at the <code>/ws/v1/slider/publisher</code> end point of the AppMaster (e.g. http://c6403.ambari.apache.org:34701/ws/v1/slider/publisher). Its obtainable through <code>slider-client status <app name></code> where field <code>info.am.web.url</code> specifies the base address. The URL is also advertised in the AppMaster tracking UI.</p>
+<p><strong>Client configuration</strong>
+Client configurations are at <code>/ws/v1/slider/publisher/slider\<config name></code> where <em>config name</em> can be </p>
+<ul>
+<li>site config file name without extension, such as <code>hbase-site</code> (e.g. http://c6403.ambari.apache.org:34701/ws/v1/slider/publisher/slider/hbase-site) where the output is json formatted name-value pairs</li>
+<li>or, with extension such as <code>hbase-site.xml</code> (http://c6403.ambari.apache.org:34701/ws/v1/slider/publisher/slider/hbase-site.xml) to get an XML formatted output that can be consumed by the clients</li>
+</ul>
+<p><strong>Log locations</strong></p>
+<p>The log locations for various containers in the application instance are at <code>ws/v1/slider/publisher/slider/logfolders</code></p>
+<div class="codehilite"><pre><span class="p">{</span>
+
+ "<span class="n">description</span>"<span class="p">:</span> "<span class="n">LogFolders</span>"<span class="p">,</span>
+ "<span class="n">entries</span>"<span class="p">:</span> <span class="p">{</span>
+ "<span class="n">c6403</span><span class="p">.</span><span class="n">ambari</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">org</span><span class="o">-</span><span class="n">container_1404783501621_0002_01_000002</span><span class="o">-</span><span class="n">AGENT_LOG_ROOT</span>"<span class="p">:</span> "<span class="o">/</span><span class="n">hadoop</span><span class="o">/</span><span class="n">yarn</span><span class="o">/</span><span class="nb">log</span><span class="o">/</span><span class="n">application_1404783501621_0002</span><span class="o">/</span><span class="n">container_1404783501621_0002_01_000002</span>"<span class="p">,</span>
+ "<span class="n">c6403</span><span class="p">.</span><span class="n">ambari</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">org</span><span class="o">-</span><span class="n">container_1404783501621_0002_01_000003</span><span class="o">-</span><span class="n">AGENT_LOG_ROOT</span>"<span class="p">:</span> "<span class="o">/</span><span class="n">hadoop</span><span class="o">/</span><span class="n">yarn</span><span class="o">/</span><span class="nb">log</span><span class="o">/</span><span class="n">application_1404783501621_0002</span><span class="o">/</span><span class="n">container_1404783501621_0002_01_000003</span>"<span class="p">,</span>
+ "<span class="n">c6403</span><span class="p">.</span><span class="n">ambari</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">org</span><span class="o">-</span><span class="n">container_1404783501621_0002_01_000003</span><span class="o">-</span><span class="n">AGENT_WORK_ROOT</span>"<span class="p">:</span> "<span class="o">/</span><span class="n">hadoop</span><span class="o">/</span><span class="n">yarn</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">usercache</span><span class="o">/</span><span class="n">yarn</span><span class="o">/</span><span class="n">appcache</span><span class="o">/</span><span class="n">application_1404783501621_0002</span><span class="o">/</span><span class="n">container_1404783501621_0002_01_000003</span>"<span class="p">,</span>
+ "<span class="n">c6403</span><span class="p">.</span><span class="n">ambari</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">org</span><span class="o">-</span><span class="n">container_1404783501621_0002_01_000002</span><span class="o">-</span><span class="n">AGENT_WORK_ROOT</span>"<span class="p">:</span> "<span class="o">/</span><span class="n">hadoop</span><span class="o">/</span><span class="n">yarn</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">usercache</span><span class="o">/</span><span class="n">yarn</span><span class="o">/</span><span class="n">appcache</span><span class="o">/</span><span class="n">application_1404783501621_0002</span><span class="o">/</span><span class="n">container_1404783501621_0002_01_000002</span>"
+ <span class="p">},</span>
+ "<span class="n">updated</span>"<span class="p">:</span> 0<span class="p">,</span>
+ "<span class="n">empty</span>"<span class="p">:</span> <span class="n">false</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<p><strong>Quick links</strong></p>
+<p>An application may publish some quick links for the monitoring UI, JMX endpoint, etc. as the listening ports are dynamically allocated and thus need to be published. These information is available at <code>/ws/v1/slider/publisher/slider/quicklinks</code>.</p>
+<h3 id="wzxhzdk53wzxhzdk54manage-the-application-lifecycle"><a name="manage"></a>Manage the Application Lifecycle</h3>
+<p>Once started, applications can be frozen/stopped, thawed/restarted, and destroyed/removed as follows:</p>
+<h4 id="frozen">Frozen:</h4>
+<div class="codehilite"><pre><span class="o">./</span><span class="n">slider</span> <span class="n">freeze</span> <span class="n">cl1</span>
+</pre></div>
+
+
+<h4 id="thawed">Thawed:</h4>
+<div class="codehilite"><pre><span class="o">./</span><span class="n">slider</span> <span class="n">thaw</span> <span class="n">cl1</span>
+</pre></div>
+
+
+<h4 id="destroyed">Destroyed:</h4>
+<div class="codehilite"><pre><span class="o">./</span><span class="n">slider</span> <span class="n">destroy</span>
+</pre></div>
+
+
+<h4 id="flexed">Flexed:</h4>
+<div class="codehilite"><pre><span class="o">./</span><span class="n">slider</span> <span class="n">flex</span> <span class="n">cl1</span> <span class="o">--</span><span class="n">component</span> <span class="n">worker</span> 5
+</pre></div>
+
+
+<h1 id="wzxhzdk55wzxhzdk56appendix-a-debugging-slider-agent"><a name="appendixa"></a>Appendix A: Debugging Slider-Agent</h1>
+<h2 id="create-and-deploy-slider-agent-configuration">Create and deploy Slider Agent configuration</h2>
+<p>Create an agent config file (agent.ini) based on the sample available at:</p>
+<div class="codehilite"><pre><span class="cp">${</span><span class="n">slider</span><span class="o">-</span><span class="n">install</span><span class="o">-</span><span class="nb">dir</span><span class="cp">}</span>/slider-0.30.0/agent/conf/agent.ini
+</pre></div>
+
+
+<p>The sample agent.ini file can be used as is (see below). Some of the parameters of interest are:</p>
+<p><code>log_level</code> = INFO or DEBUG, to control the verbosity of log</p>
+<p><code>app_log_dir</code> = the relative location of the application log file</p>
+<p><code>log_dir</code> = the relative location of the agent and command log file</p>
+<div class="codehilite"><pre><span class="k">[server]</span>
+<span class="na">hostname</span><span class="o">=</span><span class="s">localhost</span>
+<span class="na">port</span><span class="o">=</span><span class="s">8440</span>
+<span class="na">secured_port</span><span class="o">=</span><span class="s">8441</span>
+<span class="na">check_path</span><span class="o">=</span><span class="s">/ws/v1/slider/agents/</span>
+<span class="na">register_path</span><span class="o">=</span><span class="s">/ws/v1/slider/agents/{name}/register</span>
+<span class="na">heartbeat_path</span><span class="o">=</span><span class="s">/ws/v1/slider/agents/{name}/heartbeat</span>
+
+<span class="k">[agent]</span>
+<span class="na">app_pkg_dir</span><span class="o">=</span><span class="s">app/definition</span>
+<span class="na">app_install_dir</span><span class="o">=</span><span class="s">app/install</span>
+<span class="na">app_run_dir</span><span class="o">=</span><span class="s">app/run</span>
+<span class="na">app_dbg_cmd</span><span class="o">=</span>
+<span class="na">debug_mode_enabled</span><span class="o">=</span><span class="s">true</span>
+
+<span class="na">app_task_dir</span><span class="o">=</span><span class="s">app/command-log</span>
+<span class="na">app_log_dir</span><span class="o">=</span><span class="s">app/log</span>
+<span class="na">app_tmp_dir</span><span class="o">=</span><span class="s">app/tmp</span>
+
+<span class="na">log_dir</span><span class="o">=</span><span class="s">infra/log</span>
+<span class="na">run_dir</span><span class="o">=</span><span class="s">infra/run</span>
+<span class="na">version_file</span><span class="o">=</span><span class="s">infra/version</span>
+
+<span class="na">log_level</span><span class="o">=</span><span class="s">INFO</span>
+
+<span class="k">[python]</span>
+
+<span class="k">[command]</span>
+<span class="na">max_retries</span><span class="o">=</span><span class="s">2</span>
+<span class="na">sleep_between_retries</span><span class="o">=</span><span class="s">1</span>
+
+<span class="k">[security]</span>
+
+<span class="k">[heartbeat]</span>
+<span class="na">state_interval</span><span class="o">=</span><span class="s">6</span>
+<span class="na">log_lines_count</span><span class="o">=</span><span class="s">300</span>
+</pre></div>
+
+
+<p>Once created, deploy the agent.ini file to HDFS (it can be deployed in any location accessible to application instance):</p>
+<div class="codehilite"><pre><span class="n">su</span> <span class="n">yarn</span>
+
+<span class="n">hdfs</span> <span class="n">dfs</span> <span class="o">-</span><span class="n">copyFromLocal</span> <span class="n">agent</span><span class="p">.</span><span class="n">ini</span> <span class="o">/</span><span class="n">slider</span><span class="o">/</span><span class="n">agent</span><span class="o">/</span><span class="n">conf</span>
+</pre></div>
+
+
+<p>Modify the --template json file (appConfig.json) and add the location of the agent.ini file.</p>
+<div class="codehilite"><pre>"<span class="n">agent</span><span class="p">.</span><span class="n">conf</span>"<span class="p">:</span> "<span class="o">/</span><span class="n">slider</span><span class="o">/</span><span class="n">agent</span><span class="o">/</span><span class="n">conf</span><span class="o">/</span><span class="n">agent</span><span class="p">.</span><span class="n">ini</span>"
+</pre></div>
+
+
+<h1 id="wzxhzdk57wzxhzdk58appendix-b-resource-template-resourcesjson"><a name="appendixb"></a>Appendix B: Resource template (resources.json)</h1>
+<p>This sample is suitable for HBase application.</p>
+<div class="codehilite"><pre><span class="p">{</span>
+ "<span class="n">schema</span>"<span class="p">:</span> "<span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">example</span><span class="p">.</span><span class="n">org</span><span class="o">/</span><span class="n">specification</span><span class="o">/</span><span class="n">v2</span><span class="p">.</span>0<span class="p">.</span>0"<span class="p">,</span>
+ "<span class="n">metadata</span>"<span class="p">:</span> <span class="p">{</span>
+ <span class="p">},</span>
+ "<span class="k">global</span>"<span class="p">:</span> <span class="p">{</span>
+ <span class="p">},</span>
+ "<span class="n">components</span>"<span class="p">:</span> <span class="p">{</span>
+ "<span class="n">HBASE_MASTER</span>"<span class="p">:</span> <span class="p">{</span>
+ "<span class="n">yarn</span><span class="p">.</span><span class="n">role</span><span class="p">.</span><span class="n">priority</span>"<span class="p">:</span> "1"<span class="p">,</span>
+ "<span class="n">yarn</span><span class="p">.</span><span class="n">component</span><span class="p">.</span><span class="n">instances</span>"<span class="p">:</span> "1"<span class="p">,</span>
+ "<span class="n">yarn</span><span class="p">.</span><span class="n">memory</span>"<span class="p">:</span> "256"
+ <span class="p">},</span>
+ "<span class="n">slider</span><span class="o">-</span><span class="n">appmaster</span>"<span class="p">:</span> <span class="p">{</span>
+ <span class="p">},</span>
+ "<span class="n">HBASE_REGIONSERVER</span>"<span class="p">:</span> <span class="p">{</span>
+ "<span class="n">yarn</span><span class="p">.</span><span class="n">role</span><span class="p">.</span><span class="n">priority</span>"<span class="p">:</span> "2"<span class="p">,</span>
+ "<span class="n">yarn</span><span class="p">.</span><span class="n">component</span><span class="p">.</span><span class="n">instances</span>"<span class="p">:</span> "1"<span class="p">,</span>
+ "<span class="n">yarn</span><span class="p">.</span><span class="n">memory</span>"<span class="p">:</span> "256"
+ <span class="p">}</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<h1 id="wzxhzdk59wzxhzdk60appendix-c-config-template-appcofigjson"><a name="appendixc"></a>Appendix C: Config template (appCofig.json)</h1>
+<p>This sample is suitable for HBase application. See <a href="/docs/slider_specs/application_instance_configuration.html">Application Instance Configuration</a> for detailed explanation of how to create an appConfig.json file.</p>
+<div class="codehilite"><pre>{
+ "schema": "http://example.org/specification/v2.0.0",
+ "metadata": {
+ },
+ "global": {
+ "application.def": "<span class="cp">${</span><span class="n">app</span><span class="o">.</span><span class="n">package</span><span class="o">.</span><span class="n">name</span><span class="cp">}</span>.zip",
+ "create.default.zookeeper.node": "true",
+ "config_types": "core-site,hdfs-site,hbase-site",
+ "java_home": "/usr/jdk64/jdk1.7.0_45",
+ "package_list": "files/hbase-<span class="cp">${</span><span class="n">hbase</span><span class="o">.</span><span class="n">version</span><span class="cp">}</span>-bin.tar.gz",
+ "site.global.app_user": "yarn",
+ "site.global.app_log_dir": "<span class="cp">${</span><span class="n">AGENT_LOG_ROOT</span><span class="cp">}</span>/app/log",
+ "site.global.app_pid_dir": "<span class="cp">${</span><span class="n">AGENT_WORK_ROOT</span><span class="cp">}</span>/app/run",
+ "site.global.app_root": "<span class="cp">${</span><span class="n">AGENT_WORK_ROOT</span><span class="cp">}</span>/app/install/hbase-<span class="cp">${</span><span class="n">hbase</span><span class="o">.</span><span class="n">version</span><span class="cp">}</span>",
+ "site.global.app_install_dir": "<span class="cp">${</span><span class="n">AGENT_WORK_ROOT</span><span class="cp">}</span>/app/install",
+ "site.global.hbase_master_heapsize": "1024m",
+ "site.global.hbase_regionserver_heapsize": "1024m",
+ "site.global.hbase_instance_name": "instancename",
+ "site.global.hbase_root_password": "secret",
+ "site.global.user_group": "hadoop",
+ "site.global.security_enabled": "false",
+ "site.global.monitor_protocol": "http",
+ "site.global.ganglia_server_host": "<span class="cp">${</span><span class="n">NN_HOST</span><span class="cp">}</span>",
+ "site.global.ganglia_server_port": "8667",
+ "site.global.ganglia_server_id": "Application1",
+ "site.hbase-site.hbase.hstore.flush.retries.number": "120",
+ "site.hbase-site.hbase.client.keyvalue.maxsize": "10485760",
+ "site.hbase-site.hbase.hstore.compactionThreshold": "3",
+ "site.hbase-site.hbase.rootdir": "<span class="cp">${</span><span class="n">DEFAULT_DATA_DIR</span><span class="cp">}</span>/data",
+ "site.hbase-site.hbase.stagingdir": "<span class="cp">${</span><span class="n">DEFAULT_DATA_DIR</span><span class="cp">}</span>/staging",
+ "site.hbase-site.hbase.regionserver.handler.count": "60",
+ "site.hbase-site.hbase.regionserver.global.memstore.lowerLimit": "0.38",
+ "site.hbase-site.hbase.hregion.memstore.block.multiplier": "2",
+ "site.hbase-site.hbase.hregion.memstore.flush.size": "134217728",
+ "site.hbase-site.hbase.superuser": "yarn",
+ "site.hbase-site.hbase.zookeeper.property.clientPort": "2181",
+ "site.hbase-site.hbase.regionserver.global.memstore.upperLimit": "0.4",
+ "site.hbase-site.zookeeper.session.timeout": "30000",
+ "site.hbase-site.hbase.tmp.dir": "<span class="cp">${</span><span class="n">AGENT_WORK_ROOT</span><span class="cp">}</span>/work/app/tmp",
+ "site.hbase-site.hbase.local.dir": "<span class="cp">${</span><span class="n">hbase</span><span class="o">.</span><span class="n">tmp</span><span class="o">.</span><span class="n">dir</span><span class="cp">}</span>/local",
+ "site.hbase-site.hbase.hregion.max.filesize": "10737418240",
+ "site.hbase-site.hfile.block.cache.size": "0.40",
+ "site.hbase-site.hbase.security.authentication": "simple",
+ "site.hbase-site.hbase.defaults.for.version.skip": "true",
+ "site.hbase-site.hbase.zookeeper.quorum": "<span class="cp">${</span><span class="n">ZK_HOST</span><span class="cp">}</span>",
+ "site.hbase-site.zookeeper.znode.parent": "<span class="cp">${</span><span class="n">DEF_ZK_PATH</span><span class="cp">}</span>",
+ "site.hbase-site.hbase.hstore.blockingStoreFiles": "10",
+ "site.hbase-site.hbase.hregion.majorcompaction": "86400000",
+ "site.hbase-site.hbase.security.authorization": "false",
+ "site.hbase-site.hbase.cluster.distributed": "true",
+ "site.hbase-site.hbase.hregion.memstore.mslab.enabled": "true",
+ "site.hbase-site.hbase.client.scanner.caching": "100",
+ "site.hbase-site.hbase.zookeeper.useMulti": "true",
+ "site.hbase-site.hbase.regionserver.info.port": "0",
+ "site.hbase-site.hbase.master.info.port": "<span class="cp">${</span><span class="n">HBASE_MASTER</span><span class="o">.</span><span class="n">ALLOCATED_PORT</span><span class="cp">}</span>",
+ "site.hbase-site.hbase.regionserver.port": "0"
+ },
+ "components": {
+ "HBASE_MASTER": {
+ },
+ "slider-appmaster": {
+ "jvm.heapsize": "256M"
+ },
+ "HBASE_REGIONSERVER": {
+ }
+ }
+}
+</pre></div>
+ </div>
+
+ <div id="footer">
+ <a alt="Apache Software Foundation" href="http://www.apache.org">
+ <img id="asf-logo" alt="Apache Software Foundation" src="/images/feather-small.gif" width="100">
+ </a>
+ <div class="copyright">
+ <p>
+ Copyright © 2011-2014 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ Apache Slider, Slider, Apache, the Apache feather logo, and the Apache Incubator
+ project logo are trademarks of the <a href="http://www.apache.org">Apache Software Foundation</a>.<br />
+ Site created with <a href="http://getbootstrap.com/">Bootstrap</a> including icons from <a href="http://glyphicons.com/">GLYPHICONS</a> and <a href="http://fontawesome.io/">Font Awesome</a>.
+ </p>
+ </div>
+ </div>
+ </div>
+
+</div>
+</div>
+
+<script type="text/javascript">
+
+</script>
+</body>
+</html>
Added: websites/staging/slider/trunk/content/docs/manpage.html
==============================================================================
--- websites/staging/slider/trunk/content/docs/manpage.html (added)
+++ websites/staging/slider/trunk/content/docs/manpage.html Tue Jul 22 18:17:12 2014
@@ -0,0 +1,560 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+ <link href="/css/bootstrap.min.css" rel="stylesheet">
+ <link href="/css/bootstrap-theme.min.css" rel="stylesheet">
+ <!-- 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]-->
+ <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
+ <script src="/js/bootstrap.min.js"></script>
+ <link href="/css/slider.css" rel="stylesheet" type="text/css">
+ <link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet">
+ <title></title>
+
+</head>
+
+<body>
+<nav class="navbar navbar-default navbar-fixed-top" role="navigation">
+<div class="container-fluid">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-items">
+ <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="navbar-brand" href="/index.html">Slider</a>
+ </div>
+ <div class="collapse navbar-collapse" id="navbar-items">
+ <ul class="nav navbar-nav">
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="#">
+ Project <span class="caret"></span>
+ </a>
+<ul class="dropdown-menu">
+<li id="nav_index"><a href="/index.html">Home</a></li>
+<li id="nav_downloads"><a href="/downloads">Downloads</a></li>
+<li id="nav_source"><a href="https://git-wip-us.apache.org/repos/asf/incubator-slider.git"><i class="fa fa-external-link"></i> Source</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0"><i class="fa fa-external-link"></i> License</a></li>
+<li class="divider"></li>
+<li class="dropdown-header">Community</li>
+<li id="nav_team"><a href="/team.html">Team</a></li>
+<li id="nav_mailinglists"><a href="/mailing_lists.html">Mailing Lists</a></li>
+<li class="divider"></li>
+<li class="dropdown-header">Tools</li>
+<li id="nav_jira"><a href="https://issues.apache.org/jira/browse/SLIDER"><i class="fa fa-external-link"></i> Issues</a></li>
+<li id="nav_builds"><a href="https://builds.apache.org/job/Slider-develop"><i class="fa fa-external-link"></i> Builds</a></li>
+</ul>
+</li>
+
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="/design">
+ Design <span class="caret"></span>
+ </a>
+<ul class="dropdown-menu">
+<li id="nav_design_overview"><a href="/design/architecture.html">Overview</a></li>
+<li id="nav_app_needs"><a href="/docs/slider_specs/application_needs.html">Application Needs</a></li>
+<li id="nav_spec"><a href="/design/specification/index.html">Expected Behavior</a></li>
+<li id="nav_registry"><a href="/design/registry/index.html">Service Registry</a></li>
+<li id="nav_ssl_impl"><a href="/design/ssl_implementation.html">SSL Implementation</a></li>
+<li id="nav_role_history"><a href="/design/rolehistory.html">Role History</a></li>
+</ul>
+</li>
+
+
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="/developing">
+ Developing <span class="caret"></span>
+ </a>
+<ul class="dropdown-menu">
+<li id="nav_dev_building"><a href="/developing/building.html">Building</a></li>
+<li id="nav_dev_debugging"><a href="/docs/debugging.html">Debugging</a></li>
+<li id="nav_dev_testing"><a href="/developing/testing.html">Testing</a></li>
+<li id="nav_dev_funtesting"><a href="/developing/functional_tests.html">Functional Testing</a></li>
+<li id="nav_dev_manual_testing"><a href="/developing/manual_testing.html">Manual Testing</a></li>
+<li id="nav_releasing"><a href="/developing/releasing.html">Releasing</a></li>
+</ul>
+</li>
+
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="#">
+ Using <span class="caret"></span>
+ </a>
+<ul class="dropdown-menu">
+<li id="nav_use_getting_started"><a href="/docs/getting_started.html">Getting Started</a></li>
+<li id="nav_use_manpage"><a href="/docs/manpage.html">Man Page</a></li>
+<li id="nav_use_examples"><a href="/docs/examples.html">Examples</a></li>
+<li id="nav_use_client_config"><a href="/docs/client-configuration.html">Client Configuration</a></li>
+<li id="nav_use_exitcodes"><a href="/docs/exitcodes.html">Client Exit Codes</a></li>
+<li id="nav_use_security"><a href="/docs/security.html">Security</a></li>
+<li id="nav_am_agent_ssl"><a href="/docs/ssl.html">Agent to AM SSL</a></li>
+<li id="nav_use_app_package"><a href="/docs/slider_specs/index.html">Creating App Packages</a></li>
+<li id="nav_use_app_configuration"><a href="/docs/configuration/index.html">App Configuration Model</a></li>
+<li id="nav_use_debugging"><a href="/docs/debugging.html">Debugging</a></li>
+<li id="nav_use_troubleshooting"><a href="/docs/troubleshooting.html">Troubleshooting</a></li>
+</ul>
+</li>
+
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="#">
+ ASF Links <span class="caret"></span>
+ </a>
+<ul class="dropdown-menu">
+<li><a href="http://www.apache.org"><i class="fa fa-external-link"></i> Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html"><i class="fa fa-external-link"></i> Sponsorship</a></li>
+<li><a href="http://www.apache.org/security/"><i class="fa fa-external-link"></i> Security</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html"><i class="fa fa-external-link"></i> Thanks</a></li>
+</ul>
+</li>
+</ul>
+
+ </div>
+
+</div>
+</nav>
+
+
+<div class="container-fluid">
+<div class="row">
+ <div class="col-md-2" id="sidebar">
+ <div style="text-align: center">
+ <h1><a href="/index.html">Apache Slider (incubating)</a></h1>
+ <hr>
+Latest release: <strong>0.40-incubating</strong><br>
+ <br>
+ <a id="download-button-sidebar" class="btn btn-success btn-block" href="/downloads/" role="button">Download</a>
+ </div>
+ <hr>
+ <a href="http://incubator.apache.org"><img id="logo" alt="Apache Incubator ™" class="img-responsive" src="http://incubator.apache.org/images/apache-incubator-logo.png"/></a>
+ </div>
+ <div class="col-md-8 col-md-offset-1">
+
+ <div id="content">
+
+ <h1 class="title"></h1>
+
+ <!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<h1 id="apache-slider-yarn-hosted-applications">Apache Slider: YARN-hosted applications</h1>
+<h2 id="name">NAME</h2>
+<p>slider -YARN-hosted applications</p>
+<h2 id="synopsis">SYNOPSIS</h2>
+<p>Slider enables applications to be dynamically created on a YARN-managed datacenter.
+The program can be used to create, pause, and shutdown the application. It can also be used to list current active
+and existing but not running "frozen" application instances.</p>
+<h2 id="concepts">CONCEPTS</h2>
+<ol>
+<li>
+<p>A <em>Slider application</em> is an application packaged to be deployed by Slider. It consists of one or more distributed <em>components</em> </p>
+</li>
+<li>
+<p>A <em>Slider application instance</em> is a slider application configured to be deployable on a specific YARN cluster, with a specific configuration. An instance can be <em>live</em> -actually running- or <em>frozen</em>. When frozen all its configuration details and instance-specific data are preserved on HDFS.</p>
+</li>
+<li>
+<p>An <em>image</em> is a <em>tar.gz</em> file containing binaries used to create the application. 1. Images are kept in the HDFS filesystem and identified by their path names; filesystem permissions can be used to share images amongst users.</p>
+</li>
+<li>
+<p>An <em>image configuration</em> is a directory that is overlaid file-by-file onto the conf/ directory inside the HBase image.</p>
+</li>
+<li>
+<p>Users can have multiple image configurations -they too are kept in HDFS, identified by their path names, and can be shared by setting the appropriate permissions, along with a configuration template file.</p>
+</li>
+<li>
+<p>Only those files provided in the image configuration directory overwrite the default values contained in the image; all other configuration files are retained.</p>
+</li>
+<li>
+<p>Late-binding properties can also be provided at create time.</p>
+</li>
+<li>
+<p>Slider can overwrite some of the configuration properties to enable the dynamically created components to bind correctly to each other.</p>
+</li>
+<li>
+<p>An <em>instance directory</em> is a directory created in HDFS describing the application instance; it records the configuration -both user specified, application-default and any dynamically created by slider. </p>
+</li>
+<li>
+<p>A user can create an application instance.</p>
+</li>
+<li>
+<p>A live instances can be <em>frozen</em>, saving its final state to its application instance state directory. All running components are shut down.</p>
+</li>
+<li>
+<p>A frozen instance can be <em>thawed</em> -a its components started on or near the servers where they were previously running.</p>
+</li>
+<li>
+<p>A frozen instance can be <em>destroyed</em>. </p>
+</li>
+<li>
+<p>Running instances can be listed. </p>
+</li>
+<li>
+<p>An instance consists of a set of components</p>
+</li>
+<li>
+<p>The supported component types depends upon the slider application.</p>
+</li>
+<li>
+<p>the count of each component must initially be specified when a application instance is created.</p>
+</li>
+<li>
+<p>Users can flex an application instance: adding or removing components dynamically.
+If the application instance is live, the changes will have immediate effect. If not, the changes will be picked up when the instance is next thawed.</p>
+</li>
+</ol>
+<!--- ======================================================================= -->
+
+<h2 id="invoking-slider">Invoking Slider</h2>
+<div class="codehilite"><pre><span class="n">slider</span> <span class="o"><</span><span class="n">ACTION</span><span class="o">></span> <span class="p">[</span><span class="o"><</span><span class="n">name</span><span class="o">></span><span class="p">]</span> <span class="p">[</span><span class="o"><</span><span class="n">OPTIONS</span><span class="o">></span><span class="p">]</span>
+</pre></div>
+
+
+<!--- ======================================================================= -->
+
+<h2 id="common-command-line-options">COMMON COMMAND-LINE OPTIONS</h2>
+<h3 id="-conf-configurationxml"><code>--conf configuration.xml</code></h3>
+<p>Configure the Slider client. This allows the filesystem, zookeeper instance and other properties to be picked up from the configuration file, rather than on the command line.</p>
+<p>Important: *this configuration file is not propagated to the application. It is purely for configuring the client itself. </p>
+<h3 id="-d-namevalue"><code>-D name=value</code></h3>
+<p>Define a Hadoop configuration option which overrides any options in the client configuration XML files.</p>
+<h3 id="-m-manager-url"><code>-m, --manager url</code></h3>
+<p>URL of the YARN resource manager</p>
+<h3 id="-fs-filesystem-uri"><code>--fs filesystem-uri</code></h3>
+<p>Use the specific filesystem URI as an argument to the operation.</p>
+<!--- ======================================================================= -->
+
+<!--- ======================================================================= -->
+
+<h2 id="actions">Actions</h2>
+<p>COMMANDS</p>
+<h3 id="build-name"><code>build <name></code></h3>
+<p>Build an instance of the given name, with the specific options.</p>
+<p>It is not started; this can be done later with a <code>thaw</code> command.</p>
+<h3 id="create-name"><code>create <name></code></h3>
+<p>Build and run an applicaton instance of the given name </p>
+<p>The <code>--wait</code> parameter, if provided, specifies the time to wait until the YARN application is actually running. Even after the YARN application has started, there may be some delay for the instance to start up.</p>
+<h3 id="arguments-for-build-and-create">Arguments for <code>build</code> and <code>create</code></h3>
+<h5 id="-package-uri-to-package"><code>--package <uri-to-package></code></h5>
+<p>This define the slider application package to be deployed.</p>
+<h5 id="-option-name-value"><code>--option <name> <value></code></h5>
+<p>Set a application instance option. </p>
+<p>Example:</p>
+<p>Set an option to be passed into the <code>-site.xml</code> file of the target system, reducing
+the HDFS replication factor to 2. (</p>
+<div class="codehilite"><pre><span class="o">--</span><span class="n">option</span> <span class="n">site</span><span class="p">.</span><span class="n">dfs</span><span class="p">.</span><span class="n">blocksize</span> 128<span class="n">m</span>
+</pre></div>
+
+
+<p>Increase the number of YARN containers which must fail before the Slider application instance
+itself fails.</p>
+<div class="codehilite"><pre><span class="o">-</span><span class="n">O</span> <span class="n">slider</span><span class="p">.</span><span class="n">container</span><span class="p">.</span><span class="n">failure</span><span class="p">.</span><span class="n">threshold</span> 16
+</pre></div>
+
+
+<h5 id="-appconf-dfspath"><code>--appconf dfspath</code></h5>
+<p>A URI path to the configuration directory containing the template application specification. The path must be on a filesystem visible to all nodes in the YARN cluster.</p>
+<ol>
+<li>Only one configuration directory can be specified.</li>
+<li>The contents of the directory will only be read when the application instance is created/built.</li>
+</ol>
+<p>Example:</p>
+<div class="codehilite"><pre><span class="o">--</span><span class="n">appconf</span> <span class="n">hdfs</span><span class="p">:</span><span class="o">//</span><span class="n">namenode</span><span class="o">/</span><span class="n">users</span><span class="o">/</span><span class="n">slider</span><span class="o">/</span><span class="n">conf</span><span class="o">/</span><span class="n">hbase</span><span class="o">-</span><span class="n">template</span>
+<span class="o">--</span><span class="n">appconf</span> <span class="n">file</span><span class="p">:</span><span class="o">//</span><span class="n">users</span><span class="o">/</span><span class="n">accumulo</span><span class="o">/</span><span class="n">conf</span><span class="o">/</span><span class="n">template</span>
+</pre></div>
+
+
+<h5 id="-apphome-localpath"><code>--apphome localpath</code></h5>
+<p>A path to the home dir of a pre-installed application. If set when a Slider
+application instance is created, the instance will run with the binaries pre-installed
+on the nodes at this location</p>
+<p><em>Important</em>: this is a path in the local filesystem which must be present
+on all hosts in the YARN cluster</p>
+<p>Example</p>
+<div class="codehilite"><pre><span class="o">--</span><span class="n">apphome</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">hadoop</span><span class="o">/</span><span class="n">hbase</span>
+</pre></div>
+
+
+<h5 id="-template-filename"><code>--template <filename></code></h5>
+<p>Filename for the template application instance configuration. This
+will be merged with -and can overwrite- the built-in configuration options, and can
+then be overwritten by any command line <code>--option</code> and <code>--compopt</code> arguments to
+generate the final application configuration.</p>
+<h5 id="-resources-filename"><code>--resources <filename></code></h5>
+<p>Filename for the resources configuration. This
+will be merged with -and can overwrite- the built-in resource options, and can
+then be overwritten by any command line <code>--resopt</code>, <code>--rescompopt</code> and <code>--component</code>
+arguments to generate the final resource configuration.</p>
+<h5 id="-image-path"><code>--image path</code></h5>
+<p>The full path in Hadoop HDFS to a <code>.tar</code> or <code>.tar.gz</code> file containing
+the binaries needed to run the target application.</p>
+<p>Example</p>
+<div class="codehilite"><pre><span class="o">--</span><span class="n">image</span> <span class="n">hdfs</span><span class="p">:</span><span class="o">//</span><span class="n">namenode</span><span class="o">/</span><span class="n">shared</span><span class="o">/</span><span class="n">binaries</span><span class="o">/</span><span class="n">hbase</span><span class="o">-</span>0<span class="p">.</span>96<span class="p">.</span><span class="n">tar</span><span class="p">.</span><span class="n">gz</span>
+</pre></div>
+
+
+<h5 id="-component-name-count"><code>--component <name> <count></code></h5>
+<p>The desired number of instances of a component</p>
+<p>Example</p>
+<div class="codehilite"><pre><span class="o">--</span><span class="n">component</span> <span class="n">worker</span> 16
+</pre></div>
+
+
+<p>This just sets the <code>component.instances</code> value of the named component's resource configuration.
+it is exactly equivalent to </p>
+<div class="codehilite"><pre><span class="o">--</span><span class="n">rco</span> <span class="n">worker</span> <span class="n">component</span><span class="p">.</span><span class="n">instances</span> 16
+</pre></div>
+
+
+<h4 id="-compopt-component-option-value"><code>--compopt <component> <option> <value></code></h4>
+<p>Provide a specific application configuration option for a component</p>
+<p>Example</p>
+<div class="codehilite"><pre><span class="o">--</span><span class="n">compopt</span> <span class="n">master</span> <span class="n">env</span><span class="p">.</span><span class="n">TIMEOUT</span> 10000
+</pre></div>
+
+
+<p>These options are saved into the <code>app_conf.json</code> file; they are not used to configure the YARN Resource
+allocations, which must use the <code>--rco</code> parameter</p>
+<h4 id="resource-component-option-rescompopt-rco">Resource Component option <code>--rescompopt</code> <code>--rco</code></h4>
+<p><code>--rescompopt <component> <option> <value></code> </p>
+<p>Set any role-specific option, such as its YARN memory requirements.</p>
+<p>Example</p>
+<div class="codehilite"><pre><span class="o">--</span><span class="n">rco</span> <span class="n">worker</span> <span class="n">master</span> <span class="n">yarn</span><span class="p">.</span><span class="n">memory</span> 2048
+<span class="o">--</span><span class="n">rco</span> <span class="n">worker</span> <span class="n">worker</span> <span class="n">yarn</span><span class="p">.</span><span class="n">memory</span> <span class="n">max</span>
+</pre></div>
+
+
+<h5 id="-zkhosts-host1port1host2port2host3port3"><code>--zkhosts host1:port1,[host2:port2,host3:port3, ...]</code></h5>
+<p>The zookeeper quorum.</p>
+<p>Example</p>
+<div class="codehilite"><pre><span class="o">--</span><span class="n">zkhosts</span> <span class="n">zk1</span><span class="p">:</span>2181<span class="p">,</span><span class="n">zk2</span><span class="p">:</span>2181<span class="p">,</span><span class="n">zk3</span><span class="p">:</span>4096
+</pre></div>
+
+
+<p>If unset, the zookeeper quorum defined in the property <code>slider.zookeeper.quorum</code>
+is used</p>
+<h3 id="destroy-name"><code>destroy <name></code></h3>
+<p>Destroy a (stopped) applicaton instance .</p>
+<p>Important: This deletes all persistent data</p>
+<p>Example</p>
+<div class="codehilite"><pre><span class="n">slider</span> <span class="n">destroy</span> <span class="n">instance1</span>
+</pre></div>
+
+
+<h3 id="exists-name-live"><code>exists <name> [--live]</code></h3>
+<p>Probe the existence of the named Slider application instance. If the <code>--live</code> flag is set, the instance
+must actually be running</p>
+<p>If not, an error code is returned.</p>
+<p>When the --live` flag is unset, the command looks for the application instance to be
+defined in the filesystem -its operation state is not checked.</p>
+<p>Return codes</p>
+<div class="codehilite"><pre> 0 <span class="p">:</span> <span class="n">application</span> <span class="n">instance</span> <span class="n">is</span> <span class="n">defined</span> <span class="n">in</span> <span class="n">the</span> <span class="n">filesystem</span>
+70 <span class="p">:</span> <span class="n">application</span> <span class="n">instance</span> <span class="n">is</span> <span class="n">unknown</span>
+</pre></div>
+
+
+<p>Example:</p>
+<div class="codehilite"><pre><span class="n">slider</span> <span class="n">exists</span> <span class="n">instance4</span>
+</pre></div>
+
+
+<h4 id="live-tests">Live Tests</h4>
+<p>When the <code>--live</code> flag is set, the application instance must be running for the command
+to succeed</p>
+<ol>
+<li>The probe does not check the status of any Slider-deployed services, merely that a application instance has been deployed</li>
+<li>A application instance that is finished or failed is not considered to be live.</li>
+</ol>
+<p>Return codes</p>
+<div class="codehilite"><pre> 0 <span class="p">:</span> <span class="n">application</span> <span class="n">instance</span> <span class="n">is</span> <span class="n">running</span>
+<span class="o">-</span>1 <span class="p">:</span> <span class="n">application</span> <span class="n">instance</span> <span class="n">exists</span> <span class="n">but</span> <span class="n">is</span> <span class="n">not</span> <span class="n">running</span>
+70 <span class="p">:</span> <span class="n">application</span> <span class="n">instance</span> <span class="n">is</span> <span class="n">unknown</span>
+</pre></div>
+
+
+<p>Example:</p>
+<div class="codehilite"><pre><span class="n">slider</span> <span class="n">exists</span> <span class="n">instance4</span> <span class="o">--</span><span class="n">live</span>
+</pre></div>
+
+
+<h3 id="flex-name-component-component-count"><code>flex <name> [--component component count]*</code></h3>
+<p>Flex the number of workers in an application instance to the new value. If greater than before, new copies of the component will be requested. If less, component instances will be destroyed.</p>
+<p>This operation has a return value of 0 if the size of a running instance was changed. </p>
+<p>It returns -1 if there is no running application instance, or the size of the flexed instance matches that of the original -in which case its state does not change.</p>
+<p>Example</p>
+<div class="codehilite"><pre><span class="n">slider</span> <span class="n">flex</span> <span class="n">instance1</span> <span class="o">--</span><span class="n">component</span> <span class="n">worker</span> 8 <span class="o">--</span><span class="n">filesystem</span> <span class="n">hdfs</span><span class="p">:</span><span class="o">//</span><span class="n">host</span><span class="p">:</span><span class="n">port</span>
+<span class="n">slider</span> <span class="n">flex</span> <span class="n">instance1</span> <span class="o">--</span><span class="n">component</span> <span class="n">master</span> 2 <span class="o">--</span><span class="n">filesystem</span> <span class="n">hdfs</span><span class="p">:</span><span class="o">//</span><span class="n">host</span><span class="p">:</span><span class="n">port</span>
+</pre></div>
+
+
+<h3 id="freeze-name-force-wait-time-message-text"><code>freeze <name> [--force] [--wait time] [--message text]</code></h3>
+<p>freeze the application instance. The running application is stopped. Its settings are retained in HDFS.</p>
+<p>The <code>--wait</code> argument can specify a time in seconds to wait for the application instance to be frozen.</p>
+<p>The <code>--force</code> flag causes YARN asked directly to terminate the application instance.
+The <code>--message</code> argument supplies an optional text message to be used in
+the request: this will appear in the application's diagnostics in the YARN RM UI.</p>
+<p>If an unknown (or already frozen) application instance is named, no error is returned.</p>
+<p>Examples</p>
+<div class="codehilite"><pre><span class="n">slider</span> <span class="n">freeze</span> <span class="n">instance1</span> <span class="o">--</span><span class="n">wait</span> 30
+<span class="n">slider</span> <span class="n">freeze</span> <span class="n">instance2</span> <span class="o">--</span><span class="n">force</span> <span class="o">--</span><span class="n">message</span> "<span class="n">maintenance</span> <span class="n">session</span>"
+</pre></div>
+
+
+<h3 id="list-name"><code>list <name></code></h3>
+<p>List running Slider application instances visible to the user.</p>
+<p>If an instance name is given and there is no running instance with that name, an error is returned. </p>
+<p>Example</p>
+<div class="codehilite"><pre><span class="n">slider</span> <span class="n">list</span>
+<span class="n">slider</span> <span class="n">list</span> <span class="n">instance1</span>
+</pre></div>
+
+
+<h3 id="registry-list-listconf-getconf-conf-name-name-servicetype-servicetype-verbose"><code>registry (--list | --listconf | --getconf <conf>) [--name <name>] [--servicetype <servicetype>] [--verbose]</code></h3>
+<p>List registered application instances visible to the user. This is slightly
+different from the <code>slider list</code> command in that it does not make use of the
+YARN application list. Instead it communicates with Zookeeper -and works
+with any applications which has registered itself with the "service registry"</p>
+<p>The <code>--name <name></code> option names the registry entry to work with. For slider applications,
+this is the application instance</p>
+<p>The <code>--servicetype <servicetype></code> option allows a different service type to be chosen.
+The default is <code>"org.apache.slider</code></p>
+<p>The <code>--verbose</code> flag triggers more verbose output on the operations</p>
+<p>The <code>--internal</code> flag indicates the configurations to be listed and retrieved
+are from the "internal" list of configuration data provided for use within a
+deployed application. </p>
+<p>There are two common exit codes, the exact values being documented
+in <a href="exitcodes.html">Exit Codes</a></p>
+<ol>
+<li>If there is no matching service then the operation fails with the
+<code>EXIT_NOT_FOUND</code> code (77).</li>
+<li>If there are no configurations in a listing, or the named configuration
+is not found, the command returns the exit code <code>EXIT_NOT_FOUND</code> (77)</li>
+</ol>
+<p>Operations:</p>
+<h4 id="slider-registry-list-servicetype-servicetype-name-name-verbose"><code>slider registry --list [--servicetype <servicetype>] [--name <name>] [--verbose]</code></h4>
+<p>List all services of the service type and optionally the name. </p>
+<h4 id="slider-registry-listconf-name-name-internal-servicetype-servicetype"><code>slider registry --listconf [--name <name>] [--internal] [--servicetype <servicetype>]</code></h4>
+<p>List the configurations exported by of a named application</p>
+<h4 id="slider-registry-getconf-configuration-format-xmljsonproperties-dest-path-internal-get-the-configuration"><code>slider registry --getconf <configuration> [--format (xml|json|properties)] [--dest <path>] [--internal]</code> get the configuration</h4>
+<p>Get a named configuration in a chosen format. Default: XML</p>
+<p><code>--dest <path></code> : the filename or directory to save a configuration to.
+ <code>--format (xml|json|properties)</code> defines the output format</p>
+<h3 id="status-name-out-filename"><code>status <name> [--out <filename>]</code></h3>
+<p>Get the status of the named application instance in JSON format. A filename can be used to
+specify the destination.</p>
+<p>Examples:</p>
+<div class="codehilite"><pre><span class="n">slider</span> <span class="n">status</span> <span class="n">instance1</span> <span class="o">--</span><span class="n">manager</span> <span class="n">host</span><span class="p">:</span><span class="n">port</span>
+
+<span class="n">slider</span> <span class="n">status</span> <span class="n">instance2</span> <span class="o">--</span><span class="n">manager</span> <span class="n">host</span><span class="p">:</span><span class="n">port</span> <span class="o">--</span><span class="n">out</span> <span class="n">status</span><span class="p">.</span><span class="n">json</span>
+</pre></div>
+
+
+<h3 id="thaw-name-wait-time"><code>thaw <name> [--wait time</code>]</h3>
+<p>Resume a frozen application instance, recreating it from its previously saved state. This will include a best-effort attempt to create the same number of nodes as before, though their locations may be different.</p>
+<p>Examples:</p>
+<div class="codehilite"><pre><span class="n">slider</span> <span class="n">thaw</span> <span class="n">instance2</span>
+<span class="n">slider</span> <span class="n">thaw</span> <span class="n">instance1</span> <span class="o">--</span><span class="n">wait</span> 60
+</pre></div>
+
+
+<p>If the application instance is already running, this command will not affect it.</p>
+<h3 id="version"><code>version</code></h3>
+<p>The command <code>slider version</code> prints out information about the compiled
+Slider application, the version of Hadoop against which it was built -and
+the version of Hadoop that is currently on its classpath.</p>
+<p>Note that this is the client-side Hadoop version, not that running on the server, though
+that can be obtained in the status operation</p>
+<h2 id="commands-for-testing">Commands for testing</h2>
+<p>These are clearly abnormal operations; they are here primarily for testing
+-and documented for completeness.</p>
+<h3 id="kill-container-name-id-container-id"><code>kill-container <name> --id container-id</code></h3>
+<p>Kill a YARN container belong to the application. This is useful primarily for testing the
+resilience to failures.</p>
+<p>Container IDs can be determined from the application instance status JSON document.</p>
+<h3 id="am-suicide-name-exitcode-code-message-message-wait-time"><code>am-suicide <name> [--exitcode code] [--message message] [--wait time]</code></h3>
+<p>This operation is purely for testing Slider Application Master restart;
+it triggers an asynchronous self-destruct operation in the AM -an
+operation that does not make any attempt to cleanly shut down the process. </p>
+<p>If the application has not exceeded its restart limit (as set by
+<code>slider.yarn.restart.limit</code>), YARN will attempt to restart the failed application.</p>
+<p>Example</p>
+<div class="codehilite"><pre><span class="n">slider</span> <span class="n">am</span><span class="o">-</span><span class="n">suicide</span> <span class="o">--</span><span class="n">exitcode</span> 1 <span class="o">--</span><span class="n">wait</span> 5000 <span class="o">-</span><span class="n">message</span> "<span class="n">test</span>"
+</pre></div>
+
+
+<!--- ======================================================================= -->
+
+<h2 id="instance-naming">Instance Naming</h2>
+<p>Application instance names must:</p>
+<ol>
+<li>be at least one character long</li>
+<li>begin with a lower case letter</li>
+<li>All other characters must be in the range [a-z,0-9,_]</li>
+<li>All upper case characters are converted to lower case</li>
+</ol>
+<p>Example valid names:</p>
+<div class="codehilite"><pre><span class="n">slider1</span>
+<span class="n">storm4</span>
+<span class="n">hbase_instance</span>
+<span class="n">accumulo_m1_tserve4</span>
+</pre></div>
+ </div>
+
+ <div id="footer">
+ <a alt="Apache Software Foundation" href="http://www.apache.org">
+ <img id="asf-logo" alt="Apache Software Foundation" src="/images/feather-small.gif" width="100">
+ </a>
+ <div class="copyright">
+ <p>
+ Copyright © 2011-2014 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ Apache Slider, Slider, Apache, the Apache feather logo, and the Apache Incubator
+ project logo are trademarks of the <a href="http://www.apache.org">Apache Software Foundation</a>.<br />
+ Site created with <a href="http://getbootstrap.com/">Bootstrap</a> including icons from <a href="http://glyphicons.com/">GLYPHICONS</a> and <a href="http://fontawesome.io/">Font Awesome</a>.
+ </p>
+ </div>
+ </div>
+ </div>
+
+</div>
+</div>
+
+<script type="text/javascript">
+
+</script>
+</body>
+</html>