Skip to content

Commit 6a61dbc

Browse files
author
Dean Troyer
committed
Command object docs: catalog, credentials, endpoint, region, token
catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28
1 parent cc54f98 commit 6a61dbc

6 files changed

Lines changed: 207 additions & 2 deletions

File tree

‎doc/source/command-objects/catalog.rst‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
=======
2+
catalog
3+
=======
4+
5+
Identity v2
6+
7+
catalog list
8+
------------
9+
10+
.. code:: bash
11+
12+
os catalog list
13+
14+
catalog show
15+
------------
16+
17+
.. code:: bash
18+
19+
os catalog show
20+
<service>

‎doc/source/command-objects/credentials.rst‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
===========
2+
credentials
3+
===========
4+
5+
credentials create
6+
------------------
7+
8+
.. ''[consider rolling the ec2 creds into this too]''
9+
10+
.. code:: bash
11+
12+
os credentials create
13+
--x509
14+
[<private-key-file>]
15+
[<certificate-file>]
16+
17+
credentials show
18+
----------------
19+
20+
.. code:: bash
21+
22+
os credentials show
23+
[--token]
24+
[--user]
25+
[--x509 [--root]]

‎doc/source/command-objects/endpoint.rst‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
========
2+
endpoint
3+
========
4+
5+
Identity v2, v3
6+
7+
endpoint create
8+
---------------
9+
10+
.. program:: endpoint create
11+
.. code:: bash
12+
13+
os endpoint create
14+
--publicurl <public-url>
15+
[--adminurl <admin-url>]
16+
[--internalurl <internal-url>]
17+
[--region <endpoint-region>]
18+
<service>
19+
20+
endpoint delete
21+
---------------
22+
23+
.. program:: endpoint delete
24+
.. code:: bash
25+
26+
os endpoint delete
27+
<endpoint-id>
28+
29+
endpoint list
30+
-------------
31+
32+
.. program:: endpoint list
33+
.. code:: bash
34+
35+
os endpoint list
36+
[--long]
37+
38+
endpoint show
39+
-------------
40+
41+
.. program:: endpoint show
42+
.. code:: bash
43+
44+
os endpoint show
45+
<endpoint_or_service-type>

‎doc/source/command-objects/region.rst‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
======
2+
region
3+
======
4+
5+
Identity v3
6+
7+
region create
8+
-------------
9+
10+
Create new region
11+
12+
.. code:: bash
13+
14+
os region create
15+
[--parent-region <region-id>]
16+
[--description <region-description>]
17+
[--url <region-url>]
18+
<region-id>
19+
20+
:option:`--parent-region` <region-id>
21+
Parent region
22+
23+
:option:`--description` <region-description>
24+
New region description
25+
26+
:option:`--url` <region-url>
27+
New region URL
28+
29+
:option:`<region-id>`
30+
New region ID
31+
32+
region delete
33+
-------------
34+
35+
Delete region
36+
37+
.. code:: bash
38+
39+
os region delete
40+
<region>
41+
42+
:option:`<region>`
43+
Region to delete
44+
45+
region list
46+
-----------
47+
48+
List regions
49+
50+
.. code:: bash
51+
52+
os region list
53+
[--parent-region <region-id>]
54+
55+
:option:`--parent-region` <region-id>
56+
Filter by a specific parent region
57+
58+
region set
59+
----------
60+
61+
Set region properties
62+
63+
.. code:: bash
64+
65+
os region set
66+
[--parent-region <region-id>]
67+
[--description <region-description>]
68+
[--url <region-url>]
69+
<region>
70+
71+
:option:`--parent-region` <region-id>
72+
New parent region
73+
74+
:option:`--description` <region-description>
75+
New region description
76+
77+
:option:`--url` <region-url>
78+
New region URL
79+
80+
:option:`<region>`
81+
Region ID to modify
82+
83+
region show
84+
-----------
85+
86+
Show region
87+
88+
.. code:: bash
89+
90+
os region show
91+
<region>
92+
93+
:option:`<region>`
94+
Region ID to modify

‎doc/source/command-objects/token.rst‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
=====
2+
token
3+
=====
4+
5+
Identity v2, v3
6+
7+
token issue
8+
-----------
9+
10+
.. code:: bash
11+
12+
os token issue
13+
14+
token revoke
15+
------------
16+
17+
.. code:: bash
18+
19+
os token revoke

‎doc/source/commands.rst‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,13 +72,14 @@ referring to both Compute and Volume quotas.
7272
* ``access token``: Identity - long-lived OAuth-based token
7373
* ``aggregate``: (**Compute**) a grouping of servers
7474
* ``backup``: Volume - a volume copy
75+
* ``catalog``: (**Identity**) service catalog
7576
* ``console log``: (**Compute**) server console text dump
7677
* ``console url``: (**Compute**) server remote console URL
7778
* ``consumer``: Identity - OAuth-based delegatee
7879
* ``container``: Object Store - a grouping of objects
79-
* ``credential``: Identity - specific to identity providers
80+
* ``credentials``: (**Identity**) specific to identity providers
8081
* ``domain``: Identity - a grouping of projects
81-
* ``endpoint``: Identity - the base URL used to contact a specific service
82+
* ``endpoint``: (**Identity**) the base URL used to contact a specific service
8283
* ``extension``: (**Compute**, **Identity**, **Volume**) OpenStack server API extensions
8384
* ``flavor``: Compute - pre-defined configurations of servers: ram, root disk, etc
8485
* ``group``: Identity - a grouping of users
@@ -96,6 +97,7 @@ referring to both Compute and Volume quotas.
9697
* ``policy``: Identity - determines authorization
9798
* ``project``: (**Identity**) owns a group of resources
9899
* ``quota``: (**Compute**, **Volume**) resource usage restrictions
100+
* ``region``: (**Identity**)
99101
* ``request token``: Identity - temporary OAuth-based token
100102
* ``role``: Identity - a policy object used to determine authorization
101103
* ``security group``: Compute, Network - groups of network access rules

0 commit comments

Comments
 (0)