You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@knox.apache.org by kr...@apache.org on 2019/07/24 22:13:50 UTC

svn commit: r1863719 - in /knox: site/books/knox-1-3-0/ site/books/knox-1-4-0/ trunk/books/1.3.0/ trunk/books/1.4.0/

Author: krisden
Date: Wed Jul 24 22:13:49 2019
New Revision: 1863719

URL: http://svn.apache.org/viewvc?rev=1863719&view=rev
Log:
KNOX-1947 - Document the Cloudera Manager API service definition

Added:
    knox/trunk/books/1.3.0/service_cloudera_manager.md
    knox/trunk/books/1.4.0/service_cloudera_manager.md
Modified:
    knox/site/books/knox-1-3-0/user-guide.html
    knox/site/books/knox-1-4-0/user-guide.html
    knox/trunk/books/1.3.0/book.md
    knox/trunk/books/1.3.0/book_service-details.md
    knox/trunk/books/1.4.0/book.md
    knox/trunk/books/1.4.0/book_service-details.md

Modified: knox/site/books/knox-1-3-0/user-guide.html
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-3-0/user-guide.html?rev=1863719&r1=1863718&r2=1863719&view=diff
==============================================================================
--- knox/site/books/knox-1-3-0/user-guide.html (original)
+++ knox/site/books/knox-1-3-0/user-guide.html Wed Jul 24 22:13:49 2019
@@ -126,6 +126,7 @@
       <li><a href="#Storm">Storm</a></li>
       <li><a href="#Solr">Solr</a></li>
       <li><a href="#Avatica">Avatica</a></li>
+      <li><a href="#Cloudera+Manager">Cloudera Manager</a></li>
       <li><a href="#Livy+Server">Livy Server</a></li>
       <li><a href="#Elasticsearch">Elasticsearch</a></li>
       <li><a href="#Common+Service+Config">Common Service Config</a></li>
@@ -6019,6 +6020,7 @@ dep/commons-codec-1.7.jar
   <li><a href="#Storm">Storm</a></li>
   <li><a href="#Solr">Solr</a></li>
   <li><a href="#Avatica">Avatica</a></li>
+  <li><a href="#Cloudera+Manager">Cloudera Manager</a></li>
   <li><a href="#Livy+Server">Livy Server</a></li>
   <li><a href="#Elasticsearch">Elasticsearch</a></li>
 </ul>
@@ -8211,6 +8213,16 @@ props.setProperty(&quot;truststore&quot;
 props.setProperty(&quot;truststore_password&quot;, &quot;very_secret&quot;);
 DriverManager.getConnection(url, props);
 </code></pre>
+<h3><a id="Cloudera+Manager">Cloudera Manager</a> <a href="#Cloudera+Manager"><img src="markbook-section-link.png"/></a></h3>
+<p>Knox provides proxied access to Cloudera Manager API.</p>
+<h4><a id="Gateway+configuration">Gateway configuration</a> <a href="#Gateway+configuration"><img src="markbook-section-link.png"/></a></h4>
+<p>The Gateway can be configured for Cloudera Manager API by modifying the topology XML file and providing a new service XML file.</p>
+<p>In the topology XML file, add the following with the correct hostname:</p>
+<pre><code>&lt;service&gt;
+  &lt;role&gt;CM-API&lt;/role&gt;
+  &lt;url&gt;http://&lt;cloudera-manager&gt;:7180/api&lt;/url&gt;
+&lt;/service&gt;
+</code></pre>
 <h3><a id="Livy+Server">Livy Server</a> <a href="#Livy+Server"><img src="markbook-section-link.png"/></a></h3>
 <p>Knox provides proxied access to Livy server for submitting Spark jobs. The gateway can be used to provide authentication and encryption for clients to servers like Livy.</p>
 <h4><a id="Gateway+configuration">Gateway configuration</a> <a href="#Gateway+configuration"><img src="markbook-section-link.png"/></a></h4>

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=1863719&r1=1863718&r2=1863719&view=diff
==============================================================================
--- knox/site/books/knox-1-4-0/user-guide.html (original)
+++ knox/site/books/knox-1-4-0/user-guide.html Wed Jul 24 22:13:49 2019
@@ -126,6 +126,7 @@
       <li><a href="#Storm">Storm</a></li>
       <li><a href="#Solr">Solr</a></li>
       <li><a href="#Avatica">Avatica</a></li>
+      <li><a href="#Cloudera+Manager">Cloudera Manager</a></li>
       <li><a href="#Livy+Server">Livy Server</a></li>
       <li><a href="#Elasticsearch">Elasticsearch</a></li>
       <li><a href="#Common+Service+Config">Common Service Config</a></li>
@@ -6019,6 +6020,7 @@ dep/commons-codec-1.7.jar
   <li><a href="#Storm">Storm</a></li>
   <li><a href="#Solr">Solr</a></li>
   <li><a href="#Avatica">Avatica</a></li>
+  <li><a href="#Cloudera+Manager">Cloudera Manager</a></li>
   <li><a href="#Livy+Server">Livy Server</a></li>
   <li><a href="#Elasticsearch">Elasticsearch</a></li>
 </ul>
@@ -8211,6 +8213,16 @@ props.setProperty(&quot;truststore&quot;
 props.setProperty(&quot;truststore_password&quot;, &quot;very_secret&quot;);
 DriverManager.getConnection(url, props);
 </code></pre>
+<h3><a id="Cloudera+Manager">Cloudera Manager</a> <a href="#Cloudera+Manager"><img src="markbook-section-link.png"/></a></h3>
+<p>Knox provides proxied access to Cloudera Manager API.</p>
+<h4><a id="Gateway+configuration">Gateway configuration</a> <a href="#Gateway+configuration"><img src="markbook-section-link.png"/></a></h4>
+<p>The Gateway can be configured for Cloudera Manager API by modifying the topology XML file and providing a new service XML file.</p>
+<p>In the topology XML file, add the following with the correct hostname:</p>
+<pre><code>&lt;service&gt;
+  &lt;role&gt;CM-API&lt;/role&gt;
+  &lt;url&gt;http://&lt;cloudera-manager&gt;:7180/api&lt;/url&gt;
+&lt;/service&gt;
+</code></pre>
 <h3><a id="Livy+Server">Livy Server</a> <a href="#Livy+Server"><img src="markbook-section-link.png"/></a></h3>
 <p>Knox provides proxied access to Livy server for submitting Spark jobs. The gateway can be used to provide authentication and encryption for clients to servers like Livy.</p>
 <h4><a id="Gateway+configuration">Gateway configuration</a> <a href="#Gateway+configuration"><img src="markbook-section-link.png"/></a></h4>

Modified: knox/trunk/books/1.3.0/book.md
URL: http://svn.apache.org/viewvc/knox/trunk/books/1.3.0/book.md?rev=1863719&r1=1863718&r2=1863719&view=diff
==============================================================================
--- knox/trunk/books/1.3.0/book.md (original)
+++ knox/trunk/books/1.3.0/book.md Wed Jul 24 22:13:49 2019
@@ -99,6 +99,7 @@
     * #[Storm]
     * #[Solr]
     * #[Avatica]
+    * #[Cloudera Manager]
     * #[Livy Server]
     * #[Elasticsearch]
     * #[Common Service Config]

Modified: knox/trunk/books/1.3.0/book_service-details.md
URL: http://svn.apache.org/viewvc/knox/trunk/books/1.3.0/book_service-details.md?rev=1863719&r1=1863718&r2=1863719&view=diff
==============================================================================
--- knox/trunk/books/1.3.0/book_service-details.md (original)
+++ knox/trunk/books/1.3.0/book_service-details.md Wed Jul 24 22:13:49 2019
@@ -39,6 +39,7 @@ These are the current Hadoop services wi
 * #[Storm]
 * #[Solr]
 * #[Avatica]
+* #[Cloudera Manager]
 * #[Livy Server]
 * #[Elasticsearch]
 
@@ -92,6 +93,7 @@ Therefore each request via cURL will res
 <<service_config.md>>
 <<service_default_ha.md>>
 <<service_avatica.md>>
+<<service_cloudera_manager.md>>
 <<service_livy.md>>
 <<service_elasticsearch.md>>
 <<service_ssl_certificate_trust.md>>

Added: knox/trunk/books/1.3.0/service_cloudera_manager.md
URL: http://svn.apache.org/viewvc/knox/trunk/books/1.3.0/service_cloudera_manager.md?rev=1863719&view=auto
==============================================================================
--- knox/trunk/books/1.3.0/service_cloudera_manager.md (added)
+++ knox/trunk/books/1.3.0/service_cloudera_manager.md Wed Jul 24 22:13:49 2019
@@ -0,0 +1,33 @@
+<!---
+   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.
+--->
+
+### Cloudera Manager ###
+
+Knox provides proxied access to Cloudera Manager API.
+
+#### Gateway configuration ####
+
+The Gateway can be configured for Cloudera Manager API by modifying the topology XML file
+and providing a new service XML file.
+
+In the topology XML file, add the following with the correct hostname:
+
+    <service>
+      <role>CM-API</role>
+      <url>http://<cloudera-manager>:7180/api</url>
+    </service>
+

Modified: knox/trunk/books/1.4.0/book.md
URL: http://svn.apache.org/viewvc/knox/trunk/books/1.4.0/book.md?rev=1863719&r1=1863718&r2=1863719&view=diff
==============================================================================
--- knox/trunk/books/1.4.0/book.md (original)
+++ knox/trunk/books/1.4.0/book.md Wed Jul 24 22:13:49 2019
@@ -99,6 +99,7 @@
     * #[Storm]
     * #[Solr]
     * #[Avatica]
+    * #[Cloudera Manager]
     * #[Livy Server]
     * #[Elasticsearch]
     * #[Common Service Config]

Modified: knox/trunk/books/1.4.0/book_service-details.md
URL: http://svn.apache.org/viewvc/knox/trunk/books/1.4.0/book_service-details.md?rev=1863719&r1=1863718&r2=1863719&view=diff
==============================================================================
--- knox/trunk/books/1.4.0/book_service-details.md (original)
+++ knox/trunk/books/1.4.0/book_service-details.md Wed Jul 24 22:13:49 2019
@@ -39,6 +39,7 @@ These are the current Hadoop services wi
 * #[Storm]
 * #[Solr]
 * #[Avatica]
+* #[Cloudera Manager]
 * #[Livy Server]
 * #[Elasticsearch]
 
@@ -92,6 +93,7 @@ Therefore each request via cURL will res
 <<service_config.md>>
 <<service_default_ha.md>>
 <<service_avatica.md>>
+<<service_cloudera_manager.md>>
 <<service_livy.md>>
 <<service_elasticsearch.md>>
 <<service_ssl_certificate_trust.md>>

Added: knox/trunk/books/1.4.0/service_cloudera_manager.md
URL: http://svn.apache.org/viewvc/knox/trunk/books/1.4.0/service_cloudera_manager.md?rev=1863719&view=auto
==============================================================================
--- knox/trunk/books/1.4.0/service_cloudera_manager.md (added)
+++ knox/trunk/books/1.4.0/service_cloudera_manager.md Wed Jul 24 22:13:49 2019
@@ -0,0 +1,33 @@
+<!---
+   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.
+--->
+
+### Cloudera Manager ###
+
+Knox provides proxied access to Cloudera Manager API.
+
+#### Gateway configuration ####
+
+The Gateway can be configured for Cloudera Manager API by modifying the topology XML file
+and providing a new service XML file.
+
+In the topology XML file, add the following with the correct hostname:
+
+    <service>
+      <role>CM-API</role>
+      <url>http://<cloudera-manager>:7180/api</url>
+    </service>
+