From 9599ffe65d9dcd4b3aa780d346eccd1e760890bf Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Tue, 13 Jun 2017 15:55:33 -0400 Subject: 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 --- doc/source/cli/command-objects/ec2-credentials.rst | 138 +++++++++++++++++++++ 1 file changed, 138 insertions(+) create mode 100644 doc/source/cli/command-objects/ec2-credentials.rst (limited to 'doc/source/cli/command-objects/ec2-credentials.rst') 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 ] + [--user ] + [--user-domain ] + [--project-domain ] + +.. option:: --project + + Create credentials in project (name or ID; default: current authenticated project) + +.. option:: --user + + Create credentials for user (name or ID; default: current authenticated user) + +.. option:: --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 + + 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-domain ] + [ ...] + +.. option:: --user + + Delete credentials for user (name or ID) + +.. option:: --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-domain ] + +.. option:: --user + + Filter list by (name or ID) + +.. option:: --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-domain ] + + +.. option:: --user + + Show credentials for user (name or ID) + +.. option:: --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. -- cgit v1.2.1