From 254910d3ce34c954551a0827aa8727d6367f48f3 Mon Sep 17 00:00:00 2001
From: Dean Troyer <dtroyer@gmail.com>
Date: Mon, 17 Nov 2014 16:42:30 -0600
Subject: Begin copying wiki command list here

* Sort by command objects
* Drop the comparison to the project CLIs
* Minor updates to command help to match docs

Initially include the cross-API commands to establish the structure and format.

Change-Id: I77a7b3c89e088b66aa62941e29ce0b65b532285b
---
 doc/source/command-objects/extension.rst |  41 ++++++++
 doc/source/command-objects/limits.rst    |  28 ++++++
 doc/source/command-objects/quota.rst     | 157 +++++++++++++++++++++++++++++++
 3 files changed, 226 insertions(+)
 create mode 100644 doc/source/command-objects/extension.rst
 create mode 100644 doc/source/command-objects/limits.rst
 create mode 100644 doc/source/command-objects/quota.rst

(limited to 'doc/source/command-objects')

diff --git a/doc/source/command-objects/extension.rst b/doc/source/command-objects/extension.rst
new file mode 100644
index 00000000..8f39a625
--- /dev/null
+++ b/doc/source/command-objects/extension.rst
@@ -0,0 +1,41 @@
+=========
+extension
+=========
+
+Many OpenStack server APIs include API extensions that enable
+additional functionality.
+
+extension list
+--------------
+
+List API extensions
+
+.. program:: extension list
+.. code:: bash
+
+    os extension list
+        [--compute]
+        [--identity]
+        [--network]
+        [--volume]
+        [--long]
+
+.. option:: --compute
+
+    List extensions for the Compute API
+
+.. option:: --identity
+
+    List extensions for the Identity API
+
+.. option:: --network
+
+    List extensions for the Network API
+
+.. option:: --volume
+
+    List extensions for the Volume API
+
+.. option:: --long
+
+    List additional fields in output
diff --git a/doc/source/command-objects/limits.rst b/doc/source/command-objects/limits.rst
new file mode 100644
index 00000000..ac388e0f
--- /dev/null
+++ b/doc/source/command-objects/limits.rst
@@ -0,0 +1,28 @@
+======
+limits
+======
+
+The Compute and Volume APIs have resource usage limits.
+
+limits show
+-----------
+
+Show compute and volume limits
+
+.. program:: limits show
+.. code:: bash
+
+    os limits show
+        --absolute [--reserved] | --rate
+
+.. option:: --absolute
+
+    Show absolute limits
+
+.. option:: --rate
+
+    Show rate limits
+
+.. option:: --reserved
+
+    Include reservations count [only valid with :option:`--absolute`]
diff --git a/doc/source/command-objects/quota.rst b/doc/source/command-objects/quota.rst
new file mode 100644
index 00000000..ba6712c0
--- /dev/null
+++ b/doc/source/command-objects/quota.rst
@@ -0,0 +1,157 @@
+=====
+quota
+=====
+
+Resource quotas appear in multiple APIs, OpenStackClient presents them as a single object with multiple properties.
+
+quota set
+---------
+
+Set quotas for project
+
+.. program:: quota set
+.. code:: bash
+
+    os quota set
+        # Compute settings
+        [--cores <num-cores>]
+        [--fixed-ips <num-fixed-ips>]
+        [--floating-ips <num-floating-ips>]
+        [--injected-file-size <injected-file-bytes>]
+        [--injected-files <num-injected-files>]
+        [--instances <num-instances>]
+        [--key-pairs <num-key-pairs>]
+        [--properties <num-properties>]
+        [--ram <ram-mb>]
+
+        # Volume settings
+        [--gigabytes <new-gigabytes>]
+        [--snapshots <new-snapshots>]
+        [--volumes <new-volumes>]
+
+        <project>
+
+Set quotas for class
+
+.. code:: bash
+
+    os quota set
+        --class
+        # Compute settings
+        [--cores <num-cores>]
+        [--fixed-ips <num-fixed-ips>]
+        [--floating-ips <num-floating-ips>]
+        [--injected-file-size <injected-file-bytes>]
+        [--injected-files <num-injected-files>]
+        [--instances <num-instances>]
+        [--key-pairs <num-key-pairs>]
+        [--properties <num-properties>]
+        [--ram <ram-mb>]
+
+        # Volume settings
+        [--gigabytes <new-gigabytes>]
+        [--snapshots <new-snapshots>]
+        [--volumes <new-volumes>]
+
+        <class>
+
+.. option:: --class
+
+    Set quotas for ``<class>``
+
+.. option:: --properties <new-properties>
+
+    New value for the properties quota
+
+.. option:: --ram <new-ram>
+
+    New value for the ram quota
+
+.. option:: --secgroup-rules <new-secgroup-rules>
+
+    New value for the secgroup-rules quota
+
+.. option:: --instances <new-instances>
+
+    New value for the instances quota
+
+.. option:: --key-pairs <new-key-pairs>
+
+    New value for the key-pairs quota
+
+.. option:: --fixed-ips <new-fixed-ips>
+
+    New value for the fixed-ips quota
+
+.. option:: --secgroups <new-secgroups>
+
+    New value for the secgroups quota
+
+.. option:: --injected-file-size <new-injected-file-size>
+
+    New value for the injected-file-size quota
+
+.. option:: --floating-ips <new-floating-ips>
+
+    New value for the floating-ips quota
+
+.. option:: --injected-files <new-injected-files>
+
+    New value for the injected-files quota
+
+.. option:: --cores <new-cores>
+
+    New value for the cores quota
+
+.. option:: --injected-path-size <new-injected-path-size>
+
+    New value for the injected-path-size quota
+
+.. option:: --gigabytes <new-gigabytes>
+
+    New value for the gigabytes quota
+
+.. option:: --volumes <new-volumes>
+
+    New value for the volumes quota
+
+.. option:: --snapshots <new-snapshots>
+
+    New value for the snapshots quota
+
+quota show
+----------
+
+Show quotas for project
+
+.. program:: quota show
+.. code:: bash
+
+    os quota show
+        [--default]
+        <project>
+
+
+.. option:: --default
+
+    Show default quotas for :ref:`\<project\> <quota_show-project>`
+
+.. _quota_show-project:
+.. describe:: <project>
+
+    Show quotas for class
+
+.. code:: bash
+
+    os quota show
+        --class
+        <class>
+
+.. option:: --class
+
+    Show quotas for :ref:`\<class\> <quota_show-class>`
+
+.. _quota_show-class:
+.. describe:: <class>
+
+    Class to show
\ No newline at end of file
-- 
cgit v1.2.1