You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@slider.apache.org by bi...@apache.org on 2014/07/07 21:03:40 UTC
svn commit: r1608561 [12/16] - in /incubator/slider/site/content: ./ css/
design/ design/registry/ design/specification/ developing/ docs/
docs/configuration/ docs/slider_specs/ downloads/ fonts/ images/ js/
release_notes/
Added: incubator/slider/site/content/docs/manpage.html
URL: http://svn.apache.org/viewvc/incubator/slider/site/content/docs/manpage.html?rev=1608561&view=auto
==============================================================================
--- incubator/slider/site/content/docs/manpage.html (added)
+++ incubator/slider/site/content/docs/manpage.html Mon Jul 7 19:03:38 2014
@@ -0,0 +1,535 @@
+<!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_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_use_app_package"><a href="/docs/slider_specs/index.html">App Packaging</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.30-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>
+<pre class="codehilite"><code>slider <ACTION> [<name>] [<OPTIONS>]</code></pre>
+
+
+<!--- ======================================================================= -->
+
+<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>
+<pre class="codehilite"><code>--option site.dfs.blocksize 128m</code></pre>
+
+
+<p>Increase the number of YARN containers which must fail before the Slider application instance
+itself fails.</p>
+<pre class="codehilite"><code>-O slider.container.failure.threshold 16</code></pre>
+
+
+<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>
+<pre class="codehilite"><code>--appconf hdfs://namenode/users/slider/conf/hbase-template
+--appconf file://users/accumulo/conf/template</code></pre>
+
+
+<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>
+<pre class="codehilite"><code>--apphome /usr/hadoop/hbase</code></pre>
+
+
+<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>
+<pre class="codehilite"><code>--image hdfs://namenode/shared/binaries/hbase-0.96.tar.gz</code></pre>
+
+
+<h5 id="-component-name-count"><code>--component <name> <count></code></h5>
+<p>The desired number of instances of a component</p>
+<p>Example</p>
+<pre class="codehilite"><code>--component worker 16</code></pre>
+
+
+<p>This just sets the <code>component.instances</code> value of the named component's resource configuration.
+it is exactly equivalent to </p>
+<pre class="codehilite"><code>--rco worker component.instances 16</code></pre>
+
+
+<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>
+<pre class="codehilite"><code>--compopt master env.TIMEOUT 10000</code></pre>
+
+
+<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>
+<pre class="codehilite"><code>--rco worker master yarn.memory 2048
+--rco worker worker yarn.memory max</code></pre>
+
+
+<h5 id="-zkhosts-host1port1host2port2host3port3"><code>--zkhosts host1:port1,[host2:port2,host3:port3, ...]</code></h5>
+<p>The zookeeper quorum.</p>
+<p>Example</p>
+<pre class="codehilite"><code>--zkhosts zk1:2181,zk2:2181,zk3:4096</code></pre>
+
+
+<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>
+<pre class="codehilite"><code>slider destroy instance1</code></pre>
+
+
+<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>
+<pre class="codehilite"><code> 0 : application instance is defined in the filesystem
+70 : application instance is unknown</code></pre>
+
+
+<p>Example:</p>
+<pre class="codehilite"><code>slider exists instance4</code></pre>
+
+
+<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>
+<pre class="codehilite"><code> 0 : application instance is running
+-1 : application instance exists but is not running
+70 : application instance is unknown</code></pre>
+
+
+<p>Example:</p>
+<pre class="codehilite"><code>slider exists instance4 --live</code></pre>
+
+
+<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>
+<pre class="codehilite"><code>slider flex instance1 --component worker 8 --filesystem hdfs://host:port
+slider flex instance1 --component master 2 --filesystem hdfs://host:port</code></pre>
+
+
+<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>
+<pre class="codehilite"><code>slider freeze instance1 --wait 30
+slider freeze instance2 --force --message "maintenance session"</code></pre>
+
+
+<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>
+<pre class="codehilite"><code>slider list
+slider list instance1</code></pre>
+
+
+<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="registry-list-servicetype-servicetype-name-name-verbose"><code>registry --list [--servicetype <servicetype>] [--name <name>] [--verbose]</code></h4>
+<p>List all services of the service type and optionally the name. </p>
+<h4 id="registry-listconf-name-name-internal-servicetype-servicetype"><code>registry --listconf [--name <name>] [--internal] [--servicetype <servicetype>]</code></h4>
+<p>List the configurations exported by of a named application</p>
+<h4 id="registry-getconf-configuration-format-xmljsonproperties-dest-path-internal-get-the-configuration"><code>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>
+<pre class="codehilite"><code>slider status instance1 --manager host:port
+
+slider status instance2 --manager host:port --out status.json</code></pre>
+
+
+<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>
+<pre class="codehilite"><code>slider thaw instance2
+slider thaw instance1 --wait 60</code></pre>
+
+
+<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>
+<pre class="codehilite"><code>slider am-suicide --exitcode 1 --wait 5000 -message "test"</code></pre>
+
+
+<!--- ======================================================================= -->
+
+<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>
+<pre class="codehilite"><code>slider1
+storm4
+hbase_instance
+accumulo_m1_tserve4</code></pre>
+ </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>
Propchange: incubator/slider/site/content/docs/manpage.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/slider/site/content/docs/security.html
URL: http://svn.apache.org/viewvc/incubator/slider/site/content/docs/security.html?rev=1608561&view=auto
==============================================================================
--- incubator/slider/site/content/docs/security.html (added)
+++ incubator/slider/site/content/docs/security.html Mon Jul 7 19:03:38 2014
@@ -0,0 +1,350 @@
+<!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_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_use_app_package"><a href="/docs/slider_specs/index.html">App Packaging</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.30-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-security">Apache Slider Security</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>
+<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>
+<p>Slider runs in secure clusters, but with restrictions</p>
+<ol>
+<li>The keytabs to allow a worker to authenticate with the master must
+ be distributed in advance: Slider does not attempt to pass these around.</li>
+<li>Until the location of Slider node instances can be strictly limited to
+ a set of nodes (a future YARN feature), the keytabs must be passed to
+ all the nodes in the cluster in advance, <em>and made available to the
+ user creating the cluster</em></li>
+<li>due to the way that HBase and accumulo authenticate worker nodes to
+ the masters, any HBase node running on a server must authenticate as
+ the same principal, and so have equal access rights to the HBase cluster.</li>
+<li>As the data directories for a slider cluster are created under the home
+ directories of that user, the principals representing all role instances
+ in the clusters <em>MUST</em> have read/write access to these files. This can be
+ done with a shortname that matches that of the user, or by requesting
+ that Slider create a directory with group write permissions -and using LDAP
+ 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>
+<ul>
+<li>Slider and deployed applications to work against secure HDFS</li>
+<li>Slider to work with secure YARN.</li>
+<li>Slider to start secure applications</li>
+<li>Kerberos and ActiveDirectory to perform the authentication.</li>
+<li>Slider to only allow cluster operations by authenticated users -command line and direct RPC. </li>
+<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>
+<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>
+<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>
+<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>
+<ul>
+<li>Kerberos is running and that HDFS and YARN are running Kerberized.</li>
+<li>LDAP cannot be assumed. </li>
+<li>Credentials needed for the application can be pushed out into the local filesystems of
+ the of the worker nodes via some external mechanism (e.g. scp), and protected by
+ the access permissions of the native filesystem. Any user with access to these
+ credentials is considered to have been granted such rights.</li>
+<li>These credentials can outlive the duration of the application instances</li>
+<li>The user running the application has the same identity as that of the application.</li>
+<li>All application instances run by a single user can share the same machine-specific
+kerberos identities.</li>
+</ul>
+<h2 id="design">Design</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>
+<li>The user is expected to have their own principals for every host in the cluster of the form
+ username/hostname@REALM</li>
+<li>A keytab must be generated which contains all these principals -and distributed
+ to all the nodes in the cluster with read access permissions to the user.</li>
+<li>When the user creates a secure cluster, they provide the standard HBase kerberos options
+ to identify the principals to use and the keytab location.</li>
+</ol>
+<p>The Slider Client will talk to HDFS and YARN authenticating itself with the TGT,
+talking to the YARN and HDFS principals which it has been configured to expect.</p>
+<p>This can be done as described in [Client Configuration] (/docs/client-configuration.html) on the command line as</p>
+<pre class="codehilite"><code> -D yarn.resourcemanager.principal=yarn/master@LOCAL
+ -D dfs.namenode.kerberos.principal=hdfs/master@LOCAL</code></pre>
+
+
+<p>The Slider Client will create the cluster data directory in HDFS with <code>rwx</code> permissions for<br />
+user <code>r-x</code> for the group and <code>---</code> for others. (these can be configurable as part of the cluster options), </p>
+<p>It will then deploy the AM, which will (somehow? for how long?) retain the access
+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>
+<h2 id="securing-communications-between-the-slider-client-and-the-slider-am">Securing communications between the Slider Client and the Slider AM.</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>
+<p>This is provided by the YARN Resource Manager when the client application
+wishes to talk with the SliderAM -a token which is only provided after
+the caller authenticates itself as the user that has access rights
+to the cluster</p>
+<p>To allow the client to freeze 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>
+<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>
+<pre class="codehilite"><code><property>
+ <name>hadoop.security.authorization</name>
+ <value>true</value>
+</property>
+
+<property>
+ <name>hadoop.security.authentication</name>
+ <value>kerberos</value>
+</property></code></pre>
+
+
+<p>Or it can be done on the command line</p>
+<pre class="codehilite"><code>-D hadoop.security.authorization=true -D hadoop.security.authentication=kerberos</code></pre>
+
+
+<h3 id="adding-kerberos-binding-properties-to-the-slider-client-jvm">Adding Kerberos binding properties to the Slider Client JVM</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>
+<p>If is not set up, a stack trace with kerberos classes at the top and
+the message <code>java.lang.IllegalArgumentException: Can't get Kerberos realm</code>
+will be printed -and the client will then fail.</p>
+<p>The realm and controller can be defined in the Java system properties
+<code>java.security.krb5.realm</code> and <code>java.security.krb5.kdc</code>. These can be fixed
+in the JVM options, as described in the [Client Configuration] (/docs/client-configuration.html)
+documentation.</p>
+<p>They can also be set on the Slider command line itself, using the <code>-S</code> parameter.</p>
+<pre class="codehilite"><code>-S java.security.krb5.realm=MINICLUSTER -S java.security.krb5.kdc=hadoop-kdc</code></pre>
+
+
+<h3 id="important-java-cryptography-package">Important: Java Cryptography Package</h3>
+<p>When trying to talk to a secure, cluster you may see the message:</p>
+<pre class="codehilite"><code>No valid credentials provided (Mechanism level: Illegal key size)]</code></pre>
+
+
+<p>This means that the JRE does not have the extended cryptography package
+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>
+<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>
+<li><a href="http://hbase.apache.org/book/security.html">Chapter 8. Secure Apache HBase</a></li>
+<li>Hadoop Operations p135+</li>
+<li><a href="http://docs.oracle.com/javase/7/docs/technotes/guides/security/jgss/tutorials/KerberosReq.htmla">Java Kerberos Requirements</a></li>
+<li><a href="http://docs.oracle.com/javase/7/docs/technotes/guides/security/jgss/tutorials/Troubleshooting.html">Troubleshooting Kerberos on Java</a></li>
+<li>For OS/X users, the GUI ticket viewer is <code>/System/Library/CoreServices/Ticket\ Viewer.app</code></li>
+</ol>
+ </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>
Propchange: incubator/slider/site/content/docs/security.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/slider/site/content/docs/slider_specs/application_configuration.html
URL: http://svn.apache.org/viewvc/incubator/slider/site/content/docs/slider_specs/application_configuration.html?rev=1608561&view=auto
==============================================================================
--- incubator/slider/site/content/docs/slider_specs/application_configuration.html (added)
+++ incubator/slider/site/content/docs/slider_specs/application_configuration.html Mon Jul 7 19:03:38 2014
@@ -0,0 +1,259 @@
+<!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_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_use_app_package"><a href="/docs/slider_specs/index.html">App Packaging</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.30-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-application-configuration">Apache Slider Application Configuration</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>
+<p><img alt="Image" src="../../resources/images/app_config_folders_01.png?raw=true" /></p>
+<p>A config file is of the form:</p>
+<pre class="codehilite"><code><?xml version="1.0"?>
+<?xml-stylesheet type="text/xsl" href="configuration.xsl"?>
+<configuration>
+ <property>
+ ...
+ </property>
+</configuration></code></pre>
+
+
+<p>Each configuration property is specified as follows:</p>
+<pre class="codehilite"><code><property>
+ <name>storm.zookeeper.session.timeout</name>
+ <value>20000</value>
+ <description>The session timeout for clients to ZooKeeper.</description>
+ <required>false</required>
+ <valueRestriction>0-30000</valueRestriction>
+ </property>
+ <property>
+ <name>storm.zookeeper.root</name>
+ <value>/storm</value>
+ <description>The root location at which Storm stores data in ZK.</description>
+ <required>true</required>
+ </property>
+ <property>
+ <name>jvm.heapsize</name>
+ <value>256</value>
+ <description>The default JVM heap size for any component instance.</description>
+ <required>true</required>
+ </property>
+ <property>
+ <name>nimbus.host</name>
+ <value>localhost</value>
+ <description>The host that the master server is running on.</description>
+ <required>true</required>
+ <clientVisible>true</clientVisible>
+ </property></code></pre>
+
+
+<ul>
+<li>
+<p>name: name of the parameter</p>
+</li>
+<li>
+<p>value: default value of the parameter</p>
+</li>
+<li>
+<p>description: a short description of the parameter</p>
+</li>
+<li>
+<p>required: if the parameter is mandatory in which case it must have a value - default is "false"</p>
+</li>
+<li>
+<p>clientVisible: if the property must be exported for a client</p>
+</li>
+</ul>
+ </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>
Propchange: incubator/slider/site/content/docs/slider_specs/application_configuration.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/slider/site/content/docs/slider_specs/application_definition.html
URL: http://svn.apache.org/viewvc/incubator/slider/site/content/docs/slider_specs/application_definition.html?rev=1608561&view=auto
==============================================================================
--- incubator/slider/site/content/docs/slider_specs/application_definition.html (added)
+++ incubator/slider/site/content/docs/slider_specs/application_definition.html Mon Jul 7 19:03:38 2014
@@ -0,0 +1,390 @@
+<!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_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_use_app_package"><a href="/docs/slider_specs/index.html">App Packaging</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.30-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-application-definition">Apache Slider Application Definition</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>
+<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>
+<li>
+<p><strong>name</strong>: the name of the application</p>
+</li>
+<li>
+<p><strong>version</strong>: the version of the application. name and version together uniquely identify an application.</p>
+</li>
+<li>
+<p><strong>type</strong>: the type of the application. "YARN-APP" identifies an application definition suitable for YARN.</p>
+</li>
+<li>
+<p><strong>minHadoopVersion</strong>: the minimum version of hadoop on which the app can run</p>
+</li>
+<li>
+<p><strong>components</strong>: the list of component that the application is comprised of</p>
+</li>
+<li>
+<p><strong>osSpecifics</strong>: OS specific package information for the application</p>
+</li>
+<li>
+<p><em>commandScript</em>: application wide commands may also be defined. The command is executed on a component instance that is a client</p>
+</li>
+<li>
+<p><em>dependencies</em>: application can define a list of dependencies. Dependencies can be on the base services such as HDFS, ZOOKEEPER, YARN which are infrastructure services or GANGLIA, NAGIOS, etc. which are monitoring/alert services. The dependencies are parsed by the management infrastructure to provide the necessary configurations to allow the app to access the services. For example, a HDFS folder could be requested by the app to store its data, a ZOOKEEPER node to co-ordinate among components.</p>
+</li>
+</ul>
+<p>An application contains several component. The fields associated with a component are:</p>
+<ul>
+<li>
+<p><strong>name</strong>: name of the component</p>
+</li>
+<li>
+<p><strong>category</strong>: type of the component - MASTER, SLAVE, and CLIENT</p>
+</li>
+<li>
+<p><strong>minInstanceCount</strong>: the minimum number of instances required for this component</p>
+</li>
+<li>
+<p><em>maxInstanceCount</em>: maximum number of instances allowed for a component</p>
+</li>
+<li>
+<p><strong>commandScript</strong>: the script that implements the commands.</p>
+</li>
+<li>
+<p><strong>script</strong>: the script location - relative to the AppPackage root</p>
+</li>
+<li>
+<p><strong>scriptType</strong>: type of the script</p>
+</li>
+<li>
+<p><strong>timeout</strong>: default timeout of the script</p>
+</li>
+<li>
+<p><em>customCommands</em>: any additional commands available for the component and their implementation</p>
+</li>
+</ul>
+<p>An application definition also includes the package used to install the application. Its typically a tarball or some other form of package that does not require root access to install. The details of what happens during install is captured in the command script.</p>
+<ul>
+<li>
+<p><strong>osSpecific</strong>: details on a per OS basis</p>
+</li>
+<li>
+<p><strong>osType</strong>: "any" refers to any OS ~ typical for tarballs</p>
+</li>
+<li>
+<p><strong>packages</strong>: list of packages that needs to be deployed</p>
+</li>
+<li>
+<p><strong>type</strong>: type of package</p>
+</li>
+<li>
+<p><strong>name</strong>: name of the package</p>
+</li>
+<li>
+<p><strong>location</strong>: location of the package (can be a relative folder within the parent AppPackage)</p>
+</li>
+</ul>
+<p>Application can define a an order of activation which dictates if some component activation must follow the successful activation of other components.</p>
+<ul>
+<li>
+<p><strong>command</strong>: specifies the component and the command in the form component-command <em>currently, START is the only valid command</em></p>
+</li>
+<li>
+<p><strong>requires</strong>: specifies component and their state that the command depends on, provided in the form component-state <em>currently, STARTED is the only valid state</em></p>
+</li>
+</ul>
+<p>Applications can also advertise a set of properties (typically urls) that can only be bound when the application components are active. One such item can be the jmx endpoint. The properties to be advertised are organized as export groups (exportGroup) and each group can export one or more properties organized as a property bag. These values are visible through the registry service.</p>
+<ul>
+<li><strong>name</strong>: specifies the name of the export group</li>
+</ul>
+<p>Each exportGroup contains one or more exports.</p>
+<ul>
+<li>
+<p><strong>name</strong>: the name of the export</p>
+</li>
+<li>
+<p><strong>value</strong>: the template that will be populated by Slider and then exported</p>
+<p><metainfo>
+ <schemaVersion>2.0</schemaVersion>
+ <application>
+ <name>HBASE</name>
+ <version>0.96.0.2.1.1</version>
+ <type>YARN-APP</type>
+ <minHadoopVersion>2.1.0</minHadoopVersion>
+ <components>
+ <component>
+ <name>HBASE_MASTER</name>
+ <category>MASTER</category>
+ <minInstanceCount>1</minInstanceCount>
+ <maxInstanceCount>2</maxInstanceCount>
+ <commandScript>
+ <script>scripts/hbase_master.py</script>
+ <scriptType>PYTHON</scriptType>
+ <timeout>600</timeout>
+ </commandScript>
+ <customCommands>
+ <customCommand>
+ <name>GRACEFUL_STOP</name>
+ <commandScript>
+ <script>scripts/hbase_master.py</script>
+ <scriptType>PYTHON</scriptType>
+ <timeout>1800</timeout>
+ </commandScript>
+ </customCommand>
+ </customCommands>
+ </component></p>
+<pre class="codehilite"><code> <component>
+ <name>HBASE_REGIONSERVER</name>
+ <category>SLAVE</category>
+ <minInstanceCount>1</minInstanceCount>
+ ...
+ </component>
+
+ <component>
+ <name>HBASE_CLIENT</name>
+ <category>CLIENT</category>
+ ...
+ </components>
+
+ <osSpecifics>
+ <osSpecific>
+ <osType>any</osType>
+ <packages>
+ <package>
+ <type>tarball</type>
+ <name>hbase-0.96.1-tar.gz</name>
+ <location>package/files</location>
+ </package>
+ </packages>
+ </osSpecific>
+ </osSpecifics>
+
+ <commandOrders>
+ <commandOrder>
+ <command>HBASE_REGIONSERVER-START</command>
+ <requires>HBASE_MASTER-STARTED</requires>
+ </commandOrder>
+ </commandOrders>
+
+ <exportGroups>
+ <exportGroup>
+ <name>QuickLinks</name>
+ <exports>
+ <export>
+ <name>JMX_Endpoint</name>
+ <value>http://${HBASE_MASTER_HOST}:${site.hbase-site.hbase.master.info.port}/jmx</value>
+ </export>
+ <export>
+ <name>Master_Status</name>
+ <value>http://${HBASE_MASTER_HOST}:${site.hbase-site.hbase.master.info.port}/master-status</value>
+ </export>
+ </exports>
+ </exportGroup>
+ </exportGroups>
+
+ <commandScript>
+ <script>scripts/app_health_check.py</script>
+ <scriptType>PYTHON</scriptType>
+ <timeout>300</timeout>
+ </commandScript>
+
+</application></code></pre>
+
+
+<p></metainfo></p>
+</li>
+</ul>
+ </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>
Propchange: incubator/slider/site/content/docs/slider_specs/application_definition.html
------------------------------------------------------------------------------
svn:eol-style = native