From 480921d0e8009e20372037cba4fb6e381760a9c1 Mon Sep 17 00:00:00 2001
From: Steve Martinelli <stevemar@ca.ibm.com>
Date: Wed, 31 Dec 2014 02:49:15 -0500
Subject: [PATCH] Add docs for usage show/list
Change-Id: Iaf911d69a0b63d705f8789a4640018a428b87be6
---
doc/source/command-objects/usage.rst | 50 ++++++++++++++++++++++++++++
doc/source/commands.rst | 1 +
openstackclient/compute/v2/usage.py | 12 +++----
3 files changed, 57 insertions(+), 6 deletions(-)
create mode 100644 doc/source/command-objects/usage.rst
diff --git a/doc/source/command-objects/usage.rst b/doc/source/command-objects/usage.rst
new file mode 100644
index 0000000000..551176c700
--- /dev/null
+++ b/doc/source/command-objects/usage.rst
@@ -0,0 +1,50 @@
+=====
+usage
+=====
+
+Compute v2
+
+usage list
+----------
+
+List resource usage per project
+
+.. program:: usage list
+.. code:: bash
+
+ os 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
+
+ os 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)
diff --git a/doc/source/commands.rst b/doc/source/commands.rst
index 04c451c8fb..37d3107de8 100644
--- a/doc/source/commands.rst
+++ b/doc/source/commands.rst
@@ -107,6 +107,7 @@ referring to both Compute and Volume quotas.
* ``service``: Identity - a cloud service
* ``snapshot``: Volume - a point-in-time copy of a volume
* ``token``: (**Identity**) a bearer token managed by Identity service
+* ``usage``: (**Compute**) display host resources being consumed
* ``user``: (**Identity**) individual cloud resources users
* ``user role``: (**Identity**) roles assigned to a user
* ``volume``: Volume - block volumes
diff --git a/openstackclient/compute/v2/usage.py b/openstackclient/compute/v2/usage.py
index c71ecb1873..308241cf25 100644
--- a/openstackclient/compute/v2/usage.py
+++ b/openstackclient/compute/v2/usage.py
@@ -125,6 +125,12 @@ class ShowUsage(show.ShowOne):
def get_parser(self, prog_name):
parser = super(ShowUsage, self).get_parser(prog_name)
+ parser.add_argument(
+ "--project",
+ metavar="<project>",
+ default=None,
+ help="Name or ID of project to show usage for."
+ )
parser.add_argument(
"--start",
metavar="<start>",
@@ -138,12 +144,6 @@ class ShowUsage(show.ShowOne):
default=None,
help="Usage range end date, ex 2012-01-20 (default: tomorrow)."
)
- parser.add_argument(
- "--project",
- metavar="<project>",
- default=None,
- help="Name or ID of project to show usage for."
- )
return parser
def take_action(self, parsed_args):