knox-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From m...@apache.org
Subject svn commit: r1817118 - in /knox: site/books/knox-0-14-0/user-guide.html site/index.html site/issue-tracking.html site/license.html site/mail-lists.html site/project-info.html site/team-list.html trunk/books/0.14.0/knox_cli.md
Date Mon, 04 Dec 2017 19:17:31 GMT
Author: more
Date: Mon Dec  4 19:17:31 2017
New Revision: 1817118

URL: http://svn.apache.org/viewvc?rev=1817118&view=rev
Log:
KNOX-1127 - Document KNOX CLI Remote Configuration Registry Commands (Phil Zampino  via Sandeep
More)

Modified:
    knox/site/books/knox-0-14-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.14.0/knox_cli.md

Modified: knox/site/books/knox-0-14-0/user-guide.html
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-14-0/user-guide.html?rev=1817118&r1=1817117&r2=1817118&view=diff
==============================================================================
--- knox/site/books/knox-0-14-0/user-guide.html (original)
+++ knox/site/books/knox-0-14-0/user-guide.html Mon Dec  4 19:17:31 2017
@@ -1309,6 +1309,84 @@ keytool -keystore gateway.jks -storepass
       <td>Optional; Print extra debug info on failed authentication</td>
     </tr>
   </tbody>
+</table><h4><a id="Remote+Configuration+Registry+Client+Listing">Remote
Configuration Registry Client Listing</a> <a href="#Remote+Configuration+Registry+Client+Listing"><img
src="markbook-section-link.png"/></a></h4><h5><a id="`bin/knoxcli.sh+list-registry-clients`"><code>bin/knoxcli.sh
list-registry-clients</code></a> <a href="#`bin/knoxcli.sh+list-registry-clients`"><img
src="markbook-section-link.png"/></a></h5><p>Lists the <a href="#Remote+Configuration+Registry+Clients">remote
configuration registry clients</a> defined in &lsquo;{GATEWAY_HOME}/conf/gateway-site.xml&rsquo;.</p><h4><a
id="Upload+Provider+Configuration+to+a+Remote+Configuration+Registry">Upload Provider Configuration
to a Remote Configuration Registry</a> <a href="#Upload+Provider+Configuration+to+a+Remote+Configuration+Registry"><img
src="markbook-section-link.png"/></a></h4><h5><a id="`bin/knoxcli.sh+upload-provider-config+providerConfigFile+--registry-client+name+[--entry-name+entryName]`"><code>bin/knoxcli.sh
  upload-provider-config providerConfigFile --registry-client name [--entry-name entryName]</code></a>
<a href="#`bin/knoxcli.sh+upload-provider-config+providerConfigFile+--registry-client+name+[--entry-name+entryName]`"><img
src="markbook-section-link.png"/></a></h5><p>Upload a provider configuration
file to the remote configuration registry for which the referenced client provides acces.
By default, the entry name will be the same as the uploaded file&rsquo;s name.</p>
+<table>
+  <thead>
+    <tr>
+      <th>argument </th>
+      <th>description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>--registry-client </td>
+      <td>Required; The name of a remote configuration registry client, as defined
in gateway-site.xml</td>
+    </tr>
+    <tr>
+      <td>--entry-name </td>
+      <td>Optional; The name of the entry for the uploaded content in the registry.</td>
+    </tr>
+  </tbody>
+</table><h4><a id="Upload+Descriptor+to+a+Remote+Configuration+Registry">Upload
Descriptor to a Remote Configuration Registry</a> <a href="#Upload+Descriptor+to+a+Remote+Configuration+Registry"><img
src="markbook-section-link.png"/></a></h4><h5><a id="`bin/knoxcli.sh+upload-descriptor+descriptorFile+--registry-client+name+[--entry-name+entryName]`"><code>bin/knoxcli.sh
upload-descriptor descriptorFile --registry-client name [--entry-name entryName]</code></a>
<a href="#`bin/knoxcli.sh+upload-descriptor+descriptorFile+--registry-client+name+[--entry-name+entryName]`"><img
src="markbook-section-link.png"/></a></h5><p>Upload a descriptor file
to the remote configuration registry for which the referenced client provides acces. By default,
the entry name will be the same as the uploaded file&rsquo;s name.</p>
+<table>
+  <thead>
+    <tr>
+      <th>argument </th>
+      <th>description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>--registry-client </td>
+      <td>Required; The name of a remote configuration registry client, as defined
in gateway-site.xml</td>
+    </tr>
+    <tr>
+      <td>--entry-name </td>
+      <td>Optional; The name of the entry for the uploaded content in the registry.</td>
+    </tr>
+  </tbody>
+</table><h4><a id="Delete+a+Provider+Configuration+From+a+Remote+Configuration+Registry">Delete
a Provider Configuration From a Remote Configuration Registry</a> <a href="#Delete+a+Provider+Configuration+From+a+Remote+Configuration+Registry"><img
src="markbook-section-link.png"/></a></h4><h5><a id="`bin/knoxcli.sh+delete-provider-config+providerConfig+--registry-client+name`"><code>bin/knoxcli.sh
delete-provider-config providerConfig --registry-client name</code></a> <a
href="#`bin/knoxcli.sh+delete-provider-config+providerConfig+--registry-client+name`"><img
src="markbook-section-link.png"/></a></h5><p>Delete a provider configuration
from the remote configuration registry for which the referenced client provides acces.</p>
+<table>
+  <thead>
+    <tr>
+      <th>argument </th>
+      <th>description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>--registry-client </td>
+      <td>Required; The name of a remote configuration registry client, as defined
in gateway-site.xml</td>
+    </tr>
+  </tbody>
+</table><h4><a id="Delete+a+Descriptor+From+a+Remote+Configuration+Registry">Delete
a Descriptor From a Remote Configuration Registry</a> <a href="#Delete+a+Descriptor+From+a+Remote+Configuration+Registry"><img
src="markbook-section-link.png"/></a></h4><h5><a id="`bin/knoxcli.sh+delete-descriptor+descriptor+--registry-client+name`"><code>bin/knoxcli.sh
delete-descriptor descriptor --registry-client name</code></a> <a href="#`bin/knoxcli.sh+delete-descriptor+descriptor+--registry-client+name`"><img
src="markbook-section-link.png"/></a></h5><p>Delete a descriptor from
the remote configuration registry for which the referenced client provides acces.</p>
+<table>
+  <thead>
+    <tr>
+      <th>argument </th>
+      <th>description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>--registry-client </td>
+      <td>Required; The name of a remote configuration registry client, as defined
in gateway-site.xml</td>
+    </tr>
+  </tbody>
+</table><h4><a id="Get+the+ACL+For+an+Entry+in+a+Remote+Configuration+Registry">Get
the ACL For an Entry in a Remote Configuration Registry</a> <a href="#Get+the+ACL+For+an+Entry+in+a+Remote+Configuration+Registry"><img
src="markbook-section-link.png"/></a></h4><h5><a id="`bin/knoxcli.sh+get-registry-acl+entry+--registry-client+name`"><code>bin/knoxcli.sh
get-registry-acl entry --registry-client name</code></a> <a href="#`bin/knoxcli.sh+get-registry-acl+entry+--registry-client+name`"><img
src="markbook-section-link.png"/></a></h5><p>List the ACL set for the
specified entry in the remote configuration registry for which the referenced client provides
acces.</p>
+<table>
+  <thead>
+    <tr>
+      <th>argument </th>
+      <th>description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>--registry-client </td>
+      <td>Required; The name of a remote configuration registry client, as defined
in gateway-site.xml</td>
+    </tr>
+  </tbody>
 </table><h3><a id="Admin+API">Admin API</a> <a href="#Admin+API"><img
src="markbook-section-link.png"/></a></h3><p>Access to the administrator
functions of Knox are provided by the Admin REST API.</p><h4><a id="Admin+API+URL">Admin
API URL</a> <a href="#Admin+API+URL"><img src="markbook-section-link.png"/></a></h4><p>The
URL mapping for the Knox Admin API is:</p>
 <table>
   <tbody>

Modified: knox/site/index.html
URL: http://svn.apache.org/viewvc/knox/site/index.html?rev=1817118&r1=1817117&r2=1817118&view=diff
==============================================================================
--- knox/site/index.html (original)
+++ knox/site/index.html Mon Dec  4 19:17:31 2017
@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <!--
- | Generated by Apache Maven Doxia at 2017-12-01
+ | Generated by Apache Maven Doxia at 2017-12-04
  | Rendered using Apache Maven Fluido Skin 1.3.0
 -->
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <meta name="Date-Revision-yyyymmdd" content="20171201" />
+    <meta name="Date-Revision-yyyymmdd" content="20171204" />
     <meta http-equiv="Content-Language" content="en" />
     <title>Knox Gateway &#x2013; REST API and Application Gateway for the Apache
Hadoop Ecosystem</title>
     <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -58,7 +58,7 @@
               
                 
                     
-                  <li id="publishDate" class="pull-right">Last Published: 2017-12-01</li>

+                  <li id="publishDate" class="pull-right">Last Published: 2017-12-04</li>

             
                             </ul>
       </div>

Modified: knox/site/issue-tracking.html
URL: http://svn.apache.org/viewvc/knox/site/issue-tracking.html?rev=1817118&r1=1817117&r2=1817118&view=diff
==============================================================================
--- knox/site/issue-tracking.html (original)
+++ knox/site/issue-tracking.html Mon Dec  4 19:17:31 2017
@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <!--
- | Generated by Apache Maven Doxia at 2017-12-01
+ | Generated by Apache Maven Doxia at 2017-12-04
  | Rendered using Apache Maven Fluido Skin 1.3.0
 -->
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <meta name="Date-Revision-yyyymmdd" content="20171201" />
+    <meta name="Date-Revision-yyyymmdd" content="20171204" />
     <meta http-equiv="Content-Language" content="en" />
     <title>Knox Gateway &#x2013; Issue Tracking</title>
     <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -58,7 +58,7 @@
               
                 
                     
-                  <li id="publishDate" class="pull-right">Last Published: 2017-12-01</li>

+                  <li id="publishDate" class="pull-right">Last Published: 2017-12-04</li>

             
                             </ul>
       </div>

Modified: knox/site/license.html
URL: http://svn.apache.org/viewvc/knox/site/license.html?rev=1817118&r1=1817117&r2=1817118&view=diff
==============================================================================
--- knox/site/license.html (original)
+++ knox/site/license.html Mon Dec  4 19:17:31 2017
@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <!--
- | Generated by Apache Maven Doxia at 2017-12-01
+ | Generated by Apache Maven Doxia at 2017-12-04
  | Rendered using Apache Maven Fluido Skin 1.3.0
 -->
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <meta name="Date-Revision-yyyymmdd" content="20171201" />
+    <meta name="Date-Revision-yyyymmdd" content="20171204" />
     <meta http-equiv="Content-Language" content="en" />
     <title>Knox Gateway &#x2013; Project License</title>
     <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -58,7 +58,7 @@
               
                 
                     
-                  <li id="publishDate" class="pull-right">Last Published: 2017-12-01</li>

+                  <li id="publishDate" class="pull-right">Last Published: 2017-12-04</li>

             
                             </ul>
       </div>

Modified: knox/site/mail-lists.html
URL: http://svn.apache.org/viewvc/knox/site/mail-lists.html?rev=1817118&r1=1817117&r2=1817118&view=diff
==============================================================================
--- knox/site/mail-lists.html (original)
+++ knox/site/mail-lists.html Mon Dec  4 19:17:31 2017
@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <!--
- | Generated by Apache Maven Doxia at 2017-12-01
+ | Generated by Apache Maven Doxia at 2017-12-04
  | Rendered using Apache Maven Fluido Skin 1.3.0
 -->
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <meta name="Date-Revision-yyyymmdd" content="20171201" />
+    <meta name="Date-Revision-yyyymmdd" content="20171204" />
     <meta http-equiv="Content-Language" content="en" />
     <title>Knox Gateway &#x2013; Project Mailing Lists</title>
     <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -58,7 +58,7 @@
               
                 
                     
-                  <li id="publishDate" class="pull-right">Last Published: 2017-12-01</li>

+                  <li id="publishDate" class="pull-right">Last Published: 2017-12-04</li>

             
                             </ul>
       </div>

Modified: knox/site/project-info.html
URL: http://svn.apache.org/viewvc/knox/site/project-info.html?rev=1817118&r1=1817117&r2=1817118&view=diff
==============================================================================
--- knox/site/project-info.html (original)
+++ knox/site/project-info.html Mon Dec  4 19:17:31 2017
@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <!--
- | Generated by Apache Maven Doxia at 2017-12-01
+ | Generated by Apache Maven Doxia at 2017-12-04
  | Rendered using Apache Maven Fluido Skin 1.3.0
 -->
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <meta name="Date-Revision-yyyymmdd" content="20171201" />
+    <meta name="Date-Revision-yyyymmdd" content="20171204" />
     <meta http-equiv="Content-Language" content="en" />
     <title>Knox Gateway &#x2013; Project Information</title>
     <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -58,7 +58,7 @@
               
                 
                     
-                  <li id="publishDate" class="pull-right">Last Published: 2017-12-01</li>

+                  <li id="publishDate" class="pull-right">Last Published: 2017-12-04</li>

             
                             </ul>
       </div>

Modified: knox/site/team-list.html
URL: http://svn.apache.org/viewvc/knox/site/team-list.html?rev=1817118&r1=1817117&r2=1817118&view=diff
==============================================================================
--- knox/site/team-list.html (original)
+++ knox/site/team-list.html Mon Dec  4 19:17:31 2017
@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <!--
- | Generated by Apache Maven Doxia at 2017-12-01
+ | Generated by Apache Maven Doxia at 2017-12-04
  | Rendered using Apache Maven Fluido Skin 1.3.0
 -->
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <meta name="Date-Revision-yyyymmdd" content="20171201" />
+    <meta name="Date-Revision-yyyymmdd" content="20171204" />
     <meta http-equiv="Content-Language" content="en" />
     <title>Knox Gateway &#x2013; Team list</title>
     <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -58,7 +58,7 @@
               
                 
                     
-                  <li id="publishDate" class="pull-right">Last Published: 2017-12-01</li>

+                  <li id="publishDate" class="pull-right">Last Published: 2017-12-04</li>

             
                             </ul>
       </div>

Modified: knox/trunk/books/0.14.0/knox_cli.md
URL: http://svn.apache.org/viewvc/knox/trunk/books/0.14.0/knox_cli.md?rev=1817118&r1=1817117&r2=1817118&view=diff
==============================================================================
--- knox/trunk/books/0.14.0/knox_cli.md (original)
+++ knox/trunk/books/0.14.0/knox_cli.md Mon Dec  4 19:17:31 2017
@@ -129,4 +129,64 @@ argument | description
 \-\-port	| Optional; port that the cluster is running on. If not supplied CLI will try to
read config files to find the port.
 \-\-u	| Required; username to authorize against Hadoop services
 \-\-p	| Required; password to match username
-\-\-d | Optional; Print extra debug info on failed authentication
\ No newline at end of file
+\-\-d | Optional; Print extra debug info on failed authentication
+
+#### Remote Configuration Registry Client Listing ####
+##### `bin/knoxcli.sh list-registry-clients` #####
+
+Lists the [remote configuration registry clients](#Remote+Configuration+Registry+Clients)
defined in '{GATEWAY_HOME}/conf/gateway-site.xml'.
+
+
+#### Upload Provider Configuration to a Remote Configuration Registry ####
+##### `bin/knoxcli.sh upload-provider-config providerConfigFile --registry-client name [--entry-name
entryName]` ####
+
+Upload a provider configuration file to the remote configuration registry for which the referenced
client provides acces.
+By default, the entry name will be the same as the uploaded file's name.
+
+argument | description
+---------|-----------
+\-\-registry\-client | Required; The name of a remote configuration registry client, as defined
in gateway-site.xml
+\-\-entry\-name	| Optional; The name of the entry for the uploaded content in the registry.
+
+
+#### Upload Descriptor to a Remote Configuration Registry ####
+##### `bin/knoxcli.sh upload-descriptor descriptorFile --registry-client name [--entry-name
entryName]` ####
+
+Upload a descriptor file to the remote configuration registry for which the referenced client
provides acces.
+By default, the entry name will be the same as the uploaded file's name.
+
+argument | description
+---------|-----------
+\-\-registry\-client | Required; The name of a remote configuration registry client, as defined
in gateway-site.xml
+\-\-entry\-name	| Optional; The name of the entry for the uploaded content in the registry.
+
+
+#### Delete a Provider Configuration From a Remote Configuration Registry ####
+##### `bin/knoxcli.sh delete-provider-config providerConfig --registry-client name` ####
+
+Delete a provider configuration from the remote configuration registry for which the referenced
client provides acces.
+
+argument | description
+---------|-----------
+\-\-registry\-client | Required; The name of a remote configuration registry client, as defined
in gateway-site.xml
+
+
+#### Delete a Descriptor From a Remote Configuration Registry ####
+##### `bin/knoxcli.sh delete-descriptor descriptor --registry-client name` ####
+
+Delete a descriptor from the remote configuration registry for which the referenced client
provides acces.
+
+argument | description
+---------|-----------
+\-\-registry\-client | Required; The name of a remote configuration registry client, as defined
in gateway-site.xml
+
+
+#### Get the ACL For an Entry in a Remote Configuration Registry ####
+##### `bin/knoxcli.sh get-registry-acl entry --registry-client name` ####
+
+List the ACL set for the specified entry in the remote configuration registry for which the
referenced client provides acces.
+
+argument | description
+---------|-----------
+\-\-registry\-client | Required; The name of a remote configuration registry client, as defined
in gateway-site.xml
+



Mime
View raw message