You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@knox.apache.org by mo...@apache.org on 2020/04/09 19:25:35 UTC
svn commit: r1876334 - in /knox: site/books/knox-1-4-0/user-guide.html
site/index.html site/issue-management.html site/licenses.html
site/mailing-lists.html site/project-info.html site/team.html
trunk/books/1.4.0/knox_cli.md
Author: more
Date: Thu Apr 9 19:25:35 2020
New Revision: 1876334
URL: http://svn.apache.org/viewvc?rev=1876334&view=rev
Log:
KNOX-2312 - Document KnoxCLI command to convert topologies to providers and descriptors
Modified:
knox/site/books/knox-1-4-0/user-guide.html
knox/site/index.html
knox/site/issue-management.html
knox/site/licenses.html
knox/site/mailing-lists.html
knox/site/project-info.html
knox/site/team.html
knox/trunk/books/1.4.0/knox_cli.md
Modified: knox/site/books/knox-1-4-0/user-guide.html
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/user-guide.html?rev=1876334&r1=1876333&r2=1876334&view=diff
==============================================================================
--- knox/site/books/knox-1-4-0/user-guide.html (original)
+++ knox/site/books/knox-1-4-0/user-guide.html Thu Apr 9 19:25:35 2020
@@ -2164,6 +2164,63 @@ ls -alrt {GATEWAY_HOME}/data/deployment
</tr>
</tbody>
</table>
+<h4><a id="Convert+topology+file+to+provider+and+descriptor+config+files">Convert topology file to provider and descriptor config files</a> <a href="#Convert+topology+file+to+provider+and+descriptor+config+files"><img src="markbook-section-link.png"/></a></h4>
+<h5><a id="`bin/knoxcli.sh+convert-topology+--path+path/to/topology.xml+--provider-name+my-prov.json+[--descriptor-name+my-desc.json]+`"><code>bin/knoxcli.sh convert-topology --path path/to/topology.xml --provider-name my-prov.json [--descriptor-name my-desc.json]</code></a> <a href="#`bin/knoxcli.sh+convert-topology+--path+path/to/topology.xml+--provider-name+my-prov.json+[--descriptor-name+my-desc.json]+`"><img src="markbook-section-link.png"/></a></h5>
+<p>Convert topology xml files to provider and descriptor config files.</p>
+<table>
+ <thead>
+ <tr>
+ <th>Argument </th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>--path </td>
+ <td>Required; Path to topology xml file.</td>
+ </tr>
+ <tr>
+ <td>--provider-name </td>
+ <td>Required; Name of the provider json config file (including .json extension).</td>
+ </tr>
+ <tr>
+ <td>--descriptor-name </td>
+ <td>Optional; Name of descriptor json config file (including .json extension).</td>
+ </tr>
+ <tr>
+ <td>--topology-name </td>
+ <td>Optional; topology-name can be use instead of --path option, if used, KnoxCLI will attempt to find topology from deployed topologies directory. If not provided, topology name will be used as descriptor name</td>
+ </tr>
+ <tr>
+ <td>--output-path </td>
+ <td>Optional; Output directory to save provider and descriptor config files if not provided, config files will be saved in appropriate Knox config directory.</td>
+ </tr>
+ <tr>
+ <td>--force </td>
+ <td>Optional; Force rewriting of existing files, if not used, command will fail when the config files with same name already exist.</td>
+ </tr>
+ <tr>
+ <td>--cluster </td>
+ <td>Optional; Cluster name, required for service discovery.</td>
+ </tr>
+ <tr>
+ <td>--discovery-url </td>
+ <td>Optional; Service discovery URL, required for service discovery.</td>
+ </tr>
+ <tr>
+ <td>--discovery-user </td>
+ <td>Optional; Service discovery user, required for service discovery.</td>
+ </tr>
+ <tr>
+ <td>--discovery-pwd-alias </td>
+ <td>Optional; Password alias for service discovery user, required for service discovery.</td>
+ </tr>
+ <tr>
+ <td>--discovery-type </td>
+ <td>Optional; Service discovery type, required for service discovery.</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>
Modified: knox/site/index.html
URL: http://svn.apache.org/viewvc/knox/site/index.html?rev=1876334&r1=1876333&r2=1876334&view=diff
==============================================================================
--- knox/site/index.html (original)
+++ knox/site/index.html Thu Apr 9 19:25:35 2020
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from src/site/markdown/index.md at 2020-04-08
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from src/site/markdown/index.md at 2020-04-09
| Rendered using Apache Maven Fluido Skin 1.7
-->
<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="20200408" />
+ <meta name="Date-Revision-yyyymmdd" content="20200409" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – Announcing Apache Knox 1.3.0!</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
@@ -40,7 +40,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2020-04-08</li>
+ <li id="publishDate">Last Published: 2020-04-09</li>
</ul>
</div>
<div class="row-fluid">
Modified: knox/site/issue-management.html
URL: http://svn.apache.org/viewvc/knox/site/issue-management.html?rev=1876334&r1=1876333&r2=1876334&view=diff
==============================================================================
--- knox/site/issue-management.html (original)
+++ knox/site/issue-management.html Thu Apr 9 19:25:35 2020
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:issue-management at 2020-04-08
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:issue-management at 2020-04-09
| Rendered using Apache Maven Fluido Skin 1.7
-->
<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="20200408" />
+ <meta name="Date-Revision-yyyymmdd" content="20200409" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – Issue Management</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
@@ -40,7 +40,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2020-04-08</li>
+ <li id="publishDate">Last Published: 2020-04-09</li>
</ul>
</div>
<div class="row-fluid">
Modified: knox/site/licenses.html
URL: http://svn.apache.org/viewvc/knox/site/licenses.html?rev=1876334&r1=1876333&r2=1876334&view=diff
==============================================================================
--- knox/site/licenses.html (original)
+++ knox/site/licenses.html Thu Apr 9 19:25:35 2020
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:licenses at 2020-04-08
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:licenses at 2020-04-09
| Rendered using Apache Maven Fluido Skin 1.7
-->
<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="20200408" />
+ <meta name="Date-Revision-yyyymmdd" content="20200409" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – Project Licenses</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
@@ -40,7 +40,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2020-04-08</li>
+ <li id="publishDate">Last Published: 2020-04-09</li>
</ul>
</div>
<div class="row-fluid">
Modified: knox/site/mailing-lists.html
URL: http://svn.apache.org/viewvc/knox/site/mailing-lists.html?rev=1876334&r1=1876333&r2=1876334&view=diff
==============================================================================
--- knox/site/mailing-lists.html (original)
+++ knox/site/mailing-lists.html Thu Apr 9 19:25:35 2020
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:mailing-lists at 2020-04-08
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:mailing-lists at 2020-04-09
| Rendered using Apache Maven Fluido Skin 1.7
-->
<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="20200408" />
+ <meta name="Date-Revision-yyyymmdd" content="20200409" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – Project Mailing Lists</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
@@ -40,7 +40,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2020-04-08</li>
+ <li id="publishDate">Last Published: 2020-04-09</li>
</ul>
</div>
<div class="row-fluid">
Modified: knox/site/project-info.html
URL: http://svn.apache.org/viewvc/knox/site/project-info.html?rev=1876334&r1=1876333&r2=1876334&view=diff
==============================================================================
--- knox/site/project-info.html (original)
+++ knox/site/project-info.html Thu Apr 9 19:25:35 2020
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from org.apache.maven.plugins:maven-site-plugin:3.7.1:CategorySummaryDocumentRenderer at 2020-04-08
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from org.apache.maven.plugins:maven-site-plugin:3.7.1:CategorySummaryDocumentRenderer at 2020-04-09
| Rendered using Apache Maven Fluido Skin 1.7
-->
<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="20200408" />
+ <meta name="Date-Revision-yyyymmdd" content="20200409" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – Project Information</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
@@ -40,7 +40,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2020-04-08</li>
+ <li id="publishDate">Last Published: 2020-04-09</li>
</ul>
</div>
<div class="row-fluid">
Modified: knox/site/team.html
URL: http://svn.apache.org/viewvc/knox/site/team.html?rev=1876334&r1=1876333&r2=1876334&view=diff
==============================================================================
--- knox/site/team.html (original)
+++ knox/site/team.html Thu Apr 9 19:25:35 2020
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:team at 2020-04-08
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:team at 2020-04-09
| Rendered using Apache Maven Fluido Skin 1.7
-->
<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="20200408" />
+ <meta name="Date-Revision-yyyymmdd" content="20200409" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – Project Team</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
@@ -40,7 +40,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2020-04-08</li>
+ <li id="publishDate">Last Published: 2020-04-09</li>
</ul>
</div>
<div class="row-fluid">
Modified: knox/trunk/books/1.4.0/knox_cli.md
URL: http://svn.apache.org/viewvc/knox/trunk/books/1.4.0/knox_cli.md?rev=1876334&r1=1876333&r2=1876334&view=diff
==============================================================================
--- knox/trunk/books/1.4.0/knox_cli.md (original)
+++ knox/trunk/books/1.4.0/knox_cli.md Thu Apr 9 19:25:35 2020
@@ -224,3 +224,23 @@ Argument | Description
---------|-----------
\-\-registry\-client | Required; The name of a [remote configuration registry client](#Remote+Configuration+Registry+Clients), as defined in gateway-site.xml
+#### Convert topology file to provider and descriptor config files ####
+##### `bin/knoxcli.sh convert-topology --path path/to/topology.xml --provider-name my-prov.json [--descriptor-name my-desc.json] ` ####
+
+Convert topology xml files to provider and descriptor config files.
+
+Argument | Description
+---------|-----------
+\-\-path | Required; Path to topology xml file.
+\-\-provider\-name | Required; Name of the provider json config file (including .json extension).
+\-\-descriptor\-name | Optional; Name of descriptor json config file (including .json extension).
+\-\-topology\-name | Optional; topology-name can be use instead of \-\-path option, if used, KnoxCLI will attempt to find topology from deployed topologies directory. If not provided, topology name will be used as descriptor name
+\-\-output\-path | Optional; Output directory to save provider and descriptor config files if not provided, config files will be saved in appropriate Knox config directory.
+\-\-force | Optional; Force rewriting of existing files, if not used, command will fail when the config files with same name already exist.
+\-\-cluster | Optional; Cluster name, required for service discovery.
+\-\-discovery\-url | Optional; Service discovery URL, required for service discovery.
+\-\-discovery\-user | Optional; Service discovery user, required for service discovery.
+\-\-discovery\-pwd\-alias | Optional; Password alias for service discovery user, required for service discovery.
+\-\-discovery\-type | Optional; Service discovery type, required for service discovery.
+
+