Skip to content

Commit 0183e72

Browse files
Zuulopenstack-gerrit
Zuul
authored and
openstack-gerrit
committed
Merge "docs: Migrate volume commands to autoprogram-cliff"
2 parents 29f2444 + 6e773f6 commit 0183e72

8 files changed

Lines changed: 22 additions & 875 deletions

File tree

‎doc/source/cli/command-objects/volume-backend.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
volume backend
33
==============
44

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

7-
.. autoprogram-cliff:: openstack.volume.v2
7+
.. autoprogram-cliff:: openstack.volume.v3
88
:command: volume backend *

‎doc/source/cli/command-objects/volume-backup.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
volume backup
33
=============
44

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

7-
.. autoprogram-cliff:: openstack.volume.v2
7+
.. autoprogram-cliff:: openstack.volume.v3
88
:command: volume backup *
99

‎doc/source/cli/command-objects/volume-host.rst‎

Lines changed: 3 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -2,51 +2,7 @@
22
volume host
33
===========
44

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

7-
volume host failover
8-
--------------------
9-
10-
Failover volume host to different backend
11-
12-
.. program:: volume host failover
13-
.. code:: bash
14-
15-
openstack volume host failover
16-
--volume-backend <backend-id>
17-
<host-name>
18-
19-
.. option:: --volume-backend <backend-id>
20-
21-
The ID of the volume backend replication
22-
target where the host will failover to (required)
23-
24-
.. _volume_host_failover-host-name:
25-
.. describe:: <host-name>
26-
27-
Name of volume host
28-
29-
volume host set
30-
---------------
31-
32-
Set volume host properties
33-
34-
.. program:: volume host set
35-
.. code:: bash
36-
37-
openstack volume host set
38-
[--enable | --disable]
39-
<host-name>
40-
41-
.. option:: --enable
42-
43-
Thaw and enable the specified volume host.
44-
45-
.. option:: --disable
46-
47-
Freeze and disable the specified volume host
48-
49-
.. _volume_host_set-host-name:
50-
.. describe:: <host-name>
51-
52-
Name of volume host
7+
.. autoprogram-cliff:: openstack.volume.v3
8+
:command: volume host *

‎doc/source/cli/command-objects/volume-qos.rst‎

Lines changed: 3 additions & 168 deletions
Original file line numberDiff line numberDiff line change
@@ -2,172 +2,7 @@
22
volume qos
33
==========
44

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

7-
volume qos associate
8-
--------------------
9-
10-
Associate a QoS specification to a volume type
11-
12-
.. program:: volume qos associate
13-
.. code:: bash
14-
15-
openstack volume qos associate
16-
<qos-spec>
17-
<volume-type>
18-
19-
.. _volume_qos_associate:
20-
.. describe:: <qos-spec>
21-
22-
QoS specification to modify (name or ID)
23-
24-
.. describe:: <volume-type>
25-
26-
Volume type to associate the QoS (name or ID)
27-
28-
volume qos create
29-
-----------------
30-
31-
Create new QoS Specification
32-
33-
.. program:: volume qos create
34-
.. code:: bash
35-
36-
openstack volume qos create
37-
[--consumer <consumer>]
38-
[--property <key=value> [...] ]
39-
<name>
40-
41-
.. option:: --consumer <consumer>
42-
43-
Consumer of the QoS. Valid consumers: 'front-end', 'back-end', 'both' (defaults to 'both')
44-
45-
.. option:: --property <key=value>
46-
47-
Set a property on this QoS specification (repeat option to set multiple properties)
48-
49-
.. _volume_qos_create-name:
50-
.. describe:: <name>
51-
52-
New QoS specification name
53-
54-
volume qos delete
55-
-----------------
56-
57-
Delete QoS specification
58-
59-
.. program:: volume qos delete
60-
.. code:: bash
61-
62-
openstack volume qos delete
63-
[--force]
64-
<qos-spec> [<qos-spec> ...]
65-
66-
.. option:: --force
67-
68-
Allow to delete in-use QoS specification(s)
69-
70-
.. _volume_qos_delete-qos-spec:
71-
.. describe:: <qos-spec>
72-
73-
QoS specification(s) to delete (name or ID)
74-
75-
volume qos disassociate
76-
-----------------------
77-
78-
Disassociate a QoS specification from a volume type
79-
80-
.. program:: volume qos disassociate
81-
.. code:: bash
82-
83-
openstack volume qos disassociate
84-
--volume-type <volume-type> | --all
85-
<qos-spec>
86-
87-
.. option:: --volume-type <volume-type>
88-
89-
Volume type to disassociate the QoS from (name or ID)
90-
91-
.. option:: --all
92-
93-
Disassociate the QoS from every volume type
94-
95-
.. _volume_qos_disassociate-qos-spec:
96-
.. describe:: <qos-spec>
97-
98-
QoS specification to modify (name or ID)
99-
100-
volume qos list
101-
---------------
102-
103-
List QoS specifications
104-
105-
.. program:: volume qos list
106-
.. code:: bash
107-
108-
openstack volume qos list
109-
110-
volume qos set
111-
--------------
112-
113-
Set QoS specification properties
114-
115-
.. program:: volume qos set
116-
.. code:: bash
117-
118-
openstack volume qos set
119-
[--no-property]
120-
[--property <key=value> [...] ]
121-
<qos-spec>
122-
123-
.. option:: --no-property
124-
125-
Remove all properties from :ref:`\<snapshot\> <volume_qos_set-qos-spec>`
126-
(specify both :option:`--no-property` and :option:`--property` to
127-
remove the current properties before setting new properties.)
128-
129-
.. option:: --property <key=value>
130-
131-
Property to add or modify for this QoS specification (repeat option to set multiple properties)
132-
133-
.. _volume_qos_set-qos-spec:
134-
.. describe:: <qos-spec>
135-
136-
QoS specification to modify (name or ID)
137-
138-
volume qos show
139-
---------------
140-
141-
Display QoS specification details
142-
143-
.. program:: volume qos show
144-
.. code:: bash
145-
146-
openstack volume qos show
147-
<qos-spec>
148-
149-
.. _volume_qos_show-qos-spec:
150-
.. describe:: <qos-spec>
151-
152-
QoS specification to display (name or ID)
153-
154-
volume qos unset
155-
----------------
156-
157-
Unset QoS specification properties
158-
159-
.. program:: volume qos unset
160-
.. code:: bash
161-
162-
openstack volume qos unset
163-
[--property <key> [...] ]
164-
<qos-spec>
165-
166-
.. option:: --property <key>
167-
168-
Property to remove from QoS specification (repeat option to remove multiple properties)
169-
170-
.. _volume_qos_unset-qos-spec:
171-
.. describe:: <qos-spec>
172-
173-
QoS specification to modify (name or ID)
7+
.. autoprogram-cliff:: openstack.volume.v3
8+
:command: volume qos *

‎doc/source/cli/command-objects/volume-service.rst‎

Lines changed: 3 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -2,65 +2,7 @@
22
volume service
33
==============
44

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

7-
volume service list
8-
-------------------
9-
10-
List volume service
11-
12-
.. program:: volume service list
13-
.. code:: bash
14-
15-
openstack volume service list
16-
[--host <host>]
17-
[--service <service>]
18-
[--long]
19-
20-
.. option:: --host <host>
21-
22-
List services on specified host (name only)
23-
24-
.. option:: --service <service>
25-
26-
List only specified service (name only)
27-
28-
.. option:: --long
29-
30-
List additional fields in output
31-
32-
volume service set
33-
------------------
34-
35-
Set volume service properties
36-
37-
.. program:: volume service set
38-
.. code:: bash
39-
40-
openstack volume service set
41-
[--enable | --disable]
42-
[--disable-reason <reason>]
43-
<host>
44-
<service>
45-
46-
.. option:: --enable
47-
48-
Enable volume service
49-
50-
.. option:: --disable
51-
52-
Disable volume service
53-
54-
.. option:: --disable-reason <reason>
55-
56-
Reason for disabling the service
57-
(should be used with :option:`--disable` option)
58-
59-
.. _volume_service_set-host:
60-
.. describe:: <host>
61-
62-
Name of host
63-
64-
.. describe:: <service>
65-
66-
Name of service (Binary name)
7+
.. autoprogram-cliff:: openstack.volume.v3
8+
:command: volume service *

0 commit comments

Comments
 (0)