knox-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From lmc...@apache.org
Subject svn commit: r1588691 [1/2] - in /knox: site/books/knox-0-4-0/ trunk/books/0.4.0/
Date Sat, 19 Apr 2014 18:29:28 GMT
Author: lmccay
Date: Sat Apr 19 18:29:28 2014
New Revision: 1588691

URL: http://svn.apache.org/r1588691
Log:
updated various pages for 0.4.0 release

Modified:
    knox/site/books/knox-0-4-0/knox-0-4-0-new.html
    knox/site/books/knox-0-4-0/knox-0-4-0.html
    knox/site/books/knox-0-4-0/likeised
    knox/trunk/books/0.4.0/book_getting-started.md
    knox/trunk/books/0.4.0/book_limitations.md
    knox/trunk/books/0.4.0/config.md
    knox/trunk/books/0.4.0/config_preauth_sso_provider.md

Modified: knox/site/books/knox-0-4-0/knox-0-4-0-new.html
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-4-0/knox-0-4-0-new.html?rev=1588691&r1=1588690&r2=1588691&view=diff
==============================================================================
--- knox/site/books/knox-0-4-0/knox-0-4-0-new.html (original)
+++ knox/site/books/knox-0-4-0/knox-0-4-0-new.html Sat Apr 19 18:29:28 2014
@@ -124,15 +124,11 @@ Server: Jetty(6.1.26)
 {"accessTime":0,"blockSize":0,"group":"hdfs","length":0,"modificationTime":1350596040075,"owner":"hdfs","pathSuffix":"tmp","permission":"777","replication":0,"type":"DIRECTORY"},
 {"accessTime":0,"blockSize":0,"group":"hdfs","length":0,"modificationTime":1350595857178,"owner":"hdfs","pathSuffix":"user","permission":"755","replication":0,"type":"DIRECTORY"}
 ]}}
-</code></pre><h4><a id="Submit+a+MR+job+via+Knox."></a>Submit a MR job via Knox.</h4><h4><a id="Get+status+of+a+MR+job+via+Knox."></a>Get status of a MR job via Knox.</h4><h4><a id="Cancel+a+MR+job+via+Knox."></a>Cancel a MR job via Knox.</h4><h3><a id="More+Examples"></a>More Examples</h3></div><div id="Apache+Knox+Details"><h2><a id="Apache+Knox+Details"></a>Apache Knox Details</h2><p>This section provides everything you need to know to get the Knox gateway up and running against a Hadoop cluster.</p><h4><a id="Hadoop"></a>Hadoop</h4><p>An an existing Hadoop 1.x or 2.x cluster is required for Knox sit in front of and protect. It is possible to use a Hadoop cluster deployed on EC2 but this will require additional configuration not covered here. It is also possible to use a limited set of services in Hadoop cluster secured with Kerberos. This too required additional configuration that is not described here. See <a href="#Supported+Services">Supported Services</a> for details on what
  is supported for this release.</p><p>The Hadoop cluster should be ensured to have at least WebHDFS, WebHCat (i.e. Templeton) and Oozie configured, deployed and running. HBase/Stargate and Hive can also be accessed via the Knox Gateway given the proper versions and configuration.</p><p>The instructions that follow assume a few things:</p>
+</code></pre><h4><a id="Submit+a+MR+job+via+Knox."></a>Submit a MR job via Knox.</h4><h4><a id="Get+status+of+a+MR+job+via+Knox."></a>Get status of a MR job via Knox.</h4><h4><a id="Cancel+a+MR+job+via+Knox."></a>Cancel a MR job via Knox.</h4><h3><a id="More+Examples"></a>More Examples</h3></div><div id="Apache+Knox+Details"><h2><a id="Apache+Knox+Details"></a>Apache Knox Details</h2><p>This section provides everything you need to know to get the Knox gateway up and running against a Hadoop cluster.</p><h4><a id="Hadoop"></a>Hadoop</h4><p>An existing Hadoop 2.x cluster is required for Knox 0.4.0 to sit in front of and protect. It is possible to use a Hadoop cluster deployed on EC2 but this will require additional configuration not covered here. It is also possible to protect access to a services of a Hadoop cluster that is secured with kerberos. This too requires additional configuration that is described in other sections of this guide. See <a href="#Supported+Services">Supported S
 ervices</a> for details on what is supported for this release.</p><p>The Hadoop cluster should be ensured to have at least WebHDFS, WebHCat (i.e. Templeton) and Oozie configured, deployed and running. HBase/Stargate and Hive can also be accessed via the Knox Gateway given the proper versions and configuration.</p><p>The instructions that follow assume a few things:</p>
 <ol>
   <li>The gateway is <em>not</em> collocated with the Hadoop clusters themselves.</li>
   <li>The host names and IP addresses of the cluster services are accessible by the gateway where ever it happens to be running.</li>
-</ol><p>All of the instructions and samples provided here are tailored and tested to work &ldquo;out of the box&rdquo; against a <a href="http://hortonworks.com/products/hortonworks-sandbox">Hortonworks Sandbox 2.x VM</a>.</p></div><div id="Apache+Knox+Directory+Layout"><h4><a id="Layout"></a>Apache Knox Directory Layout</h4><p>Knox can be installed by expanding the zip file or with rpm. With rpm based install the following directories are created in addition to those described in this section.</p>
-<pre><code>/usr/lib/knox
-/var/log/knox
-/var/run/knox
-</code></pre><p>The directory <code>/usr/lib/knox</code> is considered your <code>{GATEWAY_HOME}</code> and will adhere to the layout described below. The directory <code>/var/log/knox</code> will contain the output files from the server. The directory <code>/var/run/knox</code> will contain the process ID for a currently running gateway server.</p><p>Regardless of the installation method used the layout and content of the <code>{GATEWAY_HOME}</code> will be identical. The table below provides a brief explanation of the important files and directories within <code>{GATEWWAY_HOME}</code></p>
+</ol><p>All of the instructions and samples provided here are tailored and tested to work &ldquo;out of the box&rdquo; against a <a href="http://hortonworks.com/products/hortonworks-sandbox">Hortonworks Sandbox 2.x VM</a>.</p></div><div id="Apache+Knox+Directory+Layout"><h4><a id="Layout"></a>Apache Knox Directory Layout</h4><p>Knox can be installed by expanding the zip/archive file.</p><p>The table below provides a brief explanation of the important files and directories within <code>{GATEWWAY_HOME}</code></p>
 <table>
   <thead>
     <tr>
@@ -146,59 +142,79 @@ Server: Jetty(6.1.26)
       <td>Contains configuration files that apply to the gateway globally (i.e. not cluster specific ). </td>
     </tr>
     <tr>
+      <td>data/ </td>
+      <td>Contains security and topology specific artifacts that require read/write access at runtime </td>
+    </tr>
+    <tr>
+      <td>data/topologies/</td>
+      <td>Contains topology files that represent Hadoop clusters which the gateway uses to deploy cluster proxies</td>
+    </tr>
+    <tr>
+      <td>data/security/ </td>
+      <td>Contains the persisted master secret and keystore dir</td>
+    </tr>
+    <tr>
+      <td>data/security/keystores/</td>
+      <td>Contains the gateway identity keystore and credential stores for the gateway and each deployed cluster topology</td>
+    </tr>
+    <tr>
       <td>bin/ </td>
-      <td>Contains the executable shell scripts, batch files and JARs for clients and servers. </td>
+      <td>Contains the executable shell scripts, batch files and JARs for clients and servers.</td>
     </tr>
     <tr>
-      <td>deployments/ </td>
-      <td>Contains topology descriptors used to configure the gateway for specific Hadoop clusters. </td>
+      <td>data/deployments/ </td>
+      <td>Contains deployed cluster topologies used to protect access to specific Hadoop clusters.</td>
     </tr>
     <tr>
       <td>lib/ </td>
-      <td>Contains the JARs for all the components that make up the gateway. </td>
+      <td>Contains the JARs for all the components that make up the gateway.</td>
     </tr>
     <tr>
       <td>dep/ </td>
-      <td>Contains the JARs for all of the components upon which the gateway depends. </td>
+      <td>Contains the JARs for all of the components upon which the gateway depends.</td>
     </tr>
     <tr>
       <td>ext/ </td>
-      <td>A directory where user supplied extension JARs can be placed to extends the gateways functionality. </td>
+      <td>A directory where user supplied extension JARs can be placed to extends the gateways functionality.</td>
+    </tr>
+    <tr>
+      <td>pids/ </td>
+      <td>Contains the process ids for running ldap and gateway servers</td>
     </tr>
     <tr>
       <td>samples/ </td>
-      <td>Contains a number of samples that can be used to explore the functionality of the gateway. </td>
+      <td>Contains a number of samples that can be used to explore the functionality of the gateway.</td>
     </tr>
     <tr>
       <td>templates/ </td>
-      <td>Contains default configuration files that can be copied and customized. </td>
+      <td>Contains default configuration files that can be copied and customized.</td>
     </tr>
     <tr>
       <td>README </td>
-      <td>Provides basic information about the Apache Knox Gateway. </td>
+      <td>Provides basic information about the Apache Knox Gateway.</td>
     </tr>
     <tr>
       <td>ISSUES </td>
-      <td>Describes significant know issues. </td>
+      <td>Describes significant know issues.</td>
     </tr>
     <tr>
       <td>CHANGES </td>
-      <td>Enumerates the changes between releases. </td>
+      <td>Enumerates the changes between releases.</td>
     </tr>
     <tr>
       <td>LICENSE </td>
-      <td>Documents the license under which this software is provided. </td>
+      <td>Documents the license under which this software is provided.</td>
     </tr>
     <tr>
       <td>NOTICE </td>
-      <td>Documents required attribution notices for included dependencies. </td>
+      <td>Documents required attribution notices for included dependencies.</td>
     </tr>
     <tr>
       <td>DISCLAIMER </td>
-      <td>Documents that this release is from a project undergoing incubation at Apache. </td>
+      <td>Documents that this release is from a project undergoing incubation at Apache.</td>
     </tr>
   </tbody>
-</table></div><div id="Supported+Services"><h3><a id="Supported+Services"></a>Supported Services</h3><p>This table enumerates the versions of various Hadoop services that have been tested to work with the Knox Gateway. Only more recent versions of some Hadoop components when secured via Kerberos can be accessed via the Knox Gateway.</p>
+</table></div><div id="Supported+Services"><h3><a id="Supported+Services"></a>Supported Services</h3><p>This table enumerates the versions of various Hadoop services that have been tested to work with the Knox Gateway.</p>
 <table>
   <thead>
     <tr>
@@ -211,15 +227,15 @@ Server: Jetty(6.1.26)
   <tbody>
     <tr>
       <td>WebHDFS </td>
-      <td>2.1.0 </td>
+      <td>2.4.0 </td>
       <td><img src="check.png"  alt="y"/> </td>
       <td><img src="check.png"  alt="y"/> </td>
     </tr>
     <tr>
       <td>WebHCat/Templeton </td>
-      <td>0.11.0 </td>
+      <td>0.13.0 </td>
+      <td><img src="check.png"  alt="y"/> </td>
       <td><img src="check.png"  alt="y"/> </td>
-      <td><img src="error.png"  alt="n"/> </td>
     </tr>
     <tr>
       <td> </td>
@@ -235,45 +251,21 @@ Server: Jetty(6.1.26)
     </tr>
     <tr>
       <td>HBase/Stargate </td>
-      <td>0.95.2 </td>
+      <td>0.98.0 </td>
       <td><img src="check.png"  alt="y"/> </td>
-      <td><img src="error.png"  alt="n"/> </td>
-    </tr>
-    <tr>
-      <td>Hive (via WebHCat) </td>
-      <td>0.11.0 </td>
       <td><img src="check.png"  alt="y"/> </td>
-      <td><img src="error.png"  alt="n"/> </td>
     </tr>
     <tr>
-      <td> </td>
-      <td>0.12.0 </td>
+      <td>Hive (via WebHCat) </td>
+      <td>0.13.0 </td>
       <td><img src="check.png"  alt="y"/> </td>
       <td><img src="check.png"  alt="y"/> </td>
     </tr>
     <tr>
       <td>Hive (via JDBC) </td>
-      <td>0.11.0 </td>
-      <td><img src="error.png"  alt="n"/> </td>
-      <td><img src="error.png"  alt="n"/> </td>
-    </tr>
-    <tr>
-      <td> </td>
-      <td>0.12.0 </td>
+      <td>0.13.0 </td>
+      <td><img src="check.png"  alt="y"/> </td>
       <td><img src="check.png"  alt="y"/> </td>
-      <td><img src="error.png"  alt="n"/> </td>
-    </tr>
-    <tr>
-      <td>Hive (via ODBC) </td>
-      <td>0.11.0 </td>
-      <td><img src="error.png"  alt="n"/> </td>
-      <td><img src="error.png"  alt="n"/> </td>
-    </tr>
-    <tr>
-      <td> </td>
-      <td>0.12.0 </td>
-      <td><img src="error.png"  alt="n"/> </td>
-      <td><img src="error.png"  alt="n"/> </td>
     </tr>
   </tbody>
 </table><h3><a id="More+Examples"></a>More Examples</h3><p>These examples provide more detail about how to access various Apache Hadoop services via the Apache Knox Gateway.</p>
@@ -340,7 +332,7 @@ Server: Jetty(6.1.26)
 &lt;/service&gt;
 </code></pre>
 <dl><dt>/topology/service</dt><dd>Provider information about a particular service within the Hadoop cluster. Not all services are necessarily exposed as gateway endpoints.</dd><dt>/topology/service/role</dt><dd>Identifies the role of this service. Currently supported roles are: WEBHDFS, WEBHCAT, WEBHBASE, OOZIE, HIVE, NAMENODE, JOBTRACKER Additional service roles can be supported via plugins.</dd><dt>topology/service/url</dt><dd>The URL identifying the location of a particular service within the Hadoop cluster.</dd>
-</dl><h4><a id="Hostmap+Provider"></a>Hostmap Provider</h4><p>The purpose of the Hostmap provider is to handle situations where host are know by one name within the cluster and another name externally. This frequently occurs when virtual machines are used and in particular using cloud hosting services. Currently the Hostmap provider is configured as part of the topology file. The basic structure is shown below.</p>
+</dl><h4><a id="Hostmap+Provider"></a>Hostmap Provider</h4><p>The purpose of the Hostmap provider is to handle situations where host are known by one name within the cluster and another name externally. This frequently occurs when virtual machines are used and in particular when using cloud hosting services. Currently, the Hostmap provider is configured as part of the topology file. The basic structure is shown below.</p>
 <pre><code>&lt;topology&gt;
     &lt;gateway&gt;
         ...
@@ -383,7 +375,7 @@ ip-10-39-107-209.ec2.internal
     &lt;/gateway&gt;
     ...
 &lt;/topology&gt;
-</code></pre><h5><a id="Hostmap+Provider+Example+-+Sandbox"></a>Hostmap Provider Example - Sandbox</h5><p>Hortonwork&rsquo;s Sandbox 2.x poses a different challenge for host name mapping. This version of the Sandbox uses port mapping to make the Sandbox VM appear as though it is accessible via localhost. However the Sandbox VM is internally configured to consider sandbox.hortonworks.com as the host name. So from the perspective of a client accessing Sandbox the external host name is localhost. The Hostmap configuration required to allow access to Sandbox from the host operating system is this.</p>
+</code></pre><h5><a id="Hostmap+Provider+Example+-+Sandbox"></a>Hostmap Provider Example - Sandbox</h5><p>The Hortonworks Sandbox 2.x poses a different challenge for host name mapping. This version of the Sandbox uses port mapping to make the Sandbox VM appear as though it is accessible via localhost. However the Sandbox VM is internally configured to consider sandbox.hortonworks.com as the host name. So from the perspective of a client accessing Sandbox the external host name is localhost. The Hostmap configuration required to allow access to Sandbox from the host operating system is this.</p>
 <pre><code>&lt;topology&gt;
     &lt;gateway&gt;
         ...
@@ -401,19 +393,19 @@ ip-10-39-107-209.ec2.internal
 <dl><dt>topology/gateway/provider/role</dt><dd>The role for a Hostmap provider must always be <code>hostmap</code>.</dd><dt>topology/gateway/provider/name</dt><dd>The Hostmap provider supplied out-of-the-box is selected via the name <code>static</code>.</dd><dt>topology/gateway/provider/enabled</dt><dd>Host mapping can be enabled or disabled by providing <code>true</code> or <code>false</code>.</dd><dt>topology/gateway/provider/param</dt><dd>Host mapping is configured by providing parameters for each external to internal mapping.</dd><dt>topology/gateway/provider/param/name</dt><dd>The parameter names represent an external host names associated with the internal host names provided by the value element. This can be a comma separated list of host names that all represent the same physical host. When mapping from internal to external host name the first external host name in the list is used.</dd><dt>topology/gateway/provider/param/value</dt><dd>The parameter values represent the inte
 rnal host names associated with the external host names provider by the name element. This can be a comma separated list of host names that all represent the same physical host. When mapping from external to internal host names the first internal host name in the list is used.</dd>
 </dl><h4><a id="Logging"></a>Logging</h4><p>If necessary you can enable additional logging by editing the <code>log4j.properties</code> file in the <code>conf</code> directory. Changing the rootLogger value from <code>ERROR</code> to <code>DEBUG</code> will generate a large amount of debug logging. A number of useful, more fine loggers are also provided in the file.</p><h4><a id="Java+VM+Options"></a>Java VM Options</h4><p>TODO - Java VM options doc.</p><h4><a id="Persisting+the+Master+Secret"></a>Persisting the Master Secret</h4><p>The master secret is required to start the server. This secret is used to access secured artifacts by the gateway instance. Keystore, trust stores and credential stores are all protected with the master secret.</p><p>You may persist the master secret by supplying the <em>-persist-master</em> switch at startup. This will result in a warning indicating that persisting the secret is less secure than providing it at startup. We do make some provisions in ord
 er to protect the persisted password.</p><p>It is encrypted with AES 128 bit encryption and where possible the file permissions are set to only be accessible by the user that the gateway is running as.</p><p>After persisting the secret, ensure that the file at config/security/master has the appropriate permissions set for your environment. This is probably the most important layer of defense for master secret. Do not assume that the encryption if sufficient protection.</p><p>A specific user should be created to run the gateway this user will be the only user with permissions for the persisted master file.</p><p>See the Knox CLI section for descriptions of the command line utilties related to the master secret.</p><h4><a id="Management+of+Security+Artifacts"></a>Management of Security Artifacts</h4><p>There are a number of artifacts that are used by the gateway in ensuring the security of wire level communications, access to protected resources and the encryption of sensitive data. T
 hese artifacts can be managed from outside of the gateway instances or generated and populated by the gateway instance itself.</p><p>The following is a description of how this is coordinated with both standalone (development, demo, etc) gateway instances and instances as part of a cluster of gateways in mind.</p><p>Upon start of the gateway server we:</p>
 <ol>
-  <li>Look for an identity store at <code>conf/security/keystores/gateway.jks</code>.  The identity store contains the certificate and private key used to represent the identity of the server for SSL connections and signature creation.
+  <li>Look for an identity store at <code>data/security/keystores/gateway.jks</code>.  The identity store contains the certificate and private key used to represent the identity of the server for SSL connections and signature creation.
   <ul>
     <li>If there is no identity store we create one and generate a self-signed certificate for use in standalone/demo mode.  The certificate is stored with an alias of gateway-identity.</li>
-    <li>If there is an identity store found than we ensure that it can be loaded using the provided master secret and that there is an alias with called gateway-identity.</li>
+    <li>If there is an identity store found than we ensure that it can be loaded using the provided master secret and that there is an alias called gateway-identity.</li>
   </ul></li>
-  <li>Look for a credential store at <code>conf/security/keystores/__gateway-credentials.jceks</code>.  This credential store is used to store secrets/passwords that are used by the gateway.  For instance, this is where the pass-phrase for accessing the gateway-identity certificate is kept.
+  <li>Look for a credential store at <code>data/security/keystores/__gateway-credentials.jceks</code>.  This credential store is used to store secrets/passwords that are used by the gateway.  For instance, this is where the passphrase for accessing the gateway-identity certificate is kept.
   <ul>
-    <li>If there is no credential store found then we create one and populate it with a generated pass-phrase for the alias <code>gateway-identity-passphrase</code>.  This is coordinated with the population of the self-signed cert into the identity-store.</li>
+    <li>If there is no credential store found then we create one and populate it with a generated passphrase for the alias <code>gateway-identity-passphrase</code>.  This is coordinated with the population of the self-signed cert into the identity-store.</li>
     <li>If a credential store is found then we ensure that it can be loaded using the provided master secret and that the expected aliases have been populated with secrets.</li>
   </ul></li>
 </ol><p>Upon deployment of a Hadoop cluster topology within the gateway we:</p>
 <ol>
-  <li>Look for a credential store for the topology. For instance, we have a sample topology that gets deployed out of the box. We look for <code>conf/security/keystores/sandbox-credentials.jceks</code>. This topology specific credential store is used for storing secrets/passwords that are used for encrypting sensitive data with topology specific keys.
+  <li>Look for a credential store for the topology. For instance, we have a sample topology that gets deployed out of the box. We look for <code>data/security/keystores/sandbox-credentials.jceks</code>. This topology specific credential store is used for storing secrets/passwords that are used for encrypting sensitive data with topology specific keys.
   <ul>
     <li>If no credential store is found for the topology being deployed then one is created for it.  Population of the aliases is delegated to the configured providers within the system that will require the use of a secret for a particular task.  They may programmatic set the value of the secret or choose to have the value for the specified alias generated through the AliasService.</li>
     <li>If a credential store is found then we ensure that it can be loaded with the provided master secret and the configured providers have the opportunity to ensure that the aliases are populated and if not to populate them.</li>
@@ -423,7 +415,7 @@ ip-10-39-107-209.ec2.internal
   <li>Using a single gateway instance as a master instance the artifacts can be generated or placed into the expected location and then replicated across all of the slave instances before startup.</li>
   <li>Using an NFS mount as a central location for the artifacts would provide a single source of truth without the need to replicate them over the network. Of course, NFS mounts have their own challenges.</li>
   <li>Using the KnoxCLI to create and manage the security artifacts.</li>
-</ol><p>See the Knox CLI section for descriptions of the command line utilties related to the security artifact management.</p><h4><a id="Keystores"></a>Keystores</h4><p>In order to provide your own certificate for use by the gateway, you will need to either import an existing key pair into a Java keystore or generate a self-signed cert using the Java keytool.</p><h5><a id="Importing+a+key+pair+into+a+Java+keystore"></a>Importing a key pair into a Java keystore</h5><h1><a id="----NEEDS+TESTING"></a>&mdash;-NEEDS TESTING</h1><p>One way to accomplish this is to start with a PKCS12 store for your key pair and then convert it to a Java keystore or JKS.</p>
+</ol><p>See the Knox CLI section for descriptions of the command line utilties related to the security artifact management.</p><h4><a id="Keystores"></a>Keystores</h4><p>In order to provide your own certificate for use by the gateway, you will need to either import an existing key pair into a Java keystore or generate a self-signed cert using the Java keytool.</p><h5><a id="Importing+a+key+pair+into+a+Java+keystore"></a>Importing a key pair into a Java keystore</h5><p>One way to accomplish this is to start with a PKCS12 store for your key pair and then convert it to a Java keystore or JKS.</p>
 <pre><code>openssl pkcs12 -export -in cert.pem -inkey key.pem &gt; server.p12
 </code></pre><p>The above example uses openssl to create a PKCS12 encoded store for your provided certificate private key.</p>
 <pre><code>keytool -importkeystore -srckeystore {server.p12} -destkeystore gateway.jks -srcstoretype pkcs12
@@ -431,11 +423,11 @@ ip-10-39-107-209.ec2.internal
 <ol>
   <li>the alias MUST be &ldquo;gateway-identity&rdquo;</li>
   <li>the name of the expected identity keystore for the gateway MUST be gateway.jks</li>
-  <li>the passwords for the keystore and the imported key MUST both be the master secret for the gateway install</li>
-</ol><p>NOTE: The password for the keystore as well as that of the imported key must be the master secret for the gateway instance.</p><h1><a id="----END+NEEDS+TESTING"></a>&mdash;-END NEEDS TESTING</h1><h5><a id="Generating+a+self-signed+cert+for+use+in+testing+or+development+environments"></a>Generating a self-signed cert for use in testing or development environments</h5>
+  <li>the passwords for the keystore and the imported key may both be set to the master secret for the gateway install</li>
+</ol><p>NOTE: The password for the keystore as well as that of the imported key may be the master secret for the gateway instance or you may set the gateway-identity-passphrase alias using the Knox CLI to the actual key passphrase. See the Knox CLI section for details.</p><h5><a id="Generating+a+self-signed+cert+for+use+in+testing+or+development+environments"></a>Generating a self-signed cert for use in testing or development environments</h5>
 <pre><code>keytool -genkey -keyalg RSA -alias gateway-identity -keystore gateway.jks \
     -storepass {master-secret} -validity 360 -keysize 2048
-</code></pre><p>Keytool will prompt you for a number of elements used will comprise the distiniguished name (DN) within your certificate. </p><p><em>NOTE:</em> When it prompts you for your First and Last name be sure to type in the hostname of the machine that your gateway instance will be running on. This is used by clients during hostname verification to ensure that the presented certificate matches the hostname that was used in the URL for the connection - so they need to match.</p><p><em>NOTE:</em> When it prompts for the key password just press enter to ensure that it is the same as the keystore password. Which as was described earlier must match the master secret for the gateway instance.</p><p>See the Knox CLI section for descriptions of the command line utilties related to the management of the keystores.</p><h5><a id="Credential+Store"></a>Credential Store</h5><p>Whenever you provide your own keystore with either a self-signed cert or a real certificate signed by a trusted 
 authority, you will need to create an empty credential store. This is necessary for the current release in order for the system to utilize the same password for the keystore and the key.</p><p>The credential stores in Knox use the JCEKS keystore type as it allows for the storage of general secrets in addition to certificates.</p><p>Keytool may be used to create credential stores but the Knox CLI section details how to create aliases. These aliases are managed within credential stores which are created by the CLI as appropriate. </p><p>See the Knox CLI section for descriptions of the command line utilties related to the management of the credential stores.</p><h5><a id="Provisioning+of+Keystores"></a>Provisioning of Keystores</h5><p>Once you have created these keystores you must move them into place for the gateway to discover them and use them to represent its identity for SSL connections. This is done by copying the keystores to the <code>{GATEWAY_HOME}/conf/security/keystores</cod
 e> directory for your gateway install.</p><h4><a id="Summary+of+Secrets+to+be+Managed"></a>Summary of Secrets to be Managed</h4>
+</code></pre><p>Keytool will prompt you for a number of elements used will comprise the distiniguished name (DN) within your certificate. </p><p><em>NOTE:</em> When it prompts you for your First and Last name be sure to type in the hostname of the machine that your gateway instance will be running on. This is used by clients during hostname verification to ensure that the presented certificate matches the hostname that was used in the URL for the connection - so they need to match.</p><p><em>NOTE:</em> When it prompts for the key password just press enter to ensure that it is the same as the keystore password. Which as was described earlier must match the master secret for the gateway instance. Alternatively, you can set it to another passphrase - take note of it and set the gateway-identity-passphrase alias to that passphrase using the Knox CLI.</p><p>See the Knox CLI section for descriptions of the command line utilties related to the management of the keystores.</p><h5><a id="Cre
 dential+Store"></a>Credential Store</h5><p>Whenever you provide your own keystore with either a self-signed cert or an issued certificate signed by a trusted authority, you will need to set an alias for the gateway-identity-passphrase or create an empty credential store. This is necessary for the current release in order for the system to determine the correct password for the keystore and the key.</p><p>The credential stores in Knox use the JCEKS keystore type as it allows for the storage of general secrets in addition to certificates.</p><p>Keytool may be used to create credential stores but the Knox CLI section details how to create aliases. These aliases are managed within credential stores which are created by the CLI as needed. The simplest approach is to create the gateway-identity-passpharse alias with the Knox CLI. This will create the credential store if it doesn&rsquo;t already exist and add the key passphrase.</p><p>See the Knox CLI section for descriptions of the comman
 d line utilties related to the management of the credential stores.</p><h5><a id="Provisioning+of+Keystores"></a>Provisioning of Keystores</h5><p>Once you have created these keystores you must move them into place for the gateway to discover them and use them to represent its identity for SSL connections. This is done by copying the keystores to the <code>{GATEWAY_HOME}/data/security/keystores</code> directory for your gateway install.</p><h4><a id="Summary+of+Secrets+to+be+Managed"></a>Summary of Secrets to be Managed</h4>
 <ol>
   <li>Master secret - the same for all gateway instances in a cluster of gateways</li>
   <li>All security related artifacts are protected with the master secret</li>
@@ -1116,7 +1108,7 @@ APACHE_HOME/bin/apachectl -k stop
   </tbody>
 </table><h4><a id="REST+Invocation"></a>REST Invocation</h4><p>The following curl command can be used to request a directory listing from HDFS while passing in the expected header X-XSRF-Header.</p>
 <pre><code>curl -k -i --header &quot;X-XSRF-Header: valid&quot; -v -u guest:guest-password https://localhost:8443/gateway/sandbox/webhdfs/v1/tmp?op=LISTSTATUS
-</code></pre><p>Omitting the &ndash;header &ldquo;X-XSRF-Header: valid&rdquo; above should result in an HTTP 400 bad_request.</p><p>Disabling the provider will then allow a request that is missing the header through. </p></div><div id="Preauthenticated+SSO+Provider"><h3><a id="Preauthenticated+SSO+Provider"></a>Preauthenticated SSO Provider</h3><p>A number of SSO solutions provide mechanisms for federating an authenticated identity across applications. These mechanisms are at times simple HTTP Header type tokens that can be used to propagate the identity across process boundaries.</p><p>Knox Gateway needs a pluggable mechanism for consuming these tokens and federating the asserted identity through an interaction with the Hadoop cluster. </p><p><strong>CAUTION: The use of this provider requires that proper network security and identity provider configuration and deployment does not allow requests directly to the Knox gateway. Otherwise, this provider will leave the gateway exposed to
  identity spoofing.</strong></p><h4><a id="Configuration"></a>Configuration</h4><h5><a id="Overview"></a>Overview</h5><p>The HeaderPreAuth provider is configured within the topology file and has a minimal configuration that assumes SM_USER for CA SiteMinder. The following example is the bare minimum configuration for SiteMinder (with no IP address validation).</p>
+</code></pre><p>Omitting the &ndash;header &ldquo;X-XSRF-Header: valid&rdquo; above should result in an HTTP 400 bad_request.</p><p>Disabling the provider will then allow a request that is missing the header through. </p></div><div id="Preauthenticated+SSO+Provider"><h3><a id="Preauthenticated+SSO+Provider"></a>Preauthenticated SSO Provider</h3><p>A number of SSO solutions provide mechanisms for federating an authenticated identity across applications. These mechanisms are at times simple HTTP Header type tokens that can be used to propagate the identity across process boundaries.</p><p>Knox Gateway needs a pluggable mechanism for consuming these tokens and federating the asserted identity through an interaction with the Hadoop cluster. </p><p><strong>CAUTION: The use of this provider requires that proper network security and identity provider configuration and deployment does not allow requests directly to the Knox gateway. Otherwise, this provider will leave the gateway exposed to
  identity spoofing.</strong></p><h4><a id="Configuration"></a>Configuration</h4><h5><a id="Overview"></a>Overview</h5><p>This provider was designed for use with identity solutions such as those provided by CA&rsquo;s SiteMinder and IBM&rsquo;s Tivoli Access Manager. While direct testing with these products has not been done, there has been extensive unit and functional testing that ensure that it should work with such providers.</p><p>The HeaderPreAuth provider is configured within the topology file and has a minimal configuration that assumes SM_USER for CA SiteMinder. The following example is the bare minimum configuration for SiteMinder (with no IP address validation).</p>
 <pre><code>&lt;provider&gt;
   &lt;role&gt;federation&lt;/role&gt;
   &lt;name&gt;HeaderPreAuth&lt;/name&gt;
@@ -2728,7 +2720,7 @@ connection.close();
 2012-02-03 --- 18:35:34 --- SampleClass6 --- [TRACE]
 2012-02-03 --- 18:35:34 --- SampleClass2 --- [DEBUG]
 ...
-</code></pre></div><div id="Limitations"><h2><a id="Limitations"></a>Limitations</h2><h3><a id="Secure+Oozie+POST/PUT+Request+Payload+Size+Restriction"></a>Secure Oozie POST/PUT Request Payload Size Restriction</h3><p>With one exception there are no know size limits for requests or responses payloads that pass through the gateway. The exception involves POST or PUT request payload sizes for Oozie in a Kerberos secured Hadoop cluster. In this one case there is currently a 4Kb payload size limit for the first request made to the Hadoop cluster. This is a result of how the gateway negotiates a trust relationship between itself and the cluster via SPNego. There is an undocumented configuration setting to modify this limit&rsquo;s value if required. In the future this will be made more easily configuration and at that time it will be documented.</p><h3><a id="LDAP+Groups+Acquisition"></a>LDAP Groups Acquisition</h3><p>The LDAP authenticator currently does not &ldquo;out of the box&rdquo;
  support the acquisition of group information. This can be addressed by implementing a custom Shiro Realm extension. Building this into the default implementation is on the roadmap.</p><h3><a id="Group+Membership+Propagation"></a>Group Membership Propagation</h3><p>Groups that are acquired via Identity Assertion Group Principal Mapping are not propigated to the Hadoop services. Therefore groups used for Service Level Authorization policy may not match those acquired within the cluster via GroupMappingServiceProvider plugins.</p></div><div id="Troubleshooting"><h2><a id="Troubleshooting"></a>Troubleshooting</h2><h3><a id="Finding+Logs"></a>Finding Logs</h3><p>When things aren&rsquo;t working the first thing you need to do is examine the diagnostic logs. Depending upon how you are running the gateway these diagnostic logs will be output to different locations.</p><h4><a id="java+-jar+bin/gateway.jar"></a>java -jar bin/gateway.jar</h4><p>When the gateway is run this way the diagnostic 
 output is written directly to the console. If you want to capture that output you will need to redirect the console output to a file using OS specific techniques.</p>
+</code></pre></div><div id="Limitations"><h2><a id="Limitations"></a>Limitations</h2><h3><a id="Secure+Oozie+POST/PUT+Request+Payload+Size+Restriction"></a>Secure Oozie POST/PUT Request Payload Size Restriction</h3><p>With one exception there are no know size limits for requests or responses payloads that pass through the gateway. The exception involves POST or PUT request payload sizes for Oozie in a Kerberos secured Hadoop cluster. In this one case there is currently a 4Kb payload size limit for the first request made to the Hadoop cluster. This is a result of how the gateway negotiates a trust relationship between itself and the cluster via SPNego. There is an undocumented configuration setting to modify this limit&rsquo;s value if required. In the future this will be made more easily configuration and at that time it will be documented.</p><h3><a id="LDAP+Groups+Acquisition+from+AD"></a>LDAP Groups Acquisition from AD</h3><p>The LDAP authenticator currently does not &ldquo;out o
 f the box&rdquo; support the acquisition of group information from Microsoft Active Directory. Building this into the default implementation is on the roadmap.</p><h3><a id="Group+Membership+Propagation"></a>Group Membership Propagation</h3><p>Groups that are acquired via Shiro Group Lookup and/or Identity Assertion Group Principal Mapping are not propagated to the Hadoop services. Therefore groups used for Service Level Authorization policy may not match those acquired within the cluster via GroupMappingServiceProvider plugins.</p></div><div id="Troubleshooting"><h2><a id="Troubleshooting"></a>Troubleshooting</h2><h3><a id="Finding+Logs"></a>Finding Logs</h3><p>When things aren&rsquo;t working the first thing you need to do is examine the diagnostic logs. Depending upon how you are running the gateway these diagnostic logs will be output to different locations.</p><h4><a id="java+-jar+bin/gateway.jar"></a>java -jar bin/gateway.jar</h4><p>When the gateway is run this way the diagnos
 tic output is written directly to the console. If you want to capture that output you will need to redirect the console output to a file using OS specific techniques.</p>
 <pre><code>java -jar bin/gateway.jar &gt; gateway.log
 </code></pre><h4><a id="bin/gateway.sh+start"></a>bin/gateway.sh start</h4><p>When the gateway is run this way the diagnostic output is written to /var/log/knox/knox.out and /var/log/knox/knox.err. Typically only knox.out will have content.</p><h3><a id="Increasing+Logging"></a>Increasing Logging</h3><p>The <code>log4j.properties</code> files <code>{GATEWAY_HOME}/conf</code> can be used to change the granularity of the logging done by Knox. The Knox server must be restarted in order for these changes to take effect. There are various useful loggers pre-populated but commented out.</p>
 <pre><code>log4j.logger.org.apache.hadoop.gateway=DEBUG # Use this logger to increase the debugging of Apache Knox itself.
@@ -2854,4 +2846,5 @@ java -jar bin/gateway.jar -version
   <li>The date and time you access our site;</li>
   <li>The pages you visit; and</li>
   <li>The addresses of pages from where you followed a link to our site.</li>
-</ul><p>Part of this information is gathered using a tracking cookie set by the <a href="http://www.google.com/analytics/">Google Analytics</a> service. Google&rsquo;s policy for the use of this information is described in their <a href="http://www.google.com/privacy.html">privacy policy</a>. See your browser&rsquo;s documentation for instructions on how to disable the cookie if you prefer not to share this data with Google.</p><p>We use the gathered information to help us make our site more useful to visitors and to better understand how and when our site is used. We do not track or collect personally identifiable information or associate gathered data with any personally identifying information from other sources.</p><p>By using this website, you consent to the collection of this data in the manner and for the purpose described above.</p></div></div></div>
+</ul><p>Part of this information is gathered using a tracking cookie set by the <a href="http://www.google.com/analytics/">Google Analytics</a> service. Google&rsquo;s policy for the use of this information is described in their <a href="http://www.google.com/privacy.html">privacy policy</a>. See your browser&rsquo;s documentation for instructions on how to disable the cookie if you prefer not to share this data with Google.</p><p>We use the gathered information to help us make our site more useful to visitors and to better understand how and when our site is used. We do not track or collect personally identifiable information or associate gathered data with any personally identifying information from other sources.</p><p>By using this website, you consent to the collection of this data in the manner and for the purpose described above.</p>
+</div></div></div>

Modified: knox/site/books/knox-0-4-0/knox-0-4-0.html
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-4-0/knox-0-4-0.html?rev=1588691&r1=1588690&r2=1588691&view=diff
==============================================================================
--- knox/site/books/knox-0-4-0/knox-0-4-0.html (original)
+++ knox/site/books/knox-0-4-0/knox-0-4-0.html Sat Apr 19 18:29:28 2014
@@ -124,15 +124,11 @@ Server: Jetty(6.1.26)
 {&quot;accessTime&quot;:0,&quot;blockSize&quot;:0,&quot;group&quot;:&quot;hdfs&quot;,&quot;length&quot;:0,&quot;modificationTime&quot;:1350596040075,&quot;owner&quot;:&quot;hdfs&quot;,&quot;pathSuffix&quot;:&quot;tmp&quot;,&quot;permission&quot;:&quot;777&quot;,&quot;replication&quot;:0,&quot;type&quot;:&quot;DIRECTORY&quot;},
 {&quot;accessTime&quot;:0,&quot;blockSize&quot;:0,&quot;group&quot;:&quot;hdfs&quot;,&quot;length&quot;:0,&quot;modificationTime&quot;:1350595857178,&quot;owner&quot;:&quot;hdfs&quot;,&quot;pathSuffix&quot;:&quot;user&quot;,&quot;permission&quot;:&quot;755&quot;,&quot;replication&quot;:0,&quot;type&quot;:&quot;DIRECTORY&quot;}
 ]}}
-</code></pre><h4><a id="Submit+a+MR+job+via+Knox."></a>Submit a MR job via Knox.</h4><h4><a id="Get+status+of+a+MR+job+via+Knox."></a>Get status of a MR job via Knox.</h4><h4><a id="Cancel+a+MR+job+via+Knox."></a>Cancel a MR job via Knox.</h4><h3><a id="More+Examples"></a>More Examples</h3><h2><a id="Apache+Knox+Details"></a>Apache Knox Details</h2><p>This section provides everything you need to know to get the Knox gateway up and running against a Hadoop cluster.</p><h4><a id="Hadoop"></a>Hadoop</h4><p>An an existing Hadoop 1.x or 2.x cluster is required for Knox sit in front of and protect. It is possible to use a Hadoop cluster deployed on EC2 but this will require additional configuration not covered here. It is also possible to use a limited set of services in Hadoop cluster secured with Kerberos. This too required additional configuration that is not described here. See <a href="#Supported+Services">Supported Services</a> for details on what is supported for this release.</p><
 p>The Hadoop cluster should be ensured to have at least WebHDFS, WebHCat (i.e. Templeton) and Oozie configured, deployed and running. HBase/Stargate and Hive can also be accessed via the Knox Gateway given the proper versions and configuration.</p><p>The instructions that follow assume a few things:</p>
+</code></pre><h4><a id="Submit+a+MR+job+via+Knox."></a>Submit a MR job via Knox.</h4><h4><a id="Get+status+of+a+MR+job+via+Knox."></a>Get status of a MR job via Knox.</h4><h4><a id="Cancel+a+MR+job+via+Knox."></a>Cancel a MR job via Knox.</h4><h3><a id="More+Examples"></a>More Examples</h3><h2><a id="Apache+Knox+Details"></a>Apache Knox Details</h2><p>This section provides everything you need to know to get the Knox gateway up and running against a Hadoop cluster.</p><h4><a id="Hadoop"></a>Hadoop</h4><p>An existing Hadoop 2.x cluster is required for Knox 0.4.0 to sit in front of and protect. It is possible to use a Hadoop cluster deployed on EC2 but this will require additional configuration not covered here. It is also possible to protect access to a services of a Hadoop cluster that is secured with kerberos. This too requires additional configuration that is described in other sections of this guide. See <a href="#Supported+Services">Supported Services</a> for details on what is s
 upported for this release.</p><p>The Hadoop cluster should be ensured to have at least WebHDFS, WebHCat (i.e. Templeton) and Oozie configured, deployed and running. HBase/Stargate and Hive can also be accessed via the Knox Gateway given the proper versions and configuration.</p><p>The instructions that follow assume a few things:</p>
 <ol>
   <li>The gateway is <em>not</em> collocated with the Hadoop clusters themselves.</li>
   <li>The host names and IP addresses of the cluster services are accessible by the gateway where ever it happens to be running.</li>
-</ol><p>All of the instructions and samples provided here are tailored and tested to work &ldquo;out of the box&rdquo; against a <a href="http://hortonworks.com/products/hortonworks-sandbox">Hortonworks Sandbox 2.x VM</a>.</p><h4><a id="Apache+Knox+Directory+Layout"></a>Apache Knox Directory Layout</h4><p>Knox can be installed by expanding the zip file or with rpm. With rpm based install the following directories are created in addition to those described in this section.</p>
-<pre><code>/usr/lib/knox
-/var/log/knox
-/var/run/knox
-</code></pre><p>The directory <code>/usr/lib/knox</code> is considered your <code>{GATEWAY_HOME}</code> and will adhere to the layout described below. The directory <code>/var/log/knox</code> will contain the output files from the server. The directory <code>/var/run/knox</code> will contain the process ID for a currently running gateway server.</p><p>Regardless of the installation method used the layout and content of the <code>{GATEWAY_HOME}</code> will be identical. The table below provides a brief explanation of the important files and directories within <code>{GATEWWAY_HOME}</code></p>
+</ol><p>All of the instructions and samples provided here are tailored and tested to work &ldquo;out of the box&rdquo; against a <a href="http://hortonworks.com/products/hortonworks-sandbox">Hortonworks Sandbox 2.x VM</a>.</p><h4><a id="Apache+Knox+Directory+Layout"></a>Apache Knox Directory Layout</h4><p>Knox can be installed by expanding the zip/archive file.</p><p>The table below provides a brief explanation of the important files and directories within <code>{GATEWWAY_HOME}</code></p>
 <table>
   <thead>
     <tr>
@@ -146,59 +142,79 @@ Server: Jetty(6.1.26)
       <td>Contains configuration files that apply to the gateway globally (i.e. not cluster specific ). </td>
     </tr>
     <tr>
+      <td>data/ </td>
+      <td>Contains security and topology specific artifacts that require read/write access at runtime </td>
+    </tr>
+    <tr>
+      <td>data/topologies/</td>
+      <td>Contains topology files that represent Hadoop clusters which the gateway uses to deploy cluster proxies</td>
+    </tr>
+    <tr>
+      <td>data/security/ </td>
+      <td>Contains the persisted master secret and keystore dir</td>
+    </tr>
+    <tr>
+      <td>data/security/keystores/</td>
+      <td>Contains the gateway identity keystore and credential stores for the gateway and each deployed cluster topology</td>
+    </tr>
+    <tr>
       <td>bin/ </td>
-      <td>Contains the executable shell scripts, batch files and JARs for clients and servers. </td>
+      <td>Contains the executable shell scripts, batch files and JARs for clients and servers.</td>
     </tr>
     <tr>
-      <td>deployments/ </td>
-      <td>Contains topology descriptors used to configure the gateway for specific Hadoop clusters. </td>
+      <td>data/deployments/ </td>
+      <td>Contains deployed cluster topologies used to protect access to specific Hadoop clusters.</td>
     </tr>
     <tr>
       <td>lib/ </td>
-      <td>Contains the JARs for all the components that make up the gateway. </td>
+      <td>Contains the JARs for all the components that make up the gateway.</td>
     </tr>
     <tr>
       <td>dep/ </td>
-      <td>Contains the JARs for all of the components upon which the gateway depends. </td>
+      <td>Contains the JARs for all of the components upon which the gateway depends.</td>
     </tr>
     <tr>
       <td>ext/ </td>
-      <td>A directory where user supplied extension JARs can be placed to extends the gateways functionality. </td>
+      <td>A directory where user supplied extension JARs can be placed to extends the gateways functionality.</td>
+    </tr>
+    <tr>
+      <td>pids/ </td>
+      <td>Contains the process ids for running ldap and gateway servers</td>
     </tr>
     <tr>
       <td>samples/ </td>
-      <td>Contains a number of samples that can be used to explore the functionality of the gateway. </td>
+      <td>Contains a number of samples that can be used to explore the functionality of the gateway.</td>
     </tr>
     <tr>
       <td>templates/ </td>
-      <td>Contains default configuration files that can be copied and customized. </td>
+      <td>Contains default configuration files that can be copied and customized.</td>
     </tr>
     <tr>
       <td>README </td>
-      <td>Provides basic information about the Apache Knox Gateway. </td>
+      <td>Provides basic information about the Apache Knox Gateway.</td>
     </tr>
     <tr>
       <td>ISSUES </td>
-      <td>Describes significant know issues. </td>
+      <td>Describes significant know issues.</td>
     </tr>
     <tr>
       <td>CHANGES </td>
-      <td>Enumerates the changes between releases. </td>
+      <td>Enumerates the changes between releases.</td>
     </tr>
     <tr>
       <td>LICENSE </td>
-      <td>Documents the license under which this software is provided. </td>
+      <td>Documents the license under which this software is provided.</td>
     </tr>
     <tr>
       <td>NOTICE </td>
-      <td>Documents required attribution notices for included dependencies. </td>
+      <td>Documents required attribution notices for included dependencies.</td>
     </tr>
     <tr>
       <td>DISCLAIMER </td>
-      <td>Documents that this release is from a project undergoing incubation at Apache. </td>
+      <td>Documents that this release is from a project undergoing incubation at Apache.</td>
     </tr>
   </tbody>
-</table><h3><a id="Supported+Services"></a>Supported Services</h3><p>This table enumerates the versions of various Hadoop services that have been tested to work with the Knox Gateway. Only more recent versions of some Hadoop components when secured via Kerberos can be accessed via the Knox Gateway.</p>
+</table><h3><a id="Supported+Services"></a>Supported Services</h3><p>This table enumerates the versions of various Hadoop services that have been tested to work with the Knox Gateway.</p>
 <table>
   <thead>
     <tr>
@@ -211,15 +227,15 @@ Server: Jetty(6.1.26)
   <tbody>
     <tr>
       <td>WebHDFS </td>
-      <td>2.1.0 </td>
+      <td>2.4.0 </td>
       <td><img src="check.png"  alt="y"/> </td>
       <td><img src="check.png"  alt="y"/> </td>
     </tr>
     <tr>
       <td>WebHCat/Templeton </td>
-      <td>0.11.0 </td>
+      <td>0.13.0 </td>
+      <td><img src="check.png"  alt="y"/> </td>
       <td><img src="check.png"  alt="y"/> </td>
-      <td><img src="error.png"  alt="n"/> </td>
     </tr>
     <tr>
       <td> </td>
@@ -235,45 +251,21 @@ Server: Jetty(6.1.26)
     </tr>
     <tr>
       <td>HBase/Stargate </td>
-      <td>0.95.2 </td>
+      <td>0.98.0 </td>
       <td><img src="check.png"  alt="y"/> </td>
-      <td><img src="error.png"  alt="n"/> </td>
-    </tr>
-    <tr>
-      <td>Hive (via WebHCat) </td>
-      <td>0.11.0 </td>
       <td><img src="check.png"  alt="y"/> </td>
-      <td><img src="error.png"  alt="n"/> </td>
     </tr>
     <tr>
-      <td> </td>
-      <td>0.12.0 </td>
+      <td>Hive (via WebHCat) </td>
+      <td>0.13.0 </td>
       <td><img src="check.png"  alt="y"/> </td>
       <td><img src="check.png"  alt="y"/> </td>
     </tr>
     <tr>
       <td>Hive (via JDBC) </td>
-      <td>0.11.0 </td>
-      <td><img src="error.png"  alt="n"/> </td>
-      <td><img src="error.png"  alt="n"/> </td>
-    </tr>
-    <tr>
-      <td> </td>
-      <td>0.12.0 </td>
+      <td>0.13.0 </td>
+      <td><img src="check.png"  alt="y"/> </td>
       <td><img src="check.png"  alt="y"/> </td>
-      <td><img src="error.png"  alt="n"/> </td>
-    </tr>
-    <tr>
-      <td>Hive (via ODBC) </td>
-      <td>0.11.0 </td>
-      <td><img src="error.png"  alt="n"/> </td>
-      <td><img src="error.png"  alt="n"/> </td>
-    </tr>
-    <tr>
-      <td> </td>
-      <td>0.12.0 </td>
-      <td><img src="error.png"  alt="n"/> </td>
-      <td><img src="error.png"  alt="n"/> </td>
     </tr>
   </tbody>
 </table><h3><a id="More+Examples"></a>More Examples</h3><p>These examples provide more detail about how to access various Apache Hadoop services via the Apache Knox Gateway.</p>
@@ -340,7 +332,7 @@ Server: Jetty(6.1.26)
 &lt;/service&gt;
 </code></pre>
 <dl><dt>/topology/service</dt><dd>Provider information about a particular service within the Hadoop cluster. Not all services are necessarily exposed as gateway endpoints.</dd><dt>/topology/service/role</dt><dd>Identifies the role of this service. Currently supported roles are: WEBHDFS, WEBHCAT, WEBHBASE, OOZIE, HIVE, NAMENODE, JOBTRACKER Additional service roles can be supported via plugins.</dd><dt>topology/service/url</dt><dd>The URL identifying the location of a particular service within the Hadoop cluster.</dd>
-</dl><h4><a id="Hostmap+Provider"></a>Hostmap Provider</h4><p>The purpose of the Hostmap provider is to handle situations where host are know by one name within the cluster and another name externally. This frequently occurs when virtual machines are used and in particular using cloud hosting services. Currently the Hostmap provider is configured as part of the topology file. The basic structure is shown below.</p>
+</dl><h4><a id="Hostmap+Provider"></a>Hostmap Provider</h4><p>The purpose of the Hostmap provider is to handle situations where host are known by one name within the cluster and another name externally. This frequently occurs when virtual machines are used and in particular when using cloud hosting services. Currently, the Hostmap provider is configured as part of the topology file. The basic structure is shown below.</p>
 <pre><code>&lt;topology&gt;
     &lt;gateway&gt;
         ...
@@ -383,7 +375,7 @@ ip-10-39-107-209.ec2.internal
     &lt;/gateway&gt;
     ...
 &lt;/topology&gt;
-</code></pre><h5><a id="Hostmap+Provider+Example+-+Sandbox"></a>Hostmap Provider Example - Sandbox</h5><p>Hortonwork&rsquo;s Sandbox 2.x poses a different challenge for host name mapping. This version of the Sandbox uses port mapping to make the Sandbox VM appear as though it is accessible via localhost. However the Sandbox VM is internally configured to consider sandbox.hortonworks.com as the host name. So from the perspective of a client accessing Sandbox the external host name is localhost. The Hostmap configuration required to allow access to Sandbox from the host operating system is this.</p>
+</code></pre><h5><a id="Hostmap+Provider+Example+-+Sandbox"></a>Hostmap Provider Example - Sandbox</h5><p>The Hortonworks Sandbox 2.x poses a different challenge for host name mapping. This version of the Sandbox uses port mapping to make the Sandbox VM appear as though it is accessible via localhost. However the Sandbox VM is internally configured to consider sandbox.hortonworks.com as the host name. So from the perspective of a client accessing Sandbox the external host name is localhost. The Hostmap configuration required to allow access to Sandbox from the host operating system is this.</p>
 <pre><code>&lt;topology&gt;
     &lt;gateway&gt;
         ...
@@ -401,19 +393,19 @@ ip-10-39-107-209.ec2.internal
 <dl><dt>topology/gateway/provider/role</dt><dd>The role for a Hostmap provider must always be <code>hostmap</code>.</dd><dt>topology/gateway/provider/name</dt><dd>The Hostmap provider supplied out-of-the-box is selected via the name <code>static</code>.</dd><dt>topology/gateway/provider/enabled</dt><dd>Host mapping can be enabled or disabled by providing <code>true</code> or <code>false</code>.</dd><dt>topology/gateway/provider/param</dt><dd>Host mapping is configured by providing parameters for each external to internal mapping.</dd><dt>topology/gateway/provider/param/name</dt><dd>The parameter names represent an external host names associated with the internal host names provided by the value element. This can be a comma separated list of host names that all represent the same physical host. When mapping from internal to external host name the first external host name in the list is used.</dd><dt>topology/gateway/provider/param/value</dt><dd>The parameter values represent the inte
 rnal host names associated with the external host names provider by the name element. This can be a comma separated list of host names that all represent the same physical host. When mapping from external to internal host names the first internal host name in the list is used.</dd>
 </dl><h4><a id="Logging"></a>Logging</h4><p>If necessary you can enable additional logging by editing the <code>log4j.properties</code> file in the <code>conf</code> directory. Changing the rootLogger value from <code>ERROR</code> to <code>DEBUG</code> will generate a large amount of debug logging. A number of useful, more fine loggers are also provided in the file.</p><h4><a id="Java+VM+Options"></a>Java VM Options</h4><p>TODO - Java VM options doc.</p><h4><a id="Persisting+the+Master+Secret"></a>Persisting the Master Secret</h4><p>The master secret is required to start the server. This secret is used to access secured artifacts by the gateway instance. Keystore, trust stores and credential stores are all protected with the master secret.</p><p>You may persist the master secret by supplying the <em>-persist-master</em> switch at startup. This will result in a warning indicating that persisting the secret is less secure than providing it at startup. We do make some provisions in ord
 er to protect the persisted password.</p><p>It is encrypted with AES 128 bit encryption and where possible the file permissions are set to only be accessible by the user that the gateway is running as.</p><p>After persisting the secret, ensure that the file at config/security/master has the appropriate permissions set for your environment. This is probably the most important layer of defense for master secret. Do not assume that the encryption if sufficient protection.</p><p>A specific user should be created to run the gateway this user will be the only user with permissions for the persisted master file.</p><p>See the Knox CLI section for descriptions of the command line utilties related to the master secret.</p><h4><a id="Management+of+Security+Artifacts"></a>Management of Security Artifacts</h4><p>There are a number of artifacts that are used by the gateway in ensuring the security of wire level communications, access to protected resources and the encryption of sensitive data. T
 hese artifacts can be managed from outside of the gateway instances or generated and populated by the gateway instance itself.</p><p>The following is a description of how this is coordinated with both standalone (development, demo, etc) gateway instances and instances as part of a cluster of gateways in mind.</p><p>Upon start of the gateway server we:</p>
 <ol>
-  <li>Look for an identity store at <code>conf/security/keystores/gateway.jks</code>.  The identity store contains the certificate and private key used to represent the identity of the server for SSL connections and signature creation.
+  <li>Look for an identity store at <code>data/security/keystores/gateway.jks</code>.  The identity store contains the certificate and private key used to represent the identity of the server for SSL connections and signature creation.
   <ul>
     <li>If there is no identity store we create one and generate a self-signed certificate for use in standalone/demo mode.  The certificate is stored with an alias of gateway-identity.</li>
-    <li>If there is an identity store found than we ensure that it can be loaded using the provided master secret and that there is an alias with called gateway-identity.</li>
+    <li>If there is an identity store found than we ensure that it can be loaded using the provided master secret and that there is an alias called gateway-identity.</li>
   </ul></li>
-  <li>Look for a credential store at <code>conf/security/keystores/__gateway-credentials.jceks</code>.  This credential store is used to store secrets/passwords that are used by the gateway.  For instance, this is where the pass-phrase for accessing the gateway-identity certificate is kept.
+  <li>Look for a credential store at <code>data/security/keystores/__gateway-credentials.jceks</code>.  This credential store is used to store secrets/passwords that are used by the gateway.  For instance, this is where the passphrase for accessing the gateway-identity certificate is kept.
   <ul>
-    <li>If there is no credential store found then we create one and populate it with a generated pass-phrase for the alias <code>gateway-identity-passphrase</code>.  This is coordinated with the population of the self-signed cert into the identity-store.</li>
+    <li>If there is no credential store found then we create one and populate it with a generated passphrase for the alias <code>gateway-identity-passphrase</code>.  This is coordinated with the population of the self-signed cert into the identity-store.</li>
     <li>If a credential store is found then we ensure that it can be loaded using the provided master secret and that the expected aliases have been populated with secrets.</li>
   </ul></li>
 </ol><p>Upon deployment of a Hadoop cluster topology within the gateway we:</p>
 <ol>
-  <li>Look for a credential store for the topology. For instance, we have a sample topology that gets deployed out of the box. We look for <code>conf/security/keystores/sandbox-credentials.jceks</code>. This topology specific credential store is used for storing secrets/passwords that are used for encrypting sensitive data with topology specific keys.
+  <li>Look for a credential store for the topology. For instance, we have a sample topology that gets deployed out of the box. We look for <code>data/security/keystores/sandbox-credentials.jceks</code>. This topology specific credential store is used for storing secrets/passwords that are used for encrypting sensitive data with topology specific keys.
   <ul>
     <li>If no credential store is found for the topology being deployed then one is created for it.  Population of the aliases is delegated to the configured providers within the system that will require the use of a secret for a particular task.  They may programmatic set the value of the secret or choose to have the value for the specified alias generated through the AliasService.</li>
     <li>If a credential store is found then we ensure that it can be loaded with the provided master secret and the configured providers have the opportunity to ensure that the aliases are populated and if not to populate them.</li>
@@ -423,7 +415,7 @@ ip-10-39-107-209.ec2.internal
   <li>Using a single gateway instance as a master instance the artifacts can be generated or placed into the expected location and then replicated across all of the slave instances before startup.</li>
   <li>Using an NFS mount as a central location for the artifacts would provide a single source of truth without the need to replicate them over the network. Of course, NFS mounts have their own challenges.</li>
   <li>Using the KnoxCLI to create and manage the security artifacts.</li>
-</ol><p>See the Knox CLI section for descriptions of the command line utilties related to the security artifact management.</p><h4><a id="Keystores"></a>Keystores</h4><p>In order to provide your own certificate for use by the gateway, you will need to either import an existing key pair into a Java keystore or generate a self-signed cert using the Java keytool.</p><h5><a id="Importing+a+key+pair+into+a+Java+keystore"></a>Importing a key pair into a Java keystore</h5><h1><a id="----NEEDS+TESTING"></a>&mdash;-NEEDS TESTING</h1><p>One way to accomplish this is to start with a PKCS12 store for your key pair and then convert it to a Java keystore or JKS.</p>
+</ol><p>See the Knox CLI section for descriptions of the command line utilties related to the security artifact management.</p><h4><a id="Keystores"></a>Keystores</h4><p>In order to provide your own certificate for use by the gateway, you will need to either import an existing key pair into a Java keystore or generate a self-signed cert using the Java keytool.</p><h5><a id="Importing+a+key+pair+into+a+Java+keystore"></a>Importing a key pair into a Java keystore</h5><p>One way to accomplish this is to start with a PKCS12 store for your key pair and then convert it to a Java keystore or JKS.</p>
 <pre><code>openssl pkcs12 -export -in cert.pem -inkey key.pem &gt; server.p12
 </code></pre><p>The above example uses openssl to create a PKCS12 encoded store for your provided certificate private key.</p>
 <pre><code>keytool -importkeystore -srckeystore {server.p12} -destkeystore gateway.jks -srcstoretype pkcs12
@@ -431,11 +423,11 @@ ip-10-39-107-209.ec2.internal
 <ol>
   <li>the alias MUST be &ldquo;gateway-identity&rdquo;</li>
   <li>the name of the expected identity keystore for the gateway MUST be gateway.jks</li>
-  <li>the passwords for the keystore and the imported key MUST both be the master secret for the gateway install</li>
-</ol><p>NOTE: The password for the keystore as well as that of the imported key must be the master secret for the gateway instance.</p><h1><a id="----END+NEEDS+TESTING"></a>&mdash;-END NEEDS TESTING</h1><h5><a id="Generating+a+self-signed+cert+for+use+in+testing+or+development+environments"></a>Generating a self-signed cert for use in testing or development environments</h5>
+  <li>the passwords for the keystore and the imported key may both be set to the master secret for the gateway install</li>
+</ol><p>NOTE: The password for the keystore as well as that of the imported key may be the master secret for the gateway instance or you may set the gateway-identity-passphrase alias using the Knox CLI to the actual key passphrase. See the Knox CLI section for details.</p><h5><a id="Generating+a+self-signed+cert+for+use+in+testing+or+development+environments"></a>Generating a self-signed cert for use in testing or development environments</h5>
 <pre><code>keytool -genkey -keyalg RSA -alias gateway-identity -keystore gateway.jks \
     -storepass {master-secret} -validity 360 -keysize 2048
-</code></pre><p>Keytool will prompt you for a number of elements used will comprise the distiniguished name (DN) within your certificate. </p><p><em>NOTE:</em> When it prompts you for your First and Last name be sure to type in the hostname of the machine that your gateway instance will be running on. This is used by clients during hostname verification to ensure that the presented certificate matches the hostname that was used in the URL for the connection - so they need to match.</p><p><em>NOTE:</em> When it prompts for the key password just press enter to ensure that it is the same as the keystore password. Which as was described earlier must match the master secret for the gateway instance.</p><p>See the Knox CLI section for descriptions of the command line utilties related to the management of the keystores.</p><h5><a id="Credential+Store"></a>Credential Store</h5><p>Whenever you provide your own keystore with either a self-signed cert or a real certificate signed by a trusted 
 authority, you will need to create an empty credential store. This is necessary for the current release in order for the system to utilize the same password for the keystore and the key.</p><p>The credential stores in Knox use the JCEKS keystore type as it allows for the storage of general secrets in addition to certificates.</p><p>Keytool may be used to create credential stores but the Knox CLI section details how to create aliases. These aliases are managed within credential stores which are created by the CLI as appropriate. </p><p>See the Knox CLI section for descriptions of the command line utilties related to the management of the credential stores.</p><h5><a id="Provisioning+of+Keystores"></a>Provisioning of Keystores</h5><p>Once you have created these keystores you must move them into place for the gateway to discover them and use them to represent its identity for SSL connections. This is done by copying the keystores to the <code>{GATEWAY_HOME}/conf/security/keystores</cod
 e> directory for your gateway install.</p><h4><a id="Summary+of+Secrets+to+be+Managed"></a>Summary of Secrets to be Managed</h4>
+</code></pre><p>Keytool will prompt you for a number of elements used will comprise the distiniguished name (DN) within your certificate. </p><p><em>NOTE:</em> When it prompts you for your First and Last name be sure to type in the hostname of the machine that your gateway instance will be running on. This is used by clients during hostname verification to ensure that the presented certificate matches the hostname that was used in the URL for the connection - so they need to match.</p><p><em>NOTE:</em> When it prompts for the key password just press enter to ensure that it is the same as the keystore password. Which as was described earlier must match the master secret for the gateway instance. Alternatively, you can set it to another passphrase - take note of it and set the gateway-identity-passphrase alias to that passphrase using the Knox CLI.</p><p>See the Knox CLI section for descriptions of the command line utilties related to the management of the keystores.</p><h5><a id="Cre
 dential+Store"></a>Credential Store</h5><p>Whenever you provide your own keystore with either a self-signed cert or an issued certificate signed by a trusted authority, you will need to set an alias for the gateway-identity-passphrase or create an empty credential store. This is necessary for the current release in order for the system to determine the correct password for the keystore and the key.</p><p>The credential stores in Knox use the JCEKS keystore type as it allows for the storage of general secrets in addition to certificates.</p><p>Keytool may be used to create credential stores but the Knox CLI section details how to create aliases. These aliases are managed within credential stores which are created by the CLI as needed. The simplest approach is to create the gateway-identity-passpharse alias with the Knox CLI. This will create the credential store if it doesn&rsquo;t already exist and add the key passphrase.</p><p>See the Knox CLI section for descriptions of the comman
 d line utilties related to the management of the credential stores.</p><h5><a id="Provisioning+of+Keystores"></a>Provisioning of Keystores</h5><p>Once you have created these keystores you must move them into place for the gateway to discover them and use them to represent its identity for SSL connections. This is done by copying the keystores to the <code>{GATEWAY_HOME}/data/security/keystores</code> directory for your gateway install.</p><h4><a id="Summary+of+Secrets+to+be+Managed"></a>Summary of Secrets to be Managed</h4>
 <ol>
   <li>Master secret - the same for all gateway instances in a cluster of gateways</li>
   <li>All security related artifacts are protected with the master secret</li>
@@ -1116,7 +1108,7 @@ APACHE_HOME/bin/apachectl -k stop
   </tbody>
 </table><h4><a id="REST+Invocation"></a>REST Invocation</h4><p>The following curl command can be used to request a directory listing from HDFS while passing in the expected header X-XSRF-Header.</p>
 <pre><code>curl -k -i --header &quot;X-XSRF-Header: valid&quot; -v -u guest:guest-password https://localhost:8443/gateway/sandbox/webhdfs/v1/tmp?op=LISTSTATUS
-</code></pre><p>Omitting the &ndash;header &ldquo;X-XSRF-Header: valid&rdquo; above should result in an HTTP 400 bad_request.</p><p>Disabling the provider will then allow a request that is missing the header through. </p><h3><a id="Preauthenticated+SSO+Provider"></a>Preauthenticated SSO Provider</h3><p>A number of SSO solutions provide mechanisms for federating an authenticated identity across applications. These mechanisms are at times simple HTTP Header type tokens that can be used to propagate the identity across process boundaries.</p><p>Knox Gateway needs a pluggable mechanism for consuming these tokens and federating the asserted identity through an interaction with the Hadoop cluster. </p><p><strong>CAUTION: The use of this provider requires that proper network security and identity provider configuration and deployment does not allow requests directly to the Knox gateway. Otherwise, this provider will leave the gateway exposed to identity spoofing.</strong></p><h4><a id="Con
 figuration"></a>Configuration</h4><h5><a id="Overview"></a>Overview</h5><p>The HeaderPreAuth provider is configured within the topology file and has a minimal configuration that assumes SM_USER for CA SiteMinder. The following example is the bare minimum configuration for SiteMinder (with no IP address validation).</p>
+</code></pre><p>Omitting the &ndash;header &ldquo;X-XSRF-Header: valid&rdquo; above should result in an HTTP 400 bad_request.</p><p>Disabling the provider will then allow a request that is missing the header through. </p><h3><a id="Preauthenticated+SSO+Provider"></a>Preauthenticated SSO Provider</h3><p>A number of SSO solutions provide mechanisms for federating an authenticated identity across applications. These mechanisms are at times simple HTTP Header type tokens that can be used to propagate the identity across process boundaries.</p><p>Knox Gateway needs a pluggable mechanism for consuming these tokens and federating the asserted identity through an interaction with the Hadoop cluster. </p><p><strong>CAUTION: The use of this provider requires that proper network security and identity provider configuration and deployment does not allow requests directly to the Knox gateway. Otherwise, this provider will leave the gateway exposed to identity spoofing.</strong></p><h4><a id="Con
 figuration"></a>Configuration</h4><h5><a id="Overview"></a>Overview</h5><p>This provider was designed for use with identity solutions such as those provided by CA&rsquo;s SiteMinder and IBM&rsquo;s Tivoli Access Manager. While direct testing with these products has not been done, there has been extensive unit and functional testing that ensure that it should work with such providers.</p><p>The HeaderPreAuth provider is configured within the topology file and has a minimal configuration that assumes SM_USER for CA SiteMinder. The following example is the bare minimum configuration for SiteMinder (with no IP address validation).</p>
 <pre><code>&lt;provider&gt;
   &lt;role&gt;federation&lt;/role&gt;
   &lt;name&gt;HeaderPreAuth&lt;/name&gt;
@@ -2728,7 +2720,7 @@ connection.close();
 2012-02-03 --- 18:35:34 --- SampleClass6 --- [TRACE]
 2012-02-03 --- 18:35:34 --- SampleClass2 --- [DEBUG]
 ...
-</code></pre><h2><a id="Limitations"></a>Limitations</h2><h3><a id="Secure+Oozie+POST/PUT+Request+Payload+Size+Restriction"></a>Secure Oozie POST/PUT Request Payload Size Restriction</h3><p>With one exception there are no know size limits for requests or responses payloads that pass through the gateway. The exception involves POST or PUT request payload sizes for Oozie in a Kerberos secured Hadoop cluster. In this one case there is currently a 4Kb payload size limit for the first request made to the Hadoop cluster. This is a result of how the gateway negotiates a trust relationship between itself and the cluster via SPNego. There is an undocumented configuration setting to modify this limit&rsquo;s value if required. In the future this will be made more easily configuration and at that time it will be documented.</p><h3><a id="LDAP+Groups+Acquisition"></a>LDAP Groups Acquisition</h3><p>The LDAP authenticator currently does not &ldquo;out of the box&rdquo; support the acquisition of 
 group information. This can be addressed by implementing a custom Shiro Realm extension. Building this into the default implementation is on the roadmap.</p><h3><a id="Group+Membership+Propagation"></a>Group Membership Propagation</h3><p>Groups that are acquired via Identity Assertion Group Principal Mapping are not propigated to the Hadoop services. Therefore groups used for Service Level Authorization policy may not match those acquired within the cluster via GroupMappingServiceProvider plugins.</p><h2><a id="Troubleshooting"></a>Troubleshooting</h2><h3><a id="Finding+Logs"></a>Finding Logs</h3><p>When things aren&rsquo;t working the first thing you need to do is examine the diagnostic logs. Depending upon how you are running the gateway these diagnostic logs will be output to different locations.</p><h4><a id="java+-jar+bin/gateway.jar"></a>java -jar bin/gateway.jar</h4><p>When the gateway is run this way the diagnostic output is written directly to the console. If you want to ca
 pture that output you will need to redirect the console output to a file using OS specific techniques.</p>
+</code></pre><h2><a id="Limitations"></a>Limitations</h2><h3><a id="Secure+Oozie+POST/PUT+Request+Payload+Size+Restriction"></a>Secure Oozie POST/PUT Request Payload Size Restriction</h3><p>With one exception there are no know size limits for requests or responses payloads that pass through the gateway. The exception involves POST or PUT request payload sizes for Oozie in a Kerberos secured Hadoop cluster. In this one case there is currently a 4Kb payload size limit for the first request made to the Hadoop cluster. This is a result of how the gateway negotiates a trust relationship between itself and the cluster via SPNego. There is an undocumented configuration setting to modify this limit&rsquo;s value if required. In the future this will be made more easily configuration and at that time it will be documented.</p><h3><a id="LDAP+Groups+Acquisition+from+AD"></a>LDAP Groups Acquisition from AD</h3><p>The LDAP authenticator currently does not &ldquo;out of the box&rdquo; support the
  acquisition of group information from Microsoft Active Directory. Building this into the default implementation is on the roadmap.</p><h3><a id="Group+Membership+Propagation"></a>Group Membership Propagation</h3><p>Groups that are acquired via Shiro Group Lookup and/or Identity Assertion Group Principal Mapping are not propagated to the Hadoop services. Therefore groups used for Service Level Authorization policy may not match those acquired within the cluster via GroupMappingServiceProvider plugins.</p><h2><a id="Troubleshooting"></a>Troubleshooting</h2><h3><a id="Finding+Logs"></a>Finding Logs</h3><p>When things aren&rsquo;t working the first thing you need to do is examine the diagnostic logs. Depending upon how you are running the gateway these diagnostic logs will be output to different locations.</p><h4><a id="java+-jar+bin/gateway.jar"></a>java -jar bin/gateway.jar</h4><p>When the gateway is run this way the diagnostic output is written directly to the console. If you want t
 o capture that output you will need to redirect the console output to a file using OS specific techniques.</p>
 <pre><code>java -jar bin/gateway.jar &gt; gateway.log
 </code></pre><h4><a id="bin/gateway.sh+start"></a>bin/gateway.sh start</h4><p>When the gateway is run this way the diagnostic output is written to /var/log/knox/knox.out and /var/log/knox/knox.err. Typically only knox.out will have content.</p><h3><a id="Increasing+Logging"></a>Increasing Logging</h3><p>The <code>log4j.properties</code> files <code>{GATEWAY_HOME}/conf</code> can be used to change the granularity of the logging done by Knox. The Knox server must be restarted in order for these changes to take effect. There are various useful loggers pre-populated but commented out.</p>
 <pre><code>log4j.logger.org.apache.hadoop.gateway=DEBUG # Use this logger to increase the debugging of Apache Knox itself.

Modified: knox/site/books/knox-0-4-0/likeised
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-4-0/likeised?rev=1588691&r1=1588690&r2=1588691&view=diff
==============================================================================
--- knox/site/books/knox-0-4-0/likeised (original)
+++ knox/site/books/knox-0-4-0/likeised Sat Apr 19 18:29:28 2014
@@ -41,4 +41,4 @@ s@<h2><a id="Export+Controls@</div><div 
 # closing the last chapter section, page-wrap and content sections is done outside of this script
 # using cat >> filename
 
-# sed -f likeised knox-incubating-0-4-0.html > knox-incubating-0-4-0-new.html && echo "</div></div></div>" >> knox-incubating-0-4-0-new.html
+# sed -f likeised knox-0-4-0.html > knox-0-4-0-new.html && echo "</div></div></div>" >> knox-0-4-0-new.html

Modified: knox/trunk/books/0.4.0/book_getting-started.md
URL: http://svn.apache.org/viewvc/knox/trunk/books/0.4.0/book_getting-started.md?rev=1588691&r1=1588690&r2=1588691&view=diff
==============================================================================
--- knox/trunk/books/0.4.0/book_getting-started.md (original)
+++ knox/trunk/books/0.4.0/book_getting-started.md Sat Apr 19 18:29:28 2014
@@ -21,10 +21,10 @@ This section provides everything you nee
 
 #### Hadoop ####
 
-An an existing Hadoop 1.x or 2.x cluster is required for Knox sit in front of and protect.
+An existing Hadoop 2.x cluster is required for Knox 0.4.0 to sit in front of and protect.
 It is possible to use a Hadoop cluster deployed on EC2 but this will require additional configuration not covered here.
-It is also possible to use a limited set of services in Hadoop cluster secured with Kerberos.
-This too required additional configuration that is not described here.
+It is also possible to protect access to a services of a Hadoop cluster that is secured with kerberos.
+This too requires additional configuration that is described in other sections of this guide.
 See #[Supported Services] for details on what is supported for this release.
 
 The Hadoop cluster should be ensured to have at least WebHDFS, WebHCat (i.e. Templeton) and Oozie configured, deployed and running.
@@ -40,57 +40,46 @@ All of the instructions and samples prov
 
 #### Apache Knox Directory Layout ####
 
-Knox can be installed by expanding the zip file or with rpm. With rpm based install the following directories are created in addition to those described in
-this section.
+Knox can be installed by expanding the zip/archive file.
 
-    /usr/lib/knox
-    /var/log/knox
-    /var/run/knox
-
-The directory `/usr/lib/knox` is considered your `{GATEWAY_HOME}` and will adhere to the layout described below.
-The directory `/var/log/knox` will contain the output files from the server.
-The directory `/var/run/knox` will contain the process ID for a currently running gateway server.
-
-
-Regardless of the installation method used the layout and content of the `{GATEWAY_HOME}` will be identical.
 The table below provides a brief explanation of the important files and directories within `{GATEWWAY_HOME}`
 
 | Directory     | Purpose |
 | ------------- | ------- |
 | conf/         | Contains configuration files that apply to the gateway globally (i.e. not cluster specific ).       |
-| bin/          | Contains the executable shell scripts, batch files and JARs for clients and servers.                |
-| deployments/  | Contains topology descriptors used to configure the gateway for specific Hadoop clusters.           |
-| lib/          | Contains the JARs for all the components that make up the gateway.                                  |
-| dep/          | Contains the JARs for all of the components upon which the gateway depends.                         |
-| ext/          | A directory where user supplied extension JARs can be placed to extends the gateways functionality. |
-| samples/      | Contains a number of samples that can be used to explore the functionality of the gateway.          |
-| templates/    | Contains default configuration files that can be copied and customized.                             |
-| README        | Provides basic information about the Apache Knox Gateway.                                           |
-| ISSUES        | Describes significant know issues.                                                                  |
-| CHANGES       | Enumerates the changes between releases.                                                            |
-| LICENSE       | Documents the license under which this software is provided.                                        |
-| NOTICE        | Documents required attribution notices for included dependencies.                                   |
-| DISCLAIMER    | Documents that this release is from a project undergoing incubation at Apache.                      |
+| data/         | Contains security and topology specific artifacts that require read/write access at runtime |
+|data/topologies/|Contains topology files that represent Hadoop clusters which the gateway uses to deploy cluster proxies|
+|data/security/ | Contains the persisted master secret and keystore dir|
+|data/security/keystores/| Contains the gateway identity keystore and credential stores for the gateway and each deployed cluster topology|
+| bin/          | Contains the executable shell scripts, batch files and JARs for clients and servers.|
+| data/deployments/ | Contains deployed cluster topologies used to protect access to specific Hadoop clusters.|
+| lib/          | Contains the JARs for all the components that make up the gateway.|
+| dep/          | Contains the JARs for all of the components upon which the gateway depends.|
+| ext/          | A directory where user supplied extension JARs can be placed to extends the gateways functionality.|
+| pids/         | Contains the process ids for running ldap and gateway servers|
+| samples/      | Contains a number of samples that can be used to explore the functionality of the gateway.|
+| templates/    | Contains default configuration files that can be copied and customized.|
+| README        | Provides basic information about the Apache Knox Gateway.|
+| ISSUES        | Describes significant know issues.|
+| CHANGES       | Enumerates the changes between releases.|
+| LICENSE       | Documents the license under which this software is provided.|
+| NOTICE        | Documents required attribution notices for included dependencies.|
+| DISCLAIMER    | Documents that this release is from a project undergoing incubation at Apache.|
 
 
 ### Supported Services ###
 
 This table enumerates the versions of various Hadoop services that have been tested to work with the Knox Gateway.
-Only more recent versions of some Hadoop components when secured via Kerberos can be accessed via the Knox Gateway.
 
 | Service            | Version    | Non-Secure  | Secure |
 | ------------------ | ---------- | ----------- | ------ |
-| WebHDFS            | 2.1.0      | ![y]        | ![y]   |
-| WebHCat/Templeton  | 0.11.0     | ![y]        | ![n]   |
+| WebHDFS            | 2.4.0      | ![y]        | ![y]   |
+| WebHCat/Templeton  | 0.13.0     | ![y]        | ![y]   |
 |                    | 0.12.0     | ![y]        | ![y]   |
 | Ozzie              | 4.0.0      | ![y]        | ![y]   |
-| HBase/Stargate     | 0.95.2     | ![y]        | ![n]   |
-| Hive (via WebHCat) | 0.11.0     | ![y]        | ![n]   |
-|                    | 0.12.0     | ![y]        | ![y]   |
-| Hive (via JDBC)    | 0.11.0     | ![n]        | ![n]   |
-|                    | 0.12.0     | ![y]        | ![n]   |
-| Hive (via ODBC)    | 0.11.0     | ![n]        | ![n]   |
-|                    | 0.12.0     | ![n]        | ![n]   |
+| HBase/Stargate     | 0.98.0     | ![y]        | ![y]   |
+| Hive (via WebHCat) | 0.13.0     | ![y]        | ![y]   |
+| Hive (via JDBC)    | 0.13.0     | ![y]        | ![y]   |
 
 
 ### More Examples ###



Mime
View raw message