You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@slider.apache.org by st...@apache.org on 2014/10/15 18:49:57 UTC

svn commit: r1632119 - in /incubator/slider/site/trunk/content: developing/testing.md docs/client-configuration.md docs/exitcodes.md docs/manpage.md

Author: stevel
Date: Wed Oct 15 16:49:56 2014
New Revision: 1632119

URL: http://svn.apache.org/r1632119
Log:
updated documentation

Modified:
    incubator/slider/site/trunk/content/developing/testing.md
    incubator/slider/site/trunk/content/docs/client-configuration.md
    incubator/slider/site/trunk/content/docs/exitcodes.md
    incubator/slider/site/trunk/content/docs/manpage.md

Modified: incubator/slider/site/trunk/content/developing/testing.md
URL: http://svn.apache.org/viewvc/incubator/slider/site/trunk/content/developing/testing.md?rev=1632119&r1=1632118&r2=1632119&view=diff
==============================================================================
--- incubator/slider/site/trunk/content/developing/testing.md (original)
+++ incubator/slider/site/trunk/content/developing/testing.md Wed Oct 15 16:49:56 2014
@@ -100,7 +100,7 @@ Example:
     
       <property>
         <name>hadoop.home</name>
-        <value>/home/slider/hadoop-2.2.0</value>
+        <value>/home/slider/hadoop-2.6.0</value>
         <description>Hadoop home dir on target systems</description>
       </property>
       
@@ -113,6 +113,22 @@ For the functional tests, the accumulo a
 need to be set to a URL of a tar file that is accessible to all the
 nodes in the cluster -which usually means HDFS, and so an `hdfs://` URL
 
+## Security 
+
+    <property>
+      <name>slider.am.login.keytab.name</name>
+      <value></value>
+    </property>
+    <property>
+      <name>slider.am.keytab.local.path</name>
+      <description>absolute path to keytab</description>
+      <value></value>
+    </property>
+    <property>
+      <name>slider.keytab.principal.name</name>
+      <value></value>
+    </property>
+
 
 ##  Provider-specific parameters
 
@@ -127,6 +143,7 @@ away
 ### Agent Tests
 
 
+
 ### HBase Tests
 
 The HBase tests can be enabled or disabled
@@ -178,4 +195,6 @@ Optional parameters
       <name>slider.test.accumulo.launch.wait.seconds</name>
       <description>Time to wait in seconds for Accumulo to start</description>
       <value>180000</value>
-     </property
\ No newline at end of file
+     </property
+     
+ 
\ No newline at end of file

Modified: incubator/slider/site/trunk/content/docs/client-configuration.md
URL: http://svn.apache.org/viewvc/incubator/slider/site/trunk/content/docs/client-configuration.md?rev=1632119&r1=1632118&r2=1632119&view=diff
==============================================================================
--- incubator/slider/site/trunk/content/docs/client-configuration.md (original)
+++ incubator/slider/site/trunk/content/docs/client-configuration.md Wed Oct 15 16:49:56 2014
@@ -212,21 +212,6 @@ a limited number of slider-specific conf
       <value>750</value>
     </property>
 
-### `slider.zookeeper.quorum` - the zookeeper quorum.
-
-This defines the zookeeper quorum for this YARN cluster. 
-
-It is used to locate the service registry, enable running instances to publish
-information about their application, and for clients to query this. 
-
-It is also used as the default zookeeper binding for any application that
-uses zookeeper in its configuration -the value set when the application is
-defined will be copied into the instance definition file.
-
-### `"slider.registry.path"` - the zookeeper path for the service registry
-
-This declares the the zookeeper path for the service registry. 
-
 ### `slider.yarn.restart.limit` - set limit on Application Master Restarts
 
 This limits how many times YARN should start a failed application master.
@@ -286,6 +271,29 @@ that contains the application data `${us
     </property>
 
 
+## YARN Registry binding
+
+
+Slider uses the (evolving) YARN service registry to register application
+instances, to locate them, and as a means to publish the configuration information
+needed to connect to the slider-deployed applications.
+
+### `slider.zookeeper.quorum` - the zookeeper quorum.
+
+This defines the zookeeper quorum for this YARN cluster. 
+
+It is used to locate the service registry, enable running instances to publish
+information about their application, and for clients to query this. 
+
+It is also used as the default zookeeper binding for any application that
+uses zookeeper in its configuration -the value set when the application is
+defined will be copied into the instance definition file.
+
+### `"slider.registry.path"` - the zookeeper path for the service registry
+
+This declares the the zookeeper path for the service registry. 
+
+
 ## Debugging configuration issues
 
 If the slider packages are set to log at debug level in the log4j configuration

Modified: incubator/slider/site/trunk/content/docs/exitcodes.md
URL: http://svn.apache.org/viewvc/incubator/slider/site/trunk/content/docs/exitcodes.md?rev=1632119&r1=1632118&r2=1632119&view=diff
==============================================================================
--- incubator/slider/site/trunk/content/docs/exitcodes.md (original)
+++ incubator/slider/site/trunk/content/docs/exitcodes.md Wed Oct 15 16:49:56 2014
@@ -129,7 +129,7 @@ no. 72.
     int EXIT_PROCESS_FAILED = 72;
   
     /**
-     * The cluster failed -too many containers were
+     * The instance could not be deployed; too many containers were
      * failing or some other threshold was reached
      */
     int EXIT_DEPLOYMENT_FAILED = 73;

Modified: incubator/slider/site/trunk/content/docs/manpage.md
URL: http://svn.apache.org/viewvc/incubator/slider/site/trunk/content/docs/manpage.md?rev=1632119&r1=1632118&r2=1632119&view=diff
==============================================================================
--- incubator/slider/site/trunk/content/docs/manpage.md (original)
+++ incubator/slider/site/trunk/content/docs/manpage.md Wed Oct 15 16:49:56 2014
@@ -392,6 +392,9 @@ The `--name <name>` option names the reg
 this is the application instance
 
 
+The `--user <user>` option names the user who owns/deployed the service.
+it defaults to the current user.
+
 The `--servicetype <servicetype>` option allows a different service type to be chosen.
 The default is `org-apache-slider`
 
@@ -417,13 +420,12 @@ List all services of the service type an
  
  
  
-#### `slider registry --listconf [--name <name>]  [--internal] [--servicetype <servicetype>]`
+#### `slider registry --listconf [--name <name>]  [--internal] [--servicetype <servicetype>] [--user <user>]`
 
 List the configurations exported by of a named application
 
 
-
-#### `slider registry --getconf <configuration> [--format (xml|json|properties)] [--servicetype <servicetype>] [--name <name>] [--dest <path>] [--internal] ` get the configuration
+#### `slider registry --getconf <configuration> [--format (xml|json|properties)] [--servicetype <servicetype>] [--name <name>] [--dest <path>] [--internal] [--user <user>]` get the configuration
  
 Get a named configuration in a chosen format. Default: XML
 
@@ -455,7 +457,7 @@ The result can be printed to the console
 the means of specifiying the destination varies depending on whether a single
 record or a listing is requested.
 
-### Resolve a single entry: `slider resolve --path <path>`
+### Resolve a single entry: `slider resolve --path <path> [--out <file> [--destdir <dir>]`
 
 The basic `slider resolve --path <path>` command, without the `--list` option
 will attempt to resolve the service record at the destination. The record
@@ -503,6 +505,11 @@ This will create a directory `services` 
 If a service `"hbase-1"` was registered a under this path, its service record
 would be saved to the file `services/hbase-1.json`.
 
+The current users base path can be referred to via the "~" prefix:
+
+    slider resolve --path ~/services/ --list 
+
+This simplifies path creation, testing a, 
 
 
 ### `start <name> [--wait time`]