From cb8590ffb3bf79a2754e913d3cc05b2b8318b8bc Mon Sep 17 00:00:00 2001 From: Steve Martinelli Date: Thu, 6 Aug 2015 22:24:22 -0700 Subject: Rename command docs to remove underscores For consistency, use dashes instead of underscores. Change-Id: I2da19b56952a8a9d172793ae211bdc58ddff4146 --- doc/source/command-objects/availability-zone.rst | 20 +++ doc/source/command-objects/availability_zone.rst | 20 --- doc/source/command-objects/role-assignment.rst | 68 ++++++++++ doc/source/command-objects/role_assignment.rst | 68 ---------- doc/source/command-objects/volume-qos.rst | 154 +++++++++++++++++++++++ doc/source/command-objects/volume_qos.rst | 154 ----------------------- 6 files changed, 242 insertions(+), 242 deletions(-) create mode 100644 doc/source/command-objects/availability-zone.rst delete mode 100644 doc/source/command-objects/availability_zone.rst create mode 100644 doc/source/command-objects/role-assignment.rst delete mode 100644 doc/source/command-objects/role_assignment.rst create mode 100644 doc/source/command-objects/volume-qos.rst delete mode 100644 doc/source/command-objects/volume_qos.rst (limited to 'doc/source/command-objects') diff --git a/doc/source/command-objects/availability-zone.rst b/doc/source/command-objects/availability-zone.rst new file mode 100644 index 00000000..37435230 --- /dev/null +++ b/doc/source/command-objects/availability-zone.rst @@ -0,0 +1,20 @@ +================= +availability zone +================= + +Compute v2 + +availability zone list +---------------------- + +List availability zones and their status + +.. program availability zone list +.. code:: bash + + os availability zone list + [--long] + +.. option:: --long + + List additional fields in output diff --git a/doc/source/command-objects/availability_zone.rst b/doc/source/command-objects/availability_zone.rst deleted file mode 100644 index 37435230..00000000 --- a/doc/source/command-objects/availability_zone.rst +++ /dev/null @@ -1,20 +0,0 @@ -================= -availability zone -================= - -Compute v2 - -availability zone list ----------------------- - -List availability zones and their status - -.. program availability zone list -.. code:: bash - - os availability zone list - [--long] - -.. option:: --long - - List additional fields in output diff --git a/doc/source/command-objects/role-assignment.rst b/doc/source/command-objects/role-assignment.rst new file mode 100644 index 00000000..6bb24cb3 --- /dev/null +++ b/doc/source/command-objects/role-assignment.rst @@ -0,0 +1,68 @@ +=============== +role assignment +=============== + +Identity v3 + +role assignment list +-------------------- + +List role assignments + +.. program:: role assignment list +.. code:: bash + + os role assignment list + [--role ] + [--user ] + [--user-domain ] + [--group ] + [--group-domain ] + [--domain ] + [--project ] + [--project-domain ] + [--effective] + [--inherited] + +.. option:: --role + + Role to filter (name or ID) + +.. option:: --user + + User to filter (name or ID) + +.. option:: --user-domain + + Domain the user belongs to (name or ID). + This can be used in case collisions between user names exist. + +.. option:: --group + + Group to filter (name or ID) + +.. option:: --group-domain + + Domain the group belongs to (name or ID). + This can be used in case collisions between group names exist. + +.. option:: --domain + + Domain to filter (name or ID) + +.. option:: --project + + Project to filter (name or ID) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. option:: --effective + + Returns only effective role assignments (defaults to False) + +.. option:: --inherited + + Specifies if the role grant is inheritable to the sub projects diff --git a/doc/source/command-objects/role_assignment.rst b/doc/source/command-objects/role_assignment.rst deleted file mode 100644 index 6bb24cb3..00000000 --- a/doc/source/command-objects/role_assignment.rst +++ /dev/null @@ -1,68 +0,0 @@ -=============== -role assignment -=============== - -Identity v3 - -role assignment list --------------------- - -List role assignments - -.. program:: role assignment list -.. code:: bash - - os role assignment list - [--role ] - [--user ] - [--user-domain ] - [--group ] - [--group-domain ] - [--domain ] - [--project ] - [--project-domain ] - [--effective] - [--inherited] - -.. option:: --role - - Role to filter (name or ID) - -.. option:: --user - - User to filter (name or ID) - -.. option:: --user-domain - - Domain the user belongs to (name or ID). - This can be used in case collisions between user names exist. - -.. option:: --group - - Group to filter (name or ID) - -.. option:: --group-domain - - Domain the group belongs to (name or ID). - This can be used in case collisions between group names exist. - -.. option:: --domain - - Domain to filter (name or ID) - -.. option:: --project - - Project to filter (name or ID) - -.. option:: --project-domain - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. option:: --effective - - Returns only effective role assignments (defaults to False) - -.. option:: --inherited - - Specifies if the role grant is inheritable to the sub projects diff --git a/doc/source/command-objects/volume-qos.rst b/doc/source/command-objects/volume-qos.rst new file mode 100644 index 00000000..d0fe36f9 --- /dev/null +++ b/doc/source/command-objects/volume-qos.rst @@ -0,0 +1,154 @@ +========== +volume qos +========== + +volume v1, v2 + +volume qos associate +-------------------- + +Associate a QoS specification to a volume type + +.. program:: volume qos associate +.. code:: bash + + os volume qos associate + + + +.. describe:: + + QoS specification to modify (name or ID) + +.. describe:: + + Volume type to associate the QoS (name or ID) + +volume qos create +----------------- + +Create new QoS Specification + +.. program:: volume qos create +.. code:: bash + + os volume qos create + [--consumer ] + [--property [...] ] + + +.. option:: --consumer + + Consumer of the QoS. Valid consumers: 'front-end', 'back-end', 'both' (defaults to 'both') + +.. option:: --property + + Set a property on this QoS specification (repeat option to set multiple properties) + +.. describe:: + + New QoS specification name + +volume qos delete +----------------- + +Delete QoS specification + +.. program:: volume qos delete +.. code:: bash + + os volume qos delete + [ ...] + +.. describe:: + + QoS specification(s) to delete (name or ID) + +volume qos disassociate +----------------------- + +Disassociate a QoS specification from a volume type + +.. program:: volume qos disassoiate +.. code:: bash + + os volume qos disassociate + --volume-type | --all + + +.. option:: --volume-type + + Volume type to disassociate the QoS from (name or ID) + +.. option:: --all + + Disassociate the QoS from every volume type + +.. describe:: + + QoS specification to modify (name or ID) + +volume qos list +--------------- + +List QoS specifications + +.. program:: volume qos list +.. code:: bash + + os volume qos list + +volume qos set +-------------- + +Set QoS specification properties + +.. program:: volume qos set +.. code:: bash + + os volume qos set + [--property [...] ] + + +.. option:: --property + + Property to add or modify for this QoS specification (repeat option to set multiple properties) + +.. describe:: + + QoS specification to modify (name or ID) + +volume qos show +--------------- + +Display QoS specification details + +.. program:: volume qos show +.. code:: bash + + os volume qos show + + +.. describe:: + + QoS specification to display (name or ID) + +volume qos unset +---------------- + +Unset QoS specification properties + +.. program:: volume qos unset +.. code:: bash + + os volume qos unset + [--property ] + + +.. option:: --property + + Property to remove from QoS specification (repeat option to remove multiple properties) + +.. describe:: + + QoS specification to modify (name or ID) diff --git a/doc/source/command-objects/volume_qos.rst b/doc/source/command-objects/volume_qos.rst deleted file mode 100644 index d0fe36f9..00000000 --- a/doc/source/command-objects/volume_qos.rst +++ /dev/null @@ -1,154 +0,0 @@ -========== -volume qos -========== - -volume v1, v2 - -volume qos associate --------------------- - -Associate a QoS specification to a volume type - -.. program:: volume qos associate -.. code:: bash - - os volume qos associate - - - -.. describe:: - - QoS specification to modify (name or ID) - -.. describe:: - - Volume type to associate the QoS (name or ID) - -volume qos create ------------------ - -Create new QoS Specification - -.. program:: volume qos create -.. code:: bash - - os volume qos create - [--consumer ] - [--property [...] ] - - -.. option:: --consumer - - Consumer of the QoS. Valid consumers: 'front-end', 'back-end', 'both' (defaults to 'both') - -.. option:: --property - - Set a property on this QoS specification (repeat option to set multiple properties) - -.. describe:: - - New QoS specification name - -volume qos delete ------------------ - -Delete QoS specification - -.. program:: volume qos delete -.. code:: bash - - os volume qos delete - [ ...] - -.. describe:: - - QoS specification(s) to delete (name or ID) - -volume qos disassociate ------------------------ - -Disassociate a QoS specification from a volume type - -.. program:: volume qos disassoiate -.. code:: bash - - os volume qos disassociate - --volume-type | --all - - -.. option:: --volume-type - - Volume type to disassociate the QoS from (name or ID) - -.. option:: --all - - Disassociate the QoS from every volume type - -.. describe:: - - QoS specification to modify (name or ID) - -volume qos list ---------------- - -List QoS specifications - -.. program:: volume qos list -.. code:: bash - - os volume qos list - -volume qos set --------------- - -Set QoS specification properties - -.. program:: volume qos set -.. code:: bash - - os volume qos set - [--property [...] ] - - -.. option:: --property - - Property to add or modify for this QoS specification (repeat option to set multiple properties) - -.. describe:: - - QoS specification to modify (name or ID) - -volume qos show ---------------- - -Display QoS specification details - -.. program:: volume qos show -.. code:: bash - - os volume qos show - - -.. describe:: - - QoS specification to display (name or ID) - -volume qos unset ----------------- - -Unset QoS specification properties - -.. program:: volume qos unset -.. code:: bash - - os volume qos unset - [--property ] - - -.. option:: --property - - Property to remove from QoS specification (repeat option to remove multiple properties) - -.. describe:: - - QoS specification to modify (name or ID) -- cgit v1.2.1