From 6a61dbc86fd2b45ea3126ed20f9f863109b794fb Mon Sep 17 00:00:00 2001 From: Dean Troyer <dtroyer@gmail.com> Date: Mon, 17 Nov 2014 22:59:57 -0600 Subject: [PATCH] Command object docs: catalog, credentials, endpoint, region, token catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28 --- doc/source/command-objects/catalog.rst | 20 +++++ doc/source/command-objects/credentials.rst | 25 ++++++ doc/source/command-objects/endpoint.rst | 45 +++++++++++ doc/source/command-objects/region.rst | 94 ++++++++++++++++++++++ doc/source/command-objects/token.rst | 19 +++++ doc/source/commands.rst | 6 +- 6 files changed, 207 insertions(+), 2 deletions(-) create mode 100644 doc/source/command-objects/catalog.rst create mode 100644 doc/source/command-objects/credentials.rst create mode 100644 doc/source/command-objects/endpoint.rst create mode 100644 doc/source/command-objects/region.rst create mode 100644 doc/source/command-objects/token.rst diff --git a/doc/source/command-objects/catalog.rst b/doc/source/command-objects/catalog.rst new file mode 100644 index 0000000000..99746dd716 --- /dev/null +++ b/doc/source/command-objects/catalog.rst @@ -0,0 +1,20 @@ +======= +catalog +======= + +Identity v2 + +catalog list +------------ + +.. code:: bash + + os catalog list + +catalog show +------------ + +.. code:: bash + + os catalog show + <service> diff --git a/doc/source/command-objects/credentials.rst b/doc/source/command-objects/credentials.rst new file mode 100644 index 0000000000..ea8fc08fff --- /dev/null +++ b/doc/source/command-objects/credentials.rst @@ -0,0 +1,25 @@ +=========== +credentials +=========== + +credentials create +------------------ + +.. ''[consider rolling the ec2 creds into this too]'' + +.. code:: bash + + os credentials create + --x509 + [<private-key-file>] + [<certificate-file>] + +credentials show +---------------- + +.. code:: bash + + os credentials show + [--token] + [--user] + [--x509 [--root]] diff --git a/doc/source/command-objects/endpoint.rst b/doc/source/command-objects/endpoint.rst new file mode 100644 index 0000000000..128ddfa021 --- /dev/null +++ b/doc/source/command-objects/endpoint.rst @@ -0,0 +1,45 @@ +======== +endpoint +======== + +Identity v2, v3 + +endpoint create +--------------- + +.. program:: endpoint create +.. code:: bash + + os endpoint create + --publicurl <public-url> + [--adminurl <admin-url>] + [--internalurl <internal-url>] + [--region <endpoint-region>] + <service> + +endpoint delete +--------------- + +.. program:: endpoint delete +.. code:: bash + + os endpoint delete + <endpoint-id> + +endpoint list +------------- + +.. program:: endpoint list +.. code:: bash + + os endpoint list + [--long] + +endpoint show +------------- + +.. program:: endpoint show +.. code:: bash + + os endpoint show + <endpoint_or_service-type> diff --git a/doc/source/command-objects/region.rst b/doc/source/command-objects/region.rst new file mode 100644 index 0000000000..788ed6facb --- /dev/null +++ b/doc/source/command-objects/region.rst @@ -0,0 +1,94 @@ +====== +region +====== + +Identity v3 + +region create +------------- + +Create new region + +.. code:: bash + + os region create + [--parent-region <region-id>] + [--description <region-description>] + [--url <region-url>] + <region-id> + +:option:`--parent-region` <region-id> + Parent region + +:option:`--description` <region-description> + New region description + +:option:`--url` <region-url> + New region URL + +:option:`<region-id>` + New region ID + +region delete +------------- + +Delete region + +.. code:: bash + + os region delete + <region> + +:option:`<region>` + Region to delete + +region list +----------- + +List regions + +.. code:: bash + + os region list + [--parent-region <region-id>] + +:option:`--parent-region` <region-id> + Filter by a specific parent region + +region set +---------- + +Set region properties + +.. code:: bash + + os region set + [--parent-region <region-id>] + [--description <region-description>] + [--url <region-url>] + <region> + +:option:`--parent-region` <region-id> + New parent region + +:option:`--description` <region-description> + New region description + +:option:`--url` <region-url> + New region URL + +:option:`<region>` + Region ID to modify + +region show +----------- + +Show region + +.. code:: bash + + os region show + <region> + +:option:`<region>` + Region ID to modify diff --git a/doc/source/command-objects/token.rst b/doc/source/command-objects/token.rst new file mode 100644 index 0000000000..aec87d2850 --- /dev/null +++ b/doc/source/command-objects/token.rst @@ -0,0 +1,19 @@ +===== +token +===== + +Identity v2, v3 + +token issue +----------- + +.. code:: bash + + os token issue + +token revoke +------------ + +.. code:: bash + + os token revoke diff --git a/doc/source/commands.rst b/doc/source/commands.rst index 250a8039d8..e15e000925 100644 --- a/doc/source/commands.rst +++ b/doc/source/commands.rst @@ -72,13 +72,14 @@ referring to both Compute and Volume quotas. * ``access token``: Identity - long-lived OAuth-based token * ``aggregate``: (**Compute**) a grouping of servers * ``backup``: Volume - a volume copy +* ``catalog``: (**Identity**) service catalog * ``console log``: (**Compute**) server console text dump * ``console url``: (**Compute**) server remote console URL * ``consumer``: Identity - OAuth-based delegatee * ``container``: Object Store - a grouping of objects -* ``credential``: Identity - specific to identity providers +* ``credentials``: (**Identity**) specific to identity providers * ``domain``: Identity - a grouping of projects -* ``endpoint``: Identity - the base URL used to contact a specific service +* ``endpoint``: (**Identity**) the base URL used to contact a specific service * ``extension``: (**Compute**, **Identity**, **Volume**) OpenStack server API extensions * ``flavor``: Compute - pre-defined configurations of servers: ram, root disk, etc * ``group``: Identity - a grouping of users @@ -96,6 +97,7 @@ referring to both Compute and Volume quotas. * ``policy``: Identity - determines authorization * ``project``: (**Identity**) owns a group of resources * ``quota``: (**Compute**, **Volume**) resource usage restrictions +* ``region``: (**Identity**) * ``request token``: Identity - temporary OAuth-based token * ``role``: Identity - a policy object used to determine authorization * ``security group``: Compute, Network - groups of network access rules