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 2017/05/31 14:00:57 UTC
svn commit: r1797042 - in /knox: site/ site/books/knox-0-10-0/
site/books/knox-0-11-0/ site/books/knox-0-12-0/ site/books/knox-0-4-0/
site/books/knox-0-5-0/ site/books/knox-0-6-0/ site/books/knox-0-7-0/
site/books/knox-0-8-0/ site/books/knox-0-9-0/ sit...
Author: more
Date: Wed May 31 14:00:56 2017
New Revision: 1797042
URL: http://svn.apache.org/viewvc?rev=1797042&view=rev
Log:
KNOX-945 - Documentation for Topology Port Mapping feature
Added:
knox/trunk/books/0.12.0/book_topology_port_mapping.md
Modified:
knox/site/books/knox-0-10-0/deployment-overview.png
knox/site/books/knox-0-10-0/deployment-provider.png
knox/site/books/knox-0-10-0/deployment-service.png
knox/site/books/knox-0-10-0/general_saml_flow.png
knox/site/books/knox-0-10-0/runtime-overview.png
knox/site/books/knox-0-10-0/runtime-request-processing.png
knox/site/books/knox-0-11-0/deployment-overview.png
knox/site/books/knox-0-11-0/deployment-provider.png
knox/site/books/knox-0-11-0/deployment-service.png
knox/site/books/knox-0-11-0/general_saml_flow.png
knox/site/books/knox-0-11-0/runtime-overview.png
knox/site/books/knox-0-11-0/runtime-request-processing.png
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-12-0/user-guide.html
knox/site/books/knox-0-4-0/deployment-overview.png
knox/site/books/knox-0-4-0/deployment-provider.png
knox/site/books/knox-0-4-0/deployment-service.png
knox/site/books/knox-0-4-0/runtime-overview.png
knox/site/books/knox-0-4-0/runtime-request-processing.png
knox/site/books/knox-0-5-0/deployment-overview.png
knox/site/books/knox-0-5-0/deployment-provider.png
knox/site/books/knox-0-5-0/deployment-service.png
knox/site/books/knox-0-5-0/runtime-overview.png
knox/site/books/knox-0-5-0/runtime-request-processing.png
knox/site/books/knox-0-6-0/deployment-overview.png
knox/site/books/knox-0-6-0/deployment-provider.png
knox/site/books/knox-0-6-0/deployment-service.png
knox/site/books/knox-0-6-0/runtime-overview.png
knox/site/books/knox-0-6-0/runtime-request-processing.png
knox/site/books/knox-0-7-0/deployment-overview.png
knox/site/books/knox-0-7-0/deployment-provider.png
knox/site/books/knox-0-7-0/deployment-service.png
knox/site/books/knox-0-7-0/general_saml_flow.png
knox/site/books/knox-0-7-0/runtime-overview.png
knox/site/books/knox-0-7-0/runtime-request-processing.png
knox/site/books/knox-0-8-0/deployment-overview.png
knox/site/books/knox-0-8-0/deployment-provider.png
knox/site/books/knox-0-8-0/deployment-service.png
knox/site/books/knox-0-8-0/general_saml_flow.png
knox/site/books/knox-0-8-0/runtime-overview.png
knox/site/books/knox-0-8-0/runtime-request-processing.png
knox/site/books/knox-0-9-0/deployment-overview.png
knox/site/books/knox-0-9-0/deployment-provider.png
knox/site/books/knox-0-9-0/deployment-service.png
knox/site/books/knox-0-9-0/general_saml_flow.png
knox/site/books/knox-0-9-0/runtime-overview.png
knox/site/books/knox-0-9-0/runtime-request-processing.png
knox/site/books/knox-0-9-1/deployment-overview.png
knox/site/books/knox-0-9-1/deployment-provider.png
knox/site/books/knox-0-9-1/deployment-service.png
knox/site/books/knox-0-9-1/general_saml_flow.png
knox/site/books/knox-0-9-1/runtime-overview.png
knox/site/books/knox-0-9-1/runtime-request-processing.png
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.12.0/book.md
knox/trunk/books/0.12.0/book_gateway-details.md
Modified: knox/site/books/knox-0-10-0/deployment-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-10-0/deployment-overview.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-10-0/deployment-provider.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-10-0/deployment-provider.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-10-0/deployment-service.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-10-0/deployment-service.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-10-0/general_saml_flow.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-10-0/general_saml_flow.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-10-0/runtime-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-10-0/runtime-overview.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-10-0/runtime-request-processing.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-10-0/runtime-request-processing.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-11-0/deployment-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-11-0/deployment-overview.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-11-0/deployment-provider.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-11-0/deployment-provider.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-11-0/deployment-service.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-11-0/deployment-service.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-11-0/general_saml_flow.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-11-0/general_saml_flow.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-11-0/runtime-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-11-0/runtime-overview.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-11-0/runtime-request-processing.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-11-0/runtime-request-processing.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
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=1797042&r1=1797041&r2=1797042&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=1797042&r1=1797041&r2=1797042&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=1797042&r1=1797041&r2=1797042&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=1797042&r1=1797041&r2=1797042&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=1797042&r1=1797041&r2=1797042&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=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-12-0/user-guide.html
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-12-0/user-guide.html?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
--- knox/site/books/knox-0-12-0/user-guide.html (original)
+++ knox/site/books/knox-0-12-0/user-guide.html Wed May 31 14:00:56 2017
@@ -25,7 +25,12 @@
</ul></li>
<li><a href="#Gateway+Details">Gateway Details</a>
<ul>
- <li><a href="#URL+Mapping">URL Mapping</a></li>
+ <li><a href="#URL+Mapping">URL Mapping</a>
+ <ul>
+ <li><a href="#Default+Topology+URLs">Default Topology URLs</a></li>
+ <li><a href="#Fully+Qualified+URLs">Fully Qualified URLs</a></li>
+ <li><a href="#Topology+Port+Mapping">Topology Port Mapping</a></li>
+ </ul></li>
<li><a href="#Configuration">Configuration</a></li>
<li><a href="#Knox+CLI">Knox CLI</a></li>
<li><a href="#Admin+API">Admin API</a></li>
@@ -367,7 +372,23 @@ curl -i -k -u guest:guest-password -X GE
<li>The Knox Demo LDAP Server is started - you can start it from Ambari</li>
<li>Change the hosts and ports within the <code>{GATEWAY_HOME}/conf/topologies/sandbox.xml</code> to reflect your actual cluster service locations.</li>
<li><p>Be sure to use an actual Java JRE to run the sample with something like:</p><p>/usr/jdk64/jdk1.7.0_67/bin/java -jar bin/shell.jar samples/ExampleWebHdfsLs.groovy</p></li>
-</ol><h2><a id="Gateway+Details">Gateway Details</a> <a href="#Gateway+Details"><img src="markbook-section-link.png"/></a></h2><p>This section describes the details of the Knox Gateway itself. Including: </p>
+</ol>
+<!---
+ 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.
+--><h2><a id="Gateway+Details">Gateway Details</a> <a href="#Gateway+Details"><img src="markbook-section-link.png"/></a></h2><p>This section describes the details of the Knox Gateway itself. Including: </p>
<ul>
<li>How URLs are mapped between a gateway that services multiple Hadoop clusters and the clusters themselves</li>
<li>How the gateway is configured through gateway-site.xml and cluster specific topology files</li>
@@ -402,7 +423,23 @@ https://{gateway-host}:{gateway-port}/{g
<li>Gateway: <code>jdbc:hive2://{gateway-host}:{gateway-port}/;ssl=true;sslTrustStore={gateway-trust-store-path};trustStorePassword={gateway-trust-store-password};transportMode=http;httpPath={gateway-path}/{cluster-name}/hive</code></li>
<li>Cluster: <code>http://{hive-host}:10001/cliservice</code></li>
</ul></li>
-</ul><p>The values for <code>{gateway-host}</code>, <code>{gateway-port}</code>, <code>{gateway-path}</code> are provided via the gateway configuration file (i.e. <code>{GATEWAY_HOME}/conf/gateway-site.xml</code>).</p><p>The value for <code>{cluster-name}</code> is derived from the file name of the cluster topology descriptor (e.g. <code>{GATEWAY_HOME}/deployments/{cluster-name}.xml</code>).</p><p>The value for <code>{webhdfs-host}</code>, <code>{webhcat-host}</code>, <code>{oozie-host}</code>, <code>{hbase-host}</code> and <code>{hive-host}</code> are provided via the cluster topology descriptor (e.g. <code>{GATEWAY_HOME}/conf/topologies/{cluster-name}.xml</code>).</p><p>Note: The ports 50070, 50111, 11000, 8080 and 10001 are the defaults for WebHDFS, WebHCat, Oozie, HBase and Hive respectively. Their values can also be provided via the cluster topology descriptor if your Hadoop cluster uses different ports.</p><p>Note: The HBase REST API uses port 8080 by default. This often clash
es with other running services. In the Hortonworks Sandbox Ambari might be running on this port so you might have to change it to a different port (e.g. 60080). </p><h3><a id="Configuration">Configuration</a> <a href="#Configuration"><img src="markbook-section-link.png"/></a></h3><p>Configuration for Apache Knox includes:</p>
+</ul><p>The values for <code>{gateway-host}</code>, <code>{gateway-port}</code>, <code>{gateway-path}</code> are provided via the gateway configuration file (i.e. <code>{GATEWAY_HOME}/conf/gateway-site.xml</code>).</p><p>The value for <code>{cluster-name}</code> is derived from the file name of the cluster topology descriptor (e.g. <code>{GATEWAY_HOME}/deployments/{cluster-name}.xml</code>).</p><p>The value for <code>{webhdfs-host}</code>, <code>{webhcat-host}</code>, <code>{oozie-host}</code>, <code>{hbase-host}</code> and <code>{hive-host}</code> are provided via the cluster topology descriptor (e.g. <code>{GATEWAY_HOME}/conf/topologies/{cluster-name}.xml</code>).</p><p>Note: The ports 50070, 50111, 11000, 8080 and 10001 are the defaults for WebHDFS, WebHCat, Oozie, HBase and Hive respectively. Their values can also be provided via the cluster topology descriptor if your Hadoop cluster uses different ports.</p><p>Note: The HBase REST API uses port 8080 by default. This often clash
es with other running services. In the Hortonworks Sandbox Ambari might be running on this port so you might have to change it to a different port (e.g. 60080). </p><h4><a id="Topology+Port+Mapping">Topology Port Mapping</a> <a href="#Topology+Port+Mapping"><img src="markbook-section-link.png"/></a></h4><p>This feature allows mapping of a topology to a port, as a result one can have a specific topology listening on a configured port. This feature routes URLs to these port-mapped topologies without the additional context that the gateway uses for differentiating from one Hadoop cluster to another, just like the <a href="#Default+Topology+URLs">Default Topology URLs</a> feature, but on a dedicated port. </p><p>The configuration for Topology Port Mapping goes in <code>gateway-site.xml</code> file. The configuration uses the property name and value model to configure the settings for this feature. The format for the property name is <code>gateway.port.mapping.{topologyName}</code> and v
alue is the port number that this topology would listen on. </p><p>In the following example, the topology <code>development</code> will listen on 9443 (if the port is not already taken).</p>
+<pre><code> <property>
+ <name>gateway.port.mapping.development</name>
+ <value>9443</value>
+ <description>Topology and Port mapping</description>
+ </property>
+</code></pre><p>An example of how one can access WebHDFS URL using the above configuration is</p>
+<pre><code> https://{gateway-host}:9443/webhdfs
+ https://{gateway-host}:9443/{gateway-path}/development/webhdfs
+ https://{gateway-host}:{gateway-port}/{gateway-path}/development/webhdfs
+</code></pre><p>All of the above URL will be valid URLs for the above described configuration.</p><p>This feature is turned on by default, to turn it off use the property <code>gateway.port.mapping.enabled</code>. e.g.</p>
+<pre><code> <property>
+ <name>gateway.port.mapping.enabled</name>
+ <value>false</value>
+ <description>Enable/Disable port mapping feature.</description>
+ </property>
+</code></pre><p>If a topology mapped port is in use by another topology or process then an ERROR message is logged and gateway startup continues as normal.</p><h3><a id="Configuration">Configuration</a> <a href="#Configuration"><img src="markbook-section-link.png"/></a></h3><p>Configuration for Apache Knox includes:</p>
<ol>
<li><a href="#Related+Cluster+Configuration">Related Cluster Configuration</a> that must be done within the Hadoop cluster to allow Knox to communicate with various services</li>
<li><a href="#Gateway+Server+Configuration">Gateway Server Configuration</a> - which is the configurable elements of the server itself which applies to behavior that spans all topologies or managed Hadoop clusters</li>
Modified: knox/site/books/knox-0-4-0/deployment-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-4-0/deployment-overview.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-4-0/deployment-provider.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-4-0/deployment-provider.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-4-0/deployment-service.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-4-0/deployment-service.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-4-0/runtime-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-4-0/runtime-overview.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-4-0/runtime-request-processing.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-4-0/runtime-request-processing.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-5-0/deployment-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-5-0/deployment-overview.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-5-0/deployment-provider.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-5-0/deployment-provider.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-5-0/deployment-service.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-5-0/deployment-service.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-5-0/runtime-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-5-0/runtime-overview.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-5-0/runtime-request-processing.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-5-0/runtime-request-processing.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-6-0/deployment-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-6-0/deployment-overview.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-6-0/deployment-provider.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-6-0/deployment-provider.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-6-0/deployment-service.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-6-0/deployment-service.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-6-0/runtime-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-6-0/runtime-overview.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-6-0/runtime-request-processing.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-6-0/runtime-request-processing.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-7-0/deployment-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-7-0/deployment-overview.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-7-0/deployment-provider.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-7-0/deployment-provider.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-7-0/deployment-service.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-7-0/deployment-service.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-7-0/general_saml_flow.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-7-0/general_saml_flow.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-7-0/runtime-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-7-0/runtime-overview.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-7-0/runtime-request-processing.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-7-0/runtime-request-processing.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-8-0/deployment-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-8-0/deployment-overview.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-8-0/deployment-provider.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-8-0/deployment-provider.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-8-0/deployment-service.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-8-0/deployment-service.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-8-0/general_saml_flow.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-8-0/general_saml_flow.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-8-0/runtime-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-8-0/runtime-overview.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-8-0/runtime-request-processing.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-8-0/runtime-request-processing.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-9-0/deployment-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-9-0/deployment-overview.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-9-0/deployment-provider.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-9-0/deployment-provider.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-9-0/deployment-service.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-9-0/deployment-service.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-9-0/general_saml_flow.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-9-0/general_saml_flow.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-9-0/runtime-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-9-0/runtime-overview.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-9-0/runtime-request-processing.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-9-0/runtime-request-processing.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-9-1/deployment-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-9-1/deployment-overview.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-9-1/deployment-provider.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-9-1/deployment-provider.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-9-1/deployment-service.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-9-1/deployment-service.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-9-1/general_saml_flow.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-9-1/general_saml_flow.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-9-1/runtime-overview.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-9-1/runtime-overview.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-9-1/runtime-request-processing.png
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-9-1/runtime-request-processing.png?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/index.html
URL: http://svn.apache.org/viewvc/knox/site/index.html?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
--- knox/site/index.html (original)
+++ knox/site/index.html Wed May 31 14:00:56 2017
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-04-29
+ | Generated by Apache Maven Doxia at 2017-05-31
| 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="20170429" />
+ <meta name="Date-Revision-yyyymmdd" content="20170531" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – 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-04-29</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-05-31</li>
</ul>
</div>
Modified: knox/site/issue-tracking.html
URL: http://svn.apache.org/viewvc/knox/site/issue-tracking.html?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
--- knox/site/issue-tracking.html (original)
+++ knox/site/issue-tracking.html Wed May 31 14:00:56 2017
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-04-29
+ | Generated by Apache Maven Doxia at 2017-05-31
| 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="20170429" />
+ <meta name="Date-Revision-yyyymmdd" content="20170531" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – 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-04-29</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-05-31</li>
</ul>
</div>
Modified: knox/site/license.html
URL: http://svn.apache.org/viewvc/knox/site/license.html?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
--- knox/site/license.html (original)
+++ knox/site/license.html Wed May 31 14:00:56 2017
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-04-29
+ | Generated by Apache Maven Doxia at 2017-05-31
| 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="20170429" />
+ <meta name="Date-Revision-yyyymmdd" content="20170531" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – 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-04-29</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-05-31</li>
</ul>
</div>
Modified: knox/site/mail-lists.html
URL: http://svn.apache.org/viewvc/knox/site/mail-lists.html?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
--- knox/site/mail-lists.html (original)
+++ knox/site/mail-lists.html Wed May 31 14:00:56 2017
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-04-29
+ | Generated by Apache Maven Doxia at 2017-05-31
| 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="20170429" />
+ <meta name="Date-Revision-yyyymmdd" content="20170531" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – 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-04-29</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-05-31</li>
</ul>
</div>
Modified: knox/site/project-info.html
URL: http://svn.apache.org/viewvc/knox/site/project-info.html?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
--- knox/site/project-info.html (original)
+++ knox/site/project-info.html Wed May 31 14:00:56 2017
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-04-29
+ | Generated by Apache Maven Doxia at 2017-05-31
| 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="20170429" />
+ <meta name="Date-Revision-yyyymmdd" content="20170531" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – 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-04-29</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-05-31</li>
</ul>
</div>
Modified: knox/site/team-list.html
URL: http://svn.apache.org/viewvc/knox/site/team-list.html?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
--- knox/site/team-list.html (original)
+++ knox/site/team-list.html Wed May 31 14:00:56 2017
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-04-29
+ | Generated by Apache Maven Doxia at 2017-05-31
| 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="20170429" />
+ <meta name="Date-Revision-yyyymmdd" content="20170531" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – 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-04-29</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-05-31</li>
</ul>
</div>
Modified: knox/trunk/books/0.12.0/book.md
URL: http://svn.apache.org/viewvc/knox/trunk/books/0.12.0/book.md?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
--- knox/trunk/books/0.12.0/book.md (original)
+++ knox/trunk/books/0.12.0/book.md Wed May 31 14:00:56 2017
@@ -33,6 +33,9 @@
* #[Supported Services]
* #[Gateway Details]
* #[URL Mapping]
+ * #[Default Topology URLs]
+ * #[Fully Qualified URLs]
+ * #[Topology Port Mapping]
* #[Configuration]
* #[Knox CLI]
* #[Admin API]
Modified: knox/trunk/books/0.12.0/book_gateway-details.md
URL: http://svn.apache.org/viewvc/knox/trunk/books/0.12.0/book_gateway-details.md?rev=1797042&r1=1797041&r2=1797042&view=diff
==============================================================================
--- knox/trunk/books/0.12.0/book_gateway-details.md (original)
+++ knox/trunk/books/0.12.0/book_gateway-details.md Wed May 31 14:00:56 2017
@@ -13,7 +13,7 @@
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.
---->
+-->
## Gateway Details ##
@@ -78,6 +78,7 @@ Their values can also be provided via th
Note: The HBase REST API uses port 8080 by default. This often clashes with other running services.
In the Hortonworks Sandbox Ambari might be running on this port so you might have to change it to a different port (e.g. 60080).
+<<book_topology_port_mapping.md>>
<<config.md>>
<<knox_cli.md>>
<<admin_api.md>>
Added: knox/trunk/books/0.12.0/book_topology_port_mapping.md
URL: http://svn.apache.org/viewvc/knox/trunk/books/0.12.0/book_topology_port_mapping.md?rev=1797042&view=auto
==============================================================================
--- knox/trunk/books/0.12.0/book_topology_port_mapping.md (added)
+++ knox/trunk/books/0.12.0/book_topology_port_mapping.md Wed May 31 14:00:56 2017
@@ -0,0 +1,36 @@
+#### Topology Port Mapping #####
+This feature allows mapping of a topology to a port, as a result one can have a specific topology listening on a configured port. This feature
+routes URLs to these port-mapped topologies without the additional context that the gateway uses for differentiating from one Hadoop cluster to another,
+just like the #[Default Topology URLs] feature, but on a dedicated port.
+
+The configuration for Topology Port Mapping goes in `gateway-site.xml` file. The configuration uses the property name and value model
+to configure the settings for this feature. The format for the property name is `gateway.port.mapping.{topologyName}` and value is the port number that this
+topology would listen on.
+
+In the following example, the topology `development` will listen on 9443 (if the port is not already taken).
+
+ <property>
+ <name>gateway.port.mapping.development</name>
+ <value>9443</value>
+ <description>Topology and Port mapping</description>
+ </property>
+
+An example of how one can access WebHDFS URL using the above configuration is
+
+ https://{gateway-host}:9443/webhdfs
+ https://{gateway-host}:9443/{gateway-path}/development/webhdfs
+ https://{gateway-host}:{gateway-port}/{gateway-path}/development/webhdfs
+
+All of the above URL will be valid URLs for the above described configuration.
+
+This feature is turned on by default, to turn it off use the property `gateway.port.mapping.enabled`.
+e.g.
+
+ <property>
+ <name>gateway.port.mapping.enabled</name>
+ <value>false</value>
+ <description>Enable/Disable port mapping feature.</description>
+ </property>
+
+If a topology mapped port is in use by another topology or process then an ERROR message is logged and gateway startup continues as normal.
+
\ No newline at end of file