Modified: websites/staging/slider/trunk/content/docs/manpage.html
==============================================================================
--- websites/staging/slider/trunk/content/docs/manpage.html (original)
+++ websites/staging/slider/trunk/content/docs/manpage.html Mon Nov 2 17:24:47
2015
@@ -155,7 +155,7 @@
<div style="text-align: center">
<h1><a href="/index.html">Apache Slider (incubating)</a></h1>
<hr>
-Latest release: <strong>0.80.0-incubating</strong><br>
+Latest release: <strong>0.81.1-incubating</strong><br>
<br>
<a id="download-button-sidebar" class="btn btn-success btn-block"
href="/downloads/" role="button">Download</a>
</div>
@@ -168,7 +168,18 @@ Latest release: <strong>0.80.0-incubatin
<h1 class="title"></h1>
- <!---
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink,
h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink,
dt:hover > .elementid-permalink { visibility: visible }</style>
+<!---
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.
@@ -185,14 +196,14 @@ Latest release: <strong>0.80.0-incubatin
limitations under the License.
-->
-<h1 id="apache-slider-yarn-hosted-applications">Apache Slider: YARN-hosted
applications</h1>
-<h2 id="name">NAME</h2>
+<h1 id="apache-slider-yarn-hosted-applications">Apache Slider: YARN-hosted
applications<a class="headerlink"
href="#apache-slider-yarn-hosted-applications" title="Permanent
link">¶</a></h1>
+<h2 id="name">NAME<a class="headerlink" href="#name" title="Permanent
link">¶</a></h2>
<p>slider -YARN-hosted applications</p>
-<h2 id="synopsis">SYNOPSIS</h2>
+<h2 id="synopsis">SYNOPSIS<a class="headerlink" href="#synopsis"
title="Permanent link">¶</a></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 "stopped" application instances.</p>
-<h2 id="concepts">CONCEPTS</h2>
+<h2 id="concepts">CONCEPTS<a class="headerlink" href="#concepts"
title="Permanent link">¶</a></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>
@@ -235,38 +246,38 @@ If not, the changes will be picked up wh
</ol>
<!--- =======================================================================
-->
-<h2 id="invoking-slider">Invoking Slider</h2>
+<h2 id="invoking-slider">Invoking Slider<a class="headerlink"
href="#invoking-slider" title="Permanent link">¶</a></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>
+<h2 id="common-command-line-options">COMMON COMMAND-LINE OPTIONS<a
class="headerlink" href="#common-command-line-options" title="Permanent
link">¶</a></h2>
+<h3 id="-conf-configurationxml"><code>--conf configuration.xml</code><a
class="headerlink" href="#-conf-configurationxml" title="Permanent
link">¶</a></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>
+<h3 id="-d-namevalue"><code>-D name=value</code><a class="headerlink"
href="#-d-namevalue" title="Permanent link">¶</a></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>
+<h3 id="-m-manager-url"><code>-m, --manager url</code><a class="headerlink"
href="#-m-manager-url" title="Permanent link">¶</a></h3>
<p>URL of the YARN resource manager</p>
-<h3 id="-fs-filesystem-uri"><code>--fs filesystem-uri</code></h3>
+<h3 id="-fs-filesystem-uri"><code>--fs filesystem-uri</code><a
class="headerlink" href="#-fs-filesystem-uri" title="Permanent
link">¶</a></h3>
<p>Use the specific filesystem URI as an argument to the operation.</p>
<!--- =======================================================================
-->
<!--- =======================================================================
-->
-<h2 id="actions">Actions</h2>
+<h2 id="actions">Actions<a class="headerlink" href="#actions" title="Permanent
link">¶</a></h2>
<p>COMMANDS</p>
-<h3 id="slider-build-name"><code>slider build <name></code></h3>
+<h3 id="slider-build-name"><code>slider build <name></code><a
class="headerlink" href="#slider-build-name" title="Permanent
link">¶</a></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>start</code>
command.</p>
-<h3 id="slider-create-name"><code>slider create <name></code></h3>
+<h3 id="slider-create-name"><code>slider create <name></code><a
class="headerlink" href="#slider-create-name" title="Permanent
link">¶</a></h3>
<p>Build and run an application instance of the given name </p>
-<h4 id="arguments-for-build-and-create"><strong>Arguments for
<code>build</code> and <code>create</code></strong></h4>
-<h5 id="-package-uri-to-package"><code>--package
<uri-to-package></code></h5>
+<h4 id="arguments-for-build-and-create"><strong>Arguments for
<code>build</code> and <code>create</code></strong><a class="headerlink"
href="#arguments-for-build-and-create" title="Permanent link">¶</a></h4>
+<h5 id="-package-uri-to-package"><code>--package
<uri-to-package></code><a class="headerlink"
href="#-package-uri-to-package" title="Permanent link">¶</a></h5>
<p>This define the slider application package to be deployed.</p>
-<h5 id="-option-name-value"><code>--option <name>
<value></code></h5>
+<h5 id="-option-name-value"><code>--option <name> <value></code><a
class="headerlink" href="#-option-name-value" title="Permanent
link">¶</a></h5>
<p>Set an 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
@@ -281,7 +292,7 @@ itself fails.</p>
</pre></div>
-<h5 id="-appconf-dfspath"><code>--appconf dfspath</code></h5>
+<h5 id="-appconf-dfspath"><code>--appconf dfspath</code><a class="headerlink"
href="#-appconf-dfspath" title="Permanent link">¶</a></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>
@@ -293,7 +304,7 @@ itself fails.</p>
</pre></div>
-<h5 id="-apphome-localpath"><code>--apphome localpath</code></h5>
+<h5 id="-apphome-localpath"><code>--apphome localpath</code><a
class="headerlink" href="#-apphome-localpath" title="Permanent
link">¶</a></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>
@@ -304,17 +315,17 @@ on all hosts in the YARN cluster</p>
</pre></div>
-<h5 id="-template-filename"><code>--template <filename></code></h5>
+<h5 id="-template-filename"><code>--template <filename></code><a
class="headerlink" href="#-template-filename" title="Permanent
link">¶</a></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>
+<h5 id="-resources-filename"><code>--resources <filename></code><a
class="headerlink" href="#-resources-filename" title="Permanent
link">¶</a></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>
+<h5 id="-image-path"><code>--image path</code><a class="headerlink"
href="#-image-path" title="Permanent link">¶</a></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>
@@ -322,7 +333,7 @@ the binaries needed to run the target ap
</pre></div>
-<h5 id="-component-name-count"><code>--component <name>
<count></code></h5>
+<h5 id="-component-name-count"><code>--component <name>
<count></code><a class="headerlink" href="#-component-name-count"
title="Permanent link">¶</a></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
@@ -335,7 +346,7 @@ it is exactly equivalent to </p>
</pre></div>
-<h4 id="-compopt-component-option-value"><code>--compopt <component>
<option> <value></code></h4>
+<h4 id="-compopt-component-option-value"><code>--compopt <component>
<option> <value></code><a class="headerlink"
href="#-compopt-component-option-value" title="Permanent link">¶</a></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
@@ -344,7 +355,7 @@ it is exactly equivalent to </p>
<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>
+<h4 id="resource-component-option-rescompopt-rco">Resource Component option
<code>--rescompopt</code> <code>--rco</code><a class="headerlink"
href="#resource-component-option-rescompopt-rco" title="Permanent
link">¶</a></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>
@@ -353,7 +364,7 @@ allocations, which must use the <code>--
</pre></div>
-<h5 id="-zkhosts-host1port1host2port2host3port3"><code>--zkhosts
host1:port1,[host2:port2,host3:port3, ...]</code></h5>
+<h5 id="-zkhosts-host1port1host2port2host3port3"><code>--zkhosts
host1:port1,[host2:port2,host3:port3, ...]</code><a class="headerlink"
href="#-zkhosts-host1port1host2port2host3port3" title="Permanent
link">¶</a></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
@@ -362,27 +373,27 @@ allocations, which must use the <code>--
<p>If unset, the zookeeper quorum defined in the property
<code>slider.zookeeper.quorum</code>
is used</p>
-<h4 id="-zkpath-zookeeper-path"><code>--zkpath
<zookeeper-path></code></h4>
+<h4 id="-zkpath-zookeeper-path"><code>--zkpath <zookeeper-path></code><a
class="headerlink" href="#-zkpath-zookeeper-path" title="Permanent
link">¶</a></h4>
<p>A path in the zookeeper cluster to create for an application. This
is useful for applications which require a path to be created in advance
of their deployment. When the an application instance is destroyed, this
path will be deleted.</p>
-<h5 id="-queue-queue-name"><code>--queue <queue name></code></h5>
+<h5 id="-queue-queue-name"><code>--queue <queue name></code><a
class="headerlink" href="#-queue-queue-name" title="Permanent
link">¶</a></h5>
<p>The queue to deploy the application to. By default, YARN will pick the
queue.</p>
<p>Example</p>
<div class="codehilite"><pre><span class="o">--</span><span
class="n">queue</span> <span class="n">applications</span>
</pre></div>
-<h4 id="arguments-purely-for-the-create-operation">Arguments purely for the
<code>create</code> operation</h4>
-<h5 id="-wait-milliseconds"><code>--wait <milliseconds></code></h5>
+<h4 id="arguments-purely-for-the-create-operation">Arguments purely for the
<code>create</code> operation<a class="headerlink"
href="#arguments-purely-for-the-create-operation" title="Permanent
link">¶</a></h4>
+<h5 id="-wait-milliseconds"><code>--wait <milliseconds></code><a
class="headerlink" href="#-wait-milliseconds" title="Permanent
link">¶</a></h5>
<p>The <code>--wait</code> parameter, if provided, specifies the time in
milliseconds 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>
<p>[--out <filename>]</p>
-<h5 id="-out-filename"><code>--out <filename></code></h5>
+<h5 id="-out-filename"><code>--out <filename></code><a
class="headerlink" href="#-out-filename" title="Permanent link">¶</a></h5>
<p>The name of a file to save a YARN application report to as a JSON file. This
file will contain the YARN application ID and other information about the
submitted application.</p>
-<h4 id="examples"><code>Examples</code></h4>
+<h4 id="examples"><code>Examples</code><a class="headerlink" href="#examples"
title="Permanent link">¶</a></h4>
<p>Create an application by providing <code>template</code> and
<code>resources</code>.</p>
<div class="codehilite"><pre><span class="n">create</span> <span
class="n">hbase1</span> <span class="o">--</span><span
class="n">template</span> <span class="o">/</span><span
class="n">usr</span><span class="o">/</span><span class="n">work</span><span
class="o">/</span><span class="n">hbase</span><span class="o">/</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="o">/</span><span class="n">usr</span><span class="o">/</span><span
class="n">work</span><span class="o">/</span><span class="n">hbase</span><span
class="o">/</span><span class="n">resources</span><span class="p">.</span><span
class="n">json</span>
</pre></div>
@@ -393,7 +404,7 @@ submitted application.</p>
</pre></div>
-<h3 id="destroy-name"><code>destroy <name></code></h3>
+<h3 id="destroy-name"><code>destroy <name></code><a class="headerlink"
href="#destroy-name" title="Permanent link">¶</a></h3>
<p>Destroy a (stopped) application instance .</p>
<p>Important: This deletes all persistent data</p>
<p>Example</p>
@@ -401,7 +412,7 @@ submitted application.</p>
</pre></div>
-<h3 id="exists-name-live-state-status"><code>exists <name> [--live]
[--state status]</code></h3>
+<h3 id="exists-name-live-state-status"><code>exists <name> [--live]
[--state status]</code><a class="headerlink"
href="#exists-name-live-state-status" title="Permanent link">¶</a></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>
@@ -421,7 +432,7 @@ are found.</p>
</pre></div>
-<h4 id="live-tests">Live Tests</h4>
+<h4 id="live-tests">Live Tests<a class="headerlink" href="#live-tests"
title="Permanent link">¶</a></h4>
<p>When the <code>--live</code> flag is set, the application instance must be
running
or about to run for the probe to succeed.
That is, either application is running (<code>RUNNING</code>) or in any of the
states
@@ -467,7 +478,7 @@ merely that the application instance has
</pre></div>
-<h3 id="flex-name-component-component-count"><code>flex <name>
[--component component count]*</code></h3>
+<h3 id="flex-name-component-component-count"><code>flex <name>
[--component component count]*</code><a class="headerlink"
href="#flex-name-component-component-count" title="Permanent
link">¶</a></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>
@@ -481,13 +492,13 @@ cluster</p>
</pre></div>
-<h3
id="install-package-name-name-of-the-package-package-package-file-replacepkg"><code>install-package
--name <name of the package> --package <package file>
[--replacepkg]</code></h3>
+<h3
id="install-package-name-name-of-the-package-package-package-file-replacepkg"><code>install-package
--name <name of the package> --package <package file>
[--replacepkg]</code><a class="headerlink"
href="#install-package-name-name-of-the-package-package-package-file-replacepkg"
title="Permanent link">¶</a></h3>
<p>Install the application package to the default package location for the
user under ~/.slider/package/<name>. This is the location referred to by the
appConfig.json file provided in the --template parameter in the create
command.</p>
-<h5 id="-name-name-of-the-package"><code>--name <name of the
package></code></h5>
+<h5 id="-name-name-of-the-package"><code>--name <name of the
package></code><a class="headerlink" href="#-name-name-of-the-package"
title="Permanent link">¶</a></h5>
<p>Name of the package. It may be the same as the name provided in the
metainfo.xml. Ensure that the same value is used in the default application
package location specified in the default appConfig.json file.</p>
-<h5 id="-package-package-file"><code>--package <package file></code></h5>
+<h5 id="-package-package-file"><code>--package <package file></code><a
class="headerlink" href="#-package-package-file" title="Permanent
link">¶</a></h5>
<p>Location of the package on local disk.</p>
-<h5 id="-replacepkg"><code>--replacepkg</code></h5>
+<h5 id="-replacepkg"><code>--replacepkg</code><a class="headerlink"
href="#-replacepkg" title="Permanent link">¶</a></h5>
<p>Optional. Whether to overwrite an already installed package.</p>
<p>Example</p>
<div class="codehilite"><pre><span class="n">slider</span> <span
class="n">install</span><span class="o">-</span><span class="n">package</span>
<span class="o">--</span><span class="n">name</span> <span
class="n">HBASE</span> <span class="o">--</span><span class="n">package</span>
<span class="o">/</span><span class="n">usr</span><span class="o">/</span><span
class="n">work</span><span class="o">/</span><span
class="n">package</span><span class="o">/</span><span
class="n">hbase</span><span class="o">/</span><span
class="n">slider</span><span class="o">-</span><span
class="n">hbase</span><span class="o">-</span><span class="n">app</span><span
class="o">-</span><span class="n">package</span><span class="o">-</span>0<span
class="p">.</span>98<span class="p">.</span>4<span class="o">-</span><span
class="n">hadoop2</span><span class="p">.</span><span class="n">zip</span>
@@ -495,7 +506,7 @@ cluster</p>
</pre></div>
-<h3 id="list-name-live-status-status"><code>list [name] [--live] [--status
status]</code></h3>
+<h3 id="list-name-live-status-status"><code>list [name] [--live] [--status
status]</code><a class="headerlink" href="#list-name-live-status-status"
title="Permanent link">¶</a></h3>
<p>List Slider application instances visible to the user. This includes
instances
which are on the filesystem.</p>
<p>If no instance name is specified, all instances matching the criteria are
listed.</p>
@@ -532,7 +543,7 @@ by a <code>--state</code> argument â�
</pre></div>
-<h3
id="registry-list-listconf-getconf-conf-name-name-servicetype-servicetype-out-filename-verbose"><code>registry
(--list | --listconf | --getconf <conf> ) [--name <name>]
[--servicetype <servicetype>] [--out <filename>]
[--verbose]</code></h3>
+<h3
id="registry-list-listconf-getconf-conf-name-name-servicetype-servicetype-out-filename-verbose"><code>registry
(--list | --listconf | --getconf <conf> ) [--name <name>]
[--servicetype <servicetype>] [--out <filename>]
[--verbose]</code><a class="headerlink"
href="#registry-list-listconf-getconf-conf-name-name-servicetype-servicetype-out-filename-verbose"
title="Permanent link">¶</a></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
@@ -556,15 +567,15 @@ in <a href="exitcodes.html">Exit Codes</
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-user-user-out-filename"><code>slider
registry --list [--servicetype <servicetype>] [--name <name>]
[--verbose] [--user <user>] [--out <filename>]</code></h4>
+<h4
id="slider-registry-list-servicetype-servicetype-name-name-verbose-user-user-out-filename"><code>slider
registry --list [--servicetype <servicetype>] [--name <name>]
[--verbose] [--user <user>] [--out <filename>]</code><a
class="headerlink"
href="#slider-registry-list-servicetype-servicetype-name-name-verbose-user-user-out-filename"
title="Permanent link">¶</a></h4>
<p>List all services of the service type and optionally the name. </p>
<p>If <code>--out</code> specified a file, the output is listed to the file,
one entry
per line. An empty file means that no entries were found.</p>
-<h4
id="slider-registry-listconf-name-name-internal-servicetype-servicetype-user-user-out-filename"><code>slider
registry --listconf [--name <name>] [--internal] [--servicetype
<servicetype>] [--user <user>] [--out <filename>]</code></h4>
+<h4
id="slider-registry-listconf-name-name-internal-servicetype-servicetype-user-user-out-filename"><code>slider
registry --listconf [--name <name>] [--internal] [--servicetype
<servicetype>] [--user <user>] [--out <filename>]</code><a
class="headerlink"
href="#slider-registry-listconf-name-name-internal-servicetype-servicetype-user-user-out-filename"
title="Permanent link">¶</a></h4>
<p>List the configurations exported by of a named application.</p>
<p>If <code>--out</code> specified a file, the output is listed to the file,
one entry
per line. An empty file means that no entries were found.</p>
-<h4
id="slider-registry-getconf-configuration-format-xmljsonproperties-servicetype-servicetype-name-name-dest-path-internal-user-user-get-the-configuration"><code>slider
registry --getconf <configuration> [--format (xml|json|properties)]
[--servicetype <servicetype>] [--name <name>] [--dest <path>]
[--internal] [--user <user>]</code> get the configuration</h4>
+<h4
id="slider-registry-getconf-configuration-format-xmljsonproperties-servicetype-servicetype-name-name-dest-path-internal-user-user-get-the-configuration"><code>slider
registry --getconf <configuration> [--format (xml|json|properties)]
[--servicetype <servicetype>] [--name <name>] [--dest <path>]
[--internal] [--user <user>]</code> get the configuration<a
class="headerlink"
href="#slider-registry-getconf-configuration-format-xmljsonproperties-servicetype-servicetype-name-name-dest-path-internal-user-user-get-the-configuration"
title="Permanent link">¶</a></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>
@@ -583,13 +594,13 @@ path is used for the file:</p>
<p>This will download the configuration to the file
<code>configfile.xml</code>.</p>
-<h3 id="slider-resolve-path-path-out-filename-list-destdir-dir"><code>slider
resolve --path <path> [--out <filename>] [--list] [--destdir
<dir]</code></h3>
+<h3 id="slider-resolve-path-path-out-filename-list-destdir-dir"><code>slider
resolve --path <path> [--out <filename>] [--list] [--destdir
<dir]</code><a class="headerlink"
href="#slider-resolve-path-path-out-filename-list-destdir-dir" title="Permanent
link">¶</a></h3>
<p>This command resolves the service record under a path in the registry,
or lists all service records directly under a path.</p>
<p>The result can be printed to the console (default) or saved to the
filesystem;
the means of specifiying the destination varies depending on whether a single
record or a listing is requested.</p>
-<h3
id="resolve-a-single-entry-slider-resolve-path-path-out-file-destdir-dir">Resolve
a single entry: <code>slider resolve --path <path> [--out <file>
[--destdir <dir>]</code></h3>
+<h3
id="resolve-a-single-entry-slider-resolve-path-path-out-file-destdir-dir">Resolve
a single entry: <code>slider resolve --path <path> [--out <file>
[--destdir <dir>]</code><a class="headerlink"
href="#resolve-a-single-entry-slider-resolve-path-path-out-file-destdir-dir"
title="Permanent link">¶</a></h3>
<p>The basic <code>slider resolve --path <path></code> command, without
the <code>--list</code> option
will attempt to resolve the service record at the destination. The record
may be saved to the file specified with the <code>--out</code></p>
@@ -606,7 +617,7 @@ and save it to a file</p>
<p>If the specified path is not in the registry, or the path exists but there
is no service record there, the return code is <code>EXIT_NOT_FOUND</code>,
77.</p>
-<h3
id="list-all-entries-and-services-under-a-path-slider-resolve-path-path-list">List
all entries and services under a path: <code>slider resolve --path
<path> --list</code></h3>
+<h3
id="list-all-entries-and-services-under-a-path-slider-resolve-path-path-list">List
all entries and services under a path: <code>slider resolve --path
<path> --list</code><a class="headerlink"
href="#list-all-entries-and-services-under-a-path-slider-resolve-path-path-list"
title="Permanent link">¶</a></h3>
<p><code>slider resolve --path <path> --list</code> command will list
all service records
directly under a path.</p>
<p>The all entries will be listed to the console,
@@ -641,7 +652,7 @@ would be saved to the file <code>service
<p>This simplifies path creation, testing a, </p>
-<h3 id="start-name-wait-milliseconds-out-filename"><code>start <name>
[--wait milliseconds] [--out <filename>]</code></h3>
+<h3 id="start-name-wait-milliseconds-out-filename"><code>start <name>
[--wait milliseconds] [--out <filename>]</code><a class="headerlink"
href="#start-name-wait-milliseconds-out-filename" title="Permanent
link">¶</a></h3>
<p>Start a stopped application instance, recreating it from its previously
saved state.</p>
<p>After the application is launched, if an <code>--out</code> argument
specified a file,
@@ -655,7 +666,7 @@ specified.</p>
<p>If the application instance is already running, this command will not
affect it.</p>
-<h3 id="status-name-out-filename"><code>status <name> [--out
<filename>]</code></h3>
+<h3 id="status-name-out-filename"><code>status <name> [--out
<filename>]</code><a class="headerlink" href="#status-name-out-filename"
title="Permanent link">¶</a></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>
@@ -665,7 +676,7 @@ specify the destination.</p>
</pre></div>
-<h3 id="stop-name-force-wait-time-message-text"><code>stop <name>
[--force] [--wait time] [--message text]</code></h3>
+<h3 id="stop-name-force-wait-time-message-text"><code>stop <name>
[--force] [--wait time] [--message text]</code><a class="headerlink"
href="#stop-name-force-wait-time-message-text" title="Permanent
link">¶</a></h3>
<p>stop 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 stopped.</p>
<p>The <code>--force</code> flag causes YARN asked directly to terminate the
application instance.
@@ -678,20 +689,20 @@ the request: this will appear in the app
</pre></div>
-<h3 id="version"><code>version</code></h3>
+<h3 id="version"><code>version</code><a class="headerlink" href="#version"
title="Permanent link">¶</a></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>
+<h2 id="commands-for-testing">Commands for testing<a class="headerlink"
href="#commands-for-testing" title="Permanent link">¶</a></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>
+<h3 id="kill-container-name-id-container-id"><code>kill-container <name>
--id container-id</code><a class="headerlink"
href="#kill-container-name-id-container-id" title="Permanent
link">¶</a></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>
+<h3
id="am-suicide-name-exitcode-code-message-message-wait-time"><code>am-suicide
<name> [--exitcode code] [--message message] [--wait time]</code><a
class="headerlink"
href="#am-suicide-name-exitcode-code-message-message-wait-time"
title="Permanent link">¶</a></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>
@@ -704,7 +715,7 @@ operation that does not make any attempt
<!--- =======================================================================
-->
-<h2 id="instance-naming">Instance Naming</h2>
+<h2 id="instance-naming">Instance Naming<a class="headerlink"
href="#instance-naming" title="Permanent link">¶</a></h2>
<p>Application instance names must:</p>
<ol>
<li>be at least one character long</li>
Modified: websites/staging/slider/trunk/content/docs/security.html
==============================================================================
--- websites/staging/slider/trunk/content/docs/security.html (original)
+++ websites/staging/slider/trunk/content/docs/security.html Mon Nov 2
17:24:47 2015
@@ -155,7 +155,7 @@
<div style="text-align: center">
<h1><a href="/index.html">Apache Slider (incubating)</a></h1>
<hr>
-Latest release: <strong>0.80.0-incubating</strong><br>
+Latest release: <strong>0.81.1-incubating</strong><br>
<br>
<a id="download-button-sidebar" class="btn btn-success btn-block"
href="/downloads/" role="button">Download</a>
</div>
@@ -168,7 +168,18 @@ Latest release: <strong>0.80.0-incubatin
<h1 class="title"></h1>
- <!---
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink,
h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink,
dt:hover > .elementid-permalink { visibility: visible }</style>
+<!---
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.
@@ -185,15 +196,15 @@ Latest release: <strong>0.80.0-incubatin
limitations under the License.
-->
-<h1 id="apache-slider-security">Apache Slider Security</h1>
+<h1 id="apache-slider-security">Apache Slider Security<a class="headerlink"
href="#apache-slider-security" title="Permanent link">¶</a></h1>
<p>This document discusses the design, implementation and use of Slider
to deploy secure applications on a secure Hadoop cluster.</p>
-<h3 id="important">Important:</h3>
+<h3 id="important">Important:<a class="headerlink" href="#important"
title="Permanent link">¶</a></h3>
<p>This document does not cover Kerberos, how to secure a Hadoop cluster,
Kerberos
command line tools or how Hadoop uses delegation tokens to delegate permissions
round a cluster. These are prerequisites &em;though some links to useful pages
are
listed at the bottom. </p>
-<h2 id="concepts">Concepts</h2>
+<h2 id="concepts">Concepts<a class="headerlink" href="#concepts"
title="Permanent link">¶</a></h2>
<p>Slider runs in secure clusters, but with restrictions</p>
<ol>
<li>The keytabs to allow the AM and components to authenticate with the master
are
@@ -213,8 +224,8 @@ listed at the bottom. </p>
to indentify the application principals as members of the same group
as the user.</li>
</ol>
-<h2 id="security-requirements">Security Requirements</h2>
-<h3 id="needs">Needs</h3>
+<h2 id="security-requirements">Security Requirements<a class="headerlink"
href="#security-requirements" title="Permanent link">¶</a></h2>
+<h3 id="needs">Needs<a class="headerlink" href="#needs" title="Permanent
link">¶</a></h3>
<ul>
<li>Slider and deployed applications to work against secure HDFS</li>
<li>Slider to work with secure YARN.</li>
@@ -224,21 +235,21 @@ listed at the bottom. </p>
<li>Any Slider Web UI and REST API for Ambari to only allow access to
authenticated users.</li>
<li>The Slider database in <code>~/.slider/clusters/$name/data</code> to be
writable by HBase</li>
</ul>
-<h3 id="short-lived-clusters">Short-lived Clusters</h3>
+<h3 id="short-lived-clusters">Short-lived Clusters<a class="headerlink"
href="#short-lived-clusters" title="Permanent link">¶</a></h3>
<ul>
<li>Cluster to remain secure for the duration of the Kerberos tokens issued to
Slider.</li>
</ul>
-<h3 id="long-lived-clusters">Long-lived Clusters</h3>
+<h3 id="long-lived-clusters">Long-lived Clusters<a class="headerlink"
href="#long-lived-clusters" title="Permanent link">¶</a></h3>
<ul>
<li>Slider application instance and HBase instance to remain functional and
secure over an indefinite period of time.</li>
</ul>
-<h3 id="initial-non-requirements">Initial Non-requirements</h3>
+<h3 id="initial-non-requirements">Initial Non-requirements<a
class="headerlink" href="#initial-non-requirements" title="Permanent
link">¶</a></h3>
<ul>
<li>Secure audit trail of cluster operations.</li>
<li>Multiple authorized users being granted rights to a Slider Cluster (YARN
admins can always kill the Slider application instance.</li>
<li>Any way to revoke certificates/rights of running containers.</li>
</ul>
-<h3 id="assumptions">Assumptions</h3>
+<h3 id="assumptions">Assumptions<a class="headerlink" href="#assumptions"
title="Permanent link">¶</a></h3>
<ul>
<li>Kerberos is running and that HDFS and YARN are running Kerberized.</li>
<li>LDAP cannot be assumed. </li>
@@ -251,7 +262,7 @@ listed at the bottom. </p>
<li>All application instances run by a single user can share the same
machine-specific
kerberos identities.</li>
</ul>
-<h2 id="design">Design</h2>
+<h2 id="design">Design<a class="headerlink" href="#design" title="Permanent
link">¶</a></h2>
<ol>
<li>The user is expected to have their own Kerberos principal, and have used
<code>kinit</code>
or equivalent to authenticate with Kerberos and gain a (time-bounded)
TGT</li>
@@ -277,9 +288,9 @@ user <code>r-x</code> for the group and
rights of the user that created the cluster.</p>
<p>The Application Master will read in the JSON cluster specification file,
and instantiate the
relevant number of componentss. </p>
-<h3 id="the-keytab-distributionaccess-options">The Keytab distribution/access
Options</h3>
+<h3 id="the-keytab-distributionaccess-options">The Keytab distribution/access
Options<a class="headerlink" href="#the-keytab-distributionaccess-options"
title="Permanent link">¶</a></h3>
<p>Rather than relying on delegation token based authentication mechanisms,
the AM leverages keytab files for obtaining the principals to authenticate to
the configured cluster KDC. In order to perform this login the AM requires
access to a keytab file that contains the principal representing the user
identity to be associated with the launched application instance (e.g. in an
HBase installation you may elect to leverage the <code>hbase</code> principal
for this purpose). There are two mechanisms supported for keytab access and/or
distribution:</p>
-<h4 id="local-keytab-file-access">Local Keytab file access:</h4>
+<h4 id="local-keytab-file-access">Local Keytab file access:<a
class="headerlink" href="#local-keytab-file-access" title="Permanent
link">¶</a></h4>
<p>An application deployer may choose to pre-distribute the keytab files
required to the Node Manager (NM) hosts in a Yarn cluster. In that instance the
appConfig.json requires the following properties:</p>
<div class="codehilite"><pre><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>
@@ -301,7 +312,7 @@ relevant number of componentss. </p>
</pre></div>
-<h4 id="slider-keytab-distribution">Slider keytab distribution:</h4>
+<h4 id="slider-keytab-distribution">Slider keytab distribution:<a
class="headerlink" href="#slider-keytab-distribution" title="Permanent
link">¶</a></h4>
<p>The deployer can select to upload the keytab files (manually or using the
Slider client install-keytab option - see below) for the AM and the application
to an HDFS directory (with appropriate permissions set) and slider will
localize the keytab files to locations accessible by the AM or the application
containers:</p>
<div class="codehilite"><pre><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>
@@ -337,7 +348,7 @@ specified relative to the <code>$AGENT_W
<li>The principal name established on the client side before invocation of the
Slider CLI (the principal used to <code>kinit</code>) or</li>
<li>The value specified for a <code>slider.keytab.principal.name</code>
property. </li>
</ul>
-<h4 id="slider-client-keytab-installation">Slider Client Keytab
installation:</h4>
+<h4 id="slider-client-keytab-installation">Slider Client Keytab
installation:<a class="headerlink" href="#slider-client-keytab-installation"
title="Permanent link">¶</a></h4>
<p>The Slider client can be leveraged to install keytab files individually
into a designated
keytab HDFS folder. The format of the command is:</p>
<div class="codehilite"><pre><span class="n">slider</span> <span
class="n">install</span><span class="o">-</span><span class="n">keytab</span>
â<span class="n">keytab</span> <span class="o"><</span><span
class="n">path</span> <span class="n">to</span> <span class="n">keytab</span>
<span class="n">on</span> <span class="n">local</span> <span
class="n">file</span> <span class="n">system</span><span class="o">></span>
â<span class="n">folder</span> <span class="o"><</span><span
class="n">name</span> <span class="n">of</span> <span class="n">HDFS</span>
<span class="n">folder</span> <span class="n">to</span> <span
class="n">store</span> <span class="n">keytab</span><span class="o">></span>
<span class="p">[</span>â<span class="n">overwrite</span><span
class="p">]</span>
@@ -373,7 +384,7 @@ The command can be used to upload keytab
</pre></div>
-<h2
id="securing-communications-between-the-slider-client-and-the-slider-am">Securing
communications between the Slider Client and the Slider AM.</h2>
+<h2
id="securing-communications-between-the-slider-client-and-the-slider-am">Securing
communications between the Slider Client and the Slider AM.<a
class="headerlink"
href="#securing-communications-between-the-slider-client-and-the-slider-am"
title="Permanent link">¶</a></h2>
<p>When the AM is deployed in a secure cluster,
it automatically uses Kerberos-authorized RPC channels. The client must
acquire a
token to talk the AM. </p>
@@ -383,7 +394,7 @@ the caller authenticates itself as the u
to the cluster</p>
<p>To allow the client to stop a Slider application instance while they are
unable to acquire
a token to authenticate with the AM, use the <code>--force</code> option.</p>
-<h3 id="how-to-enable-a-secure-slider-client">How to enable a secure Slider
client</h3>
+<h3 id="how-to-enable-a-secure-slider-client">How to enable a secure Slider
client<a class="headerlink" href="#how-to-enable-a-secure-slider-client"
title="Permanent link">¶</a></h3>
<p>Slider can be placed into secure mode by setting the Hadoop security
options:</p>
<p>This can be done in <code>slider-client.xml</code>:</p>
<div class="codehilite"><pre><span class="nt"><property></span>
@@ -403,7 +414,7 @@ a token to authenticate with the AM, use
</pre></div>
-<h3 id="adding-kerberos-binding-properties-to-the-slider-client-jvm">Adding
Kerberos binding properties to the Slider Client JVM</h3>
+<h3 id="adding-kerberos-binding-properties-to-the-slider-client-jvm">Adding
Kerberos binding properties to the Slider Client JVM<a class="headerlink"
href="#adding-kerberos-binding-properties-to-the-slider-client-jvm"
title="Permanent link">¶</a></h3>
<p>The Java Kerberos library needs to know the Kerberos controller and
realm to use. This should happen automatically if this is set up as the
default Kerberos binding (on a Unix system this is done in
<code>/etc/krb5.conf</code>.</p>
@@ -419,7 +430,7 @@ documentation.</p>
</pre></div>
-<h2
id="generation-and-deployment-of-application-keystorestruststores">Generation
and deployment of application keystores/truststores</h2>
+<h2
id="generation-and-deployment-of-application-keystorestruststores">Generation
and deployment of application keystores/truststores<a class="headerlink"
href="#generation-and-deployment-of-application-keystorestruststores"
title="Permanent link">¶</a></h2>
<p>Application components may make use of keystores and truststores to
establish secure communications.
Given the nature of application deployments in a YARN cluster and the lack of
certainty concerning
the host on which a component container may be allocated,
@@ -431,7 +442,7 @@ Slider provides the facility for creatin
<li>Specify the password property for the component keystore or truststore
or,</li>
<li>Specify the property providing the alias that references a credential
managed by the Hadoop Credential Provider. This credential provides the
password for securing the keystore/truststore.</li>
</ul>
-<h3 id="specifying-a-keystoretruststore-password">Specifying a
keystore/truststore password</h3>
+<h3 id="specifying-a-keystoretruststore-password">Specifying a
keystore/truststore password<a class="headerlink"
href="#specifying-a-keystoretruststore-password" title="Permanent
link">¶</a></h3>
<p>Applications that make use of a keystore and/or truststore may already have
configuration
properties that reference the value for the password used to secure the given
certificate store.
In those instances the application configuration can reference the value of
the password property
@@ -449,7 +460,7 @@ in the component specific configuration
<li>The application has a property in its site configuration file named
<code>"app_component.keystore.password"</code>.
This property is specified in the appConfig file's global section (with the
"site.myapp-site" prefix), and is referenced here to indicate to Slider which
application property provides the store password.</li>
</ul>
-<h3 id="specifying-a-keystoretruststore-credential-provider-alias">Specifying
a keystore/truststore Credential Provider alias</h3>
+<h3 id="specifying-a-keystoretruststore-credential-provider-alias">Specifying
a keystore/truststore Credential Provider alias<a class="headerlink"
href="#specifying-a-keystoretruststore-credential-provider-alias"
title="Permanent link">¶</a></h3>
<p>Applications that utilize the Credenfial Provider API to retrieve
application passwords can specify the following configuration:</p>
<ul>
<li>Indicate the credential storage path in the <code>credentials</code>
section of the app configuration file:<div class="codehilite"><pre>
"credentials": {
@@ -472,7 +483,7 @@ This property is specified in the appCon
</li>
</ul>
<p>At runtime, Slider will read the credential mapped to the alias (in this
case, "app_component.keystore.password.alias"), and leverage the password
stored to secure the generated keystore.</p>
-<h2 id="important-java-cryptography-package">Important: Java Cryptography
Package</h2>
+<h2 id="important-java-cryptography-package">Important: Java Cryptography
Package<a class="headerlink" href="#important-java-cryptography-package"
title="Permanent link">¶</a></h2>
<p>When trying to talk to a secure, cluster you may see the message:</p>
<div class="codehilite"><pre><span class="n">No</span> <span
class="n">valid</span> <span class="n">credentials</span> <span
class="n">provided</span> <span class="p">(</span><span
class="n">Mechanism</span> <span class="n">level</span><span class="p">:</span>
<span class="n">Illegal</span> <span class="n">key</span> <span
class="nb">size</span><span class="p">)]</span>
</pre></div>
@@ -484,7 +495,7 @@ This property is specified in the appCon
needed to work with the keys that Kerberos needs. This must be downloaded
from Oracle (or other supplier of the JVM) and installed according to
its accompanying instructions.</p>
-<h2 id="useful-links">Useful Links</h2>
+<h2 id="useful-links">Useful Links<a class="headerlink" href="#useful-links"
title="Permanent link">¶</a></h2>
<ol>
<li><a
href="http://hortonworks.com/wp-content/uploads/2011/10/security-design_withCover-1.pdf";>Adding
Security to Apache Hadoop</a></li>
<li><a
href="http://hortonworks.com/blog/the-role-of-delegation-tokens-in-apache-hadoop-security/";>The
Role of Delegation Tokens in Apache Hadoop Security</a></li>
Modified:
websites/staging/slider/trunk/content/docs/slider_specs/application_configuration.html
==============================================================================
---
websites/staging/slider/trunk/content/docs/slider_specs/application_configuration.html
(original)
+++
websites/staging/slider/trunk/content/docs/slider_specs/application_configuration.html
Mon Nov 2 17:24:47 2015
@@ -155,7 +155,7 @@
<div style="text-align: center">
<h1><a href="/index.html">Apache Slider (incubating)</a></h1>
<hr>
-Latest release: <strong>0.80.0-incubating</strong><br>
+Latest release: <strong>0.81.1-incubating</strong><br>
<br>
<a id="download-button-sidebar" class="btn btn-success btn-block"
href="/downloads/" role="button">Download</a>
</div>
@@ -168,7 +168,18 @@ Latest release: <strong>0.80.0-incubatin
<h1 class="title"></h1>
- <!---
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink,
h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink,
dt:hover > .elementid-permalink { visibility: visible }</style>
+<!---
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.
@@ -185,7 +196,7 @@ Latest release: <strong>0.80.0-incubatin
limitations under the License.
-->
-<h1 id="apache-slider-application-configuration">Apache Slider Application
Configuration</h1>
+<h1 id="apache-slider-application-configuration">Apache Slider Application
Configuration<a class="headerlink"
href="#apache-slider-application-configuration" title="Permanent
link">¶</a></h1>
<p>App Configuration captures the default configuration associated with the
application. <em>Details of configuration management is discussed in a separate
spec</em>. The default configuration is modified based on user provided
InstanceConfiguration, cluster specific details (e.g. HDFS root, local dir
root), container allocated resources (port and hostname), and dependencies
(e.g. ZK quorom hosts) and handed to the component instances.</p>
<p>App Configuration is a folder containing all configuration needed by the
application. Config files include any site.xml, log4j properties file, etc. </p>
<p>In addition, application may have configuration parameters that do not
necessarily go into a config files. Such configurations may be used during
template expansion (parameters in env.sh files), as environment variables (e.g.
JAVA_HOME), customize user names (for runas). These configurations can be
provided as user inputs or are automatically inferred from the environment.
Such configurations are stored in a file named "app_config.xml".</p>
Modified:
websites/staging/slider/trunk/content/docs/slider_specs/application_definition.html
==============================================================================
---
websites/staging/slider/trunk/content/docs/slider_specs/application_definition.html
(original)
+++
websites/staging/slider/trunk/content/docs/slider_specs/application_definition.html
Mon Nov 2 17:24:47 2015
@@ -155,7 +155,7 @@
<div style="text-align: center">
<h1><a href="/index.html">Apache Slider (incubating)</a></h1>
<hr>
-Latest release: <strong>0.80.0-incubating</strong><br>
+Latest release: <strong>0.81.1-incubating</strong><br>
<br>
<a id="download-button-sidebar" class="btn btn-success btn-block"
href="/downloads/" role="button">Download</a>
</div>
@@ -168,7 +168,18 @@ Latest release: <strong>0.80.0-incubatin
<h1 class="title"></h1>
- <!---
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink,
h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink,
dt:hover > .elementid-permalink { visibility: visible }</style>
+<!---
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.
@@ -185,9 +196,9 @@ Latest release: <strong>0.80.0-incubatin
limitations under the License.
-->
-<h1 id="apache-slider-application-definition">Apache Slider Application
Definition</h1>
+<h1 id="apache-slider-application-definition">Apache Slider Application
Definition<a class="headerlink" href="#apache-slider-application-definition"
title="Permanent link">¶</a></h1>
<p>App definition is a declarative definition of a YARN application describing
its content. The AppDefinition is used in conjunction with the <a
href="application_package.html">AppPackage</a>. Application definition is an
XML file and is packaged as metainfo.xml.</p>
-<h2 id="structure">Structure</h2>
+<h2 id="structure">Structure<a class="headerlink" href="#structure"
title="Permanent link">¶</a></h2>
<p><em>Non-mandatory fields are described in <strong>italics</strong>.</em></p>
<p>The fields to describe an application is as follows:</p>
<ul>
Modified:
websites/staging/slider/trunk/content/docs/slider_specs/application_instance_configuration.html
==============================================================================
---
websites/staging/slider/trunk/content/docs/slider_specs/application_instance_configuration.html
(original)
+++
websites/staging/slider/trunk/content/docs/slider_specs/application_instance_configuration.html
Mon Nov 2 17:24:47 2015
@@ -155,7 +155,7 @@
<div style="text-align: center">
<h1><a href="/index.html">Apache Slider (incubating)</a></h1>
<hr>
-Latest release: <strong>0.80.0-incubating</strong><br>
+Latest release: <strong>0.81.1-incubating</strong><br>
<br>
<a id="download-button-sidebar" class="btn btn-success btn-block"
href="/downloads/" role="button">Download</a>
</div>
@@ -168,7 +168,18 @@ Latest release: <strong>0.80.0-incubatin
<h1 class="title"></h1>
- <!---
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink,
h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink,
dt:hover > .elementid-permalink { visibility: visible }</style>
+<!---
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.
@@ -185,7 +196,7 @@ Latest release: <strong>0.80.0-incubatin
limitations under the License.
-->
-<h1 id="apache-slider-app-instance-configuration">Apache Slider App Instance
Configuration</h1>
+<h1 id="apache-slider-app-instance-configuration">Apache Slider App Instance
Configuration<a class="headerlink"
href="#apache-slider-app-instance-configuration" title="Permanent
link">¶</a></h1>
<p>App Instance Configuration is the configuration override provided by the
application owner when creating an application instance using Slider. This
configuration values override the default configuration available in the App
Package.</p>
<p>Instance configuration is a JSON formatted doc in the following form:</p>
<div class="codehilite"><pre><span class="p">{</span>
@@ -249,7 +260,7 @@ Latest release: <strong>0.80.0-incubatin
<p>appConf.json allows you to pass in arbitrary set of configuration that
Slider will forward to the application component instances.</p>
-<h2 id="variable-naming-convention">Variable naming convention</h2>
+<h2 id="variable-naming-convention">Variable naming convention<a
class="headerlink" href="#variable-naming-convention" title="Permanent
link">¶</a></h2>
<p>In order to understand how the naming convention works, lets look at how
the config is passed on to component commands. Slider agent recevies a
structured bag of commands as input for all commands, INSTALL, CONFIGURE,
START, etc. The command includes a section "configuration" which has config
properties arranged into named property bags.</p>
<ul>
<li>Variables of the form <code>site.xx.yy</code> translates to variables by
the name <code>yy</code> within the group <code>xx</code> and are typically
converted to site config files by the name <code>xx</code> containing variable
<code>yy</code>. For example,
<code>"site.hbase-site.hbase.regionserver.port":""</code> will be sent to the
Slider-Agent as <code>"hbase-site" : { "hbase.regionserver.port": ""}</code>
and app definition scripts can access all variables under
<code>hbase-site</code> as a single property bag.</li>
@@ -281,7 +292,7 @@ Latest release: <strong>0.80.0-incubatin
<li>"site.global.ganglia_server_id": "HBaseApplicationCluster3"</li>
</ul>
<p>All three variable values are user provided. It is also expected that a
gmond server is available on host gangliaserver.my.org listening for metrics at
port 8663 and is named "HBaseApplicationCluster3". Its the reponsibility of the
ganglia server admin to ensure that the server is unique and is only receving
metrics from the application instance.</p>
-<h2 id="available-environment-variable">Available environment variable</h2>
+<h2 id="available-environment-variable">Available environment variable<a
class="headerlink" href="#available-environment-variable" title="Permanent
link">¶</a></h2>
<table>
<tr>
<td>Property</td>
Modified:
websites/staging/slider/trunk/content/docs/slider_specs/application_needs.html
==============================================================================
---
websites/staging/slider/trunk/content/docs/slider_specs/application_needs.html
(original)
+++
websites/staging/slider/trunk/content/docs/slider_specs/application_needs.html
Mon Nov 2 17:24:47 2015
@@ -155,7 +155,7 @@
<div style="text-align: center">
<h1><a href="/index.html">Apache Slider (incubating)</a></h1>
<hr>
-Latest release: <strong>0.80.0-incubating</strong><br>
+Latest release: <strong>0.81.1-incubating</strong><br>
<br>
<a id="download-button-sidebar" class="btn btn-success btn-block"
href="/downloads/" role="button">Download</a>
</div>
@@ -168,7 +168,18 @@ Latest release: <strong>0.80.0-incubatin
<h1 class="title"></h1>
- <!---
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink,
h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink,
dt:hover > .elementid-permalink { visibility: visible }</style>
+<!---
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.
@@ -185,7 +196,7 @@ Latest release: <strong>0.80.0-incubatin
limitations under the License.
-->
-<h1 id="apache-sliders-needs-of-an-application">Apache Slider's needs of an
application</h1>
+<h1 id="apache-sliders-needs-of-an-application">Apache Slider's needs of an
application<a class="headerlink" href="#apache-sliders-needs-of-an-application"
title="Permanent link">¶</a></h1>
<p>Slider installs and runs applications in a YARN cluster -applications that
do not need to be written for YARN. </p>
<p>What they do need to be is deployable by Slider, which means installable by
YARN,
@@ -196,7 +207,7 @@ shutdown without any manual recovery pro
<p>They need to locate each other dynamically, both at startup and during
execution,
because the location of processes will be unknown at startup, and may change
due to server and process failures. </p>
-<h2 id="must">Must</h2>
+<h2 id="must">Must<a class="headerlink" href="#must" title="Permanent
link">¶</a></h2>
<ul>
<li>
<p>Install and run from a tarball -and be run from a user that is not root.
</p>
@@ -253,11 +264,11 @@ location such as <code>/etc</code>.</p>
the container.</p>
</li>
</ul>
-<h2 id="must-not">MUST NOT</h2>
+<h2 id="must-not">MUST NOT<a class="headerlink" href="#must-not"
title="Permanent link">¶</a></h2>
<ul>
<li>Require human intervention at startup or termination.</li>
</ul>
-<h2 id="should">SHOULD</h2>
+<h2 id="should">SHOULD<a class="headerlink" href="#should" title="Permanent
link">¶</a></h2>
<p>These are the features that we'd like from a service:</p>
<ul>
<li>
@@ -302,7 +313,7 @@ stored locally/in-rack, rather than just
state of a Slider application can be monitored.</p>
</li>
</ul>
-<h2 id="may">MAY</h2>
+<h2 id="may">MAY<a class="headerlink" href="#may" title="Permanent
link">¶</a></h2>
<ul>
<li>
<p>Dynamically allocate any RPC or web ports -such as supporting 0 as the
number
@@ -321,7 +332,7 @@ Slider AM restarts.</p>
E.g amount of data; app load. </p>
</li>
</ul>
-<h2 id="may-not">MAY NOT</h2>
+<h2 id="may-not">MAY NOT<a class="headerlink" href="#may-not" title="Permanent
link">¶</a></h2>
<ul>
<li>
<p>Be written for YARN.</p>
Modified:
websites/staging/slider/trunk/content/docs/slider_specs/application_package.html
==============================================================================
---
websites/staging/slider/trunk/content/docs/slider_specs/application_package.html
(original)
+++
websites/staging/slider/trunk/content/docs/slider_specs/application_package.html
Mon Nov 2 17:24:47 2015
@@ -155,7 +155,7 @@
<div style="text-align: center">
<h1><a href="/index.html">Apache Slider (incubating)</a></h1>
<hr>
-Latest release: <strong>0.80.0-incubating</strong><br>
+Latest release: <strong>0.81.1-incubating</strong><br>
<br>
<a id="download-button-sidebar" class="btn btn-success btn-block"
href="/downloads/" role="button">Download</a>
</div>
@@ -168,7 +168,18 @@ Latest release: <strong>0.80.0-incubatin
<h1 class="title"></h1>
- <!---
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink,
h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink,
dt:hover > .elementid-permalink { visibility: visible }</style>
+<!---
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.
@@ -185,9 +196,9 @@ Latest release: <strong>0.80.0-incubatin
limitations under the License.
-->
-<h1 id="apache-slider-app-package">Apache Slider App Package</h1>
+<h1 id="apache-slider-app-package">Apache Slider App Package<a
class="headerlink" href="#apache-slider-app-package" title="Permanent
link">¶</a></h1>
<p>All application artifacts, app definition, app configuration, scripts are
packaged into a structured single package that can be handed off to any YARN
application deployment tool including Slider</p>
-<h2 id="overall-structure">Overall Structure</h2>
+<h2 id="overall-structure">Overall Structure<a class="headerlink"
href="#overall-structure" title="Permanent link">¶</a></h2>
<p>App package is a zip package containing all application artifacts. App
package contains the following items:</p>
<ul>
<li>
@@ -217,13 +228,13 @@ other scripts, txt files, tarballs, etc.
</ul>
<p><img alt="Image" src="../../images/app_package_sample_04.png?raw=true"
/></p>
<p>The example above shows a semi-expanded view of an application
"HBASE-YARN-APP" and the package structure for OOZIE command scripts.</p>
-<h2 id="app-definition">app definition</h2>
+<h2 id="app-definition">app definition<a class="headerlink"
href="#app-definition" title="Permanent link">¶</a></h2>
<p>App definition is a file named "metainfo.xml". The file contains
application definition as described in <a
href="application_definition.html">Application Definition</a>. </p>
-<h2 id="default-configurations">default configurations</h2>
+<h2 id="default-configurations">default configurations<a class="headerlink"
href="#default-configurations" title="Permanent link">¶</a></h2>
<p>This folder consists of various config files containing default
configuration as described in <a href="application_configuration.html">App
Configuration</a>.</p>
-<h2 id="package-folder">package folder</h2>
+<h2 id="package-folder">package folder<a class="headerlink"
href="#package-folder" title="Permanent link">¶</a></h2>
<p>package includes the "implementation" of all management operations. The
folders within are divided into scripts, templates, and files.</p>
-<h3 id="scripts-folder">scripts folder</h3>
+<h3 id="scripts-folder">scripts folder<a class="headerlink"
href="#scripts-folder" title="Permanent link">¶</a></h3>
<p>Scripts are the implementation of management operations. There are five
default operations and a composite operation. "restart" can be redefined to
have a custom implementation.</p>
<ol>
<li>
@@ -269,7 +280,7 @@ other scripts, txt files, tarballs, etc.
<p><a href="/docs/slider_specs/writing_app_command_scripts.html">How to write
scripts</a> discusses how the scripts are developed and the structure of the
JSON_FILE containing the parameters.</p>
-<h3 id="templates-folder">templates folder</h3>
+<h3 id="templates-folder">templates folder<a class="headerlink"
href="#templates-folder" title="Permanent link">¶</a></h3>
<p>templates are configurable text files that are NOT regular config files.
<em>A library has been developed that can materialize a complete site
configuration file from a property bag and therefore are not generated from
templates.</em> Other files such as env sh files, log4j properties file, etc.
may be derived from a template. Again, the implementor can choose to create
these files from scratch and not use templates. The following operations are
allowed during template expansion:</p>
<ul>
<li>
@@ -294,7 +305,7 @@ other scripts, txt files, tarballs, etc.
</pre></div>
-<h3 id="files-folder">files folder</h3>
+<h3 id="files-folder">files folder<a class="headerlink" href="#files-folder"
title="Permanent link">¶</a></h3>
<p>files is a directory to store any other files that are needed for
management operations. Sample files stored here are tarballs used to install
the application, shell scripts used by various operations.</p>
</div>
Modified:
websites/staging/slider/trunk/content/docs/slider_specs/application_pkg_docker.html
==============================================================================
---
websites/staging/slider/trunk/content/docs/slider_specs/application_pkg_docker.html
(original)
+++
websites/staging/slider/trunk/content/docs/slider_specs/application_pkg_docker.html
Mon Nov 2 17:24:47 2015
@@ -155,7 +155,7 @@
<div style="text-align: center">
<h1><a href="/index.html">Apache Slider (incubating)</a></h1>
<hr>
-Latest release: <strong>0.80.0-incubating</strong><br>
+Latest release: <strong>0.81.1-incubating</strong><br>
<br>
<a id="download-button-sidebar" class="btn btn-success btn-block"
href="/downloads/" role="button">Download</a>
</div>
Modified:
websites/staging/slider/trunk/content/docs/slider_specs/application_pkg_upgrade.html
==============================================================================
---
websites/staging/slider/trunk/content/docs/slider_specs/application_pkg_upgrade.html
(original)
+++
websites/staging/slider/trunk/content/docs/slider_specs/application_pkg_upgrade.html
Mon Nov 2 17:24:47 2015
@@ -155,7 +155,7 @@
<div style="text-align: center">
<h1><a href="/index.html">Apache Slider (incubating)</a></h1>
<hr>
-Latest release: <strong>0.80.0-incubating</strong><br>
+Latest release: <strong>0.81.1-incubating</strong><br>
<br>
<a id="download-button-sidebar" class="btn btn-success btn-block"
href="/downloads/" role="button">Download</a>
</div>
@@ -168,7 +168,18 @@ Latest release: <strong>0.80.0-incubatin
<h1 class="title"></h1>
- <!---
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink,
h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink,
dt:hover > .elementid-permalink { visibility: visible }</style>
+<!---
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.
@@ -185,8 +196,8 @@ Latest release: <strong>0.80.0-incubatin
limitations under the License.
-->
-<h1 id="apache-slider-app-packages-rolling-upgradereconfiguration">Apache
Slider App Packages Rolling Upgrade/Reconfiguration</h1>
-<h2 id="introduction">Introduction</h2>
+<h1 id="apache-slider-app-packages-rolling-upgradereconfiguration">Apache
Slider App Packages Rolling Upgrade/Reconfiguration<a class="headerlink"
href="#apache-slider-app-packages-rolling-upgradereconfiguration"
title="Permanent link">¶</a></h1>
+<h2 id="introduction">Introduction<a class="headerlink" href="#introduction"
title="Permanent link">¶</a></h2>
<p>From version <code>0.80.0-incubating</code> onwards, Slider supports
application package rolling upgrade.
Application package owners can now upgrade to a newer version of their
application
binary and/or configuration, without any downtime.</p>
@@ -200,19 +211,19 @@ still be the older version. Hence <code>
<strong><em>master</em></strong>.</p>
<p>Currently, <em>Ambari Slider View</em> supports automated deployment and
management of application packages.
Automated application package upgrade will be supported soon.</p>
-<h2 id="phases-of-upgradedowngrade">Phases of Upgrade/Downgrade</h2>
-<h4 id="yarn-core-libraries-and-configurations-upgradedowngrade">YARN core
(libraries and configurations) upgrade/downgrade</h4>
+<h2 id="phases-of-upgradedowngrade">Phases of Upgrade/Downgrade<a
class="headerlink" href="#phases-of-upgradedowngrade" title="Permanent
link">¶</a></h2>
+<h4 id="yarn-core-libraries-and-configurations-upgradedowngrade">YARN core
(libraries and configurations) upgrade/downgrade<a class="headerlink"
href="#yarn-core-libraries-and-configurations-upgradedowngrade"
title="Permanent link">¶</a></h4>
<p> Running Slider apps will continue to run, with no
downtime</p>
-<h4 id="slider-client-upgradedowngrade">Slider client upgrade/downgrade</h4>
+<h4 id="slider-client-upgradedowngrade">Slider client upgrade/downgrade<a
class="headerlink" href="#slider-client-upgradedowngrade" title="Permanent
link">¶</a></h4>
<p> Does not affect running Slider apps at all. New
version of client can co-exist with older versions of client.</p>
-<h4
id="slider-application-master-upgradedowngrade-of-running-applications">Slider
Application Master upgrade/downgrade of running applications</h4>
+<h4
id="slider-application-master-upgradedowngrade-of-running-applications">Slider
Application Master upgrade/downgrade of running applications<a
class="headerlink"
href="#slider-application-master-upgradedowngrade-of-running-applications"
title="Permanent link">¶</a></h4>
<p> Applications started prior to the start of YARN
core upgrade/downgrade, will continue to run with the
older versions of Slider core and Hadoop libraries. There is no support for
rolling upgrade of Slider AM.
To upgrade running Slider AMs, the application needs to be stopped and
restarted with the new version
of the client.</p>
-<h4
id="applications-deployed-by-slider-binaries-and-configurations-upgradedowngrade">Applications
deployed by Slider (binaries and configurations) upgrade/downgrade</h4>
+<h4
id="applications-deployed-by-slider-binaries-and-configurations-upgradedowngrade">Applications
deployed by Slider (binaries and configurations) upgrade/downgrade<a
class="headerlink"
href="#applications-deployed-by-slider-binaries-and-configurations-upgradedowngrade"
title="Permanent link">¶</a></h4>
<p> This is what this document is primarily about.</p>
-<h2 id="rolling-upgrade-of-applications-deployed-by-slider">Rolling Upgrade of
Applications Deployed by Slider</h2>
+<h2 id="rolling-upgrade-of-applications-deployed-by-slider">Rolling Upgrade of
Applications Deployed by Slider<a class="headerlink"
href="#rolling-upgrade-of-applications-deployed-by-slider" title="Permanent
link">¶</a></h2>
<p>A run-book style list of atomic steps exposed by Slider. These steps will
be automated
by Apache Ambari in a future release. It can be easily orchestrated by a shell
script
or executed manually in the correct order.</p>
@@ -226,7 +237,7 @@ for long running applications (specifica
</pre></div>
-<h3
id="an-application-owner-brings-a-new-package-and-creates-a-new-instance">An
application owner brings a new package and creates a new instance</h3>
+<h3
id="an-application-owner-brings-a-new-package-and-creates-a-new-instance">An
application owner brings a new package and creates a new instance<a
class="headerlink"
href="#an-application-owner-brings-a-new-package-and-creates-a-new-instance"
title="Permanent link">¶</a></h3>
<p>Upload a new application package
<em>slider-hbase-app-package_v1.0.zip</em></p>
<div class="codehilite"><pre><span class="n">slider</span> <span
class="n">package</span> <span class="o">--</span><span
class="n">install</span> <span class="o">--</span><span class="n">name</span>
<span class="n">MyHBase_Facebook</span> <span class="o">--</span><span
class="n">version</span> 1<span class="p">.</span>0 <span
class="o">--</span><span class="n">package</span> <span
class="o">~/</span><span class="n">slider</span><span class="o">-</span><span
class="n">hbase</span><span class="o">-</span><span class="n">app</span><span
class="o">-</span><span class="n">package_v1</span><span
class="p">.</span>0<span class="p">.</span><span class="n">zip</span>
</pre></div>
@@ -248,7 +259,7 @@ for long running applications (specifica
</pre></div>
-<h3
id="the-app-owner-can-list-all-containers-of-an-app-instance-with-filtering-options">The
app owner can list all containers of an app instance with filtering
options</h3>
+<h3
id="the-app-owner-can-list-all-containers-of-an-app-instance-with-filtering-options">The
app owner can list all containers of an app instance with filtering options<a
class="headerlink"
href="#the-app-owner-can-list-all-containers-of-an-app-instance-with-filtering-options"
title="Permanent link">¶</a></h3>
<div class="codehilite"><pre><span class="n">slider</span> <span
class="n">list</span> <span class="n">MyHBase_Facebook_Finance</span> <span
class="o">--</span><span class="n">containers</span>
<span class="n">slider</span> <span class="n">list</span> <span
class="n">MyHBase_Facebook_Finance</span> <span class="o">--</span><span
class="n">containers</span> <span class="o">--</span><span
class="n">components</span> <span class="n">HBASE_MASTER</span>
@@ -259,7 +270,7 @@ for long running applications (specifica
</pre></div>
-<h3
id="at-some-point-the-app-owner-has-a-newer-version-of-the-package-and-needs-to-upgrade">At
some point, the app owner has a newer version of the package and needs to
upgrade</h3>
+<h3
id="at-some-point-the-app-owner-has-a-newer-version-of-the-package-and-needs-to-upgrade">At
some point, the app owner has a newer version of the package and needs to
upgrade<a class="headerlink"
href="#at-some-point-the-app-owner-has-a-newer-version-of-the-package-and-needs-to-upgrade"
title="Permanent link">¶</a></h3>
<p>Upload the newer version 2.0 of the app package</p>
<div class="codehilite"><pre><span class="n">slider</span> <span
class="n">package</span> <span class="o">--</span><span
class="n">install</span> <span class="o">--</span><span class="n">name</span>
<span class="n">MyHBase_Facebook</span> <span class="o">--</span><span
class="n">version</span> 2<span class="p">.</span>0 <span
class="o">--</span><span class="n">package</span> <span
class="o">~/</span><span class="n">slider</span><span class="o">-</span><span
class="n">hbase</span><span class="o">-</span><span class="n">app</span><span
class="o">-</span><span class="n">package_v2</span><span
class="p">.</span>0<span class="p">.</span><span class="n">zip</span>
</pre></div>
@@ -303,7 +314,7 @@ one container at a time.</p>
</pre></div>
-<h3 id="when-do-we-know-that-upgrade-is-complete">When do we know that upgrade
is complete?</h3>
+<h3 id="when-do-we-know-that-upgrade-is-complete">When do we know that upgrade
is complete?<a class="headerlink"
href="#when-do-we-know-that-upgrade-is-complete" title="Permanent
link">¶</a></h3>
<p>The upgrade command needs to be executed against all containers. Upgrade
can be considered
complete only if the following command returns no containers.</p>
<div class="codehilite"><pre><span class="n">slider</span> <span
class="n">list</span> <span class="n">MyHBase_Facebook_Finance</span> <span
class="o">--</span><span class="n">containers</span> <span
class="o">--</span><span class="n">version</span> 1<span class="p">.</span>0
@@ -315,7 +326,7 @@ check that all expected containers are r
this case).</p>
<p>If any issues are encountered in Slider and/or the application during
upgrade, the
application can be downgraded to its original version.</p>
-<h2 id="downgrade-applications-deployed-and-upgraded-by-slider">Downgrade
Applications Deployed and Upgraded by Slider</h2>
+<h2 id="downgrade-applications-deployed-and-upgraded-by-slider">Downgrade
Applications Deployed and Upgraded by Slider<a class="headerlink"
href="#downgrade-applications-deployed-and-upgraded-by-slider" title="Permanent
link">¶</a></h2>
<p>A Slider deployed application might be required to be downgraded to its
original version for
any reason - whether the upgrade was completed in entirety or was in-flight.
There are no new
commands exposed to perform downgrade. It basically involves calling the
upgrade command again
@@ -343,8 +354,8 @@ Master with the old v1.0 config and reso
</pre></div>
-<h2 id="pre-and-post-upgrade-hooks">Pre and post upgrade hooks</h2>
-<h3 id="pre-upgrade-hook-optional">Pre-upgrade hook (optional)</h3>
+<h2 id="pre-and-post-upgrade-hooks">Pre and post upgrade hooks<a
class="headerlink" href="#pre-and-post-upgrade-hooks" title="Permanent
link">¶</a></h2>
+<h3 id="pre-upgrade-hook-optional">Pre-upgrade hook (optional)<a
class="headerlink" href="#pre-upgrade-hook-optional" title="Permanent
link">¶</a></h3>
<p> The pre-upgrade steps, if provided, will allow
applications to execute simple housekeeping tasks
before Slider actually calls stop operation in an upgrade scenario
(specifically if they need to
be performed in every single container and 1000s of them are running). An
example could be to
@@ -359,14 +370,14 @@ will call the application stop hook even
pre-upgrade hook. Note, the pre-upgrade hook will be triggered only if the
currently running
application has been created using Slider verion
<code>0.80.0-incubating</code> or later and the scripts
in the package has the pre-upgrade hook defined.</p>
-<h3 id="post-upgrade-hook-optional-not-yet-supported">Post-upgrade hook
(optional) - <code>not yet supported</code></h3>
+<h3 id="post-upgrade-hook-optional-not-yet-supported">Post-upgrade hook
(optional) - <code>not yet supported</code><a class="headerlink"
href="#post-upgrade-hook-optional-not-yet-supported" title="Permanent
link">¶</a></h3>
<p> This allows applications to perform simple
housekeeping tasks prior to calling start on the new
version of the application component. This is helpful only if such tasks are
required to be
performed in every single container and 1000s of them are running. This hook
will be triggered only in the
upgrade scenario. It will not be called on new containers created using flex
up, in non-upgrade
scenarios. This makes triggering of post-upgrade hook a little tricky and
hence is not supported
today. This will be looked into, in future releases.</p>
-<h2 id="upgrade-support-of-simple-apps-with-no-packages">Upgrade support of
simple apps with no packages</h2>
+<h2 id="upgrade-support-of-simple-apps-with-no-packages">Upgrade support of
simple apps with no packages<a class="headerlink"
href="#upgrade-support-of-simple-apps-with-no-packages" title="Permanent
link">¶</a></h2>
<ul>
<li>Upgrade of such simple apps does not involve binaries</li>
<li>Upgrade of such simple apps basically means re-configuration only</li>
@@ -383,7 +394,7 @@ today. This will be looked into, in futu
</ul>
</li>
</ul>
-<h2 id="assumptionsrecommendations">Assumptions/Recommendations</h2>
+<h2 id="assumptionsrecommendations">Assumptions/Recommendations<a
class="headerlink" href="#assumptionsrecommendations" title="Permanent
link">¶</a></h2>
<ul>
<li>Letâs take the scenario when the upgrade command has been called (with
new app config and
resources) and the orchestrator is in the middle of calling upgrade command
on all containers
