openstack/python-openstackclient
Code Issues Proposed changes
0fb1378c6c
python-openstackclient/doc/source/command-objects/usage.rst

51 lines
849 B
ReStructuredText
Raw Normal View History

Add docs for usage show/list Change-Id: Iaf911d69a0b63d705f8789a4640018a428b87be6
2014-12-31 02:49:15 -05:00
=====
usage
=====
Compute v2
usage list
----------
List resource usage per project
.. program:: usage list
.. code:: bash
change os in command example to openstack(3) In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: Ie67c0152d8ff8b7c456f91dc8b9a9164437ee9d1
2016-12-20 09:26:15 +08:00
openstack usage list
Add square bracket to option parameter Because option parameter is not required. I add [] to option parameter. Change-Id: I27c14c42bf576decff90a4a290dcaad7fab00524
2016-09-23 11:14:15 +08:00
[--start <start>]
[--end <end>]
Add docs for usage show/list Change-Id: Iaf911d69a0b63d705f8789a4640018a428b87be6
2014-12-31 02:49:15 -05:00
.. option:: --start <start>
Deprecate project usage list command Rather than pointing the 'project usage list' entry point directly to ListUsage, this makes a ListProjectUsage subclass to alias the desired command and still allow for changing behaviour or issuing a deprecation messages. This implementation simply sets a new 'deprecated' attribute in the command class that cliff will use to skip this command when generating help output. The actual skipping of the command in help output is dependant on https://review.openstack.org/147349 merging in cliff, this review will simply have no effect on help output until a version of cliff with that update is present. The deprecation message printed is somewhat generic until https://review.openstack.org/147381 is merged in cliff. Until that is merged, the deprecation message will not have the name of the actual command given by the user in it, but rather the text 'this command'. Closes-bug: #1406654 Change-Id: Ie08d4f88d71a660fca1862405351109cd0aa86b6
2015-01-14 18:44:10 -06:00
Usage range start date, ex 2012-01-20 (default: 4 weeks ago)
Add docs for usage show/list Change-Id: Iaf911d69a0b63d705f8789a4640018a428b87be6
2014-12-31 02:49:15 -05:00
.. option:: --end <end>
Usage range end date, ex 2012-01-20 (default: tomorrow)
usage show
----------
Deprecate project usage list command Rather than pointing the 'project usage list' entry point directly to ListUsage, this makes a ListProjectUsage subclass to alias the desired command and still allow for changing behaviour or issuing a deprecation messages. This implementation simply sets a new 'deprecated' attribute in the command class that cliff will use to skip this command when generating help output. The actual skipping of the command in help output is dependant on https://review.openstack.org/147349 merging in cliff, this review will simply have no effect on help output until a version of cliff with that update is present. The deprecation message printed is somewhat generic until https://review.openstack.org/147381 is merged in cliff. Until that is merged, the deprecation message will not have the name of the actual command given by the user in it, but rather the text 'this command'. Closes-bug: #1406654 Change-Id: Ie08d4f88d71a660fca1862405351109cd0aa86b6
2015-01-14 18:44:10 -06:00
Show resource usage for a single project
Add docs for usage show/list Change-Id: Iaf911d69a0b63d705f8789a4640018a428b87be6
2014-12-31 02:49:15 -05:00
.. program:: usage show
.. code:: bash
change os in command example to openstack(3) In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: Ie67c0152d8ff8b7c456f91dc8b9a9164437ee9d1
2016-12-20 09:26:15 +08:00
openstack usage show
Add square bracket to option parameter Because option parameter is not required. I add [] to option parameter. Change-Id: I27c14c42bf576decff90a4a290dcaad7fab00524
2016-09-23 11:14:15 +08:00
[--project <project>]
[--start <start>]
[--end <end>]
Add docs for usage show/list Change-Id: Iaf911d69a0b63d705f8789a4640018a428b87be6
2014-12-31 02:49:15 -05:00
.. option:: --project <project>
Deprecate project usage list command Rather than pointing the 'project usage list' entry point directly to ListUsage, this makes a ListProjectUsage subclass to alias the desired command and still allow for changing behaviour or issuing a deprecation messages. This implementation simply sets a new 'deprecated' attribute in the command class that cliff will use to skip this command when generating help output. The actual skipping of the command in help output is dependant on https://review.openstack.org/147349 merging in cliff, this review will simply have no effect on help output until a version of cliff with that update is present. The deprecation message printed is somewhat generic until https://review.openstack.org/147381 is merged in cliff. Until that is merged, the deprecation message will not have the name of the actual command given by the user in it, but rather the text 'this command'. Closes-bug: #1406654 Change-Id: Ie08d4f88d71a660fca1862405351109cd0aa86b6
2015-01-14 18:44:10 -06:00
Name or ID of project to show usage for
Add docs for usage show/list Change-Id: Iaf911d69a0b63d705f8789a4640018a428b87be6
2014-12-31 02:49:15 -05:00
.. option:: --start <start>
Deprecate project usage list command Rather than pointing the 'project usage list' entry point directly to ListUsage, this makes a ListProjectUsage subclass to alias the desired command and still allow for changing behaviour or issuing a deprecation messages. This implementation simply sets a new 'deprecated' attribute in the command class that cliff will use to skip this command when generating help output. The actual skipping of the command in help output is dependant on https://review.openstack.org/147349 merging in cliff, this review will simply have no effect on help output until a version of cliff with that update is present. The deprecation message printed is somewhat generic until https://review.openstack.org/147381 is merged in cliff. Until that is merged, the deprecation message will not have the name of the actual command given by the user in it, but rather the text 'this command'. Closes-bug: #1406654 Change-Id: Ie08d4f88d71a660fca1862405351109cd0aa86b6
2015-01-14 18:44:10 -06:00
Usage range start date, ex 2012-01-20 (default: 4 weeks ago)
Add docs for usage show/list Change-Id: Iaf911d69a0b63d705f8789a4640018a428b87be6
2014-12-31 02:49:15 -05:00
.. option:: --end <end>
Usage range end date, ex 2012-01-20 (default: tomorrow)
Copy Permalink