You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-commits@hadoop.apache.org by wa...@apache.org on 2014/09/17 02:15:31 UTC
git commit: HADOOP-10922. User documentation for CredentialShell.
Contributed by Larry McCay.
Repository: hadoop
Updated Branches:
refs/heads/trunk a044407b5 -> b6d3230e4
HADOOP-10922. User documentation for CredentialShell. Contributed by Larry McCay.
Project: http://git-wip-us.apache.org/repos/asf/hadoop/repo
Commit: http://git-wip-us.apache.org/repos/asf/hadoop/commit/b6d3230e
Tree: http://git-wip-us.apache.org/repos/asf/hadoop/tree/b6d3230e
Diff: http://git-wip-us.apache.org/repos/asf/hadoop/diff/b6d3230e
Branch: refs/heads/trunk
Commit: b6d3230e41c78750b6dfd679f24852f22947b5a5
Parents: a044407
Author: Andrew Wang <wa...@apache.org>
Authored: Tue Sep 16 17:15:23 2014 -0700
Committer: Andrew Wang <wa...@apache.org>
Committed: Tue Sep 16 17:15:23 2014 -0700
----------------------------------------------------------------------
hadoop-common-project/hadoop-common/CHANGES.txt | 2 +
.../src/site/apt/CommandsManual.apt.vm | 53 ++++++++++++++++++++
2 files changed, 55 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/hadoop/blob/b6d3230e/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 194b4be..3bf9d4b 100644
--- a/hadoop-common-project/hadoop-common/CHANGES.txt
+++ b/hadoop-common-project/hadoop-common/CHANGES.txt
@@ -528,6 +528,8 @@ Release 2.6.0 - UNRELEASED
HADOOP-10868. AuthenticationFilter should support externalizing the
secret for signing and provide rotation support. (rkanter via tucu)
+ HADOOP-10922. User documentation for CredentialShell. (Larry McCay via wang)
+
OPTIMIZATIONS
HADOOP-10838. Byte array native checksumming. (James Thomas via todd)
http://git-wip-us.apache.org/repos/asf/hadoop/blob/b6d3230e/hadoop-common-project/hadoop-common/src/site/apt/CommandsManual.apt.vm
----------------------------------------------------------------------
diff --git a/hadoop-common-project/hadoop-common/src/site/apt/CommandsManual.apt.vm b/hadoop-common-project/hadoop-common/src/site/apt/CommandsManual.apt.vm
index dd4eb0a..a03dd03 100644
--- a/hadoop-common-project/hadoop-common/src/site/apt/CommandsManual.apt.vm
+++ b/hadoop-common-project/hadoop-common/src/site/apt/CommandsManual.apt.vm
@@ -85,6 +85,59 @@ User Commands
{{{../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/HadoopArchives.html}
Hadoop Archives Guide}}.
+* <<<credential>>>
+
+ Command to manage credentials, passwords and secrets within credential providers.
+
+ The CredentialProvider API in Hadoop allows for the separation of applications
+ and how they store their required passwords/secrets. In order to indicate
+ a particular provider type and location, the user must provide the
+ <hadoop.security.credential.provider.path> configuration element in core-site.xml
+ or use the command line option <<<-provider>>> on each of the following commands.
+ This provider path is a comma-separated list of URLs that indicates the type and
+ location of a list of providers that should be consulted.
+ For example, the following path:
+
+ <<<user:///,jceks://file/tmp/test.jceks,jceks://hdfs@nn1.example.com/my/path/test.jceks>>>
+
+ indicates that the current user's credentials file should be consulted through
+ the User Provider, that the local file located at <<</tmp/test.jceks>>> is a Java Keystore
+ Provider and that the file located within HDFS at <<<nn1.example.com/my/path/test.jceks>>>
+ is also a store for a Java Keystore Provider.
+
+ When utilizing the credential command it will often be for provisioning a password
+ or secret to a particular credential store provider. In order to explicitly
+ indicate which provider store to use the <<<-provider>>> option should be used. Otherwise,
+ given a path of multiple providers, the first non-transient provider will be used.
+ This may or may not be the one that you intended.
+
+ Example: <<<-provider jceks://file/tmp/test.jceks>>>
+
+ Usage: <<<hadoop credential <subcommand> [options]>>>
+
+*-------------------+-------------------------------------------------------+
+||COMMAND_OPTION || Description
+*-------------------+-------------------------------------------------------+
+| create <alias> [-v <value>][-provider <provider-path>]| Prompts the user for
+ | a credential to be stored as the given alias when a value
+ | is not provided via <<<-v>>>. The
+ | <hadoop.security.credential.provider.path> within the
+ | core-site.xml file will be used unless a <<<-provider>>> is
+ | indicated.
+*-------------------+-------------------------------------------------------+
+| delete <alias> [-i][-provider <provider-path>] | Deletes the credential with
+ | the provided alias and optionally warns the user when
+ | <<<--interactive>>> is used.
+ | The <hadoop.security.credential.provider.path> within the
+ | core-site.xml file will be used unless a <<<-provider>>> is
+ | indicated.
+*-------------------+-------------------------------------------------------+
+| list [-provider <provider-path>] | Lists all of the credential aliases
+ | The <hadoop.security.credential.provider.path> within the
+ | core-site.xml file will be used unless a <<<-provider>>> is
+ | indicated.
+*-------------------+-------------------------------------------------------+
+
* <<<distcp>>>
Copy file or directories recursively. More information can be found at