summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/usage.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2017-06-13 15:55:33 -0400
committerAndreas Jaeger <aj@suse.com>2017-06-23 11:54:32 +0200
commit9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch)
tree9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/cli/command-objects/usage.rst
parent19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff)
downloadpython-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz
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>
Diffstat (limited to 'doc/source/cli/command-objects/usage.rst')
-rw-r--r--doc/source/cli/command-objects/usage.rst50
1 files changed, 50 insertions, 0 deletions
diff --git a/doc/source/cli/command-objects/usage.rst b/doc/source/cli/command-objects/usage.rst
new file mode 100644
index 00000000..9cd0f70e
--- /dev/null
+++ b/doc/source/cli/command-objects/usage.rst
@@ -0,0 +1,50 @@
+=====
+usage
+=====
+
+Compute v2
+
+usage list
+----------
+
+List resource usage per project
+
+.. program:: usage list
+.. code:: bash
+
+ openstack usage list
+ [--start <start>]
+ [--end <end>]
+
+.. option:: --start <start>
+
+ Usage range start date, ex 2012-01-20 (default: 4 weeks ago)
+
+.. option:: --end <end>
+
+ Usage range end date, ex 2012-01-20 (default: tomorrow)
+
+usage show
+----------
+
+Show resource usage for a single project
+
+.. program:: usage show
+.. code:: bash
+
+ openstack usage show
+ [--project <project>]
+ [--start <start>]
+ [--end <end>]
+
+.. option:: --project <project>
+
+ Name or ID of project to show usage for
+
+.. option:: --start <start>
+
+ Usage range start date, ex 2012-01-20 (default: 4 weeks ago)
+
+.. option:: --end <end>
+
+ Usage range end date, ex 2012-01-20 (default: tomorrow)