summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/ec2-credentials.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2017-06-13 15:55:33 -0400
committerAndreas Jaeger <aj@suse.com>2017-06-23 11:54:32 +0200
commit9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch)
tree9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/cli/command-objects/ec2-credentials.rst
parent19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff)
downloadpython-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz
reorganize existing documentation according to the new standard layout
Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Diffstat (limited to 'doc/source/cli/command-objects/ec2-credentials.rst')
-rw-r--r--doc/source/cli/command-objects/ec2-credentials.rst138
1 files changed, 138 insertions, 0 deletions
diff --git a/doc/source/cli/command-objects/ec2-credentials.rst b/doc/source/cli/command-objects/ec2-credentials.rst
new file mode 100644
index 00000000..9174b041
--- /dev/null
+++ b/doc/source/cli/command-objects/ec2-credentials.rst
@@ -0,0 +1,138 @@
+===============
+ec2 credentials
+===============
+
+Identity v2
+
+ec2 credentials create
+----------------------
+
+Create EC2 credentials
+
+.. program:: ec2 credentials create
+.. code-block:: bash
+
+ openstack ec2 credentials create
+ [--project <project>]
+ [--user <user>]
+ [--user-domain <user-domain>]
+ [--project-domain <project-domain>]
+
+.. option:: --project <project>
+
+ Create credentials in project (name or ID; default: current authenticated project)
+
+.. option:: --user <user>
+
+ Create credentials for user (name or ID; default: current authenticated user)
+
+.. option:: --user-domain <user-domain>
+
+ Domain the user belongs to (name or ID). This can be
+ used in case collisions between user names exist.
+
+ .. versionadded:: 3
+
+.. option:: --project-domain <project-domain>
+
+ Domain the project belongs to (name or ID). This can be
+ used in case collisions between user names exist.
+
+ .. versionadded:: 3
+
+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
+
+ openstack ec2 credentials delete
+ [--user <user>]
+ [--user-domain <user-domain>]
+ <access-key> [<access-key> ...]
+
+.. option:: --user <user>
+
+ Delete credentials for user (name or ID)
+
+.. option:: --user-domain <user-domain>
+
+ Select user from a specific domain (name or ID)
+ This can be used in case collisions between user names exist.
+
+ .. versionadded:: 3
+
+.. _ec2_credentials_delete-access-key:
+.. describe:: access-key
+
+ Credentials access key(s)
+
+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
+
+ openstack ec2 credentials list
+ [--user <user>]
+ [--user-domain <user-domain>]
+
+.. option:: --user <user>
+
+ Filter list by <user> (name or ID)
+
+.. option:: --user-domain <user-domain>
+
+ Select user from a specific domain (name or ID)
+ This can be used in case collisions between user names exist.
+
+ .. versionadded:: 3
+
+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
+
+ openstack ec2 credentials show
+ [--user <user>]
+ [--user-domain <user-domain>]
+ <access-key>
+
+.. option:: --user <user>
+
+ Show credentials for user (name or ID)
+
+.. option:: --user-domain <user-domain>
+
+ Select user from a specific domain (name or ID)
+ This can be used in case collisions between user names exist.
+
+ .. versionadded:: 3
+
+.. _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.