knox-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kmin...@apache.org
Subject svn commit: r1676260 - in /knox: site/books/knox-0-6-0/dev-guide.html site/books/knox-0-6-0/user-guide.html trunk/books/0.6.0/admin_api.md trunk/books/0.6.0/book_getting-started.md trunk/books/0.6.0/dev-guide/book.md trunk/books/0.6.0/quick_start.md
Date Mon, 27 Apr 2015 13:38:25 GMT
Author: kminder
Date: Mon Apr 27 13:38:24 2015
New Revision: 1676260

URL: http://svn.apache.org/r1676260
Log: (empty)

Modified:
    knox/site/books/knox-0-6-0/dev-guide.html
    knox/site/books/knox-0-6-0/user-guide.html
    knox/trunk/books/0.6.0/admin_api.md
    knox/trunk/books/0.6.0/book_getting-started.md
    knox/trunk/books/0.6.0/dev-guide/book.md
    knox/trunk/books/0.6.0/quick_start.md

Modified: knox/site/books/knox-0-6-0/dev-guide.html
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-6-0/dev-guide.html?rev=1676260&r1=1676259&r2=1676260&view=diff
==============================================================================
--- knox/site/books/knox-0-6-0/dev-guide.html (original)
+++ knox/site/books/knox-0-6-0/dev-guide.html Mon Apr 27 13:38:24 2015
@@ -219,7 +219,7 @@
 </table><h3><a id="Development+Processes"></a>Development Processes</h3><p>The
project uses Maven in general with a few convenience Ant targets.</p><p>Building
the project can be built via Maven or Ant. The two commands below are equivalent.</p>
 <pre><code>mvn clean install
 ant
-</code></pre><p>A more complete build can be done that builds and generates
the unsigned ZIP release artifacts. You will find these in the target/{version} directory
(e.g. target/0.5.0-SNAPSHOT).</p>
+</code></pre><p>A more complete build can be done that builds and generates
the unsigned ZIP release artifacts. You will find these in the target/{version} directory
(e.g. target/0.7.0-SNAPSHOT).</p>
 <pre><code>mvn -Prelease clean install
 ant release
 </code></pre><p>There are a few other Ant targets that are especially convenient
for testing.</p><p>This command installs the gateway into the {{{install}}} directory
of the project. Note that this command does not first build the project.</p>
@@ -491,7 +491,7 @@ public interface ServiceDeploymentContri
     &lt;parent&gt;
         &lt;groupId&gt;org.apache.hadoop&lt;/groupId&gt;
         &lt;artifactId&gt;gateway&lt;/artifactId&gt;
-        &lt;version&gt;0.5.0-SNAPSHOT&lt;/version&gt;
+        &lt;version&gt;0.7.0-SNAPSHOT&lt;/version&gt;
     &lt;/parent&gt;
 
     &lt;artifactId&gt;gateway-service-weather&lt;/artifactId&gt;
@@ -543,7 +543,7 @@ public interface ServiceDeploymentContri
     &lt;parent&gt;
         &lt;groupId&gt;org.apache.hadoop&lt;/groupId&gt;
         &lt;artifactId&gt;gateway&lt;/artifactId&gt;
-        &lt;version&gt;0.5.0-SNAPSHOT&lt;/version&gt;
+        &lt;version&gt;0.7.0-SNAPSHOT&lt;/version&gt;
     &lt;/parent&gt;
 
     &lt;artifactId&gt;gateway-provider-security-authn-sample&lt;/artifactId&gt;

Modified: knox/site/books/knox-0-6-0/user-guide.html
URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-6-0/user-guide.html?rev=1676260&r1=1676259&r2=1676260&view=diff
==============================================================================
--- knox/site/books/knox-0-6-0/user-guide.html (original)
+++ knox/site/books/knox-0-6-0/user-guide.html Mon Apr 27 13:38:24 2015
@@ -79,37 +79,37 @@
   <li>Do Hadoop with Knox</li>
 </ol><h3><a id="1+-+Requirements"></a>1 - Requirements</h3><h4><a
id="Java"></a>Java</h4><p>Java 1.6 or later is required for the Knox
Gateway runtime. Use the command below to check the version of Java installed on the system
where Knox will be running.</p>
 <pre><code>java -version
-</code></pre><h4><a id="Hadoop"></a>Hadoop</h4><p>Knox
0.5.0 supports Hadoop 2.x, the quick start instructions assume a Hadoop 2.x virtual machine
based environment. </p><h3><a id="2+-+Download+Hadoop+2.x+VM"></a>2
- Download Hadoop 2.x VM</h3><p>The quick start provides a link to download Hadoop
2.0 based Hortonworks virtual machine <a href="http://hortonworks.com/products/hdp-2/#install">Sandbox</a>.
Please note Knox supports other Hadoop distributions and is configurable against a full blown
Hadoop cluster. Configuring Knox for Hadoop 2.x version, or Hadoop deployed in EC2 or a custom
Hadoop cluster is documented in advance deployment guide.</p><h3><a id="3+-+Download+Apache+Knox+Gateway"></a>3
- Download Apache Knox Gateway</h3><p>Download one of the distributions below
from the <a href="http://www.apache.org/dyn/closer.cgi/knox">Apache mirrors</a>.</p>
+</code></pre><h4><a id="Hadoop"></a>Hadoop</h4><p>Knox
0.6.0 supports Hadoop 2.x, the quick start instructions assume a Hadoop 2.x virtual machine
based environment.</p><h3><a id="2+-+Download+Hadoop+2.x+VM"></a>2
- Download Hadoop 2.x VM</h3><p>The quick start provides a link to download Hadoop
2.0 based Hortonworks virtual machine <a href="http://hortonworks.com/products/hdp-2/#install">Sandbox</a>.
Please note Knox supports other Hadoop distributions and is configurable against a full blown
Hadoop cluster. Configuring Knox for Hadoop 2.x version, or Hadoop deployed in EC2 or a custom
Hadoop cluster is documented in advance deployment guide.</p><h3><a id="3+-+Download+Apache+Knox+Gateway"></a>3
- Download Apache Knox Gateway</h3><p>Download one of the distributions below
from the <a href="http://www.apache.org/dyn/closer.cgi/knox">Apache mirrors</a>.</p>
 <ul>
-  <li>Source archive: <a href="http://www.apache.org/dyn/closer.cgi/knox/0.5.0/knox-0.5.0-src.zip">knox-0.5.0-src.zip</a>
(<a href="http://www.apache.org/dyn/closer.cgi/knox/0.5.0/knox-0.5.0-src.zip.asc">PGP
signature</a>, <a href="http://www.apache.org/dyn/closer.cgi/knox/0.5.0/knox-0.5.0-src.zip.sha">SHA1
digest</a>, <a href="http://www.apache.org/dyn/closer.cgi/knox/0.5.0/knox-0.5.0-src.zip.md5">MD5
digest</a>)</li>
-  <li>Binary archive: <a href="http://www.apache.org/dyn/closer.cgi/knox/0.5.0/knox-0.5.0.zip">knox-0.5.0.zip</a>
(<a href="http://www.apache.org/dyn/closer.cgi/knox/0.5.0/knox-0.5.0.zip.asc">PGP signature</a>,
<a href="http://www.apache.org/dyn/closer.cgi/knox/0.5.0/knox-0.5.0.zip.sha">SHA1 digest</a>,
<a href="http://www.apache.org/dyn/closer.cgi/knox/0.5.0/knox-0.5.0.zip.md5">MD5 digest</a>)</li>
+  <li>Source archive: <a href="http://www.apache.org/dyn/closer.cgi/knox/0.6.0/knox-0.6.0-src.zip">knox-0.6.0-src.zip</a>
(<a href="http://www.apache.org/dyn/closer.cgi/knox/0.6.0/knox-0.6.0-src.zip.asc">PGP
signature</a>, <a href="http://www.apache.org/dyn/closer.cgi/knox/0.6.0/knox-0.6.0-src.zip.sha">SHA1
digest</a>, <a href="http://www.apache.org/dyn/closer.cgi/knox/0.6.0/knox-0.6.0-src.zip.md5">MD5
digest</a>)</li>
+  <li>Binary archive: <a href="http://www.apache.org/dyn/closer.cgi/knox/0.6.0/knox-0.6.0.zip">knox-0.6.0.zip</a>
(<a href="http://www.apache.org/dyn/closer.cgi/knox/0.6.0/knox-0.6.0.zip.asc">PGP signature</a>,
<a href="http://www.apache.org/dyn/closer.cgi/knox/0.6.0/knox-0.6.0.zip.sha">SHA1 digest</a>,
<a href="http://www.apache.org/dyn/closer.cgi/knox/0.6.0/knox-0.6.0.zip.md5">MD5 digest</a>)</li>
 </ul><p>Apache Knox Gateway releases are available under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache
License, Version 2.0</a>. See the NOTICE file contained in each release artifact for
applicable copyright attribution notices.</p><h3><a id="Verify"></a>Verify</h3><p>While
recommended, verify is an optional step. You can verify the integrity of any downloaded files
using the PGP signatures. Please read <a href="http://httpd.apache.org/dev/verification.html">Verifying
Apache HTTP Server Releases</a> for more information on why you should verify our releases.</p><p>The
PGP signatures can be verified using PGP or GPG. First download the <a href="https://dist.apache.org/repos/dist/release/knox/KEYS">KEYS</a>
file as well as the .asc signature files for the relevant release packages. Make sure you
get these files from the main distribution directory linked above, rather than from a mirror.
Then verify the signatures using one of the methods below.</p>
 <pre><code>% pgpk -a KEYS
-% pgpv knox-0.5.0.zip.asc
+% pgpv knox-0.6.0.zip.asc
 </code></pre><p>or</p>
 <pre><code>% pgp -ka KEYS
-% pgp knox-0.5.0.zip.asc
+% pgp knox-0.6.0.zip.asc
 </code></pre><p>or</p>
 <pre><code>% gpg --import KEYS
-% gpg --verify knox-0.5.0.zip.asc
-</code></pre><h3><a id="4+-+Start+Hadoop+virtual+machine"></a>4
- Start Hadoop virtual machine</h3><p>Start the Hadoop virtual machine.</p><h3><a
id="5+-+Install+Knox"></a>5 - Install Knox</h3><p>The steps required
to install the gateway will vary depending upon which distribution format (zip | rpm) was
downloaded. In either case you will end up with a directory where the gateway is installed.
This directory will be referred to as your <code>{GATEWAY_HOME}</code> throughout
this document.</p><h4><a id="ZIP"></a>ZIP</h4><p>If you
downloaded the Zip distribution you can simply extract the contents into a directory. The
example below provides a command that can be executed to do this. Note the <code>{VERSION}</code>
portion of the command must be replaced with an actual Apache Knox Gateway version number.
This might be 0.4.0 for example and must patch the value in the file downloaded.</p>
-<pre><code>jar xf knox-{VERSION}.zip
-</code></pre><p>This will create a directory <code>knox-{VERSION}</code>
in your current directory. The directory <code>knox-{VERSION}</code> will considered
your <code>{GATEWAY_HOME}</code></p><h3><a id="6+-+Start+LDAP+embedded+in+Knox"></a>6
- Start LDAP embedded in Knox</h3><p>Knox comes with an LDAP server for demonstration
purposes.</p>
+% gpg --verify knox-0.6.0.zip.asc
+</code></pre><h3><a id="4+-+Start+Hadoop+virtual+machine"></a>4
- Start Hadoop virtual machine</h3><p>Start the Hadoop virtual machine.</p><h3><a
id="5+-+Install+Knox"></a>5 - Install Knox</h3><p>The steps required
to install the gateway will vary depending upon which distribution format (zip | rpm) was
downloaded. In either case you will end up with a directory where the gateway is installed.
This directory will be referred to as your <code>{GATEWAY_HOME}</code> throughout
this document.</p><h4><a id="ZIP"></a>ZIP</h4><p>If you
downloaded the Zip distribution you can simply extract the contents into a directory. The
example below provides a command that can be executed to do this. Note the <code>{VERSION}</code>
portion of the command must be replaced with an actual Apache Knox Gateway version number.
This might be 0.6.0 for example.</p>
+<pre><code>unzip knox-{VERSION}.zip
+</code></pre><p>This will create a directory <code>knox-{VERSION}</code>
in your current directory. The directory <code>knox-{VERSION}</code> will considered
your <code>{GATEWAY_HOME}</code></p><h3><a id="6+-+Start+LDAP+embedded+in+Knox"></a>6
- Start LDAP embedded in Knox</h3><p>Knox comes with an LDAP server for demonstration
purposes. Note: If the tool used to extract the contents of the Tar or tar.gz file was not
capable of making the files in the bin directory executable</p>
 <pre><code>cd {GATEWAY_HOME}
 bin/ldap.sh start
-</code></pre><h3><a id="7+-+Start+Knox"></a>7 - Start Knox</h3><p>The
gateway can be started using the provided shell script.</p><h6><a id="Starting+via+script"></a>Starting
via script</h6><p>Run the knoxcli create-master command in order to persist the
master secret that is used to protect the key and credential stores for the gateway instance.</p><h6><a
id="linux"></a>linux</h6>
+</code></pre><h3><a id="7+-+Create+the+Master+Secret"></a>7
- Create the Master Secret</h3><p>Run the knoxcli create-master command in order
to persist the master secret that is used to protect the key and credential stores for the
gateway instance.</p>
 <pre><code>cd {GATEWAY_HOME}
 bin/knoxcli.sh create-master
-</code></pre><p>The cli will prompt you for the master secret (i.e. password).</p><p>The
server will discover the persisted master secret during start up and complete the setup process
for demo installs. A demo install will consist of a knox gateway instance with an identity
certificate for localhost. This will require clients to be on the same machine or to turn
off hostname verification. For more involved deployments, See the Knox CLI section of this
document for additional commands - incuding the ability to create a self-signed certificate
for a specific hostname.</p>
+</code></pre><p>The cli will prompt you for the master secret (i.e. password).</p><h3><a
id="7+-+Start+Knox"></a>7 - Start Knox</h3><p>The gateway can be started
using the provided shell script.</p><p>The server will discover the persisted
master secret during start up and complete the setup process for demo installs. A demo install
will consist of a knox gateway instance with an identity certificate for localhost. This will
require clients to be on the same machine or to turn off hostname verification. For more involved
deployments, See the Knox CLI section of this document for additional configuration options,
including the ability to create a self-signed certificate for a specific hostname.</p>
 <pre><code>cd {GATEWAY_HOME}
 bin/gateway.sh start
-</code></pre><p>When starting the gateway this way the process will be
run in the backgroud. In the Sandbox environment mentioned earlier the log output is written
into the directory /var/log/knox. In addition a PID (process ID) is written into /var/run/knox.</p><p>In
order to stop a gateway that was started with the script use this command.</p>
+</code></pre><p>When starting the gateway this way the process will be
run in the background. The log files will be written to {GATEWAY_HOME}/logs and the process
ID files (PIDS) will b written to {GATEWAY_HOME}/pids.</p><p>In order to stop
a gateway that was started with the script use this command.</p>
 <pre><code>cd {GATEWAY_HOME}
 bin/gateway.sh stop
 </code></pre><p>If for some reason the gateway is stopped other than by
using the command above you may need to clear the tracking PID.</p>
 <pre><code>cd {GATEWAY_HOME}
 bin/gateway.sh clean
-</code></pre><p><strong>NOTE: This command will also clear any .out
and .err file from the /var/log/knox directory so use this with caution.</strong></p><h3><a
id="8+-+Do+Hadoop+with+Knox"></a>8 - Do Hadoop with Knox</h3><h4><a
id="Put+a+file+in+HDFS+via+Knox."></a>Put a file in HDFS via Knox.</h4><h4><a
id="CAT+a+file+in+HDFS+via+Knox."></a>CAT a file in HDFS via Knox.</h4><h4><a
id="Invoke+the+LISTSTATUS+operation+on+WebHDFS+via+the+gateway."></a>Invoke the LISTSTATUS
operation on WebHDFS via the gateway.</h4><p>This will return a directory listing
of the root (i.e. /) directory of HDFS.</p>
+</code></pre><p><strong>NOTE: This command will also clear any .out
and .err file from the {GATEWAY_HOME}/logs directory so use this with caution.</strong></p><h3><a
id="8+-+Do+Hadoop+with+Knox"></a>8 - Do Hadoop with Knox</h3><h4><a
id="Put+a+file+in+HDFS+via+Knox."></a>Put a file in HDFS via Knox.</h4><h4><a
id="CAT+a+file+in+HDFS+via+Knox."></a>CAT a file in HDFS via Knox.</h4><h4><a
id="Invoke+the+LISTSTATUS+operation+on+WebHDFS+via+the+gateway."></a>Invoke the LISTSTATUS
operation on WebHDFS via the gateway.</h4><p>This will return a directory listing
of the root (i.e. /) directory of HDFS.</p>
 <pre><code>curl -i -k -u guest:guest-password -X GET \
     &#39;https://localhost:8443/gateway/sandbox/webhdfs/v1/?op=LISTSTATUS&#39;
 </code></pre><p>The results of the above command should result in something
to along the lines of the output below. The exact information returned is subject to the content
within HDFS in your Hadoop cluster. Successfully executing this command at a minimum proves
that the gateway is properly configured to provide access to WebHDFS. It does not necessarily
provide that any of the other services are correct configured to be accessible. To validate
that see the sections for the individual services in <a href="#Service+Details">Service
Details</a>.</p>
@@ -124,7 +124,7 @@ 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 existing
Hadoop 2.x cluster is required for Knox 0.5.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>
+</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.6.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>
@@ -588,7 +588,7 @@ ip-10-39-107-209.ec2.internal
 </ul><h5><a id="Server+Version"></a>Server Version</h5><h6><a
id="Description"></a>Description</h6><p>Calls to Knox and returns the
gateway&rsquo;s current version and the version hash inside of a JSON object. </p><h6><a
id="Example+Request+URL"></a>Example Request URL</h6><p><code>https://{gateway-host}:{gateway-port}/{gateway-path}/admin/api/v1/version</code>
</p><h6><a id="Example+cURL+Request"></a>Example cURL Request</h6><p><code>curl
-u admin:admin-password -i -k https://{gateway-host}:{gateway-port}/{gateway-path}/admin/api/v1/version</code></p><h6><a
id="Response"></a>Response</h6>
 <pre><code>    {
        &quot;hash&quot;:&quot;{version-hash}&quot;,
-       &quot;version&quot;:&quot;0.5.0&quot;
+       &quot;version&quot;:&quot;0.6.0&quot;
     }
 </code></pre><h5><a id="Topology+Collection"></a>Topology Collection</h5><h6><a
id="Description"></a>Description</h6><p>Calls to Knox and return an array
of JSON objects that represent the list of deployed topologies currently inside of the gateway.
</p><h6><a id="Example+Request+URL"></a>Example Request URL</h6><p><code>https://{gateway-host}:{gateway-port}/{gateway-path}/admin/api/{api-version}/topologies</code>
</p><h6><a id="Example+cURL+Request"></a>Example cURL Request</h6><p><code>curl
-u admin:admin-password -i -k https://{gateway-host}:{gateway-port}/{gateway-path}/admin/api/v1/topologies</code></p><h6><a
id="Response"></a>Response</h6>
 <pre><code>[  

Modified: knox/trunk/books/0.6.0/admin_api.md
URL: http://svn.apache.org/viewvc/knox/trunk/books/0.6.0/admin_api.md?rev=1676260&r1=1676259&r2=1676260&view=diff
==============================================================================
--- knox/trunk/books/0.6.0/admin_api.md (original)
+++ knox/trunk/books/0.6.0/admin_api.md Mon Apr 27 13:38:24 2015
@@ -58,7 +58,7 @@ Calls to Knox and returns the gateway's
 
 		{
 			"hash":"{version-hash}",
-			"version":"0.5.0"
+			"version":"0.6.0"
 		}
 	
 

Modified: knox/trunk/books/0.6.0/book_getting-started.md
URL: http://svn.apache.org/viewvc/knox/trunk/books/0.6.0/book_getting-started.md?rev=1676260&r1=1676259&r2=1676260&view=diff
==============================================================================
--- knox/trunk/books/0.6.0/book_getting-started.md (original)
+++ knox/trunk/books/0.6.0/book_getting-started.md Mon Apr 27 13:38:24 2015
@@ -21,7 +21,7 @@ This section provides everything you nee
 
 #### Hadoop ####
 
-An existing Hadoop 2.x cluster is required for Knox 0.5.0 to sit in front of and protect.
+An existing Hadoop 2.x cluster is required for Knox 0.6.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.

Modified: knox/trunk/books/0.6.0/dev-guide/book.md
URL: http://svn.apache.org/viewvc/knox/trunk/books/0.6.0/dev-guide/book.md?rev=1676260&r1=1676259&r2=1676260&view=diff
==============================================================================
--- knox/trunk/books/0.6.0/dev-guide/book.md (original)
+++ knox/trunk/books/0.6.0/dev-guide/book.md Mon Apr 27 13:38:24 2015
@@ -148,7 +148,7 @@ ant
 ```
 
 A more complete build can be done that builds and generates the unsigned ZIP release artifacts.
-You will find these in the target/{version} directory (e.g. target/0.5.0-SNAPSHOT).
+You will find these in the target/{version} directory (e.g. target/0.7.0-SNAPSHOT).
 
 ```
 mvn -Prelease clean install
@@ -773,7 +773,7 @@ allRules.addRules( newRules );
     <parent>
         <groupId>org.apache.hadoop</groupId>
         <artifactId>gateway</artifactId>
-        <version>0.5.0-SNAPSHOT</version>
+        <version>0.7.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateway-service-weather</artifactId>
@@ -831,7 +831,7 @@ public interface ProviderDeploymentContr
     <parent>
         <groupId>org.apache.hadoop</groupId>
         <artifactId>gateway</artifactId>
-        <version>0.5.0-SNAPSHOT</version>
+        <version>0.7.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateway-provider-security-authn-sample</artifactId>

Modified: knox/trunk/books/0.6.0/quick_start.md
URL: http://svn.apache.org/viewvc/knox/trunk/books/0.6.0/quick_start.md?rev=1676260&r1=1676259&r2=1676260&view=diff
==============================================================================
--- knox/trunk/books/0.6.0/quick_start.md (original)
+++ knox/trunk/books/0.6.0/quick_start.md Mon Apr 27 13:38:24 2015
@@ -41,7 +41,7 @@ Use the command below to check the versi
 
 #### Hadoop ####
 
-Knox 0.5.0 supports Hadoop 2.x, the quick start instructions assume a Hadoop 2.x virtual
machine based environment. 
+Knox 0.6.0 supports Hadoop 2.x, the quick start instructions assume a Hadoop 2.x virtual
machine based environment.
 
 
 ### 2 - Download Hadoop 2.x VM ###
@@ -53,18 +53,18 @@ Configuring Knox for Hadoop 2.x version,
 
 Download one of the distributions below from the [Apache mirrors][mirror].
 
-* Source archive: [knox-0.5.0-src.zip][src-zip] ([PGP signature][src-pgp], [SHA1 digest][src-sha],
[MD5 digest][src-md5])
-* Binary archive: [knox-0.5.0.zip][bin-zip] ([PGP signature][bin-pgp], [SHA1 digest][bin-sha],
[MD5 digest][bin-md5])
+* Source archive: [knox-0.6.0-src.zip][src-zip] ([PGP signature][src-pgp], [SHA1 digest][src-sha],
[MD5 digest][src-md5])
+* Binary archive: [knox-0.6.0.zip][bin-zip] ([PGP signature][bin-pgp], [SHA1 digest][bin-sha],
[MD5 digest][bin-md5])
 
 [keys]: https://dist.apache.org/repos/dist/release/knox/KEYS 
-[src-zip]: http://www.apache.org/dyn/closer.cgi/knox/0.5.0/knox-0.5.0-src.zip
-[src-sha]: http://www.apache.org/dyn/closer.cgi/knox/0.5.0/knox-0.5.0-src.zip.sha
-[src-pgp]: http://www.apache.org/dyn/closer.cgi/knox/0.5.0/knox-0.5.0-src.zip.asc
-[src-md5]: http://www.apache.org/dyn/closer.cgi/knox/0.5.0/knox-0.5.0-src.zip.md5
-[bin-zip]: http://www.apache.org/dyn/closer.cgi/knox/0.5.0/knox-0.5.0.zip
-[bin-pgp]: http://www.apache.org/dyn/closer.cgi/knox/0.5.0/knox-0.5.0.zip.asc
-[bin-sha]: http://www.apache.org/dyn/closer.cgi/knox/0.5.0/knox-0.5.0.zip.sha
-[bin-md5]: http://www.apache.org/dyn/closer.cgi/knox/0.5.0/knox-0.5.0.zip.md5
+[src-zip]: http://www.apache.org/dyn/closer.cgi/knox/0.6.0/knox-0.6.0-src.zip
+[src-sha]: http://www.apache.org/dyn/closer.cgi/knox/0.6.0/knox-0.6.0-src.zip.sha
+[src-pgp]: http://www.apache.org/dyn/closer.cgi/knox/0.6.0/knox-0.6.0-src.zip.asc
+[src-md5]: http://www.apache.org/dyn/closer.cgi/knox/0.6.0/knox-0.6.0-src.zip.md5
+[bin-zip]: http://www.apache.org/dyn/closer.cgi/knox/0.6.0/knox-0.6.0.zip
+[bin-pgp]: http://www.apache.org/dyn/closer.cgi/knox/0.6.0/knox-0.6.0.zip.asc
+[bin-sha]: http://www.apache.org/dyn/closer.cgi/knox/0.6.0/knox-0.6.0.zip.sha
+[bin-md5]: http://www.apache.org/dyn/closer.cgi/knox/0.6.0/knox-0.6.0.zip.md5
 
 Apache Knox Gateway releases are available under the [Apache License, Version 2.0][asl].
 See the NOTICE file contained in each release artifact for applicable copyright attribution
notices.
@@ -81,17 +81,17 @@ Make sure you get these files from the m
 Then verify the signatures using one of the methods below.
 
     % pgpk -a KEYS
-    % pgpv knox-0.5.0.zip.asc
+    % pgpv knox-0.6.0.zip.asc
 
 or
 
     % pgp -ka KEYS
-    % pgp knox-0.5.0.zip.asc
+    % pgp knox-0.6.0.zip.asc
 
 or
 
     % gpg --import KEYS
-    % gpg --verify knox-0.5.0.zip.asc
+    % gpg --verify knox-0.6.0.zip.asc
 
 ### 4 - Start Hadoop virtual machine ###
 
@@ -108,45 +108,47 @@ This directory will be referred to as yo
 If you downloaded the Zip distribution you can simply extract the contents into a directory.
 The example below provides a command that can be executed to do this.
 Note the `{VERSION}` portion of the command must be replaced with an actual Apache Knox Gateway
version number.
-This might be 0.4.0 for example and must patch the value in the file downloaded.
+This might be 0.6.0 for example.
 
-    jar xf knox-{VERSION}.zip
+    unzip knox-{VERSION}.zip
 
 This will create a directory `knox-{VERSION}` in your current directory.
 The directory `knox-{VERSION}` will considered your `{GATEWAY_HOME}`
 
-
 ### 6 - Start LDAP embedded in Knox ###
 
 Knox comes with an LDAP server for demonstration purposes.
+Note: If the tool used to extract the contents of the Tar or tar.gz file was not capable
of
+making the files in the bin directory executable
 
     cd {GATEWAY_HOME}
     bin/ldap.sh start
 
+### 7 - Create the Master Secret
 
-### 7 - Start Knox  ###
-
-The gateway can be started using the provided shell script.
-
-
-###### Starting via script
+Run the knoxcli create-master command in order to persist the master secret
+that is used to protect the key and credential stores for the gateway instance.
 
-Run the knoxcli create-master command in order to persist the master secret that is used
to protect the key and credential stores for the gateway instance.
-
-###### linux
     cd {GATEWAY_HOME}
     bin/knoxcli.sh create-master
 
 The cli will prompt you for the master secret (i.e. password).
 
-The server will discover the persisted master secret during start up and complete the setup
process for demo installs. A demo install will consist of a knox gateway instance with an
identity certificate for localhost. This will require clients to be on the same machine or
to turn off hostname verification. For more involved deployments, See the Knox CLI section
of this document for additional commands - incuding the ability to create a self-signed certificate
for a specific hostname.
+### 7 - Start Knox  ###
+
+The gateway can be started using the provided shell script.
+
+The server will discover the persisted master secret during start up and complete the setup
process for demo installs.
+A demo install will consist of a knox gateway instance with an identity certificate for localhost.
+This will require clients to be on the same machine or to turn off hostname verification.
+For more involved deployments, See the Knox CLI section of this document for additional configuration
options,
+including the ability to create a self-signed certificate for a specific hostname.
 
     cd {GATEWAY_HOME}
     bin/gateway.sh start
 
-When starting the gateway this way the process will be run in the backgroud.
-In the Sandbox environment mentioned earlier the log output is written into the directory
/var/log/knox.
-In addition a PID (process ID) is written into /var/run/knox.
+When starting the gateway this way the process will be run in the background.
+The log files will be written to {GATEWAY_HOME}/logs and the process ID files (PIDS) will
b written to {GATEWAY_HOME}/pids.
 
 In order to stop a gateway that was started with the script use this command.
 
@@ -158,7 +160,7 @@ If for some reason the gateway is stoppe
     cd {GATEWAY_HOME}
     bin/gateway.sh clean
 
-__NOTE: This command will also clear any .out and .err file from the /var/log/knox directory
so use this with caution.__
+__NOTE: This command will also clear any .out and .err file from the {GATEWAY_HOME}/logs
directory so use this with caution.__
 
 
 ### 8 - Do Hadoop with Knox



Mime
View raw message