Command docs: ec2 credentials
Add ec2 credentials docs Change-Id: I1699d1c8e9859153557081966654646966a3268d
This commit is contained in:
parent
6c0d4b82e0
commit
4f7777ca0e
98
doc/source/command-objects/ec2-credentials.rst
Normal file
98
doc/source/command-objects/ec2-credentials.rst
Normal file
@ -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.
|
@ -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
|
||||
|
@ -37,12 +37,14 @@ class CreateEC2Creds(show.ShowOne):
|
||||
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 @@ class DeleteEC2Creds(command.Command):
|
||||
parser.add_argument(
|
||||
'--user',
|
||||
metavar='<user>',
|
||||
help=_('Specify a user [admin only]'),
|
||||
help=_('Specify a user'),
|
||||
)
|
||||
return parser
|
||||
|
||||
@ -125,7 +127,7 @@ class ListEC2Creds(lister.Lister):
|
||||
parser.add_argument(
|
||||
'--user',
|
||||
metavar='<user>',
|
||||
help=_('Specify a user [admin only]'),
|
||||
help=_('Specify a user'),
|
||||
)
|
||||
return parser
|
||||
|
||||
@ -154,7 +156,7 @@ class ListEC2Creds(lister.Lister):
|
||||
|
||||
|
||||
class ShowEC2Creds(show.ShowOne):
|
||||
"""Show EC2 credentials"""
|
||||
"""Display EC2 credentials details"""
|
||||
|
||||
log = logging.getLogger(__name__ + '.ShowEC2Creds')
|
||||
|
||||
@ -168,7 +170,7 @@ class ShowEC2Creds(show.ShowOne):
|
||||
parser.add_argument(
|
||||
'--user',
|
||||
metavar='<user>',
|
||||
help=_('Specify a user [admin only]'),
|
||||
help=_('Specify a user'),
|
||||
)
|
||||
return parser
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user