Merge "Command docs: ec2 credentials"

Jenkins · openstack-gerrit · commit 79f8ce689328 · 2015-01-02T23:03:42.000Z
diff --git a/doc/source/command-objects/ec2-credentials.rst b/doc/source/command-objects/ec2-credentials.rst
@@ -0,0 +1,98 @@
+===============
+ec2 credentials
+===============
+
+Identity v2
+
+ec2 credentials create
+----------------------
+
+Create EC2 credentials
+
+.. program:: ec2 credentials create
+.. code-block:: bash
+
+    os ec2 credentials create
+        [--project <project>]
+        [--user <user>]
+
+.. option:: --project <project>
+
+    Specify an alternate project (default: current authenticated project)
+
+.. option:: --user <user>
+
+    Specify an alternate user (default: current authenticated user)
+
+The :option:`--project` and :option:`--user`  options are typically only
+useful for admin users, but may be allowed for other users depending on
+the policy of the cloud and the roles granted to the user.
+
+ec2 credentials delete
+----------------------
+
+Delete EC2 credentials
+
+.. program:: ec2 credentials delete
+.. code-block:: bash
+
+    os ec2 credentials delete
+        [--user <user>]
+        <access-key>
+
+.. option:: --user <user>
+
+    Specify a user
+
+.. _ec2_credentials_delete-access-key:
+.. describe:: access-key
+
+    Credentials access key
+
+The :option:`--user` option is typically only useful for admin users, but
+may be allowed for other users depending on the policy of the cloud and
+the roles granted to the user.
+
+ec2 credentials list
+--------------------
+
+List EC2 credentials
+
+.. program:: ec2 credentials list
+.. code-block:: bash
+
+    os ec2 credentials list
+        [--user <user>]
+
+.. option:: --user <user>
+
+    Filter list by <user>
+
+The :option:`--user` option is typically only useful for admin users, but
+may be allowed for other users depending on the policy of the cloud and
+the roles granted to the user.
+
+ec2 credentials show
+--------------------
+
+Display EC2 credentials details
+
+.. program:: ec2 credentials show
+.. code-block:: bash
+
+    os ec2 credentials show
+        [--user <user>]
+        <access-key>
+
+.. option:: --user <user>
+
+    Specify a user
+
+.. _ec2_credentials_show-access-key:
+.. describe:: access-key
+
+    Credentials access key
+
+The :option:`--user` option is typically only useful for admin users, but
+may be allowed for other users depending on the policy of the cloud and
+the roles granted to the user.
diff --git a/doc/source/commands.rst b/doc/source/commands.rst
@@ -80,6 +80,7 @@ referring to both Compute and Volume quotas.
 * ``container``: Object Store - a grouping of objects
 * ``credentials``: (**Identity**) specific to identity providers
 * ``domain``: (**Identity**) a grouping of projects
+* ``ec2 cedentials``: (**Identity**) AWS EC2-compatibile credentials
 * ``endpoint``: (**Identity**) the base URL used to contact a specific service
 * ``extension``: (**Compute**, **Identity**, **Volume**) OpenStack server API extensions
 * ``flavor``: (**Compute**) pre-defined server configurations: ram, root disk, etc
diff --git a/openstackclient/identity/v2_0/ec2creds.py b/openstackclient/identity/v2_0/ec2creds.py
@@ -37,12 +37,14 @@ def get_parser(self, prog_name):
         parser.add_argument(
             '--project',
             metavar='<project>',
-            help=_('Specify a project [admin only]'),
+            help=_('Specify an alternate project'
+                   ' (default: current authenticated project)'),
         )
         parser.add_argument(
             '--user',
             metavar='<user>',
-            help=_('Specify a user [admin only]'),
+            help=_('Specify an alternate user'
+                   ' (default: current authenticated user)'),
         )
         return parser
 
@@ -95,7 +97,7 @@ def get_parser(self, prog_name):
         parser.add_argument(
             '--user',
             metavar='<user>',
-            help=_('Specify a user [admin only]'),
+            help=_('Specify a user'),
         )
         return parser
 
@@ -125,7 +127,7 @@ def get_parser(self, prog_name):
         parser.add_argument(
             '--user',
             metavar='<user>',
-            help=_('Specify a user [admin only]'),
+            help=_('Specify a user'),
         )
         return parser
 
@@ -154,7 +156,7 @@ def take_action(self, parsed_args):
 
 
 class ShowEC2Creds(show.ShowOne):
-    """Show EC2 credentials"""
+    """Display EC2 credentials details"""
 
     log = logging.getLogger(__name__ + '.ShowEC2Creds')
 
@@ -168,7 +170,7 @@ def get_parser(self, prog_name):
         parser.add_argument(
             '--user',
             metavar='<user>',
-            help=_('Specify a user [admin only]'),
+            help=_('Specify a user'),
         )
         return parser
 
