Author: lmccay Date: Thu Dec 14 15:41:53 2017 New Revision: 1818153 URL: http://svn.apache.org/viewvc?rev=1818153&view=rev Log: Update site for 0.14.0 release
Modified: knox/site/books/knox-0-14-0/user-guide.html 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 Modified: knox/site/books/knox-0-14-0/user-guide.html URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-14-0/user-guide.html?rev=1818153&r1=1818152&r2=1818153&view=diff ============================================================================== --- knox/site/books/knox-0-14-0/user-guide.html (original) +++ knox/site/books/knox-0-14-0/user-guide.html Thu Dec 14 15:41:53 2017 @@ -31,7 +31,18 @@ <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="#Configuration">Configuration</a> + <ul> + <li><a href="#Gateway+Server+Configuration">Gateway Server Configuration</a></li> + <li><a href="#Simplified+Topology+Descriptors">Simplified Topology Descriptors</a></li> + <li><a href="#Externalized+Provider+Configurations">Externalized Provider Configurations</a></li> + <li><a href="#Sharing+HA+Providers">Sharing HA Providers</a></li> + <li><a href="#Simplified+Descriptor+Files">Simplified Descriptor Files</a></li> + <li><a href="#Remote+Configuration+Monitor">Remote Configuration Monitor</a></li> + <li><a href="#Remote+Configuration+Registry+Clients">Remote Configuration Registry Clients</a></li> + <li><a href="#Topology+Descriptors">Topology Descriptors</a></li> + <li><a href="#Hostmap+Provider">Hostmap Provider</a></li> + </ul></li> <li><a href="#Knox+CLI">Knox CLI</a></li> <li><a href="#Admin+API">Admin API</a></li> <li><a href="#X-Forwarded-*+Headers+Support">X-Forwarded-* Headers Support</a></li> @@ -94,6 +105,7 @@ <li><a href="#Storm">Storm</a></li> <li><a href="#SOLR">SOLR</a></li> <li><a href="#Avatica">Avatica</a></li> + <li><a href="#Livy+Server">Livy Server</a></li> <li><a href="#Common+Service+Config">Common Service Config</a></li> <li><a href="#Default+Service+HA+support">Default Service HA support</a></li> </ul></li> @@ -456,7 +468,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> +</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, Apache 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}</cod e> and value 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> @@ -4546,6 +4558,7 @@ dep/commons-codec-1.7.jar <li><a href="#Storm">Storm</a></li> <li><a href="#SOLR">SOLR</a></li> <li><a href="#Avatica">Avatica</a></li> + <li><a href="#Livy+Server">Livy Server</a></li> </ul><h3><a id="Assumptions">Assumptions</a> <a href="#Assumptions"><img src="markbook-section-link.png"/></a></h3><p>This document assumes a few things about your environment in order to simplify the examples.</p> <ul> <li>The JVM is executable as simply <code>java</code>.</li> @@ -6274,7 +6287,12 @@ DriverManager.getConnection(url, props); props.setProperty("truststore", "/tmp/knox_truststore.jks"); props.setProperty("truststore_password", "very_secret"); DriverManager.getConnection(url, props); -</code></pre><h3><a id="Service+Test+API">Service Test API</a> <a href="#Service+Test+API"><img src="markbook-section-link.png"/></a></h3><p>The gateway supports a Service Test API that can be used to test Knox’s ability to connect to each of the different Hadoop services via a simeple HTTP GET request. To be able to access this API one must add the following line into the topology for which you wish to run the service test.</p> +</code></pre><h3><a id="Livy+Server">Livy Server</a> <a href="#Livy+Server"><img src="markbook-section-link.png"/></a></h3><p>Knox provides proxied access to Livy server for submitting Spark jobs. The gateway can be used to provide authentication and encryption for clients to servers like Livy.</p><h4><a id="Gateway+configuration">Gateway configuration</a> <a href="#Gateway+configuration"><img src="markbook-section-link.png"/></a></h4><p>The Gateway can be configured for Livy by modifying the topology XML file and providing a new service XML file.</p><p>In the topology XML file, add the following with the correct hostname:</p> +<pre><code><service> + <role>LIVYSERVER</role> + <url>http://<livy-server>:8998</url> +</service> +</code></pre><p>Livy server will use proxUser to run the Spark session. To avoid that a user can provide here any user (e.g. a more privileged), Knox will need to rewrite the the json body to replace what so ever is the value of proxyUser is with the username of the authenticated user.</p><p>{<br/> “driverMemory”:“2G”, “executorCores”:4, “executorMemory”:“8G”, “proxyUser”:“bernhard”, “conf”:{<br/> “spark.master”:“yarn-cluster”, “spark.jars.packages”:“com.databricks:spark-csv_2.10:1.5.0” } } </p><p>The above is an example request body to be used to create a Spark session via Live server and illustrates the “proxyUser” that requires rewrite.</p><h3><a id="Service+Test+API">Service Test API</a> <a href="#Service+Test+API"><img src="markbook-section-link.png"/></a></h3><p>The gateway supports a Service Test API that can be use d to test Knox’s ability to connect to each of the different Hadoop services via a simeple HTTP GET request. To be able to access this API one must add the following line into the topology for which you wish to run the service test.</p> <pre><code><service> <role>SERVICE-TEST</role> </service> Modified: knox/site/index.html URL: http://svn.apache.org/viewvc/knox/site/index.html?rev=1818153&r1=1818152&r2=1818153&view=diff ============================================================================== --- knox/site/index.html (original) +++ knox/site/index.html Thu Dec 14 15:41:53 2017 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-12-05 + | Generated by Apache Maven Doxia at 2017-12-14 | 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="20171205" /> + <meta name="Date-Revision-yyyymmdd" content="20171214" /> <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-12-05</li> + <li id="publishDate" class="pull-right">Last Published: 2017-12-14</li> </ul> </div> @@ -94,21 +94,21 @@ <li> - <a href="books/knox-0-13-0/user-guide.html" title="User's Guide"> + <a href="books/knox-0-14-0/user-guide.html" title="User's Guide"> <i class="none"></i> User's Guide</a> </li> <li> - <a href="books/knox-0-13-0/dev-guide.html" title="Developer's Guide"> + <a href="books/knox-0-14-0/dev-guide.html" title="Developer's Guide"> <i class="none"></i> Developer's Guide</a> </li> <li> - <a href="books/knox-0-13-0/user-guide.html#Quick+Start" title="Quick Start"> + <a href="books/knox-0-14-0/user-guide.html#Quick+Start" title="Quick Start"> <i class="none"></i> Quick Start</a> </li> @@ -130,6 +130,13 @@ <li> + <a href="https://cwiki.apache.org/confluence/display/KNOX/Release+0.14.0" class="externalLink" title="0.14.0"> + <i class="none"></i> + 0.14.0</a> + </li> + + <li> + <a href="https://cwiki.apache.org/confluence/display/KNOX/Release+0.13.0" class="externalLink" title="0.13.0"> <i class="none"></i> 0.13.0</a> Modified: knox/site/issue-tracking.html URL: http://svn.apache.org/viewvc/knox/site/issue-tracking.html?rev=1818153&r1=1818152&r2=1818153&view=diff ============================================================================== --- knox/site/issue-tracking.html (original) +++ knox/site/issue-tracking.html Thu Dec 14 15:41:53 2017 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-12-05 + | Generated by Apache Maven Doxia at 2017-12-14 | 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="20171205" /> + <meta name="Date-Revision-yyyymmdd" content="20171214" /> <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-12-05</li> + <li id="publishDate" class="pull-right">Last Published: 2017-12-14</li> </ul> </div> @@ -96,21 +96,21 @@ <li> - <a href="books/knox-0-13-0/user-guide.html" title="User's Guide"> + <a href="books/knox-0-14-0/user-guide.html" title="User's Guide"> <i class="none"></i> User's Guide</a> </li> <li> - <a href="books/knox-0-13-0/dev-guide.html" title="Developer's Guide"> + <a href="books/knox-0-14-0/dev-guide.html" title="Developer's Guide"> <i class="none"></i> Developer's Guide</a> </li> <li> - <a href="books/knox-0-13-0/user-guide.html#Quick+Start" title="Quick Start"> + <a href="books/knox-0-14-0/user-guide.html#Quick+Start" title="Quick Start"> <i class="none"></i> Quick Start</a> </li> @@ -132,6 +132,13 @@ <li> + <a href="https://cwiki.apache.org/confluence/display/KNOX/Release+0.14.0" class="externalLink" title="0.14.0"> + <i class="none"></i> + 0.14.0</a> + </li> + + <li> + <a href="https://cwiki.apache.org/confluence/display/KNOX/Release+0.13.0" class="externalLink" title="0.13.0"> <i class="none"></i> 0.13.0</a> Modified: knox/site/license.html URL: http://svn.apache.org/viewvc/knox/site/license.html?rev=1818153&r1=1818152&r2=1818153&view=diff ============================================================================== --- knox/site/license.html (original) +++ knox/site/license.html Thu Dec 14 15:41:53 2017 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-12-05 + | Generated by Apache Maven Doxia at 2017-12-14 | 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="20171205" /> + <meta name="Date-Revision-yyyymmdd" content="20171214" /> <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-12-05</li> + <li id="publishDate" class="pull-right">Last Published: 2017-12-14</li> </ul> </div> @@ -94,21 +94,21 @@ <li> - <a href="books/knox-0-13-0/user-guide.html" title="User's Guide"> + <a href="books/knox-0-14-0/user-guide.html" title="User's Guide"> <i class="none"></i> User's Guide</a> </li> <li> - <a href="books/knox-0-13-0/dev-guide.html" title="Developer's Guide"> + <a href="books/knox-0-14-0/dev-guide.html" title="Developer's Guide"> <i class="none"></i> Developer's Guide</a> </li> <li> - <a href="books/knox-0-13-0/user-guide.html#Quick+Start" title="Quick Start"> + <a href="books/knox-0-14-0/user-guide.html#Quick+Start" title="Quick Start"> <i class="none"></i> Quick Start</a> </li> @@ -130,6 +130,13 @@ <li> + <a href="https://cwiki.apache.org/confluence/display/KNOX/Release+0.14.0" class="externalLink" title="0.14.0"> + <i class="none"></i> + 0.14.0</a> + </li> + + <li> + <a href="https://cwiki.apache.org/confluence/display/KNOX/Release+0.13.0" class="externalLink" title="0.13.0"> <i class="none"></i> 0.13.0</a> Modified: knox/site/mail-lists.html URL: http://svn.apache.org/viewvc/knox/site/mail-lists.html?rev=1818153&r1=1818152&r2=1818153&view=diff ============================================================================== --- knox/site/mail-lists.html (original) +++ knox/site/mail-lists.html Thu Dec 14 15:41:53 2017 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-12-05 + | Generated by Apache Maven Doxia at 2017-12-14 | 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="20171205" /> + <meta name="Date-Revision-yyyymmdd" content="20171214" /> <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-12-05</li> + <li id="publishDate" class="pull-right">Last Published: 2017-12-14</li> </ul> </div> @@ -96,21 +96,21 @@ <li> - <a href="books/knox-0-13-0/user-guide.html" title="User's Guide"> + <a href="books/knox-0-14-0/user-guide.html" title="User's Guide"> <i class="none"></i> User's Guide</a> </li> <li> - <a href="books/knox-0-13-0/dev-guide.html" title="Developer's Guide"> + <a href="books/knox-0-14-0/dev-guide.html" title="Developer's Guide"> <i class="none"></i> Developer's Guide</a> </li> <li> - <a href="books/knox-0-13-0/user-guide.html#Quick+Start" title="Quick Start"> + <a href="books/knox-0-14-0/user-guide.html#Quick+Start" title="Quick Start"> <i class="none"></i> Quick Start</a> </li> @@ -132,6 +132,13 @@ <li> + <a href="https://cwiki.apache.org/confluence/display/KNOX/Release+0.14.0" class="externalLink" title="0.14.0"> + <i class="none"></i> + 0.14.0</a> + </li> + + <li> + <a href="https://cwiki.apache.org/confluence/display/KNOX/Release+0.13.0" class="externalLink" title="0.13.0"> <i class="none"></i> 0.13.0</a> Modified: knox/site/project-info.html URL: http://svn.apache.org/viewvc/knox/site/project-info.html?rev=1818153&r1=1818152&r2=1818153&view=diff ============================================================================== --- knox/site/project-info.html (original) +++ knox/site/project-info.html Thu Dec 14 15:41:53 2017 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-12-05 + | Generated by Apache Maven Doxia at 2017-12-14 | 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="20171205" /> + <meta name="Date-Revision-yyyymmdd" content="20171214" /> <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-12-05</li> + <li id="publishDate" class="pull-right">Last Published: 2017-12-14</li> </ul> </div> @@ -96,21 +96,21 @@ <li> - <a href="books/knox-0-13-0/user-guide.html" title="User's Guide"> + <a href="books/knox-0-14-0/user-guide.html" title="User's Guide"> <i class="none"></i> User's Guide</a> </li> <li> - <a href="books/knox-0-13-0/dev-guide.html" title="Developer's Guide"> + <a href="books/knox-0-14-0/dev-guide.html" title="Developer's Guide"> <i class="none"></i> Developer's Guide</a> </li> <li> - <a href="books/knox-0-13-0/user-guide.html#Quick+Start" title="Quick Start"> + <a href="books/knox-0-14-0/user-guide.html#Quick+Start" title="Quick Start"> <i class="none"></i> Quick Start</a> </li> @@ -132,6 +132,13 @@ <li> + <a href="https://cwiki.apache.org/confluence/display/KNOX/Release+0.14.0" class="externalLink" title="0.14.0"> + <i class="none"></i> + 0.14.0</a> + </li> + + <li> + <a href="https://cwiki.apache.org/confluence/display/KNOX/Release+0.13.0" class="externalLink" title="0.13.0"> <i class="none"></i> 0.13.0</a> Modified: knox/site/team-list.html URL: http://svn.apache.org/viewvc/knox/site/team-list.html?rev=1818153&r1=1818152&r2=1818153&view=diff ============================================================================== --- knox/site/team-list.html (original) +++ knox/site/team-list.html Thu Dec 14 15:41:53 2017 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-12-05 + | Generated by Apache Maven Doxia at 2017-12-14 | 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="20171205" /> + <meta name="Date-Revision-yyyymmdd" content="20171214" /> <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-12-05</li> + <li id="publishDate" class="pull-right">Last Published: 2017-12-14</li> </ul> </div> @@ -96,21 +96,21 @@ <li> - <a href="books/knox-0-13-0/user-guide.html" title="User's Guide"> + <a href="books/knox-0-14-0/user-guide.html" title="User's Guide"> <i class="none"></i> User's Guide</a> </li> <li> - <a href="books/knox-0-13-0/dev-guide.html" title="Developer's Guide"> + <a href="books/knox-0-14-0/dev-guide.html" title="Developer's Guide"> <i class="none"></i> Developer's Guide</a> </li> <li> - <a href="books/knox-0-13-0/user-guide.html#Quick+Start" title="Quick Start"> + <a href="books/knox-0-14-0/user-guide.html#Quick+Start" title="Quick Start"> <i class="none"></i> Quick Start</a> </li> @@ -132,6 +132,13 @@ <li> + <a href="https://cwiki.apache.org/confluence/display/KNOX/Release+0.14.0" class="externalLink" title="0.14.0"> + <i class="none"></i> + 0.14.0</a> + </li> + + <li> + <a href="https://cwiki.apache.org/confluence/display/KNOX/Release+0.13.0" class="externalLink" title="0.13.0"> <i class="none"></i> 0.13.0</a>