You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@knox.apache.org by lm...@apache.org on 2015/04/29 17:34:13 UTC
svn commit: r1676770 - in /knox: site/ site/books/knox-0-4-0/
site/books/knox-0-5-0/ site/books/knox-0-6-0/ trunk/books/0.6.0/
Author: lmccay
Date: Wed Apr 29 15:34:13 2015
New Revision: 1676770
URL: http://svn.apache.org/r1676770
Log:
knoxcli documentation to handle special characters in passwords when passed with --value from Kristopher Kane via lmccay
Modified:
knox/site/books/knox-0-4-0/deployment-overview.png
knox/site/books/knox-0-4-0/deployment-provider.png
knox/site/books/knox-0-4-0/deployment-service.png
knox/site/books/knox-0-4-0/runtime-overview.png
knox/site/books/knox-0-4-0/runtime-request-processing.png
knox/site/books/knox-0-5-0/deployment-overview.png
knox/site/books/knox-0-5-0/deployment-provider.png
knox/site/books/knox-0-5-0/deployment-service.png
knox/site/books/knox-0-5-0/runtime-overview.png
knox/site/books/knox-0-5-0/runtime-request-processing.png
knox/site/books/knox-0-6-0/deployment-overview.png
knox/site/books/knox-0-6-0/deployment-provider.png
knox/site/books/knox-0-6-0/deployment-service.png
knox/site/books/knox-0-6-0/runtime-overview.png
knox/site/books/knox-0-6-0/runtime-request-processing.png
knox/site/books/knox-0-6-0/user-guide.html
knox/site/index.html
knox/site/issue-tracking.html
knox/site/license.html
knox/site/mail-lists.html
knox/site/project-info.html
knox/site/team-list.html
knox/trunk/books/0.6.0/knox_cli.md
Modified: knox/site/books/knox-0-4-0/deployment-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-4-0/deployment-overview.png?rev=1676770&r1=1676769&r2=1676770&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-4-0/deployment-provider.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-4-0/deployment-provider.png?rev=1676770&r1=1676769&r2=1676770&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-4-0/deployment-service.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-4-0/deployment-service.png?rev=1676770&r1=1676769&r2=1676770&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-4-0/runtime-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-4-0/runtime-overview.png?rev=1676770&r1=1676769&r2=1676770&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-4-0/runtime-request-processing.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-4-0/runtime-request-processing.png?rev=1676770&r1=1676769&r2=1676770&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-5-0/deployment-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-5-0/deployment-overview.png?rev=1676770&r1=1676769&r2=1676770&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-5-0/deployment-provider.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-5-0/deployment-provider.png?rev=1676770&r1=1676769&r2=1676770&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-5-0/deployment-service.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-5-0/deployment-service.png?rev=1676770&r1=1676769&r2=1676770&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-5-0/runtime-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-5-0/runtime-overview.png?rev=1676770&r1=1676769&r2=1676770&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-5-0/runtime-request-processing.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-5-0/runtime-request-processing.png?rev=1676770&r1=1676769&r2=1676770&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-6-0/deployment-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-6-0/deployment-overview.png?rev=1676770&r1=1676769&r2=1676770&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-6-0/deployment-provider.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-6-0/deployment-provider.png?rev=1676770&r1=1676769&r2=1676770&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-6-0/deployment-service.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-6-0/deployment-service.png?rev=1676770&r1=1676769&r2=1676770&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-6-0/runtime-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-6-0/runtime-overview.png?rev=1676770&r1=1676769&r2=1676770&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-6-0/runtime-request-processing.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-6-0/runtime-request-processing.png?rev=1676770&r1=1676769&r2=1676770&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-6-0/user-guide.html
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-6-0/user-guide.html?rev=1676770&r1=1676769&r2=1676770&view=diff
==============================================================================
--- knox/site/books/knox-0-6-0/user-guide.html (original)
+++ knox/site/books/knox-0-6-0/user-guide.html Wed Apr 29 15:34:13 2015
@@ -510,7 +510,7 @@ ip-10-39-107-209.ec2.internal
<li>All security related artifacts are protected with the master secret</li>
<li>Secrets used by the gateway itself are stored within the gateway credential store and are the same across all gateway instances in the cluster of gateways</li>
<li>Secrets used by providers within cluster topologies are stored in topology specific credential stores and are the same for the same topology across the cluster of gateway instances. However, they are specific to the topology - so secrets for one hadoop cluster are different from those of another. This allows for fail-over from one gateway instance to another even when encryption is being used while not allowing the compromise of one encryption key to expose the data for all clusters.</li>
-</ol><p>NOTE: the SSL certificate will need special consideration depending on the type of certificate. Wildcard certs may be able to be shared across all gateway instances in a cluster. When certs are dedicated to specific machines the gateway identity store will not be able to be blindly replicated as host name verification problems will ensue. Obviously, trust-stores will need to be taken into account as well.</p><h3><a id="Knox+CLI"></a>Knox CLI</h3><p>The Knox CLI is a command line utility for management of various aspects of the Knox deployment. It is primarily concerned with the management of the security artifacts for the gateway instance and each of the deployed topologies or hadoop clusters that are gated by the Knox Gateway instance.</p><p>The various security artifacts are also generated and populated automatically by the Knox Gateway runtime when they are not found at startup. The assumptions made in those cases are appropriate for a test or development gateway instance
and assume ‘localhost’ for hostname specific activities. For production deployments the use of the CLI may aid in managing some production deployments.</p><p>The knoxcli.sh script is located in the {GATEWAY_HOME}/bin directory.</p><h4><a id="Help"></a>Help</h4><h5><a id="knoxcli.sh+[--help]"></a>knoxcli.sh [–help]</h5><p>prints help for all commands</p><h4><a id="Knox+Verison+Info"></a>Knox Verison Info</h4><h5><a id="knoxcli.sh+version+[--help]"></a>knoxcli.sh version [–help]</h5><p>Displays Knox version information.</p><h4><a id="Master+secret+persistence"></a>Master secret persistence</h4><h5><a id="knoxcli.sh+create-master+[--force][--help]"></a>knoxcli.sh create-master [–force][–help]</h5><p>Creates and persists an encrypted master secret in a file within {GATEWAY_HOME}/data/security/master. </p><p>NOTE: This command fails when there is an existing master file in the expected location. You may force it to overwrite the master file with the &
ndash;force switch. NOTE: this will require you to change passwords protecting the keystores for the gateway identity keystores and all credential stores.</p><h4><a id="Alias+creation"></a>Alias creation</h4><h5><a id="knoxcli.sh+create-alias+n+[--cluster+c]+[--value+v]+[--generate]+[--help]"></a>knoxcli.sh create-alias n [–cluster c] [–value v] [–generate] [–help]</h5><p>Creates a password alias and stores it in a credential store within the {GATEWAY_HOME}/data/security/keystores dir. </p>
+</ol><p>NOTE: the SSL certificate will need special consideration depending on the type of certificate. Wildcard certs may be able to be shared across all gateway instances in a cluster. When certs are dedicated to specific machines the gateway identity store will not be able to be blindly replicated as host name verification problems will ensue. Obviously, trust-stores will need to be taken into account as well.</p><h3><a id="Knox+CLI"></a>Knox CLI</h3><p>The Knox CLI is a command line utility for management of various aspects of the Knox deployment. It is primarily concerned with the management of the security artifacts for the gateway instance and each of the deployed topologies or hadoop clusters that are gated by the Knox Gateway instance.</p><p>The various security artifacts are also generated and populated automatically by the Knox Gateway runtime when they are not found at startup. The assumptions made in those cases are appropriate for a test or development gateway instance
and assume ‘localhost’ for hostname specific activities. For production deployments the use of the CLI may aid in managing some production deployments.</p><p>The knoxcli.sh script is located in the {GATEWAY_HOME}/bin directory.</p><h4><a id="Help"></a>Help</h4><h5><a id="`bin/knoxcli.sh+[--help]`"></a><code>bin/knoxcli.sh [--help]</code></h5><p>prints help for all commands</p><h4><a id="Knox+Verison+Info"></a>Knox Verison Info</h4><h5><a id="`bin/knoxcli.sh+version+[--help]`"></a><code>bin/knoxcli.sh version [--help]</code></h5><p>Displays Knox version information.</p><h4><a id="Master+secret+persistence"></a>Master secret persistence</h4><h5><a id="`bin/knoxcli.sh+create-master+[--force][--help]`"></a><code>bin/knoxcli.sh create-master [--force][--help]</code></h5><p>Creates and persists an encrypted master secret in a file within {GATEWAY_HOME}/data/security/master. </p><p>NOTE: This command fails when there is an existing master file in the expected location. You may
force it to overwrite the master file with the --force switch. NOTE: this will require you to change passwords protecting the keystores for the gateway identity keystores and all credential stores.</p><h4><a id="Alias+creation"></a>Alias creation</h4><h5><a id="`bin/knoxcli.sh+create-alias+name+[--cluster+c]+[--value+v]+[--generate]+[--help]`"></a><code>bin/knoxcli.sh create-alias name [--cluster c] [--value v] [--generate] [--help]</code></h5><p>Creates a password alias and stores it in a credential store within the {GATEWAY_HOME}/data/security/keystores dir. </p>
<table>
<thead>
<tr>
@@ -520,23 +520,23 @@ ip-10-39-107-209.ec2.internal
</thead>
<tbody>
<tr>
- <td>–name</td>
+ <td>name</td>
<td>name of the alias to create</td>
</tr>
<tr>
- <td>–cluster</td>
+ <td>--cluster</td>
<td>name of Hadoop cluster for the cluster specific credential store otherwise assumes that it is for the gateway itself</td>
</tr>
<tr>
- <td>–value</td>
- <td>parameter for specifying the actual password otherwise prompted<br/></td>
+ <td>--value</td>
+ <td>parameter for specifying the actual password otherwise prompted. Escape complex passwords or surround with single quotes.<br/></td>
</tr>
<tr>
- <td>–generate</td>
- <td>boolean flag to indicate whether the tool should just generate the value. This assumes that –value is not set - will result in error otherwise. User will not be prompted for the value when –generate is set.</td>
+ <td>--generate</td>
+ <td>boolean flag to indicate whether the tool should just generate the value. This assumes that --value is not set - will result in error otherwise. User will not be prompted for the value when --generate is set.</td>
</tr>
</tbody>
-</table><h4><a id="Alias+deletion"></a>Alias deletion</h4><h5><a id="knoxcli.sh+delete-alias+n+[--cluster+c]+[--help]"></a>knoxcli.sh delete-alias n [–cluster c] [–help]</h5><p>Deletes a password and alias mapping from a credential store within {GATEWAY_HOME}/data/security/keystores. </p>
+</table><h4><a id="Alias+deletion"></a>Alias deletion</h4><h5><a id="`bin/knoxcli.sh+delete-alias+name+[--cluster+c]+[--help]`"></a><code>bin/knoxcli.sh delete-alias name [--cluster c] [--help]</code></h5><p>Deletes a password and alias mapping from a credential store within {GATEWAY_HOME}/data/security/keystores. </p>
<table>
<thead>
<tr>
@@ -546,15 +546,15 @@ ip-10-39-107-209.ec2.internal
</thead>
<tbody>
<tr>
- <td>–name </td>
+ <td>name </td>
<td>name of the alias to delete</td>
</tr>
<tr>
- <td>–cluster </td>
- <td>name of Hadoop cluster for the cluster specific credential store otherwise assumes __gateway</td>
+ <td>--cluster </td>
+ <td>name of Hadoop cluster for the cluster specific credential store otherwise assumes ’__gateway’</td>
</tr>
</tbody>
-</table><h4><a id="Alias+listing"></a>Alias listing</h4><h5><a id="knoxcli.sh+list-alias+[--cluster+c]+[--help]"></a>knoxcli.sh list-alias [–cluster c] [–help]</h5><p>Lists the alias names for the credential store within {GATEWAY_HOME}/data/security/keystores. </p><p>NOTE: This command will list the aliases in lowercase which is a result of the underlying credential store implementation. Lookup of credentials is a case insensitive operation - so this is not an issue.</p>
+</table><h4><a id="Alias+listing"></a>Alias listing</h4><h5><a id="`bin/knoxcli.sh+list-alias+[--cluster+c]+[--help]`"></a><code>bin/knoxcli.sh list-alias [--cluster c] [--help]</code></h5><p>Lists the alias names for the credential store within {GATEWAY_HOME}/data/security/keystores. </p><p>NOTE: This command will list the aliases in lowercase which is a result of the underlying credential store implementation. Lookup of credentials is a case insensitive operation - so this is not an issue.</p>
<table>
<thead>
<tr>
@@ -564,25 +564,25 @@ ip-10-39-107-209.ec2.internal
</thead>
<tbody>
<tr>
- <td>–cluster </td>
- <td>name of Hadoop cluster for the cluster specific credential store otherwise assumes __gateway</td>
+ <td>--cluster </td>
+ <td>name of Hadoop cluster for the cluster specific credential store otherwise assumes ’__gateway’</td>
</tr>
</tbody>
-</table><h4><a id="Self-signed+cert+creation"></a>Self-signed cert creation</h4><h5><a id="knoxcli.sh+create-cert+[--hostname+n]+[--help]"></a>knoxcli.sh create-cert [–hostname n] [–help]</h5><p>Creates and stores a self-signed certificate to represent the identity of the gateway instance. This is stored within the {GATEWAY_HOME}/data/security/keystores/gateway.jks keystore. </p>
+</table><h4><a id="Self-signed+cert+creation"></a>Self-signed cert creation</h4><h5><a id="`bin/knoxcli.sh+create-cert+[--hostname+n]+[--help]`"></a><code>bin/knoxcli.sh create-cert [--hostname n] [--help]</code></h5><p>Creates and stores a self-signed certificate to represent the identity of the gateway instance. This is stored within the {GATEWAY_HOME}/data/security/keystores/gateway.jks keystore. </p>
<table>
<thead>
<tr>
- <th align="left">argument </th>
+ <th>argument </th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
- <td align="left">–hostname </td>
- <td>name of the host to be used in the self-signed certificate. This allows multi-host deployments to specify the proper hostnames for hostname verification to succeed on the client side of the SSL connection. The default is âlocalhostâ.</td>
+ <td>--hostname</td>
+ <td>name of the host to be used in the self-signed certificate. This allows multi-host deployments to specify the proper hostnames for hostname verification to succeed on the client side of the SSL connection. The default is ‘localhost’.</td>
</tr>
</tbody>
-</table><h4><a id="Topology+Redeploy"></a>Topology Redeploy</h4><h5><a id="knoxcli.sh+redeploy+[--cluster+c]"></a>knoxcli.sh redeploy [–cluster c]</h5><p>Redeploys one or all of the gateway’s clusters (a.k.a topologies).</p><h3><a id="Admin+API"></a>Admin API</h3><p>Access to the administrator functions of Knox are provided by the Admin REST API.</p><h4><a id="Admin+API+URL"></a>Admin API URL</h4><p>The URL mapping for the Knox Admin API is simple:</p>
+</table><h4><a id="Topology+Redeploy"></a>Topology Redeploy</h4><h5><a id="`bin/knoxcli.sh+redeploy+[--cluster+c]`"></a><code>bin/knoxcli.sh redeploy [--cluster c]</code></h5><p>Redeploys one or all of the gateway’s clusters (a.k.a topologies).</p><h3><a id="Admin+API"></a>Admin API</h3><p>Access to the administrator functions of Knox are provided by the Admin REST API.</p><h4><a id="Admin+API+URL"></a>Admin API URL</h4><p>The URL mapping for the Knox Admin API is simple:</p>
<table>
<tbody>
<tr>
Modified: knox/site/index.html
URL: http://svn.apache.org/viewvc/knox/site/index.html?rev=1676770&r1=1676769&r2=1676770&view=diff
==============================================================================
--- knox/site/index.html (original)
+++ knox/site/index.html Wed Apr 29 15:34:13 2015
@@ -1,5 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!-- Generated by Apache Maven Doxia Site Renderer 1.6 at 2015-04-28 -->
+<!-- Generated by Apache Maven Doxia Site Renderer 1.6 at 2015-04-29 -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
@@ -10,7 +10,7 @@
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
- <meta name="Date-Revision-yyyymmdd" content="20150428" />
+ <meta name="Date-Revision-yyyymmdd" content="20150429" />
<meta http-equiv="Content-Language" content="en" />
<script type="text/javascript">var _gaq = _gaq || [];
@@ -57,7 +57,7 @@
<a href="https://cwiki.apache.org/confluence/display/KNOX/Index" class="externalLink" title="Wiki">Wiki</a>
- | <span id="publishDate">Last Published: 2015-04-28</span>
+ | <span id="publishDate">Last Published: 2015-04-29</span>
| <span id="projectVersion">Version: 0.0.0-SNAPSHOT</span>
</div>
<div class="clear">
Modified: knox/site/issue-tracking.html
URL: http://svn.apache.org/viewvc/knox/site/issue-tracking.html?rev=1676770&r1=1676769&r2=1676770&view=diff
==============================================================================
--- knox/site/issue-tracking.html (original)
+++ knox/site/issue-tracking.html Wed Apr 29 15:34:13 2015
@@ -1,5 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!-- Generated by Apache Maven Doxia Site Renderer 1.6 at 2015-04-28 -->
+<!-- Generated by Apache Maven Doxia Site Renderer 1.6 at 2015-04-29 -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
@@ -10,7 +10,7 @@
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
- <meta name="Date-Revision-yyyymmdd" content="20150428" />
+ <meta name="Date-Revision-yyyymmdd" content="20150429" />
<meta http-equiv="Content-Language" content="en" />
<script type="text/javascript">var _gaq = _gaq || [];
@@ -57,7 +57,7 @@
<a href="https://cwiki.apache.org/confluence/display/KNOX/Index" class="externalLink" title="Wiki">Wiki</a>
- | <span id="publishDate">Last Published: 2015-04-28</span>
+ | <span id="publishDate">Last Published: 2015-04-29</span>
| <span id="projectVersion">Version: 0.0.0-SNAPSHOT</span>
</div>
<div class="clear">
Modified: knox/site/license.html
URL: http://svn.apache.org/viewvc/knox/site/license.html?rev=1676770&r1=1676769&r2=1676770&view=diff
==============================================================================
--- knox/site/license.html (original)
+++ knox/site/license.html Wed Apr 29 15:34:13 2015
@@ -1,5 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!-- Generated by Apache Maven Doxia Site Renderer 1.6 at 2015-04-28 -->
+<!-- Generated by Apache Maven Doxia Site Renderer 1.6 at 2015-04-29 -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
@@ -10,7 +10,7 @@
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
- <meta name="Date-Revision-yyyymmdd" content="20150428" />
+ <meta name="Date-Revision-yyyymmdd" content="20150429" />
<meta http-equiv="Content-Language" content="en" />
<script type="text/javascript">var _gaq = _gaq || [];
@@ -57,7 +57,7 @@
<a href="https://cwiki.apache.org/confluence/display/KNOX/Index" class="externalLink" title="Wiki">Wiki</a>
- | <span id="publishDate">Last Published: 2015-04-28</span>
+ | <span id="publishDate">Last Published: 2015-04-29</span>
| <span id="projectVersion">Version: 0.0.0-SNAPSHOT</span>
</div>
<div class="clear">
Modified: knox/site/mail-lists.html
URL: http://svn.apache.org/viewvc/knox/site/mail-lists.html?rev=1676770&r1=1676769&r2=1676770&view=diff
==============================================================================
--- knox/site/mail-lists.html (original)
+++ knox/site/mail-lists.html Wed Apr 29 15:34:13 2015
@@ -1,5 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!-- Generated by Apache Maven Doxia Site Renderer 1.6 at 2015-04-28 -->
+<!-- Generated by Apache Maven Doxia Site Renderer 1.6 at 2015-04-29 -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
@@ -10,7 +10,7 @@
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
- <meta name="Date-Revision-yyyymmdd" content="20150428" />
+ <meta name="Date-Revision-yyyymmdd" content="20150429" />
<meta http-equiv="Content-Language" content="en" />
<script type="text/javascript">var _gaq = _gaq || [];
@@ -57,7 +57,7 @@
<a href="https://cwiki.apache.org/confluence/display/KNOX/Index" class="externalLink" title="Wiki">Wiki</a>
- | <span id="publishDate">Last Published: 2015-04-28</span>
+ | <span id="publishDate">Last Published: 2015-04-29</span>
| <span id="projectVersion">Version: 0.0.0-SNAPSHOT</span>
</div>
<div class="clear">
Modified: knox/site/project-info.html
URL: http://svn.apache.org/viewvc/knox/site/project-info.html?rev=1676770&r1=1676769&r2=1676770&view=diff
==============================================================================
--- knox/site/project-info.html (original)
+++ knox/site/project-info.html Wed Apr 29 15:34:13 2015
@@ -1,5 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!-- Generated by Apache Maven Doxia Site Renderer 1.6 at 2015-04-28 -->
+<!-- Generated by Apache Maven Doxia Site Renderer 1.6 at 2015-04-29 -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
@@ -10,7 +10,7 @@
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
- <meta name="Date-Revision-yyyymmdd" content="20150428" />
+ <meta name="Date-Revision-yyyymmdd" content="20150429" />
<meta http-equiv="Content-Language" content="en" />
<script type="text/javascript">var _gaq = _gaq || [];
@@ -57,7 +57,7 @@
<a href="https://cwiki.apache.org/confluence/display/KNOX/Index" class="externalLink" title="Wiki">Wiki</a>
- | <span id="publishDate">Last Published: 2015-04-28</span>
+ | <span id="publishDate">Last Published: 2015-04-29</span>
| <span id="projectVersion">Version: 0.0.0-SNAPSHOT</span>
</div>
<div class="clear">
Modified: knox/site/team-list.html
URL: http://svn.apache.org/viewvc/knox/site/team-list.html?rev=1676770&r1=1676769&r2=1676770&view=diff
==============================================================================
--- knox/site/team-list.html (original)
+++ knox/site/team-list.html Wed Apr 29 15:34:13 2015
@@ -1,5 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!-- Generated by Apache Maven Doxia Site Renderer 1.6 at 2015-04-28 -->
+<!-- Generated by Apache Maven Doxia Site Renderer 1.6 at 2015-04-29 -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
@@ -10,7 +10,7 @@
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
- <meta name="Date-Revision-yyyymmdd" content="20150428" />
+ <meta name="Date-Revision-yyyymmdd" content="20150429" />
<meta http-equiv="Content-Language" content="en" />
<script type="text/javascript">var _gaq = _gaq || [];
@@ -57,7 +57,7 @@
<a href="https://cwiki.apache.org/confluence/display/KNOX/Index" class="externalLink" title="Wiki">Wiki</a>
- | <span id="publishDate">Last Published: 2015-04-28</span>
+ | <span id="publishDate">Last Published: 2015-04-29</span>
| <span id="projectVersion">Version: 0.0.0-SNAPSHOT</span>
</div>
<div class="clear">
Modified: knox/trunk/books/0.6.0/knox_cli.md
URL: http://svn.apache.org/viewvc/knox/trunk/books/0.6.0/knox_cli.md?rev=1676770&r1=1676769&r2=1676770&view=diff
==============================================================================
--- knox/trunk/books/0.6.0/knox_cli.md (original)
+++ knox/trunk/books/0.6.0/knox_cli.md Wed Apr 29 15:34:13 2015
@@ -23,58 +23,58 @@ The various security artifacts are also
The knoxcli.sh script is located in the {GATEWAY_HOME}/bin directory.
#### Help ####
-##### knoxcli.sh [--help] #####
+##### `bin/knoxcli.sh [--help]` #####
prints help for all commands
#### Knox Verison Info ####
-##### knoxcli.sh version [--help] #####
+##### `bin/knoxcli.sh version [--help]` #####
Displays Knox version information.
#### Master secret persistence ####
-##### knoxcli.sh create-master [--force][--help] #####
+##### `bin/knoxcli.sh create-master [--force][--help]` #####
Creates and persists an encrypted master secret in a file within {GATEWAY_HOME}/data/security/master.
-NOTE: This command fails when there is an existing master file in the expected location. You may force it to overwrite the master file with the --force switch. NOTE: this will require you to change passwords protecting the keystores for the gateway identity keystores and all credential stores.
+NOTE: This command fails when there is an existing master file in the expected location. You may force it to overwrite the master file with the \-\-force switch. NOTE: this will require you to change passwords protecting the keystores for the gateway identity keystores and all credential stores.
#### Alias creation ####
-##### knoxcli.sh create-alias n [--cluster c] [--value v] [--generate] [--help] #####
-Creates a password alias and stores it in a credential store within the {GATEWAY_HOME}/data/security/keystores dir.
+##### `bin/knoxcli.sh create-alias name [--cluster c] [--value v] [--generate] [--help]` #####
+Creates a password alias and stores it in a credential store within the {GATEWAY_HOME}/data/security/keystores dir.
-argument | description
----------|-----------
---name|name of the alias to create
---cluster|name of Hadoop cluster for the cluster specific credential store otherwise assumes that it is for the gateway itself
---value|parameter for specifying the actual password otherwise prompted<br/>
---generate|boolean flag to indicate whether the tool should just generate the value. This assumes that --value is not set - will result in error otherwise. User will not be prompted for the value when --generate is set.
+argument | description
+------------|-----------
+name|name of the alias to create
+\-\-cluster|name of Hadoop cluster for the cluster specific credential store otherwise assumes that it is for the gateway itself
+\-\-value|parameter for specifying the actual password otherwise prompted. Escape complex passwords or surround with single quotes.<br/>
+\-\-generate|boolean flag to indicate whether the tool should just generate the value. This assumes that \-\-value is not set - will result in error otherwise. User will not be prompted for the value when \-\-generate is set.
#### Alias deletion ####
-##### knoxcli.sh delete-alias n [--cluster c] [--help] #####
+##### `bin/knoxcli.sh delete-alias name [--cluster c] [--help]` #####
Deletes a password and alias mapping from a credential store within {GATEWAY_HOME}/data/security/keystores.
argument | description
---------|-----------
---name | name of the alias to delete
---cluster | name of Hadoop cluster for the cluster specific credential store otherwise assumes __gateway
+name | name of the alias to delete
+\-\-cluster | name of Hadoop cluster for the cluster specific credential store otherwise assumes '__gateway'
#### Alias listing ####
-##### knoxcli.sh list-alias [--cluster c] [--help] #####
+##### `bin/knoxcli.sh list-alias [--cluster c] [--help]` #####
Lists the alias names for the credential store within {GATEWAY_HOME}/data/security/keystores.
NOTE: This command will list the aliases in lowercase which is a result of the underlying credential store implementation. Lookup of credentials is a case insensitive operation - so this is not an issue.
argument | description
---------|-----------
---cluster | name of Hadoop cluster for the cluster specific credential store otherwise assumes __gateway
+\-\-cluster | name of Hadoop cluster for the cluster specific credential store otherwise assumes '__gateway'
#### Self-signed cert creation ####
-##### knoxcli.sh create-cert [--hostname n] [--help] #####
+##### `bin/knoxcli.sh create-cert [--hostname n] [--help]` #####
Creates and stores a self-signed certificate to represent the identity of the gateway instance. This is stored within the {GATEWAY_HOME}/data/security/keystores/gateway.jks keystore.
argument | description
-:--------|-----------
---hostname | name of the host to be used in the self-signed certificate. This allows multi-host deployments to specify the proper hostnames for hostname verification to succeed on the client side of the SSL connection. The default is âlocalhostâ.
+---------|-----------
+\-\-hostname|name of the host to be used in the self-signed certificate. This allows multi-host deployments to specify the proper hostnames for hostname verification to succeed on the client side of the SSL connection. The default is 'localhost'.
#### Topology Redeploy ####
-##### knoxcli.sh redeploy [--cluster c] #####
+##### `bin/knoxcli.sh redeploy [--cluster c]` #####
Redeploys one or all of the gateway's clusters (a.k.a topologies).