Author: krisden
Date: Wed Jul 24 22:23:53 2019
New Revision: 1863720
URL: http://svn.apache.org/viewvc?rev=1863720&view=rev
Log:
KNOX-1946 - Document the Hue UI service definition
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_ui_service_details.md
knox/trunk/books/1.4.0/book_ui_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=1863720&r1=1863719&r2=1863720&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:23:53 2019
@@ -8629,6 +8629,7 @@ curl -i -k -u username:password -H "
<li><a href="#Atlas+UI">Atlas UI</a></li>
<li><a href="#Zeppelin+UI">Zeppelin UI</a></li>
<li><a href="#Nifi+UI">Nifi UI</a></li>
+ <li><a href="#Hue+UI">Hue UI</a></li>
</ul>
<h3><a id="Assumptions">Assumptions</a> <a href="#Assumptions"><img
src="markbook-section-link.png"/></a></h3>
<p>This section assumes an environment setup similar to the one in the REST
services section <a href="#Service+Details">Service Details</a></p>
@@ -9022,6 +9023,15 @@ curl -i -k -u username:password -H "
<p>Knox also supports secure Zeppelin UIs, for secure UIs one needs to
provision Zeppelin certificate into Knox truststore. </p>
<h3><a id="Nifi+UI">Nifi UI</a> <a href="#Nifi+UI"><img
src="markbook-section-link.png"/></a></h3>
<p>You can use the Apache Knox Gateway to provide authentication access
security for your NiFi services.</p>
+<p>The URL mapping for the NiFi UI is:</p>
+<table>
+ <tbody>
+ <tr>
+ <td>Gateway </td>
+
<td><code>https://{gateway-host}:{gateway-port}/{gateway-path}/{topology}/nifi/</code></td>
+ </tr>
+ </tbody>
+</table>
<p>The Gateway can be configured for Nifi by modifying the topology XML
file.</p>
<p>In the topology XML file, add the following with the correct hostname and
port:</p>
<pre><code><service>
@@ -9031,7 +9041,24 @@ curl -i -k -u username:password -H "
</service>
</code></pre>
<p>Note the setting of the useTwoWaySsl param above. Nifi requires mutual
authentication via SSL and this param tells the dispatch to present a client
cert to the server.</p>
-<p>The above is an example request body to be used to create a Spark session
via Livy server and illustrates the “proxyUser” that requires
rewrite.</p>
+<h3><a id="Hue+UI">Hue UI</a> <a href="#Hue+UI"><img
src="markbook-section-link.png"/></a></h3>
+<p>You can use the Apache Knox Gateway to provide authentication access
security for your Hue UI.</p>
+<p>The URL mapping for the Hue UI is:</p>
+<table>
+ <tbody>
+ <tr>
+ <td>Gateway </td>
+
<td><code>https://{gateway-host}:{gateway-port}/{gateway-path}/{topology}/hue/</code></td>
+ </tr>
+ </tbody>
+</table>
+<p>The Gateway can be configured for Hue by modifying the topology XML
file.</p>
+<p>In the topology XML file, add the following with the correct hostname and
port:</p>
+<pre><code><service>
+ <role>HUE</role>
+
<url><HUE_HTTP_SCHEME>://<HUE_HOST>:<HUE_HTTP_SCHEME_PORT></url>
+</service>
+</code></pre>
<h3><a id="Admin+UI">Admin UI</a> <a href="#Admin+UI"><img
src="markbook-section-link.png"/></a></h3>
<p>The Admin UI is a web application hosted by Knox, which provides the
ability to manage provider configurations, descriptors, and topologies.</p>
<p>As an authoring facility, it eliminates the need for ssh/scp access to the
Knox host(s) to effect topology changes.<br> Furthermore, using the Admin UI
simplifies the management of topologies in Knox HA deployments by eliminating
the need to copy files to multiple Knox hosts.</p>
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=1863720&r1=1863719&r2=1863720&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:23:53 2019
@@ -8629,6 +8629,7 @@ curl -i -k -u username:password -H "
<li><a href="#Atlas+UI">Atlas UI</a></li>
<li><a href="#Zeppelin+UI">Zeppelin UI</a></li>
<li><a href="#Nifi+UI">Nifi UI</a></li>
+ <li><a href="#Hue+UI">Hue UI</a></li>
</ul>
<h3><a id="Assumptions">Assumptions</a> <a href="#Assumptions"><img
src="markbook-section-link.png"/></a></h3>
<p>This section assumes an environment setup similar to the one in the REST
services section <a href="#Service+Details">Service Details</a></p>
@@ -9022,6 +9023,15 @@ curl -i -k -u username:password -H "
<p>Knox also supports secure Zeppelin UIs, for secure UIs one needs to
provision Zeppelin certificate into Knox truststore. </p>
<h3><a id="Nifi+UI">Nifi UI</a> <a href="#Nifi+UI"><img
src="markbook-section-link.png"/></a></h3>
<p>You can use the Apache Knox Gateway to provide authentication access
security for your NiFi services.</p>
+<p>The URL mapping for the NiFi UI is:</p>
+<table>
+ <tbody>
+ <tr>
+ <td>Gateway </td>
+
<td><code>https://{gateway-host}:{gateway-port}/{gateway-path}/{topology}/nifi/</code></td>
+ </tr>
+ </tbody>
+</table>
<p>The Gateway can be configured for Nifi by modifying the topology XML
file.</p>
<p>In the topology XML file, add the following with the correct hostname and
port:</p>
<pre><code><service>
@@ -9031,7 +9041,24 @@ curl -i -k -u username:password -H "
</service>
</code></pre>
<p>Note the setting of the useTwoWaySsl param above. Nifi requires mutual
authentication via SSL and this param tells the dispatch to present a client
cert to the server.</p>
-<p>The above is an example request body to be used to create a Spark session
via Livy server and illustrates the “proxyUser” that requires
rewrite.</p>
+<h3><a id="Hue+UI">Hue UI</a> <a href="#Hue+UI"><img
src="markbook-section-link.png"/></a></h3>
+<p>You can use the Apache Knox Gateway to provide authentication access
security for your Hue UI.</p>
+<p>The URL mapping for the Hue UI is:</p>
+<table>
+ <tbody>
+ <tr>
+ <td>Gateway </td>
+
<td><code>https://{gateway-host}:{gateway-port}/{gateway-path}/{topology}/hue/</code></td>
+ </tr>
+ </tbody>
+</table>
+<p>The Gateway can be configured for Hue by modifying the topology XML
file.</p>
+<p>In the topology XML file, add the following with the correct hostname and
port:</p>
+<pre><code><service>
+ <role>HUE</role>
+
<url><HUE_HTTP_SCHEME>://<HUE_HOST>:<HUE_HTTP_SCHEME_PORT></url>
+</service>
+</code></pre>
<h3><a id="Admin+UI">Admin UI</a> <a href="#Admin+UI"><img
src="markbook-section-link.png"/></a></h3>
<p>The Admin UI is a web application hosted by Knox, which provides the
ability to manage provider configurations, descriptors, and topologies.</p>
<p>As an authoring facility, it eliminates the need for ssh/scp access to the
Knox host(s) to effect topology changes.<br> Furthermore, using the Admin UI
simplifies the management of topologies in Knox HA deployments by eliminating
the need to copy files to multiple Knox hosts.</p>
Modified: knox/trunk/books/1.3.0/book_ui_service_details.md
URL:
http://svn.apache.org/viewvc/knox/trunk/books/1.3.0/book_ui_service_details.md?rev=1863720&r1=1863719&r2=1863720&view=diff
==============================================================================
--- knox/trunk/books/1.3.0/book_ui_service_details.md (original)
+++ knox/trunk/books/1.3.0/book_ui_service_details.md Wed Jul 24 22:23:53 2019
@@ -34,6 +34,7 @@ These are the current Hadoop services wi
* #[Atlas UI]
* #[Zeppelin UI]
* #[Nifi UI]
+* #[Hue UI]
### Assumptions
@@ -463,6 +464,11 @@ Knox also supports secure Zeppelin UIs,
You can use the Apache Knox Gateway to provide authentication access security
for your NiFi services.
+The URL mapping for the NiFi UI is:
+
+| ------- |
-------------------------------------------------------------------------------------
|
+|Gateway |
`https://{gateway-host}:{gateway-port}/{gateway-path}/{topology}/nifi/`
+
The Gateway can be configured for Nifi by modifying the topology XML file.
In the topology XML file, add the following with the correct hostname and port:
@@ -476,4 +482,21 @@ In the topology XML file, add the follow
Note the setting of the useTwoWaySsl param above. Nifi requires mutual
authentication
via SSL and this param tells the dispatch to present a client cert to the
server.
-The above is an example request body to be used to create a Spark session via
Livy server and illustrates the "proxyUser" that requires rewrite.
\ No newline at end of file
+### Hue UI ###
+
+You can use the Apache Knox Gateway to provide authentication access security
for your Hue UI.
+
+The URL mapping for the Hue UI is:
+
+| ------- |
-------------------------------------------------------------------------------------
|
+|Gateway |
`https://{gateway-host}:{gateway-port}/{gateway-path}/{topology}/hue/`
+
+The Gateway can be configured for Hue by modifying the topology XML file.
+
+In the topology XML file, add the following with the correct hostname and port:
+
+ <service>
+ <role>HUE</role>
+ <url><HUE_HTTP_SCHEME>://<HUE_HOST>:<HUE_HTTP_SCHEME_PORT></url>
+ </service>
+
Modified: knox/trunk/books/1.4.0/book_ui_service_details.md
URL:
http://svn.apache.org/viewvc/knox/trunk/books/1.4.0/book_ui_service_details.md?rev=1863720&r1=1863719&r2=1863720&view=diff
==============================================================================
--- knox/trunk/books/1.4.0/book_ui_service_details.md (original)
+++ knox/trunk/books/1.4.0/book_ui_service_details.md Wed Jul 24 22:23:53 2019
@@ -34,6 +34,7 @@ These are the current Hadoop services wi
* #[Atlas UI]
* #[Zeppelin UI]
* #[Nifi UI]
+* #[Hue UI]
### Assumptions
@@ -463,6 +464,11 @@ Knox also supports secure Zeppelin UIs,
You can use the Apache Knox Gateway to provide authentication access security
for your NiFi services.
+The URL mapping for the NiFi UI is:
+
+| ------- |
-------------------------------------------------------------------------------------
|
+|Gateway |
`https://{gateway-host}:{gateway-port}/{gateway-path}/{topology}/nifi/`
+
The Gateway can be configured for Nifi by modifying the topology XML file.
In the topology XML file, add the following with the correct hostname and port:
@@ -476,4 +482,21 @@ In the topology XML file, add the follow
Note the setting of the useTwoWaySsl param above. Nifi requires mutual
authentication
via SSL and this param tells the dispatch to present a client cert to the
server.
-The above is an example request body to be used to create a Spark session via
Livy server and illustrates the "proxyUser" that requires rewrite.
\ No newline at end of file
+### Hue UI ###
+
+You can use the Apache Knox Gateway to provide authentication access security
for your Hue UI.
+
+The URL mapping for the Hue UI is:
+
+| ------- |
-------------------------------------------------------------------------------------
|
+|Gateway |
`https://{gateway-host}:{gateway-port}/{gateway-path}/{topology}/hue/`
+
+The Gateway can be configured for Hue by modifying the topology XML file.
+
+In the topology XML file, add the following with the correct hostname and port:
+
+ <service>
+ <role>HUE</role>
+ <url><HUE_HTTP_SCHEME>://<HUE_HOST>:<HUE_HTTP_SCHEME_PORT></url>
+ </service>
+
