You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@knox.apache.org by pz...@apache.org on 2019/07/25 16:29:49 UTC
svn commit: r1863743 - in /knox: site/books/knox-0-12-0/
site/books/knox-0-13-0/ site/books/knox-0-14-0/ site/books/knox-1-0-0/
site/books/knox-1-1-0/ site/books/knox-1-2-0/ site/books/knox-1-3-0/
site/books/knox-1-3-0/adminui/ site/books/knox-1-4-0/ s...
Author: pzampino
Date: Thu Jul 25 16:29:48 2019
New Revision: 1863743
URL: http://svn.apache.org/viewvc?rev=1863743&view=rev
Log:
Added ClouderaManager discovery content
Added:
knox/site/books/knox-1-3-0/adminui/ok-button.png (with props)
knox/site/books/knox-1-3-0/adminui/save-icon.png (with props)
knox/site/books/knox-1-3-0/adminui/undo-icon.png (with props)
knox/site/books/knox-1-4-0/adminui/ok-button.png (with props)
knox/site/books/knox-1-4-0/adminui/save-icon.png (with props)
knox/site/books/knox-1-4-0/adminui/undo-icon.png (with props)
knox/trunk/books/1.3.0/img/adminui/ok-button.png (with props)
knox/trunk/books/1.3.0/img/adminui/save-icon.png (with props)
knox/trunk/books/1.3.0/img/adminui/undo-icon.png (with props)
knox/trunk/books/1.4.0/img/adminui/ok-button.png (with props)
knox/trunk/books/1.4.0/img/adminui/save-icon.png (with props)
knox/trunk/books/1.4.0/img/adminui/undo-icon.png (with props)
Modified:
knox/site/books/knox-0-12-0/deployment-overview.png
knox/site/books/knox-0-12-0/deployment-provider.png
knox/site/books/knox-0-12-0/deployment-service.png
knox/site/books/knox-0-12-0/general_saml_flow.png
knox/site/books/knox-0-12-0/runtime-overview.png
knox/site/books/knox-0-12-0/runtime-request-processing.png
knox/site/books/knox-0-13-0/deployment-overview.png
knox/site/books/knox-0-13-0/deployment-provider.png
knox/site/books/knox-0-13-0/deployment-service.png
knox/site/books/knox-0-13-0/general_saml_flow.png
knox/site/books/knox-0-13-0/runtime-overview.png
knox/site/books/knox-0-13-0/runtime-request-processing.png
knox/site/books/knox-0-14-0/deployment-overview.png
knox/site/books/knox-0-14-0/deployment-provider.png
knox/site/books/knox-0-14-0/deployment-service.png
knox/site/books/knox-0-14-0/general_saml_flow.png
knox/site/books/knox-0-14-0/runtime-overview.png
knox/site/books/knox-0-14-0/runtime-request-processing.png
knox/site/books/knox-1-0-0/deployment-overview.png
knox/site/books/knox-1-0-0/deployment-provider.png
knox/site/books/knox-1-0-0/deployment-service.png
knox/site/books/knox-1-0-0/general_saml_flow.png
knox/site/books/knox-1-0-0/runtime-overview.png
knox/site/books/knox-1-0-0/runtime-request-processing.png
knox/site/books/knox-1-1-0/deployment-overview.png
knox/site/books/knox-1-1-0/deployment-provider.png
knox/site/books/knox-1-1-0/deployment-service.png
knox/site/books/knox-1-1-0/general_saml_flow.png
knox/site/books/knox-1-1-0/runtime-overview.png
knox/site/books/knox-1-1-0/runtime-request-processing.png
knox/site/books/knox-1-2-0/deployment-overview.png
knox/site/books/knox-1-2-0/deployment-provider.png
knox/site/books/knox-1-2-0/deployment-service.png
knox/site/books/knox-1-2-0/general_saml_flow.png
knox/site/books/knox-1-2-0/runtime-overview.png
knox/site/books/knox-1-2-0/runtime-request-processing.png
knox/site/books/knox-1-3-0/adminui/image17.png
knox/site/books/knox-1-3-0/deployment-overview.png
knox/site/books/knox-1-3-0/deployment-provider.png
knox/site/books/knox-1-3-0/deployment-service.png
knox/site/books/knox-1-3-0/general_saml_flow.png
knox/site/books/knox-1-3-0/runtime-overview.png
knox/site/books/knox-1-3-0/runtime-request-processing.png
knox/site/books/knox-1-3-0/user-guide.html
knox/site/books/knox-1-4-0/adminui/image17.png
knox/site/books/knox-1-4-0/deployment-overview.png
knox/site/books/knox-1-4-0/deployment-provider.png
knox/site/books/knox-1-4-0/deployment-service.png
knox/site/books/knox-1-4-0/general_saml_flow.png
knox/site/books/knox-1-4-0/runtime-overview.png
knox/site/books/knox-1-4-0/runtime-request-processing.png
knox/site/books/knox-1-4-0/user-guide.html
knox/trunk/books/1.3.0/admin_ui.md
knox/trunk/books/1.3.0/img/adminui/image17.png
knox/trunk/books/1.4.0/admin_ui.md
knox/trunk/books/1.4.0/img/adminui/image17.png
Modified: knox/site/books/knox-0-12-0/deployment-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-12-0/deployment-overview.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-12-0/deployment-provider.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-12-0/deployment-provider.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-12-0/deployment-service.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-12-0/deployment-service.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-12-0/general_saml_flow.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-12-0/general_saml_flow.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-12-0/runtime-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-12-0/runtime-overview.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-12-0/runtime-request-processing.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-12-0/runtime-request-processing.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-13-0/deployment-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-13-0/deployment-overview.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-13-0/deployment-provider.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-13-0/deployment-provider.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-13-0/deployment-service.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-13-0/deployment-service.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-13-0/general_saml_flow.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-13-0/general_saml_flow.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-13-0/runtime-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-13-0/runtime-overview.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-13-0/runtime-request-processing.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-13-0/runtime-request-processing.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-14-0/deployment-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-14-0/deployment-overview.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-14-0/deployment-provider.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-14-0/deployment-provider.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-14-0/deployment-service.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-14-0/deployment-service.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-14-0/general_saml_flow.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-14-0/general_saml_flow.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-14-0/runtime-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-14-0/runtime-overview.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-14-0/runtime-request-processing.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-14-0/runtime-request-processing.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-0-0/deployment-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-0-0/deployment-overview.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-0-0/deployment-provider.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-0-0/deployment-provider.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-0-0/deployment-service.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-0-0/deployment-service.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-0-0/general_saml_flow.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-0-0/general_saml_flow.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-0-0/runtime-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-0-0/runtime-overview.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-0-0/runtime-request-processing.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-0-0/runtime-request-processing.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-1-0/deployment-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-1-0/deployment-overview.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-1-0/deployment-provider.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-1-0/deployment-provider.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-1-0/deployment-service.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-1-0/deployment-service.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-1-0/general_saml_flow.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-1-0/general_saml_flow.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-1-0/runtime-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-1-0/runtime-overview.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-1-0/runtime-request-processing.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-1-0/runtime-request-processing.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-2-0/deployment-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-2-0/deployment-overview.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-2-0/deployment-provider.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-2-0/deployment-provider.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-2-0/deployment-service.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-2-0/deployment-service.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-2-0/general_saml_flow.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-2-0/general_saml_flow.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-2-0/runtime-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-2-0/runtime-overview.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-2-0/runtime-request-processing.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-2-0/runtime-request-processing.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-3-0/adminui/image17.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-3-0/adminui/image17.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Added: knox/site/books/knox-1-3-0/adminui/ok-button.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-3-0/adminui/ok-button.png?rev=1863743&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/site/books/knox-1-3-0/adminui/ok-button.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: knox/site/books/knox-1-3-0/adminui/save-icon.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-3-0/adminui/save-icon.png?rev=1863743&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/site/books/knox-1-3-0/adminui/save-icon.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: knox/site/books/knox-1-3-0/adminui/undo-icon.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-3-0/adminui/undo-icon.png?rev=1863743&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/site/books/knox-1-3-0/adminui/undo-icon.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: knox/site/books/knox-1-3-0/deployment-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-3-0/deployment-overview.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-3-0/deployment-provider.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-3-0/deployment-provider.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-3-0/deployment-service.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-3-0/deployment-service.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-3-0/general_saml_flow.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-3-0/general_saml_flow.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-3-0/runtime-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-3-0/runtime-overview.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-3-0/runtime-request-processing.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-3-0/runtime-request-processing.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
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=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
--- knox/site/books/knox-1-3-0/user-guide.html (original)
+++ knox/site/books/knox-1-3-0/user-guide.html Thu Jul 25 16:29:48 2019
@@ -1234,7 +1234,7 @@ ip-10-39-107-209.ec2.internal
</ul>
<p>Be sure to pay extra attention when sharing HA Provider configuration across topologies.</p>
<h5><a id="Simplified+Descriptor+Files">Simplified Descriptor Files</a> <a href="#Simplified+Descriptor+Files"><img src="markbook-section-link.png"/></a></h5>
-<p>Simplified descriptors allow service URLs to be defined explicitly, just like full topology descriptors. However, if URLs are omitted for a service, Knox will attempt to discover that service’s URLs from the Hadoop cluster. Currently, this behavior is only supported for clusters managed by Ambari. In any case, the simplified descriptors are much more concise than a full topology descriptor.</p>
+<p>Simplified descriptors allow service URLs to be defined explicitly, just like full topology descriptors. However, if URLs are omitted for a service, Knox will attempt to discover that service’s URLs from the Hadoop cluster. Currently, this behavior is only supported for clusters managed by Apache Ambari or Cloudera Manager. In any case, the simplified descriptors are much more concise than a full topology descriptor.</p>
<p><em>Descriptor Properties</em></p>
<table>
<thead>
@@ -1246,7 +1246,7 @@ ip-10-39-107-209.ec2.internal
<tbody>
<tr>
<td><code>discovery-type</code></td>
- <td>The discovery source type. (Currently, the only supported type is <code>AMBARI</code>).</td>
+ <td>The discovery source type. (Currently, the only supported types are <code>AMBARI</code> and <code>ClouderaManager</code>).</td>
</tr>
<tr>
<td><code>discovery-address</code></td>
@@ -1254,11 +1254,11 @@ ip-10-39-107-209.ec2.internal
</tr>
<tr>
<td><code>discovery-user</code></td>
- <td>The username with permission to access the discovery source. If omitted, then Knox will check for an alias named <code>ambari.discovery.user</code>, and use its value if defined.</td>
+ <td>The username with permission to access the discovery source. Optional, if the discovery type supports default credential aliases.</td>
</tr>
<tr>
<td><code>discovery-pwd-alias</code></td>
- <td>The alias of the password for the user with permission to access the discovery source. If omitted, then Knox will check for an alias named <code>ambari.discovery.password</code>, and use its value if defined.</td>
+ <td>The alias of the password for the user with permission to access the discovery source. Optional, if the discovery type supports default credential aliases.</td>
</tr>
<tr>
<td><code>provider-config-ref</code></td>
@@ -1355,7 +1355,10 @@ services:
]
}
</code></pre>
-<p>Both of these examples illustrate the specification of credentials for the interaction with Ambari. If no credentials are specified, then the default aliases are queried. Use of the default aliases is sufficient for scenarios where topology discovery will only interact with a single Ambari instance. For multiple Ambari instances however, it’s most likely that each will require different sets of credentials. The discovery-user and discovery-pwd-alias properties exist for this purpose. Note that whether using the default credential aliases or specifying a custom password alias, these <a href="#Alias+creation">aliases must be defined</a> prior to any attempt to deploy a topology using a simplified descriptor.</p>
+<p>Both of these examples illustrate the specification of credentials for the interaction with the discovery source. If no credentials are specified, then the default aliases are queried (if default aliases are supported for that discovery type). Use of the default aliases is sufficient for scenarios where Knox will only discover topology details from a single source. For multiple discovery sources however, it’s most likely that each will require different sets of credentials. The discovery-user and discovery-pwd-alias properties exist for this purpose. Note that whether using the default credential aliases or specifying a custom password alias, these <a href="#Alias+creation">aliases must be defined</a> prior to any attempt to deploy a topology using a simplified descriptor.</p>
+<h5><a id="Cluster+Discovery+Provider+Extensions">Cluster Discovery Provider Extensions</a> <a href="#Cluster+Discovery+Provider+Extensions"><img src="markbook-section-link.png"/></a></h5>
+<p>To support the ability to dynamically discover the endpoints for services being proxied, Knox provides cluster discovery provider extensions for Apache Ambari and Cloudera Manager. The Ambari support has been available since Knox 1.1.0, and limited support for Cloudera Manager has been added in Knox 1.3.0.</p>
+<p>These extensions allow discovery sources of the respective types to be queried for cluster details used to generate topologies from <a href="#Simplified+Descriptor+Files">simplified descriptors</a>. The extension to be employed is specified on a per-descriptor basis, using the <code>discovery-type</code> descriptor property.</p>
<h5><a id="Deployment+Directories">Deployment Directories</a> <a href="#Deployment+Directories"><img src="markbook-section-link.png"/></a></h5>
<p>Effecting topology changes is as simple as modifying files in two specific directories.</p>
<p>The <code>{GATEWAY_HOME}/conf/shared-providers/</code> directory is the location where Knox looks for provider configurations. This directory is monitored for changes, such that modifying a provider configuration file therein will trigger updates to any referencing simplified descriptors in the <code>{GATEWAY_HOME}/conf/descriptors/</code> directory. <em>Care should be taken when deleting these files if there are referencing descriptors; any subsequent modifications of referencing descriptors will fail when the deleted provider configuration cannot be found. The references should all be modified before deleting the provider configuration.</em></p>
@@ -1366,7 +1369,7 @@ services:
<h5><a id="Cloud+Federation+Configuration">Cloud Federation Configuration</a> <a href="#Cloud+Federation+Configuration"><img src="markbook-section-link.png"/></a></h5>
<p>Cloud Federation feature allows for a topology based federation from one Knox instance to another (from on-prem Knox instance to cloud knox instance).</p>
<h5><a id="Cluster+Configuration+Monitoring">Cluster Configuration Monitoring</a> <a href="#Cluster+Configuration+Monitoring"><img src="markbook-section-link.png"/></a></h5>
-<p>Another benefit gained through the use of simplified topology descriptors, and the associated service discovery, is the ability to monitor clusters for configuration changes. <strong>Like service discovery, this is currently only available for clusters managed by Ambari.</strong></p>
+<p>Another benefit gained through the use of simplified topology descriptors, and the associated service discovery, is the ability to monitor clusters for configuration changes. <strong>This is currently only available for clusters managed by Ambari.</strong></p>
<p>The gateway can monitor Ambari cluster configurations, and respond to changes by dynamically regenerating and redeploying the affected topologies. The following properties in gateway-site.xml can be used to control this behavior.</p>
<pre><code><property>
<name>gateway.cluster.config.monitor.ambari.enabled</name>
@@ -9129,17 +9132,19 @@ curl -i -k -u username:password -H "
<img src="adminui/image15.png" style="width:6.5in;height:3.82361in" />
<p>The provider configuration reference can entered manually, or the provider configuration selector can be used, to specify the name of an existing provider configuration.</p>
<img src="adminui/image16.png" style="width:6.5in;height:3.88125in" />
-<p>Optionally, discovery details can also be specified to direct Knox to discover the endpoints for the declared service roles from the Ambari-managed target cluster.</p>
+<p>Optionally, discovery details can also be specified to direct Knox to discover the endpoints for the declared service roles from a supported discovery source for the target cluster.</p>
<img src="adminui/image17.png" style="width:6.5in;height:5.24167in" />
<p>Choosing <img src="adminui/ok-button.png" style="height:24px;vertical-align:bottom"/> results in the persistence of the descriptor, and subsequently, the generation and deployment of the associated topology.</p>
<h6><a id="Service+Discovery">Service Discovery</a> <a href="#Service+Discovery"><img src="markbook-section-link.png"/></a></h6>
-<p>Descriptors are a means to <em>declaratively</em> specify which services should be proxied by a particular topology, allowing Knox to interrogate Ambari to determine the endpoint URLs for those declared services. The Service Discovery options tell Knox how to connect to the desired Ambari cluster to perform this endpoint discovery.</p>
+<p>Descriptors are a means to <em>declaratively</em> specify which services should be proxied by a particular topology, allowing Knox to interrogate a discovery source to determine the endpoint URLs for those declared services. The Service Discovery options tell Knox how to connect to the desired discovery source to perform this endpoint discovery.</p>
+<p><em>Type</em></p>
+<p>This property specifies the type of discovery source for the cluster hosting the services whose endpoints are to be discovered.</p>
<p><em>Address</em></p>
-<p>This property specifies the address of the Ambari instance managing the cluster hosting the services whose endpoints are to be discovered.</p>
+<p>This property specifies the address of the discovery source managing the cluster hosting the services whose endpoints are to be discovered.</p>
<p><em>Cluster</em></p>
-<p>This property specifies from which of the clusters, among those being managed by the specified Ambari instance, the service endpoints should be determined.</p>
+<p>This property specifies from which of the clusters, among those being managed by the specified discovery source, the service endpoints should be determined.</p>
<p><em>Username</em></p>
-<p>This is the identity of the Ambari user (assigned at least the <em>Cluster User</em> role), which will be used to get service configuration details from Ambari.</p>
+<p>This is the identity of the discovery source user (e.g., Ambari <em>Cluster User</em> role), which will be used to get service configuration details from the discovery source.</p>
<p><em>Password Alias</em></p>
<p>This is the Knox alias whose value is the password associated with the specified username.</p>
<p>This alias must have been defined prior to specifying it in a descriptor, or else the service discovery will fail for authentication reasons.</p>
Modified: knox/site/books/knox-1-4-0/adminui/image17.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/adminui/image17.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Added: knox/site/books/knox-1-4-0/adminui/ok-button.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/adminui/ok-button.png?rev=1863743&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/site/books/knox-1-4-0/adminui/ok-button.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: knox/site/books/knox-1-4-0/adminui/save-icon.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/adminui/save-icon.png?rev=1863743&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/site/books/knox-1-4-0/adminui/save-icon.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: knox/site/books/knox-1-4-0/adminui/undo-icon.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/adminui/undo-icon.png?rev=1863743&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/site/books/knox-1-4-0/adminui/undo-icon.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: knox/site/books/knox-1-4-0/deployment-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/deployment-overview.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-4-0/deployment-provider.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/deployment-provider.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-4-0/deployment-service.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/deployment-service.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-4-0/general_saml_flow.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/general_saml_flow.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-4-0/runtime-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/runtime-overview.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-4-0/runtime-request-processing.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/runtime-request-processing.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
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=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
--- knox/site/books/knox-1-4-0/user-guide.html (original)
+++ knox/site/books/knox-1-4-0/user-guide.html Thu Jul 25 16:29:48 2019
@@ -1234,7 +1234,7 @@ ip-10-39-107-209.ec2.internal
</ul>
<p>Be sure to pay extra attention when sharing HA Provider configuration across topologies.</p>
<h5><a id="Simplified+Descriptor+Files">Simplified Descriptor Files</a> <a href="#Simplified+Descriptor+Files"><img src="markbook-section-link.png"/></a></h5>
-<p>Simplified descriptors allow service URLs to be defined explicitly, just like full topology descriptors. However, if URLs are omitted for a service, Knox will attempt to discover that service’s URLs from the Hadoop cluster. Currently, this behavior is only supported for clusters managed by Ambari. In any case, the simplified descriptors are much more concise than a full topology descriptor.</p>
+<p>Simplified descriptors allow service URLs to be defined explicitly, just like full topology descriptors. However, if URLs are omitted for a service, Knox will attempt to discover that service’s URLs from the Hadoop cluster. Currently, this behavior is only supported for clusters managed by Apache Ambari or Cloudera Manager. In any case, the simplified descriptors are much more concise than a full topology descriptor.</p>
<p><em>Descriptor Properties</em></p>
<table>
<thead>
@@ -1246,7 +1246,7 @@ ip-10-39-107-209.ec2.internal
<tbody>
<tr>
<td><code>discovery-type</code></td>
- <td>The discovery source type. (Currently, the only supported type is <code>AMBARI</code>).</td>
+ <td>The discovery source type. (Currently, the only supported types are <code>AMBARI</code> and <code>ClouderaManager</code>).</td>
</tr>
<tr>
<td><code>discovery-address</code></td>
@@ -1254,11 +1254,11 @@ ip-10-39-107-209.ec2.internal
</tr>
<tr>
<td><code>discovery-user</code></td>
- <td>The username with permission to access the discovery source. If omitted, then Knox will check for an alias named <code>ambari.discovery.user</code>, and use its value if defined.</td>
+ <td>The username with permission to access the discovery source. Optional, if the discovery type supports default credential aliases.</td>
</tr>
<tr>
<td><code>discovery-pwd-alias</code></td>
- <td>The alias of the password for the user with permission to access the discovery source. If omitted, then Knox will check for an alias named <code>ambari.discovery.password</code>, and use its value if defined.</td>
+ <td>The alias of the password for the user with permission to access the discovery source. Optional, if the discovery type supports default credential aliases.</td>
</tr>
<tr>
<td><code>provider-config-ref</code></td>
@@ -1355,7 +1355,10 @@ services:
]
}
</code></pre>
-<p>Both of these examples illustrate the specification of credentials for the interaction with Ambari. If no credentials are specified, then the default aliases are queried. Use of the default aliases is sufficient for scenarios where topology discovery will only interact with a single Ambari instance. For multiple Ambari instances however, it’s most likely that each will require different sets of credentials. The discovery-user and discovery-pwd-alias properties exist for this purpose. Note that whether using the default credential aliases or specifying a custom password alias, these <a href="#Alias+creation">aliases must be defined</a> prior to any attempt to deploy a topology using a simplified descriptor.</p>
+<p>Both of these examples illustrate the specification of credentials for the interaction with the discovery source. If no credentials are specified, then the default aliases are queried (if default aliases are supported for that discovery type). Use of the default aliases is sufficient for scenarios where Knox will only discover topology details from a single source. For multiple discovery sources however, it’s most likely that each will require different sets of credentials. The discovery-user and discovery-pwd-alias properties exist for this purpose. Note that whether using the default credential aliases or specifying a custom password alias, these <a href="#Alias+creation">aliases must be defined</a> prior to any attempt to deploy a topology using a simplified descriptor.</p>
+<h5><a id="Cluster+Discovery+Provider+Extensions">Cluster Discovery Provider Extensions</a> <a href="#Cluster+Discovery+Provider+Extensions"><img src="markbook-section-link.png"/></a></h5>
+<p>To support the ability to dynamically discover the endpoints for services being proxied, Knox provides cluster discovery provider extensions for Apache Ambari and Cloudera Manager. The Ambari support has been available since Knox 1.1.0, and limited support for Cloudera Manager has been added in Knox 1.3.0.</p>
+<p>These extensions allow discovery sources of the respective types to be queried for cluster details used to generate topologies from <a href="#Simplified+Descriptor+Files">simplified descriptors</a>. The extension to be employed is specified on a per-descriptor basis, using the <code>discovery-type</code> descriptor property.</p>
<h5><a id="Deployment+Directories">Deployment Directories</a> <a href="#Deployment+Directories"><img src="markbook-section-link.png"/></a></h5>
<p>Effecting topology changes is as simple as modifying files in two specific directories.</p>
<p>The <code>{GATEWAY_HOME}/conf/shared-providers/</code> directory is the location where Knox looks for provider configurations. This directory is monitored for changes, such that modifying a provider configuration file therein will trigger updates to any referencing simplified descriptors in the <code>{GATEWAY_HOME}/conf/descriptors/</code> directory. <em>Care should be taken when deleting these files if there are referencing descriptors; any subsequent modifications of referencing descriptors will fail when the deleted provider configuration cannot be found. The references should all be modified before deleting the provider configuration.</em></p>
@@ -1366,7 +1369,7 @@ services:
<h5><a id="Cloud+Federation+Configuration">Cloud Federation Configuration</a> <a href="#Cloud+Federation+Configuration"><img src="markbook-section-link.png"/></a></h5>
<p>Cloud Federation feature allows for a topology based federation from one Knox instance to another (from on-prem Knox instance to cloud knox instance).</p>
<h5><a id="Cluster+Configuration+Monitoring">Cluster Configuration Monitoring</a> <a href="#Cluster+Configuration+Monitoring"><img src="markbook-section-link.png"/></a></h5>
-<p>Another benefit gained through the use of simplified topology descriptors, and the associated service discovery, is the ability to monitor clusters for configuration changes. <strong>Like service discovery, this is currently only available for clusters managed by Ambari.</strong></p>
+<p>Another benefit gained through the use of simplified topology descriptors, and the associated service discovery, is the ability to monitor clusters for configuration changes. <strong>This is currently only available for clusters managed by Ambari.</strong></p>
<p>The gateway can monitor Ambari cluster configurations, and respond to changes by dynamically regenerating and redeploying the affected topologies. The following properties in gateway-site.xml can be used to control this behavior.</p>
<pre><code><property>
<name>gateway.cluster.config.monitor.ambari.enabled</name>
@@ -9129,17 +9132,19 @@ curl -i -k -u username:password -H "
<img src="adminui/image15.png" style="width:6.5in;height:3.82361in" />
<p>The provider configuration reference can entered manually, or the provider configuration selector can be used, to specify the name of an existing provider configuration.</p>
<img src="adminui/image16.png" style="width:6.5in;height:3.88125in" />
-<p>Optionally, discovery details can also be specified to direct Knox to discover the endpoints for the declared service roles from the Ambari-managed target cluster.</p>
+<p>Optionally, discovery details can also be specified to direct Knox to discover the endpoints for the declared service roles from a supported discovery source for the target cluster.</p>
<img src="adminui/image17.png" style="width:6.5in;height:5.24167in" />
<p>Choosing <img src="adminui/ok-button.png" style="height:24px;vertical-align:bottom"/> results in the persistence of the descriptor, and subsequently, the generation and deployment of the associated topology.</p>
<h6><a id="Service+Discovery">Service Discovery</a> <a href="#Service+Discovery"><img src="markbook-section-link.png"/></a></h6>
-<p>Descriptors are a means to <em>declaratively</em> specify which services should be proxied by a particular topology, allowing Knox to interrogate Ambari to determine the endpoint URLs for those declared services. The Service Discovery options tell Knox how to connect to the desired Ambari cluster to perform this endpoint discovery.</p>
+<p>Descriptors are a means to <em>declaratively</em> specify which services should be proxied by a particular topology, allowing Knox to interrogate a discovery source to determine the endpoint URLs for those declared services. The Service Discovery options tell Knox how to connect to the desired discovery source to perform this endpoint discovery.</p>
+<p><em>Type</em></p>
+<p>This property specifies the type of discovery source for the cluster hosting the services whose endpoints are to be discovered.</p>
<p><em>Address</em></p>
-<p>This property specifies the address of the Ambari instance managing the cluster hosting the services whose endpoints are to be discovered.</p>
+<p>This property specifies the address of the discovery source managing the cluster hosting the services whose endpoints are to be discovered.</p>
<p><em>Cluster</em></p>
-<p>This property specifies from which of the clusters, among those being managed by the specified Ambari instance, the service endpoints should be determined.</p>
+<p>This property specifies from which of the clusters, among those being managed by the specified discovery source, the service endpoints should be determined.</p>
<p><em>Username</em></p>
-<p>This is the identity of the Ambari user (assigned at least the <em>Cluster User</em> role), which will be used to get service configuration details from Ambari.</p>
+<p>This is the identity of the discovery source user (e.g., Ambari <em>Cluster User</em> role), which will be used to get service configuration details from the discovery source.</p>
<p><em>Password Alias</em></p>
<p>This is the Knox alias whose value is the password associated with the specified username.</p>
<p>This alias must have been defined prior to specifying it in a descriptor, or else the service discovery will fail for authentication reasons.</p>
Modified: knox/trunk/books/1.3.0/admin_ui.md
URL: http://svn.apache.org/viewvc/knox/trunk/books/1.3.0/admin_ui.md?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
--- knox/trunk/books/1.3.0/admin_ui.md (original)
+++ knox/trunk/books/1.3.0/admin_ui.md Thu Jul 25 16:29:48 2019
@@ -149,7 +149,7 @@ existing provider configuration.
<img src="adminui/image16.png" style="width:6.5in;height:3.88125in" />
-Optionally, discovery details can also be specified to direct Knox to discover the endpoints for the declared service roles from the Ambari-managed
+Optionally, discovery details can also be specified to direct Knox to discover the endpoints for the declared service roles from a supported discovery source for the
target cluster.
<img src="adminui/image17.png" style="width:6.5in;height:5.24167in" />
@@ -158,21 +158,25 @@ Choosing <img src="adminui/ok-button.png
###### Service Discovery
-Descriptors are a means to *declaratively* specify which services should be proxied by a particular topology, allowing Knox to interrogate Ambari
-to determine the endpoint URLs for those declared services. The Service Discovery options tell Knox how to connect to the desired Ambari cluster
+Descriptors are a means to *declaratively* specify which services should be proxied by a particular topology, allowing Knox to interrogate a discovery source
+to determine the endpoint URLs for those declared services. The Service Discovery options tell Knox how to connect to the desired discovery source
to perform this endpoint discovery.
+*Type*
+
+This property specifies the type of discovery source for the cluster hosting the services whose endpoints are to be discovered.
+
*Address*
-This property specifies the address of the Ambari instance managing the cluster hosting the services whose endpoints are to be discovered.
+This property specifies the address of the discovery source managing the cluster hosting the services whose endpoints are to be discovered.
*Cluster*
-This property specifies from which of the clusters, among those being managed by the specified Ambari instance, the service endpoints should be determined.
+This property specifies from which of the clusters, among those being managed by the specified discovery source, the service endpoints should be determined.
*Username*
-This is the identity of the Ambari user (assigned at least the *Cluster User* role), which will be used to get service configuration details from Ambari.
+This is the identity of the discovery source user (e.g., Ambari *Cluster User* role), which will be used to get service configuration details from the discovery source.
*Password Alias*
Modified: knox/trunk/books/1.3.0/img/adminui/image17.png
URL: http://svn.apache.org/viewvc/knox/trunk/books/1.3.0/img/adminui/image17.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Added: knox/trunk/books/1.3.0/img/adminui/ok-button.png
URL: http://svn.apache.org/viewvc/knox/trunk/books/1.3.0/img/adminui/ok-button.png?rev=1863743&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/trunk/books/1.3.0/img/adminui/ok-button.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: knox/trunk/books/1.3.0/img/adminui/save-icon.png
URL: http://svn.apache.org/viewvc/knox/trunk/books/1.3.0/img/adminui/save-icon.png?rev=1863743&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/trunk/books/1.3.0/img/adminui/save-icon.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: knox/trunk/books/1.3.0/img/adminui/undo-icon.png
URL: http://svn.apache.org/viewvc/knox/trunk/books/1.3.0/img/adminui/undo-icon.png?rev=1863743&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/trunk/books/1.3.0/img/adminui/undo-icon.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: knox/trunk/books/1.4.0/admin_ui.md
URL: http://svn.apache.org/viewvc/knox/trunk/books/1.4.0/admin_ui.md?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
--- knox/trunk/books/1.4.0/admin_ui.md (original)
+++ knox/trunk/books/1.4.0/admin_ui.md Thu Jul 25 16:29:48 2019
@@ -149,7 +149,7 @@ existing provider configuration.
<img src="adminui/image16.png" style="width:6.5in;height:3.88125in" />
-Optionally, discovery details can also be specified to direct Knox to discover the endpoints for the declared service roles from the Ambari-managed
+Optionally, discovery details can also be specified to direct Knox to discover the endpoints for the declared service roles from a supported discovery source for the
target cluster.
<img src="adminui/image17.png" style="width:6.5in;height:5.24167in" />
@@ -158,21 +158,25 @@ Choosing <img src="adminui/ok-button.png
###### Service Discovery
-Descriptors are a means to *declaratively* specify which services should be proxied by a particular topology, allowing Knox to interrogate Ambari
-to determine the endpoint URLs for those declared services. The Service Discovery options tell Knox how to connect to the desired Ambari cluster
+Descriptors are a means to *declaratively* specify which services should be proxied by a particular topology, allowing Knox to interrogate a discovery source
+to determine the endpoint URLs for those declared services. The Service Discovery options tell Knox how to connect to the desired discovery source
to perform this endpoint discovery.
+*Type*
+
+This property specifies the type of discovery source for the cluster hosting the services whose endpoints are to be discovered.
+
*Address*
-This property specifies the address of the Ambari instance managing the cluster hosting the services whose endpoints are to be discovered.
+This property specifies the address of the discovery source managing the cluster hosting the services whose endpoints are to be discovered.
*Cluster*
-This property specifies from which of the clusters, among those being managed by the specified Ambari instance, the service endpoints should be determined.
+This property specifies from which of the clusters, among those being managed by the specified discovery source, the service endpoints should be determined.
*Username*
-This is the identity of the Ambari user (assigned at least the *Cluster User* role), which will be used to get service configuration details from Ambari.
+This is the identity of the discovery source user (e.g., Ambari *Cluster User* role), which will be used to get service configuration details from the discovery source.
*Password Alias*
Modified: knox/trunk/books/1.4.0/img/adminui/image17.png
URL: http://svn.apache.org/viewvc/knox/trunk/books/1.4.0/img/adminui/image17.png?rev=1863743&r1=1863742&r2=1863743&view=diff
==============================================================================
Binary files - no diff available.
Added: knox/trunk/books/1.4.0/img/adminui/ok-button.png
URL: http://svn.apache.org/viewvc/knox/trunk/books/1.4.0/img/adminui/ok-button.png?rev=1863743&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/trunk/books/1.4.0/img/adminui/ok-button.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: knox/trunk/books/1.4.0/img/adminui/save-icon.png
URL: http://svn.apache.org/viewvc/knox/trunk/books/1.4.0/img/adminui/save-icon.png?rev=1863743&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/trunk/books/1.4.0/img/adminui/save-icon.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: knox/trunk/books/1.4.0/img/adminui/undo-icon.png
URL: http://svn.apache.org/viewvc/knox/trunk/books/1.4.0/img/adminui/undo-icon.png?rev=1863743&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/trunk/books/1.4.0/img/adminui/undo-icon.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream