Return-Path: X-Original-To: apmail-hadoop-common-commits-archive@www.apache.org Delivered-To: apmail-hadoop-common-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id C802B184A7 for ; Mon, 22 Feb 2016 19:47:56 +0000 (UTC) Received: (qmail 70456 invoked by uid 500); 22 Feb 2016 19:47:20 -0000 Delivered-To: apmail-hadoop-common-commits-archive@hadoop.apache.org Received: (qmail 70241 invoked by uid 500); 22 Feb 2016 19:47:20 -0000 Mailing-List: contact common-commits-help@hadoop.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: common-dev@hadoop.apache.org Delivered-To: mailing list common-commits@hadoop.apache.org Received: (qmail 70212 invoked by uid 99); 22 Feb 2016 19:47:20 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 22 Feb 2016 19:47:20 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 59C12E03EC; Mon, 22 Feb 2016 19:47:20 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: arp@apache.org To: common-commits@hadoop.apache.org Date: Mon, 22 Feb 2016 19:47:22 -0000 Message-Id: <19522add65b04ae39588abb796fccf6d@git.apache.org> In-Reply-To: <7839982659ae4ff6bd79ac8b2f5987b7@git.apache.org> References: <7839982659ae4ff6bd79ac8b2f5987b7@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [03/50] [abbrv] hadoop git commit: HADOOP-12786. "hadoop key" command usage is not documented. Contributed by Xiao Chen. HADOOP-12786. "hadoop key" command usage is not documented. Contributed by Xiao Chen. Project: http://git-wip-us.apache.org/repos/asf/hadoop/repo Commit: http://git-wip-us.apache.org/repos/asf/hadoop/commit/1c48e50c Tree: http://git-wip-us.apache.org/repos/asf/hadoop/tree/1c48e50c Diff: http://git-wip-us.apache.org/repos/asf/hadoop/diff/1c48e50c Branch: refs/heads/HDFS-1312 Commit: 1c48e50ce71fd0e38740d69ce1e03119dca97a38 Parents: dea90c9 Author: Akira Ajisaka Authored: Mon Feb 15 11:38:25 2016 +0900 Committer: Akira Ajisaka Committed: Mon Feb 15 11:38:25 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(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/hadoop/blob/1c48e50c/hadoop-common-project/hadoop-common/CHANGES.txt ---------------------------------------------------------------------- diff --git a/hadoop-common-project/hadoop-common/CHANGES.txt b/hadoop-common-project/hadoop-common/CHANGES.txt index a05fd4b..0d07e36 100644 --- a/hadoop-common-project/hadoop-common/CHANGES.txt +++ b/hadoop-common-project/hadoop-common/CHANGES.txt @@ -1809,6 +1809,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 INCOMPATIBLE CHANGES http://git-wip-us.apache.org/repos/asf/hadoop/blob/1c48e50c/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/crypto/key/KeyShell.java ---------------------------------------------------------------------- diff --git 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 index 4c72d06..c69dc82 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 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; http://git-wip-us.apache.org/repos/asf/hadoop/blob/1c48e50c/hadoop-common-project/hadoop-common/src/site/markdown/CommandsManual.md ---------------------------------------------------------------------- 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 d7f0657..58fcbe9 100644 --- a/hadoop-common-project/hadoop-common/src/site/markdown/CommandsManual.md +++ b/hadoop-common-project/hadoop-common/src/site/markdown/CommandsManual.md @@ -188,7 +188,19 @@ Example: `hadoop kerbname user@EXAMPLE.COM` ### `key` -Manage keys via the KeyProvider. +Usage: `hadoop key [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 Guide](../hadoop-hdfs/TransparentEncryption.html). + +NOTE: Some KeyProviders (e.g. org.apache.hadoop.crypto.key.JavaKeyStoreProvider) does not support uppercase key names. ### `trace`