Skip to content

Commit 8132072

Browse files
Jenkinsopenstack-gerrit
authored andcommitted
Merge "Add docs for usage show/list"
2 parents 6c0d4b8 + 480921d commit 8132072

3 files changed

Lines changed: 57 additions & 6 deletions

File tree

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
=====
2+
usage
3+
=====
4+
5+
Compute v2
6+
7+
usage list
8+
----------
9+
10+
List resource usage per project
11+
12+
.. program:: usage list
13+
.. code:: bash
14+
15+
os usage list
16+
--start <start>
17+
--end <end>
18+
19+
.. option:: --start <start>
20+
21+
Usage range start date, ex 2012-01-20 (default: 4 weeks ago).
22+
23+
.. option:: --end <end>
24+
25+
Usage range end date, ex 2012-01-20 (default: tomorrow)
26+
27+
usage show
28+
----------
29+
30+
Show resource usage for a single project.
31+
32+
.. program:: usage show
33+
.. code:: bash
34+
35+
os usage show
36+
--project <project>
37+
--start <start>
38+
--end <end>
39+
40+
.. option:: --project <project>
41+
42+
Name or ID of project to show usage for.
43+
44+
.. option:: --start <start>
45+
46+
Usage range start date, ex 2012-01-20 (default: 4 weeks ago).
47+
48+
.. option:: --end <end>
49+
50+
Usage range end date, ex 2012-01-20 (default: tomorrow)

‎doc/source/commands.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,7 @@ referring to both Compute and Volume quotas.
108108
* ``service``: Identity - a cloud service
109109
* ``snapshot``: Volume - a point-in-time copy of a volume
110110
* ``token``: (**Identity**) a bearer token managed by Identity service
111+
* ``usage``: (**Compute**) display host resources being consumed
111112
* ``user``: (**Identity**) individual cloud resources users
112113
* ``user role``: (**Identity**) roles assigned to a user
113114
* ``volume``: Volume - block volumes

‎openstackclient/compute/v2/usage.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,12 @@ class ShowUsage(show.ShowOne):
125125

126126
def get_parser(self, prog_name):
127127
parser = super(ShowUsage, self).get_parser(prog_name)
128+
parser.add_argument(
129+
"--project",
130+
metavar="<project>",
131+
default=None,
132+
help="Name or ID of project to show usage for."
133+
)
128134
parser.add_argument(
129135
"--start",
130136
metavar="<start>",
@@ -138,12 +144,6 @@ def get_parser(self, prog_name):
138144
default=None,
139145
help="Usage range end date, ex 2012-01-20 (default: tomorrow)."
140146
)
141-
parser.add_argument(
142-
"--project",
143-
metavar="<project>",
144-
default=None,
145-
help="Name or ID of project to show usage for."
146-
)
147147
return parser
148148

149149
def take_action(self, parsed_args):

0 commit comments

Comments
 (0)