hadoop-common-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From aajis...@apache.org
Subject hadoop git commit: HADOOP-12786. "hadoop key" command usage is not documented. Contributed by Xiao Chen.
Date Mon, 15 Feb 2016 03:17:55 GMT
Repository: hadoop
Updated Branches:
  refs/heads/branch-2 68d98f70b -> a670165bb

HADOOP-12786. "hadoop key" command usage is not documented. Contributed by Xiao Chen.

(cherry picked from commit 1c48e50ce71fd0e38740d69ce1e03119dca97a38)

Project: http://git-wip-us.apache.org/repos/asf/hadoop/repo
Commit: http://git-wip-us.apache.org/repos/asf/hadoop/commit/a670165b
Tree: http://git-wip-us.apache.org/repos/asf/hadoop/tree/a670165b
Diff: http://git-wip-us.apache.org/repos/asf/hadoop/diff/a670165b

Branch: refs/heads/branch-2
Commit: a670165bbd743f8271375b67236b00e95ae238a1
Parents: 68d98f7
Author: Akira Ajisaka <aajisaka@apache.org>
Authored: Mon Feb 15 11:38:25 2016 +0900
Committer: Akira Ajisaka <aajisaka@apache.org>
Committed: Mon Feb 15 11:38:54 2016 +0900

 hadoop-common-project/hadoop-common/CHANGES.txt       |  3 +++
 .../java/org/apache/hadoop/crypto/key/KeyShell.java   |  2 +-
 .../hadoop-common/src/site/markdown/CommandsManual.md | 14 +++++++++++++-
 3 files changed, 17 insertions(+), 2 deletions(-)

diff --git a/hadoop-common-project/hadoop-common/CHANGES.txt b/hadoop-common-project/hadoop-common/CHANGES.txt
index 8ce2ba8..5087198 100644
--- a/hadoop-common-project/hadoop-common/CHANGES.txt
+++ b/hadoop-common-project/hadoop-common/CHANGES.txt
@@ -1175,6 +1175,9 @@ Release 2.7.2 - 2016-01-25
     HADOOP-12415. Fixed pom files to correctly include compile-time dependency on
     netty. (Tom Zeng via cos)
+    HADOOP-12786. "hadoop key" command usage is not documented.
+    (Xiao Chen via aajisaka)
 Release 2.7.1 - 2015-07-06 

diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/crypto/key/KeyShell.java
index e70788b..33ee464 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/crypto/key/KeyShell.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/crypto/key/KeyShell.java
@@ -372,7 +372,7 @@ public class KeyShell extends Configured implements Tool {
     public static final String DESC =
         "The delete subcommand deletes all versions of the key\n" +
         "specified by the <keyname> argument from within the\n" +
-        "provider specified -provider. The command asks for\n" +
+        "provider specified by -provider. The command asks for\n" +
         "user confirmation unless -f is specified.";
     String keyName = null;

diff --git a/hadoop-common-project/hadoop-common/src/site/markdown/CommandsManual.md b/hadoop-common-project/hadoop-common/src/site/markdown/CommandsManual.md
index a02f838..662e83e 100644
--- a/hadoop-common-project/hadoop-common/src/site/markdown/CommandsManual.md
+++ b/hadoop-common-project/hadoop-common/src/site/markdown/CommandsManual.md
@@ -138,7 +138,19 @@ Use [`yarn jar`](../../hadoop-yarn/hadoop-yarn-site/YarnCommands.html#jar)
to la
 ### `key`
-Manage keys via the KeyProvider.
+Usage: `hadoop key <subcommand> [options]`
+| COMMAND\_OPTION | Description |
+|:---- |:---- |
+| create *keyname* [-cipher *cipher*] [-size *size*] [-description *description*] [-attr
*attribute=value*] [-provider *provider*] [-help] | Creates a new key for the name specified
by the *keyname* argument within the provider specified by the `-provider` argument. You may
specify a cipher with the `-cipher` argument. The default cipher is currently "AES/CTR/NoPadding".
The default keysize is 128. You may specify the requested key length using the `-size` argument.
Arbitrary attribute=value style attributes may be specified using the `-attr` argument. `-attr`
may be specified multiple times, once per attribute. |
+| roll *keyname* [-provider *provider*] [-help] | Creates a new version for the specified
key within the provider indicated using the `-provider` argument |
+| delete *keyname* [-provider *provider*] [-f] [-help] | Deletes all versions of the key
specified by the *keyname* argument from within the provider specified by `-provider`. The
command asks for user confirmation unless `-f` is specified. |
+| list [-provider *provider*] [-metadata] [-help] | Displays the keynames contained within
a particular provider as configured in core-site.xml or specified with the `-provider` argument.
`-metadata` displays the metadata. |
+| -help | Prints usage of this command |
+Manage keys via the KeyProvider. For details on KeyProviders, see the [Transparent Encryption
+NOTE: Some KeyProviders (e.g. org.apache.hadoop.crypto.key.JavaKeyStoreProvider) does not
support uppercase key names.
 ### `trace`

View raw message