You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@knox.apache.org by kr...@apache.org on 2018/10/19 20:51:18 UTC

svn commit: r1844378 - in /knox: site/books/knox-1-1-0/user-guide.html trunk/books/1.1.0/service_hbase.md trunk/books/1.1.0/service_hive.md trunk/books/1.1.0/service_oozie.md

Author: krisden
Date: Fri Oct 19 20:51:17 2018
New Revision: 1844378

URL: http://svn.apache.org/viewvc?rev=1844378&view=rev
Log:
KNOX-543 - Add documentation and configuration examples to the user guide for replayBufferSize (Matthew Sharp via Kevin Risden)

Modified:
    knox/site/books/knox-1-1-0/user-guide.html
    knox/trunk/books/1.1.0/service_hbase.md
    knox/trunk/books/1.1.0/service_hive.md
    knox/trunk/books/1.1.0/service_oozie.md

Modified: knox/site/books/knox-1-1-0/user-guide.html
URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-1-0/user-guide.html?rev=1844378&r1=1844377&r2=1844378&view=diff
==============================================================================
--- knox/site/books/knox-1-1-0/user-guide.html (original)
+++ knox/site/books/knox-1-1-0/user-guide.html Fri Oct 19 20:51:17 2018
@@ -5233,8 +5233,12 @@ session.shutdown()
 <service>
     <role>OOZIE</role>
     <url>http://localhost:11000/oozie</url>
+    <param>
+        <name>replayBufferSize</name>
+        <value>8</value>
+    </param>
 </service>
-</code></pre><h4><a id="Oozie+URL+Mapping">Oozie URL Mapping</a> <a href="#Oozie+URL+Mapping"><img src="markbook-section-link.png"/></a></h4><p>For Oozie URLs, the mapping of Knox Gateway accessible URLs to direct Oozie URLs is simple.</p>
+</code></pre><p>A default replayBufferSize of 8KB is shown in the sample topology file above. This may need to be increased if your request size is larger.</p><h4><a id="Oozie+URL+Mapping">Oozie URL Mapping</a> <a href="#Oozie+URL+Mapping"><img src="markbook-section-link.png"/></a></h4><p>For Oozie URLs, the mapping of Knox Gateway accessible URLs to direct Oozie URLs is simple.</p>
 <table>
   <tbody>
     <tr>
@@ -5326,7 +5330,16 @@ curl -i -k -u guest:guest-password -X DE
   <ul>
     <li><code>Workflow.status(session).jobId(jobId).now().string</code></li>
   </ul></li>
-</ul><h3><a id="Oozie+HA">Oozie HA</a> <a href="#Oozie+HA"><img src="markbook-section-link.png"/></a></h3><p>Please look at <a href="#Default+Service+HA+support">Default Service HA support</a></p><h3><a id="HBase">HBase</a> <a href="#HBase"><img src="markbook-section-link.png"/></a></h3><p>HBase provides an optional REST API (previously called Stargate). See the HBase REST Setup section below for getting started with the HBase REST API and Knox with the Hortonworks Sandbox environment.</p><h4><a id="HBase+URL+Mapping">HBase URL Mapping</a> <a href="#HBase+URL+Mapping"><img src="markbook-section-link.png"/></a></h4>
+</ul><h3><a id="Oozie+HA">Oozie HA</a> <a href="#Oozie+HA"><img src="markbook-section-link.png"/></a></h3><p>Please look at <a href="#Default+Service+HA+support">Default Service HA support</a></p><h3><a id="HBase">HBase</a> <a href="#HBase"><img src="markbook-section-link.png"/></a></h3><p>HBase provides an optional REST API (previously called Stargate). See the HBase REST Setup section below for getting started with the HBase REST API and Knox with the Hortonworks Sandbox environment.</p><p>The gateway by default includes a sample topology descriptor file <code>{GATEWAY_HOME}/deployments/sandbox.xml</code>. The value in this sample is configured to work with an installed Sandbox VM.</p>
+<pre><code>&lt;service&gt;
+    &lt;role&gt;WEBHBASE&lt;/role&gt;
+    &lt;url&gt;http://localhost:60080&lt;/url&gt;
+    &lt;param&gt;
+        &lt;name&gt;replayBufferSize&lt;/name&gt;
+        &lt;value&gt;8&lt;/value&gt;
+    &lt;/param&gt;
+&lt;/service&gt;
+</code></pre><p>By default the gateway is configured to use port 60080 for Hbase in the Sandbox. Please see the steps to configure the port mapping below.</p><p>A default replayBufferSize of 8KB is shown in the sample topology file above. This may need to be increased if your query size is larger.</p><h4><a id="HBase+URL+Mapping">HBase URL Mapping</a> <a href="#HBase+URL+Mapping"><img src="markbook-section-link.png"/></a></h4>
 <table>
   <tbody>
     <tr>
@@ -5965,8 +5978,12 @@ session.shutdown(10, SECONDS)
 <pre><code>&lt;service&gt;
     &lt;role&gt;HIVE&lt;/role&gt;
     &lt;url&gt;http://localhost:10001/cliservice&lt;/url&gt;
+    &lt;param&gt;
+        &lt;name&gt;replayBufferSize&lt;/name&gt;
+        &lt;value&gt;8&lt;/value&gt;
+    &lt;/param&gt;
 &lt;/service&gt;
-</code></pre><p>By default the gateway is configured to use the binary transport mode for Hive in the Sandbox.</p><h4><a id="Hive+JDBC+URL+Mapping">Hive JDBC URL Mapping</a> <a href="#Hive+JDBC+URL+Mapping"><img src="markbook-section-link.png"/></a></h4>
+</code></pre><p>By default the gateway is configured to use the binary transport mode for Hive in the Sandbox.</p><p>A default replayBufferSize of 8KB is shown in the sample topology file above. This may need to be increased if your query size is larger.</p><h4><a id="Hive+JDBC+URL+Mapping">Hive JDBC URL Mapping</a> <a href="#Hive+JDBC+URL+Mapping"><img src="markbook-section-link.png"/></a></h4>
 <table>
   <tbody>
     <tr>

Modified: knox/trunk/books/1.1.0/service_hbase.md
URL: http://svn.apache.org/viewvc/knox/trunk/books/1.1.0/service_hbase.md?rev=1844378&r1=1844377&r2=1844378&view=diff
==============================================================================
--- knox/trunk/books/1.1.0/service_hbase.md (original)
+++ knox/trunk/books/1.1.0/service_hbase.md Fri Oct 19 20:51:17 2018
@@ -20,6 +20,21 @@
 HBase provides an optional REST API (previously called Stargate).
 See the HBase REST Setup section below for getting started with the HBase REST API and Knox with the Hortonworks Sandbox environment.
 
+The gateway by default includes a sample topology descriptor file `{GATEWAY_HOME}/deployments/sandbox.xml`.  The value in this sample is configured to work with an installed Sandbox VM.
+
+    <service>
+        <role>WEBHBASE</role>
+        <url>http://localhost:60080</url>
+        <param>
+            <name>replayBufferSize</name>
+            <value>8</value>
+        </param>
+    </service>
+
+By default the gateway is configured to use port 60080 for Hbase in the Sandbox.  Please see the steps to configure the port mapping below.
+
+A default replayBufferSize of 8KB is shown in the sample topology file above.  This may need to be increased if your query size is larger.
+
 #### HBase URL Mapping ####
 
 | ------- | ----------------------------------------------------------------------------- |

Modified: knox/trunk/books/1.1.0/service_hive.md
URL: http://svn.apache.org/viewvc/knox/trunk/books/1.1.0/service_hive.md?rev=1844378&r1=1844377&r2=1844378&view=diff
==============================================================================
--- knox/trunk/books/1.1.0/service_hive.md (original)
+++ knox/trunk/books/1.1.0/service_hive.md Fri Oct 19 20:51:17 2018
@@ -51,10 +51,16 @@ The value in this sample is configured t
     <service>
         <role>HIVE</role>
         <url>http://localhost:10001/cliservice</url>
+        <param>
+            <name>replayBufferSize</name>
+            <value>8</value>
+        </param>
     </service>
 
 By default the gateway is configured to use the binary transport mode for Hive in the Sandbox.
 
+A default replayBufferSize of 8KB is shown in the sample topology file above.  This may need to be increased if your query size is larger.
+
 #### Hive JDBC URL Mapping ####
 
 | ------- | ------------------------------------------------------------------------------- |

Modified: knox/trunk/books/1.1.0/service_oozie.md
URL: http://svn.apache.org/viewvc/knox/trunk/books/1.1.0/service_oozie.md?rev=1844378&r1=1844377&r2=1844378&view=diff
==============================================================================
--- knox/trunk/books/1.1.0/service_oozie.md (original)
+++ knox/trunk/books/1.1.0/service_oozie.md Fri Oct 19 20:51:17 2018
@@ -73,8 +73,14 @@ These values will need to be changed for
     <service>
         <role>OOZIE</role>
         <url>http://localhost:11000/oozie</url>
+        <param>
+            <name>replayBufferSize</name>
+            <value>8</value>
+        </param>
     </service>
 
+A default replayBufferSize of 8KB is shown in the sample topology file above.  This may need to be increased if your request size is larger.
+
 #### Oozie URL Mapping ####
 
 For Oozie URLs, the mapping of Knox Gateway accessible URLs to direct Oozie URLs is simple.