Merge "Command object docs: catalog, credentials, endpoint, region, token"

This commit is contained in:
Jenkins 2014-12-04 22:50:38 +00:00 committed by Gerrit Code Review
commit 3f8b4d2238
6 changed files with 207 additions and 2 deletions

View File

@ -0,0 +1,20 @@
=======
catalog
=======
Identity v2
catalog list
------------
.. code:: bash
os catalog list
catalog show
------------
.. code:: bash
os catalog show
<service>

View File

@ -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]]

View File

@ -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>

View File

@ -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

View File

@ -0,0 +1,19 @@
=====
token
=====
Identity v2, v3
token issue
-----------
.. code:: bash
os token issue
token revoke
------------
.. code:: bash
os token revoke

View File

@ -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