Skip to content

Commit 438878a

Browse files
Zuulopenstack-gerrit
Zuul
authored and
openstack-gerrit
committed
Merge "docs: Migrate remaining block storage commands to autocommand"
2 parents c052174 + 3eb063d commit 438878a

File tree

5 files changed

+50
-780
lines changed

5 files changed

+50
-780
lines changed

‎doc/source/cli/command-objects/access-rules.rst‎

Lines changed: 6 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -9,53 +9,11 @@ rule comprises of a service type, a request path, and a request method. Access
99
rules may only be created as attributes of application credentials, but they may
1010
be viewed and deleted independently.
1111

12+
.. autoprogram-cliff:: openstack.identity.v3
13+
:command: access rule delete
1214

13-
access rule delete
14-
------------------
15+
.. autoprogram-cliff:: openstack.identity.v3
16+
:command: access rule list
1517

16-
Delete access rule(s)
17-
18-
.. program:: access rule delete
19-
.. code:: bash
20-
21-
openstack access rule delete <access-rule> [<access-rule> ...]
22-
23-
.. describe:: <access-rule>
24-
25-
Access rule(s) to delete (ID)
26-
27-
access rule list
28-
----------------
29-
30-
List access rules
31-
32-
.. program:: access rule list
33-
.. code:: bash
34-
35-
openstack access rule list
36-
[--user <user>]
37-
[--user-domain <user-domain>]
38-
39-
.. option:: --user
40-
41-
User whose access rules to list (name or ID). If not provided, looks up the
42-
current user's access rules.
43-
44-
.. option:: --user-domain
45-
46-
Domain the user belongs to (name or ID). This can be
47-
used in case collisions between user names exist.
48-
49-
access rule show
50-
---------------------------
51-
52-
Display access rule details
53-
54-
.. program:: access rule show
55-
.. code:: bash
56-
57-
openstack access rule show <access-rule>
58-
59-
.. describe:: <access-rule>
60-
61-
Access rule to display (ID)
18+
.. autoprogram-cliff:: openstack.identity.v3
19+
:command: access rule show

‎doc/source/cli/command-objects/consistency-group-snapshot.rst‎

Lines changed: 9 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -2,95 +2,16 @@
22
consistency group snapshot
33
==========================
44

5-
Block Storage v2
5+
Block Storage v2, v3
66

7-
consistency group snapshot create
8-
---------------------------------
7+
.. autoprogram-cliff:: openstack.volume.v3
8+
:command: consistency group snapshot create
99

10-
Create new consistency group snapshot.
10+
.. autoprogram-cliff:: openstack.volume.v3
11+
:command: consistency group snapshot delete
1112

12-
.. program:: consistency group snapshot create
13-
.. code:: bash
13+
.. autoprogram-cliff:: openstack.volume.v3
14+
:command: consistency group snapshot list
1415

15-
openstack consistency group snapshot create
16-
[--consistency-group <consistency-group>]
17-
[--description <description>]
18-
[<snapshot-name>]
19-
20-
.. option:: --consistency-group <consistency-group>
21-
22-
Consistency group to snapshot (name or ID)
23-
(default to be the same as <snapshot-name>)
24-
25-
.. option:: --description <description>
26-
27-
Description of this consistency group snapshot
28-
29-
.. _consistency_group_snapshot_create-snapshot-name:
30-
.. describe:: <snapshot-name>
31-
32-
Name of new consistency group snapshot (default to None)
33-
34-
consistency group snapshot delete
35-
---------------------------------
36-
37-
Delete consistency group snapshot(s)
38-
39-
.. program:: consistency group snapshot delete
40-
.. code:: bash
41-
42-
openstack consistency group snapshot delete
43-
<consistency-group-snapshot> [<consistency-group-snapshot> ...]
44-
45-
.. _consistency_group_snapshot_delete-consistency-group-snapshot:
46-
.. describe:: <consistency-group-snapshot>
47-
48-
Consistency group snapshot(s) to delete (name or ID)
49-
50-
consistency group snapshot list
51-
-------------------------------
52-
53-
List consistency group snapshots.
54-
55-
.. program:: consistency group snapshot list
56-
.. code:: bash
57-
58-
openstack consistency group snapshot list
59-
[--all-projects]
60-
[--long]
61-
[--status <status>]
62-
[--consistency-group <consistency-group>]
63-
64-
.. option:: --all-projects
65-
66-
Show detail for all projects. Admin only.
67-
(defaults to False)
68-
69-
.. option:: --long
70-
71-
List additional fields in output
72-
73-
.. option:: --status <status>
74-
75-
Filters results by a status
76-
("available", "error", "creating", "deleting" or "error_deleting")
77-
78-
.. option:: --consistency-group <consistency-group>
79-
80-
Filters results by a consistency group (name or ID)
81-
82-
consistency group snapshot show
83-
-------------------------------
84-
85-
Display consistency group snapshot details.
86-
87-
.. program:: consistency group snapshot show
88-
.. code:: bash
89-
90-
openstack consistency group snapshot show
91-
<consistency-group-snapshot>
92-
93-
.. _consistency_group_snapshot_show-consistency-group-snapshot:
94-
.. describe:: <consistency-group-snapshot>
95-
96-
Consistency group snapshot to display (name or ID)
16+
.. autoprogram-cliff:: openstack.volume.v3
17+
:command: consistency group snapshot show

‎doc/source/cli/command-objects/consistency-group.rst‎

Lines changed: 15 additions & 162 deletions
Original file line numberDiff line numberDiff line change
@@ -2,172 +2,25 @@
22
consistency group
33
=================
44

5-
Block Storage v2
5+
Block Storage v2, v3
66

7-
consistency group add volume
8-
----------------------------
7+
.. autoprogram-cliff:: openstack.volume.v3
8+
:command: consistency group add volume
99

10-
Add volume(s) to consistency group.
10+
.. autoprogram-cliff:: openstack.volume.v3
11+
:command: consistency group create
1112

12-
.. program:: consistency group add volume
13-
.. code:: bash
13+
.. autoprogram-cliff:: openstack.volume.v3
14+
:command: consistency group delete
1415

15-
openstack consistency group add volume
16-
<consistency-group>
17-
<volume> [<volume> ...]
16+
.. autoprogram-cliff:: openstack.volume.v3
17+
:command: consistency group list
1818

19-
.. _consistency_group_add_volume:
20-
.. describe:: <consistency-group>
19+
.. autoprogram-cliff:: openstack.volume.v3
20+
:command: consistency group remove volume
2121

22-
Consistency group to contain <volume> (name or ID)
22+
.. autoprogram-cliff:: openstack.volume.v3
23+
:command: consistency group set
2324

24-
.. describe:: <volume>
25-
26-
Volume(s) to add to <consistency-group> (name or ID)
27-
(repeat option to add multiple volumes)
28-
29-
consistency group create
30-
------------------------
31-
32-
Create new consistency group.
33-
34-
.. program:: consistency group create
35-
.. code:: bash
36-
37-
openstack consistency group create
38-
--volume-type <volume-type> | --consistency-group-source <consistency-group> | --consistency-group-snapshot <consistency-group-snapshot>
39-
[--description <description>]
40-
[--availability-zone <availability-zone>]
41-
[<name>]
42-
43-
.. option:: --volume-type <volume-type>
44-
45-
Volume type of this consistency group (name or ID)
46-
47-
.. option:: --consistency-group-source <consistency-group>
48-
49-
Existing consistency group (name or ID)
50-
51-
.. option:: --consistency-group-snapshot <consistency-group-snapshot>
52-
53-
Existing consistency group snapshot (name or ID)
54-
55-
.. option:: --description <description>
56-
57-
Description of this consistency group
58-
59-
.. option:: --availability-zone <availability-zone>
60-
61-
Availability zone for this consistency group
62-
(not available if creating consistency group from source)
63-
64-
.. _consistency_group_create-name:
65-
.. describe:: <name>
66-
67-
Name of new consistency group (default to None)
68-
69-
consistency group delete
70-
------------------------
71-
72-
Delete consistency group(s).
73-
74-
.. program:: consistency group delete
75-
.. code:: bash
76-
77-
openstack consistency group delete
78-
[--force]
79-
<consistency-group> [<consistency-group> ...]
80-
81-
.. option:: --force
82-
83-
Allow delete in state other than error or available
84-
85-
.. _consistency_group_delete-consistency-group:
86-
.. describe:: <consistency-group>
87-
88-
Consistency group(s) to delete (name or ID)
89-
90-
consistency group list
91-
----------------------
92-
93-
List consistency groups.
94-
95-
.. program:: consistency group list
96-
.. code:: bash
97-
98-
openstack consistency group list
99-
[--all-projects]
100-
[--long]
101-
102-
.. option:: --all-projects
103-
104-
Show detail for all projects. Admin only.
105-
(defaults to False)
106-
107-
.. option:: --long
108-
109-
List additional fields in output
110-
111-
consistency group remove volume
112-
-------------------------------
113-
114-
Remove volume(s) from consistency group.
115-
116-
.. program:: consistency group remove volume
117-
.. code:: bash
118-
119-
openstack consistency group remove volume
120-
<consistency-group>
121-
<volume> [<volume> ...]
122-
123-
.. _consistency_group_remove_volume:
124-
.. describe:: <consistency-group>
125-
126-
Consistency group containing <volume> (name or ID)
127-
128-
.. describe:: <volume>
129-
130-
Volume(s) to remove from <consistency-group> (name or ID)
131-
(repeat option to remove multiple volumes)
132-
133-
consistency group set
134-
---------------------
135-
136-
Set consistency group properties.
137-
138-
.. program:: consistency group set
139-
.. code:: bash
140-
141-
openstack consistency group set
142-
[--name <name>]
143-
[--description <description>]
144-
<consistency-group>
145-
146-
.. option:: --name <name>
147-
148-
New consistency group name
149-
150-
.. option:: --description <description>
151-
152-
New consistency group description
153-
154-
.. _consistency_group_set-consistency-group:
155-
.. describe:: <consistency-group>
156-
157-
Consistency group to modify (name or ID)
158-
159-
consistency group show
160-
----------------------
161-
162-
Display consistency group details.
163-
164-
.. program:: consistency group show
165-
.. code:: bash
166-
167-
openstack consistency group show
168-
<consistency-group>
169-
170-
.. _consistency_group_show-consistency-group:
171-
.. describe:: <consistency-group>
172-
173-
Consistency group to display (name or ID)
25+
.. autoprogram-cliff:: openstack.volume.v3
26+
:command: consistency group show

0 commit comments

Comments
 (0)