Author: more
Date: Wed May 31 17:29:47 2017
New Revision: 1797082
URL: http://svn.apache.org/viewvc?rev=1797082&view=rev
Log:
KNOX-945 - Removed Topology Port Mapping doc from 0.12.0 and added it to new
0.13.0 doc
Modified:
knox/site/books/knox-0-12-0/user-guide.html
knox/trunk/books/0.12.0/book.md
knox/trunk/books/0.12.0/book_gateway-details.md
knox/trunk/build.xml
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=1797082&r1=1797081&r2=1797082&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 17:29:47 2017
@@ -29,7 +29,6 @@
<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>
@@ -423,23 +422,7 @@ 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><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>
+</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>
<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/trunk/books/0.12.0/book.md
URL:
http://svn.apache.org/viewvc/knox/trunk/books/0.12.0/book.md?rev=1797082&r1=1797081&r2=1797082&view=diff
==============================================================================
--- knox/trunk/books/0.12.0/book.md (original)
+++ knox/trunk/books/0.12.0/book.md Wed May 31 17:29:47 2017
@@ -35,7 +35,6 @@
* #[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=1797082&r1=1797081&r2=1797082&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 17:29:47 2017
@@ -78,7 +78,6 @@ 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>>
Modified: knox/trunk/build.xml
URL:
http://svn.apache.org/viewvc/knox/trunk/build.xml?rev=1797082&r1=1797081&r2=1797082&view=diff
==============================================================================
--- knox/trunk/build.xml (original)
+++ knox/trunk/build.xml Wed May 31 17:29:47 2017
@@ -39,7 +39,8 @@
<property name="book-0-9-1-dir"
value="${book-target}/${gateway-artifact}-0-9-1"/>
<property name="book-0-10-0-dir"
value="${book-target}/${gateway-artifact}-0-10-0"/>
<property name="book-0-11-0-dir"
value="${book-target}/${gateway-artifact}-0-11-0"/>
- <property name="book-0-12-0-dir"
value="${book-target}/${gateway-artifact}-0-12-0"/>
+ <property name="book-0-12-0-dir"
value="${book-target}/${gateway-artifact}-0-12-0"/>
+ <property name="book-0-13-0-dir"
value="${book-target}/${gateway-artifact}-0-13-0"/>
<property name="svn.release.path"
value="https://dist.apache.org/repos/dist/release/incubator/${gateway-project}";
/>
<property name="svn.staging.path"
value="https://dist.apache.org/repos/dist/dev/incubator/${gateway-project}"; />
@@ -88,7 +89,7 @@
</target>
<target name="books" depends="markbook,_books"/>
- <target name="_books"
depends="_book-0-3-0,_book-0-4-0,_book-0-5-0,_book-0-6-0,_book-0-7-0,_book-0-8-0,_book-0-9-0,_book-0-9-1,_book-0-10-0,_book-0-11-0,_book-0-12-0"/>
+ <target name="_books"
depends="_book-0-3-0,_book-0-4-0,_book-0-5-0,_book-0-6-0,_book-0-7-0,_book-0-8-0,_book-0-9-0,_book-0-9-1,_book-0-10-0,_book-0-11-0,_book-0-12-0,_book-0-13-0"/>
<target name="_book-0-3-0" depends="init">
<delete dir="${book-target}/${gateway-artifact}-0-3-0"
includes="**/*.html,**/*.css,**/*.png"/>
<java jar="markbook/target/markbook.jar" fork="true"
failonerror="true">
@@ -267,6 +268,24 @@
<fileset dir="books/static"/>
</copy>
</target>
+ <target name="_book-0-13-0" depends="init">
+ <delete dir="${book-target}/${gateway-artifact}-0-13-0"
includes="**/*.html,**/*.css,**/*.png"/>
+ <java jar="markbook/target/markbook.jar" fork="true"
failonerror="true">
+ <arg value="-i"/><arg value="books/0.13.0/book.md"/>
+ <arg value="-o"/><arg value="${book-0-13-0-dir}/user-guide.html"/>
+ </java>
+ <java jar="markbook/target/markbook.jar" fork="true"
failonerror="true">
+ <arg value="-i"/><arg value="books/0.13.0/dev-guide/book.md"/>
+ <arg value="-o"/><arg value="${book-0-13-0-dir}/dev-guide.html"/>
+ </java>
+ <java jar="markbook/target/markbook.jar" fork="true"
failonerror="true">
+ <arg value="-i"/><arg
value="books/0.13.0/dev-guide/knoxsso_integration.md"/>
+ <arg value="-o"/><arg
value="${book-0-13-0-dir}/knoxsso_integration.html"/>
+ </java>
+ <copy todir="${book-target}/${gateway-artifact}-0-13-0">
+ <fileset dir="books/static"/>
+ </copy>
+ </target>
<target name="markbook" depends="init" description="Build and package
markbook tool.">
<exec executable="${mvn.cmd}">
