knox-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From lmc...@apache.org
Subject svn commit: r1588701 - in /knox: site/books/knox-0-4-0/knox-0-4-0-new.html site/books/knox-0-4-0/knox-0-4-0.html trunk/books/0.4.0/quick_start.md
Date Sat, 19 Apr 2014 20:00:45 GMT
Author: lmccay
Date: Sat Apr 19 20:00:44 2014
New Revision: 1588701

URL: http://svn.apache.org/r1588701
Log:
cleaned up rpm, typos and hadoop 1.x references in quick start

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/trunk/books/0.4.0/quick_start.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=1588701&r1=1588700&r2=1588701&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 20:00:44 2014
@@ -88,11 +88,7 @@
 % gpg --verify knox-0.4.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><h4><a id="RPM"></a>RPM</h4><p>If
you downloaded the RPM distribution you can install it using normal RPM package tools. It
is important that the user that will be running the gateway server is used to install. This
is because several directories are created that are owned by this user. These command will
install Knox to <code>/usr/lib/knox</code> following the pattern of other Hadoop
components. This directory will be considered your <code>{GATEWAY_HOME}</code>.</p>
-<pre><code>sudo yum localinstall knox-{VERSION}.rpm
-</code></pre><p>or</p>
-<pre><code>sudo rpm -ihv knox-{VERSION}.rpm
-</code></pre><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>
+</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>
 <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 in one of two ways, as java -jar or with a 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>
@@ -107,7 +103,7 @@ 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 log
output in /var/log/knox 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+LISTSATUS+operation+on+WebHDFS+via+the+gateway."></a>Invoke the LISTSATUS
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 log
output in /var/log/knox 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>

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=1588701&r1=1588700&r2=1588701&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 20:00:44 2014
@@ -88,11 +88,7 @@
 % gpg --verify knox-0.4.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><h4><a id="RPM"></a>RPM</h4><p>If
you downloaded the RPM distribution you can install it using normal RPM package tools. It
is important that the user that will be running the gateway server is used to install. This
is because several directories are created that are owned by this user. These command will
install Knox to <code>/usr/lib/knox</code> following the pattern of other Hadoop
components. This directory will be considered your <code>{GATEWAY_HOME}</code>.</p>
-<pre><code>sudo yum localinstall knox-{VERSION}.rpm
-</code></pre><p>or</p>
-<pre><code>sudo rpm -ihv knox-{VERSION}.rpm
-</code></pre><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>
+</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>
 <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 in one of two ways, as java -jar or with a 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>
@@ -107,7 +103,7 @@ 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 log
output in /var/log/knox 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+LISTSATUS+operation+on+WebHDFS+via+the+gateway."></a>Invoke the LISTSATUS
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 log
output in /var/log/knox 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>

Modified: knox/trunk/books/0.4.0/quick_start.md
URL: http://svn.apache.org/viewvc/knox/trunk/books/0.4.0/quick_start.md?rev=1588701&r1=1588700&r2=1588701&view=diff
==============================================================================
--- knox/trunk/books/0.4.0/quick_start.md (original)
+++ knox/trunk/books/0.4.0/quick_start.md Sat Apr 19 20:00:44 2014
@@ -115,21 +115,6 @@ This will create a directory `knox-{VERS
 The directory `knox-{VERSION}` will considered your `{GATEWAY_HOME}`
 
 
-#### RPM ####
-
-If you downloaded the RPM distribution you can install it using normal RPM package tools.
-It is important that the user that will be running the gateway server is used to install.
-This is because several directories are created that are owned by this user.
-These command will install Knox to `/usr/lib/knox` following the pattern of other Hadoop
components.
-This directory will be considered your `{GATEWAY_HOME}`.
-
-    sudo yum localinstall knox-{VERSION}.rpm
-
-or
-
-    sudo rpm -ihv knox-{VERSION}.rpm
-
-
 ### 6 - Start LDAP embedded in Knox ###
 
 Knox comes with an LDAP server for demonstration purposes.
@@ -179,7 +164,7 @@ __NOTE: This command will also clear any
 
 #### Put a file in HDFS via Knox.
 #### CAT a file in HDFS via Knox.
-#### Invoke the LISTSATUS operation on WebHDFS via the gateway.
+#### Invoke the LISTSTATUS operation on WebHDFS via the gateway.
 This will return a directory listing of the root (i.e. /) directory of HDFS.
 
     curl -i -k -u guest:guest-password -X GET \



Mime
View raw message