Skip to content

Commit 17bf9cd

Browse files
Jenkinsopenstack-gerrit
Jenkins
authored and
openstack-gerrit
committed
Merge "Begin copying wiki command list here"
2 parents a2450d8 + 254910d commit 17bf9cd

10 files changed

Lines changed: 250 additions & 18 deletions

File tree

‎doc/source/command-list.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
============
2+
Command List
3+
============
4+
5+
.. toctree::
6+
:glob:
7+
:maxdepth: 2
8+
9+
command-objects/*

‎doc/source/command-objects/extension.rst‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
=========
2+
extension
3+
=========
4+
5+
Many OpenStack server APIs include API extensions that enable
6+
additional functionality.
7+
8+
extension list
9+
--------------
10+
11+
List API extensions
12+
13+
.. program:: extension list
14+
.. code:: bash
15+
16+
os extension list
17+
[--compute]
18+
[--identity]
19+
[--network]
20+
[--volume]
21+
[--long]
22+
23+
.. option:: --compute
24+
25+
List extensions for the Compute API
26+
27+
.. option:: --identity
28+
29+
List extensions for the Identity API
30+
31+
.. option:: --network
32+
33+
List extensions for the Network API
34+
35+
.. option:: --volume
36+
37+
List extensions for the Volume API
38+
39+
.. option:: --long
40+
41+
List additional fields in output

‎doc/source/command-objects/limits.rst‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
======
2+
limits
3+
======
4+
5+
The Compute and Volume APIs have resource usage limits.
6+
7+
limits show
8+
-----------
9+
10+
Show compute and volume limits
11+
12+
.. program:: limits show
13+
.. code:: bash
14+
15+
os limits show
16+
--absolute [--reserved] | --rate
17+
18+
.. option:: --absolute
19+
20+
Show absolute limits
21+
22+
.. option:: --rate
23+
24+
Show rate limits
25+
26+
.. option:: --reserved
27+
28+
Include reservations count [only valid with :option:`--absolute`]

‎doc/source/command-objects/quota.rst‎

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
=====
2+
quota
3+
=====
4+
5+
Resource quotas appear in multiple APIs, OpenStackClient presents them as a single object with multiple properties.
6+
7+
quota set
8+
---------
9+
10+
Set quotas for project
11+
12+
.. program:: quota set
13+
.. code:: bash
14+
15+
os quota set
16+
# Compute settings
17+
[--cores <num-cores>]
18+
[--fixed-ips <num-fixed-ips>]
19+
[--floating-ips <num-floating-ips>]
20+
[--injected-file-size <injected-file-bytes>]
21+
[--injected-files <num-injected-files>]
22+
[--instances <num-instances>]
23+
[--key-pairs <num-key-pairs>]
24+
[--properties <num-properties>]
25+
[--ram <ram-mb>]
26+
27+
# Volume settings
28+
[--gigabytes <new-gigabytes>]
29+
[--snapshots <new-snapshots>]
30+
[--volumes <new-volumes>]
31+
32+
<project>
33+
34+
Set quotas for class
35+
36+
.. code:: bash
37+
38+
os quota set
39+
--class
40+
# Compute settings
41+
[--cores <num-cores>]
42+
[--fixed-ips <num-fixed-ips>]
43+
[--floating-ips <num-floating-ips>]
44+
[--injected-file-size <injected-file-bytes>]
45+
[--injected-files <num-injected-files>]
46+
[--instances <num-instances>]
47+
[--key-pairs <num-key-pairs>]
48+
[--properties <num-properties>]
49+
[--ram <ram-mb>]
50+
51+
# Volume settings
52+
[--gigabytes <new-gigabytes>]
53+
[--snapshots <new-snapshots>]
54+
[--volumes <new-volumes>]
55+
56+
<class>
57+
58+
.. option:: --class
59+
60+
Set quotas for ``<class>``
61+
62+
.. option:: --properties <new-properties>
63+
64+
New value for the properties quota
65+
66+
.. option:: --ram <new-ram>
67+
68+
New value for the ram quota
69+
70+
.. option:: --secgroup-rules <new-secgroup-rules>
71+
72+
New value for the secgroup-rules quota
73+
74+
.. option:: --instances <new-instances>
75+
76+
New value for the instances quota
77+
78+
.. option:: --key-pairs <new-key-pairs>
79+
80+
New value for the key-pairs quota
81+
82+
.. option:: --fixed-ips <new-fixed-ips>
83+
84+
New value for the fixed-ips quota
85+
86+
.. option:: --secgroups <new-secgroups>
87+
88+
New value for the secgroups quota
89+
90+
.. option:: --injected-file-size <new-injected-file-size>
91+
92+
New value for the injected-file-size quota
93+
94+
.. option:: --floating-ips <new-floating-ips>
95+
96+
New value for the floating-ips quota
97+
98+
.. option:: --injected-files <new-injected-files>
99+
100+
New value for the injected-files quota
101+
102+
.. option:: --cores <new-cores>
103+
104+
New value for the cores quota
105+
106+
.. option:: --injected-path-size <new-injected-path-size>
107+
108+
New value for the injected-path-size quota
109+
110+
.. option:: --gigabytes <new-gigabytes>
111+
112+
New value for the gigabytes quota
113+
114+
.. option:: --volumes <new-volumes>
115+
116+
New value for the volumes quota
117+
118+
.. option:: --snapshots <new-snapshots>
119+
120+
New value for the snapshots quota
121+
122+
quota show
123+
----------
124+
125+
Show quotas for project
126+
127+
.. program:: quota show
128+
.. code:: bash
129+
130+
os quota show
131+
[--default]
132+
<project>
133+
134+
135+
.. option:: --default
136+
137+
Show default quotas for :ref:`\<project\> <quota_show-project>`
138+
139+
.. _quota_show-project:
140+
.. describe:: <project>
141+
142+
Show quotas for class
143+
144+
.. code:: bash
145+
146+
os quota show
147+
--class
148+
<class>
149+
150+
.. option:: --class
151+
152+
Show quotas for :ref:`\<class\> <quota_show-class>`
153+
154+
.. _quota_show-class:
155+
.. describe:: <class>
156+
157+
Class to show

‎doc/source/commands.rst‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
========
2-
Commands
3-
========
4-
5-
1+
=================
62
Command Structure
73
=================
84

@@ -83,7 +79,7 @@ referring to both Compute and Volume quotas.
8379
* ``credential``: Identity - specific to identity providers
8480
* ``domain``: Identity - a grouping of projects
8581
* ``endpoint``: Identity - the base URL used to contact a specific service
86-
* ``extension``: Compute, Identity, Volume - additional APIs available
82+
* ``extension``: (**Compute**, **Identity**, **Volume**) OpenStack server API extensions
8783
* ``flavor``: Compute - pre-defined configurations of servers: ram, root disk, etc
8884
* ``group``: Identity - a grouping of users
8985
* ``host``: Compute - the physical computer running a hypervisor
@@ -93,13 +89,13 @@ referring to both Compute and Volume quotas.
9389
* ``ip fixed``: Compute, Network - an internal IP address assigned to a server
9490
* ``ip floating``: Compute, Network - a public IP address that can be mapped to a server
9591
* ``keypair``: Compute - an SSH public key
96-
* ``limits``: Compute, Volume - resource usage limits
92+
* ``limits``: (**Compute**, **Volume**) resource usage limits
9793
* ``module``: internal - installed Python modules in the OSC process
9894
* ``network``: Network - a virtual network for connecting servers and other resources
9995
* ``object``: Object Store - a single file in the Object Store
10096
* ``policy``: Identity - determines authorization
10197
* ``project``: Identity - the owner of a group of resources
102-
* ``quota``: Compute, Volume - limit on resource usage
98+
* ``quota``: (**Compute**, **Volume**) resource usage restrictions
10399
* ``request token``: Identity - temporary OAuth-based token
104100
* ``role``: Identity - a policy object used to determine authorization
105101
* ``security group``: Compute, Network - groups of network access rules
@@ -149,7 +145,7 @@ Those actions with an opposite action are noted in parens if applicable.
149145

150146

151147
Implementation
152-
==============
148+
--------------
153149

154150
The command structure is designed to support seamless addition of plugin
155151
command modules via ``setuptools`` entry points. The plugin commands must

‎doc/source/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Contents:
1212
:maxdepth: 1
1313

1414
releases
15+
command-list
1516
commands
1617
plugins
1718
authentication

‎doc/source/releases.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Release Notes
2626
* add ``object create`` and ``object delete`` commands
2727
* add initial support for global ``--timing`` options (similar to nova CLI)
2828
* complete Python 3 compatibility
29-
* fix ``server resize` command
29+
* fix ``server resize`` command
3030
* add authentication via ``--os-trust-id`` for Identity v3
3131
* Add initial support for Network API, ``network create|delete|list|show``
3232

‎openstackclient/common/extension.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525

2626
class ListExtension(lister.Lister):
27-
"""List extension command"""
27+
"""List API extensions"""
2828

2929
log = logging.getLogger(__name__ + '.ListExtension')
3030

@@ -40,11 +40,6 @@ def get_parser(self, prog_name):
4040
action='store_true',
4141
default=False,
4242
help='List extensions for the Identity API')
43-
parser.add_argument(
44-
'--long',
45-
action='store_true',
46-
default=False,
47-
help='List additional fields in output')
4843
parser.add_argument(
4944
'--network',
5045
action='store_true',
@@ -55,6 +50,11 @@ def get_parser(self, prog_name):
5550
action='store_true',
5651
default=False,
5752
help='List extensions for the Volume API')
53+
parser.add_argument(
54+
'--long',
55+
action='store_true',
56+
default=False,
57+
help='List additional fields in output')
5858
return parser
5959

6060
def take_action(self, parsed_args):

‎openstackclient/common/quota.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ def get_parser(self, prog_name):
7272
COMPUTE_QUOTAS.items(), VOLUME_QUOTAS.items()):
7373
parser.add_argument(
7474
'--%s' % v,
75-
metavar='<new-%s>' % v,
75+
metavar='<%s>' % v,
7676
type=int,
7777
help='New value for the %s quota' % v,
7878
)

‎openstackclient/identity/v2_0/endpoint.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929

3030
class CreateEndpoint(show.ShowOne):
31-
"""Create endpoint command"""
31+
"""Create endpoint"""
3232

3333
log = logging.getLogger(__name__ + '.CreateEndpoint')
3434

0 commit comments

Comments
 (0)