Browse Source

commit 31d5824cda798535ec23d1b897d8d642627b6782
Author: Boris Shkolnik <borya@yahoo-inc.com>
Date: Thu Mar 25 10:22:55 2010 -0700

HDFS:1036 from https://issues.apache.org/jira/secure/attachment/12438856/fetchdt_doc.patch

+++ b/YAHOO-CHANGES.txt
+ HDFS-1036. Documentation for fetchdt for forrest (boryas)


git-svn-id: https://svn.apache.org/repos/asf/hadoop/common/branches/branch-0.20-security-patches@1077362 13f79535-47bb-0310-9956-ffa450edef68

Owen O'Malley 14 years ago
parent
commit
e9a4d1491f

+ 22 - 2
src/docs/src/documentation/content/xdocs/commands_manual.xml

@@ -56,8 +56,8 @@
 				<title>Generic Options</title>
 				<p>
 				  The following options are supported by <a href="commands_manual.html#dfsadmin">dfsadmin</a>, 
-				  <a href="commands_manual.html#fs">fs</a>, <a href="commands_manual.html#fsck">fsck</a> and 
-				  <a href="commands_manual.html#job">job</a>. 
+				  <a href="commands_manual.html#fs">fs</a>, <a href="commands_manual.html#fsck">fsck</a>, 
+				  <a href="commands_manual.html#job">job</a> and <a href="commands_manual.html#fetchdt">fetchdt</a>. 
 				  Applications should implement 
 				  <a href="ext:api/org/apache/hadoop/util/tool">Tool</a> to support
 				  <a href="ext:api/org/apache/hadoop/util/genericoptionsparser">
@@ -210,6 +210,26 @@
 					</table>
 			</section>
 			
+			<section>
+                <title> fetchdt </title>
+                <p>
+                    Gets Delegation Token from a NameNode. See <a href="hdfs_user_guide.html#fetchdt">fetchdt</a> for more info.
+                </p> 
+                <p><code>Usage: hadoop fetchdt [</code><a href="commands_manual.html#Generic+Options">GENERIC_OPTIONS</a><code>] 
+                [--webservice &lt;namenode_http_addr&gt;] &lt;path&gt; </code></p>
+                <table>
+                      <tr><th> COMMAND_OPTION </th><th> Description </th></tr>
+                      <tr>
+                        <td><code>&lt;fileName&gt;</code></td>
+                        <td>File name to store the token into.</td>
+                       </tr>
+                       <tr>
+                        <td><code>--webservice &lt;https_address&gt;</code></td>
+                        <td>use http protocol instead of RPC</td>
+                       </tr>
+                    </table>
+            </section>
+            
 			<section>
 				<title> jar </title>
 				<p>

+ 20 - 0
src/docs/src/documentation/content/xdocs/hdfs_user_guide.xml

@@ -98,6 +98,10 @@
     		<code>fsck</code>: a utility to diagnose health of the file system, to
     		find missing files or blocks.
     	</li>
+    	<li>
+            <code>fetchdt</code>: a utility to fetch DelegationToken and store it 
+            in a file on the local system. 
+        </li>
     	<li>
     		Rebalancer: tool to balance the cluster when the data is
     		unevenly distributed among DataNodes.
@@ -371,6 +375,22 @@
       For command usage, see <a href="commands_manual.html#fsck"><code>fsck</code> command</a>. 
       <code>fsck</code> can be run on the whole file system or on a subset of files.
      </p>
+   
+   </section> <section> <title> fetchdt </title>
+     <p>    
+      HDFS supports the <code>fetchdt</code> command to fetch Delegation Token 
+      and store it in a file on the local system. This token can be later used to 
+      access secure server (NameNode for example) from a non secure client.
+      Utility uses either RPC or HTTPS (over Kerberos) to get the token, and thus
+      requires kerberos tickets to be present before the run (run kinit to get 
+      the tickets). 
+      The HDFS <code>fetchdt</code> command is not a
+      Hadoop shell command. It can be run as '<code>bin/hadoop fetchdt DTfile </code>'.
+      After you got the token you can run an HDFS command without having Kerberos
+      tickets, by pointing HADOOP_TOKEN_FILE_LOCATION environmental variable to 
+      the delegation token file. 
+      For command usage, see <a href="commands_manual.html#fetchdt"><code>fetchdt</code> command</a>. 
+     </p>
      
    </section> <section> <title> Upgrade and Rollback </title>
      <p>