summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/command-objects/ec2-credentials.rst98
-rw-r--r--doc/source/commands.rst1
2 files changed, 99 insertions, 0 deletions
diff --git a/doc/source/command-objects/ec2-credentials.rst b/doc/source/command-objects/ec2-credentials.rst
new file mode 100644
index 00000000..a5b67549
--- /dev/null
+++ 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
index eba0a22f..e7b32ace 100644
--- 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