From 9599ffe65d9dcd4b3aa780d346eccd1e760890bf Mon Sep 17 00:00:00 2001
From: Doug Hellmann <doug@doughellmann.com>
Date: Tue, 13 Jun 2017 15:55:33 -0400
Subject: reorganize existing documentation according to the new standard
 layout

Move existing content around based on the doc-migration specification.

Replace :doc: markup with :ref: to have sphinx keep track of where the
files move and generate valid hyperlinks.

Add a few toctrees and index pages for the new directories.

Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
---
 doc/source/cli/command-objects/volume-qos.rst | 166 ++++++++++++++++++++++++++
 1 file changed, 166 insertions(+)
 create mode 100644 doc/source/cli/command-objects/volume-qos.rst

(limited to 'doc/source/cli/command-objects/volume-qos.rst')

diff --git a/doc/source/cli/command-objects/volume-qos.rst b/doc/source/cli/command-objects/volume-qos.rst
new file mode 100644
index 00000000..8fdbc122
--- /dev/null
+++ b/doc/source/cli/command-objects/volume-qos.rst
@@ -0,0 +1,166 @@
+==========
+volume qos
+==========
+
+Block Storage v1, v2
+
+volume qos associate
+--------------------
+
+Associate a QoS specification to a volume type
+
+.. program:: volume qos associate
+.. code:: bash
+
+    openstack volume qos associate
+        <qos-spec>
+        <volume-type>
+
+.. _volume_qos_associate:
+.. describe:: <qos-spec>
+
+    QoS specification to modify (name or ID)
+
+.. describe:: <volume-type>
+
+    Volume type to associate the QoS (name or ID)
+
+volume qos create
+-----------------
+
+Create new QoS Specification
+
+.. program:: volume qos create
+.. code:: bash
+
+    openstack volume qos create
+        [--consumer <consumer>]
+        [--property <key=value> [...] ]
+        <name>
+
+.. option:: --consumer <consumer>
+
+    Consumer of the QoS. Valid consumers: 'front-end', 'back-end', 'both' (defaults to 'both')
+
+.. option:: --property <key=value>
+
+    Set a property on this QoS specification (repeat option to set multiple properties)
+
+.. _volume_qos_create-name:
+.. describe:: <name>
+
+    New QoS specification name
+
+volume qos delete
+-----------------
+
+Delete QoS specification
+
+.. program:: volume qos delete
+.. code:: bash
+
+    openstack volume qos delete
+         [--force]
+         <qos-spec> [<qos-spec> ...]
+
+.. option:: --force
+
+    Allow to delete in-use QoS specification(s)
+
+.. _volume_qos_delete-qos-spec:
+.. describe:: <qos-spec>
+
+    QoS specification(s) to delete (name or ID)
+
+volume qos disassociate
+-----------------------
+
+Disassociate a QoS specification from a volume type
+
+.. program:: volume qos disassociate
+.. code:: bash
+
+    openstack volume qos disassociate
+        --volume-type <volume-type> | --all
+        <qos-spec>
+
+.. option:: --volume-type <volume-type>
+
+    Volume type to disassociate the QoS from (name or ID)
+
+.. option:: --all
+
+    Disassociate the QoS from every volume type
+
+.. _volume_qos_disassociate-qos-spec:
+.. describe:: <qos-spec>
+
+    QoS specification to modify (name or ID)
+
+volume qos list
+---------------
+
+List QoS specifications
+
+.. program:: volume qos list
+.. code:: bash
+
+    openstack volume qos list
+
+volume qos set
+--------------
+
+Set QoS specification properties
+
+.. program:: volume qos set
+.. code:: bash
+
+    openstack volume qos set
+        [--property <key=value> [...] ]
+        <qos-spec>
+
+.. option:: --property <key=value>
+
+    Property to add or modify for this QoS specification (repeat option to set multiple properties)
+
+.. _volume_qos_set-qos-spec:
+.. describe:: <qos-spec>
+
+    QoS specification to modify (name or ID)
+
+volume qos show
+---------------
+
+Display QoS specification details
+
+.. program:: volume qos show
+.. code:: bash
+
+    openstack volume qos show
+        <qos-spec>
+
+.. _volume_qos_show-qos-spec:
+.. describe:: <qos-spec>
+
+   QoS specification to display (name or ID)
+
+volume qos unset
+----------------
+
+Unset QoS specification properties
+
+.. program:: volume qos unset
+.. code:: bash
+
+    openstack volume qos unset
+        [--property <key> [...] ]
+        <qos-spec>
+
+.. option:: --property <key>
+
+    Property to remove from QoS specification (repeat option to remove multiple properties)
+
+.. _volume_qos_unset-qos-spec:
+.. describe:: <qos-spec>
+
+    QoS specification to modify (name or ID)
-- 
cgit v1.2.1