Skip to content

Commit a732bfa

Browse files
Jenkinsopenstack-gerrit
Jenkins
authored and
openstack-gerrit
committed
Merge "Update docs and release notes for 0.4.0"
2 parents 23f64a4 + 3fa5fa5 commit a732bfa

File tree

5 files changed

+95
-39
lines changed

5 files changed

+95
-39
lines changed

‎doc/source/commands.rst‎

Lines changed: 42 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ Commands take the form::
1212

1313
openstack [<global-options>] <object-1> <action> [<object-2>] [<command-arguments>]
1414

15-
* All long options names begin with two dashes ('--') and use a single dash
16-
('-') internally between words (--like-this). Underscores ('_') are not used
17-
in option names.
15+
* All long options names begin with two dashes (``--``) and use a single dash
16+
(``-``) internally between words (``--like-this``). Underscores (``_``) are
17+
not used in option names.
1818

1919

2020
Global Options
@@ -25,11 +25,12 @@ invocation regardless of action to be performed. They include authentication
2525
credentials and API version selection. Most global options have a corresponding
2626
environment variable that may also be used to set the value. If both are
2727
present, the command-line option takes priority. The environment variable
28-
names are derived from the option name by dropping the leading dashes ('--'),
29-
converting each embedded dash ('-') to an underscore ('_'), and converting
28+
names are derived from the option name by dropping the leading dashes (``--``),
29+
converting each embedded dash (``-``) to an underscore (``_``), and converting
3030
to upper case.
3131

32-
For example, ``--os-username`` can be set from the environment via ``OS_USERNAME``.
32+
For example, the default value of ``--os-username`` can be set by defining
33+
the environment variable ``OS_USERNAME``.
3334

3435

3536
Command Object(s) and Action
@@ -64,39 +65,46 @@ the command and any positional arguments the command requires.
6465
Actions
6566
-------
6667

67-
The actions used by OpenStackClient are defined below to provide a consistent meaning to each action. Many of them have logical opposite actions. Those actions with an opposite action are noted in parens if applicable.
68-
69-
* authorize - authorize a token (used in OAuth)
70-
* add (remove) - add some object to a container object; the command is built in the order of "container add object" (<container> <object>), the positional arguments appear in the same order
71-
* attach (detach) - deprecated; use add/remove
72-
* create (delete) - create a new occurrence of the specified object
73-
* delete (create) - delete a specific occurrence of the specified object
74-
* detach (attach) - deprecated; use add/remove
75-
* list - display summary information about multiple objects
76-
* lock (unlock)
77-
* migrate - move a server to a different host; --live performs a live migration if possible
78-
* pause (unpause) - stop a server and leave it in memory
79-
* reboot - forcibly reboot a server
80-
* rebuild - rebuild a server using (most of) the same arguments as in the original create
81-
* remove (add) - remove an object from a group of objects
82-
* rescue (unrescue) - reboot a server in a special rescue mode allowing access to the original disks
83-
* resize - change a server's flavor
84-
* resume (suspend) - return a suspended server to running state
85-
* save - download an object locally
86-
* set (unset) - set a property on the object, formerly called metadata
87-
* show - display detailed information about the specific object
88-
* suspend (resume) - stop a server and save to disk freeing memory
89-
* unlock (lock)
90-
* unpause (pause) - return a paused server to running state
91-
* unrescue (rescue) - return a server to normal boot mode
92-
* unset (set) - remove an attribute of the object
68+
The actions used by OpenStackClient are defined below to provide a consistent
69+
meaning to each action. Many of them have logical opposite actions.
70+
Those actions with an opposite action are noted in parens if applicable.
71+
72+
* ``authorize`` - authorize a token (used in OAuth)
73+
* ``add`` (``remove``) - add some object to a container object; the command
74+
is built in the order of ``container add object <container> <object>``,
75+
the positional arguments appear in the same order
76+
* ``create`` (``delete``) - create a new occurrence of the specified object
77+
* ``delete`` (``create``) - delete a specific occurrence of the specified object
78+
* ``issue`` (``revoke``) - issue a token
79+
* ``list`` - display summary information about multiple objects
80+
* ``lock`` (``unlock``)
81+
* ``migrate`` - move a server to a different host; ``--live`` performs a
82+
live migration if possible
83+
* ``pause`` (``unpause``) - stop a server and leave it in memory
84+
* ``reboot`` - forcibly reboot a server
85+
* ``rebuild`` - rebuild a server using (most of) the same arguments as in the original create
86+
* ``remove`` (``add``) - remove an object from a group of objects
87+
* ``rescue`` (``unrescue``) - reboot a server in a special rescue mode allowing access to the original disks
88+
* ``resize`` - change a server's flavor
89+
* ``resume`` (``suspend``) - return a suspended server to running state
90+
* ``revoke`` (``issue``) - revoke a token
91+
* ``save`` - download an object locally
92+
* ``set`` (``unset``) - set a property on the object, formerly called metadata
93+
* ``show`` - display detailed information about the specific object
94+
* ``suspend`` (``resume``) - stop a server and save to disk freeing memory
95+
* ``unlock`` (``lock``)
96+
* ``unpause`` (``pause``) - return a paused server to running state
97+
* ``unrescue`` (``rescue``) - return a server to normal boot mode
98+
* ``unset`` (``set``) - remove an attribute of the object
99+
93100

94101
Implementation
95102
==============
96103

97104
The command structure is designed to support seamless addition of plugin
98105
command modules via ``setuptools`` entry points. The plugin commands must
99-
be subclasses of Cliff's command.Command object.
106+
be subclasses of Cliff's command.Command object. See :doc:`plugins` for
107+
more information.
100108

101109

102110
Command Entry Points
@@ -111,7 +119,7 @@ entry points have the form::
111119

112120
verb_object = fully.qualified.module.vXX.object:VerbObject
113121

114-
For example, the 'list user' command fir the Identity API is identified in
122+
For example, the ``list user`` command for the Identity API is identified in
115123
``setup.cfg`` with::
116124

117125
openstack.identity.v3 =

‎doc/source/index.rst‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
OpenStack Client
2-
================
1+
===============
2+
OpenStackClient
3+
===============
34

4-
This is a command-line client for OpenStack that unifies the operation
5+
OpenStackClient (aka OSC) is a command-line client for OpenStack that
6+
unifies the operation
57
of python-keystoneclient, python-novaclient, python-glanceclient and
68
python-cinderclient in a single shell with a uniform command structure.
79

‎doc/source/man/openstack.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,9 +181,18 @@ The following environment variables can be set to alter the behaviour of :progra
181181
:envvar:`OS_CACERT`
182182
CA certificate bundle file
183183

184+
:envvar:`OS_COMPUTE_API_VERISON`
185+
Compute API version (Default: 2)
186+
184187
:envvar:`OS_IDENTITY_API_VERISON`
185188
Identity API version (Default: 2.0)
186189

190+
:envvar:`OS_IMAGE_API_VERISON`
191+
Image API version (Default: 1)
192+
193+
:envvar:`OS_VOLUME_API_VERISON`
194+
Volume API version (Default: 1)
195+
187196
:envvar:`OS_XXXX_API_VERISON`
188197
Additional API version options will be available depending on the installed API libraries.
189198

‎doc/source/plugins.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Implementation
1111
--------------
1212

1313
Plugins are discovered by enumerating the entry points
14-
found under ``openstack.cli.extension`` and initializing the specified
14+
found under :py:mod:`openstack.cli.extension` and initializing the specified
1515
client module.
1616

1717
::
@@ -42,5 +42,5 @@ defined for the API version:
4242
plugin_list = oscplugin.v1.plugin:ListPlugin
4343
plugin_show = oscplugin.v1.plugin:ShowPlugin
4444

45-
Note that OSC defines the group name as ``openstack.<api-name>.v<version>``
45+
Note that OSC defines the group name as :py:mod:`openstack.<api-name>.v<version>`
4646
so the version should not contain the leading 'v' character.

‎doc/source/releases.rst‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,43 @@
22
Release Notes
33
=============
44

5+
0.4.0 (20 Jun 2014)
6+
===================
7+
8+
* Bug 1184012_: fix Identity v2 endpoint command name/id handling
9+
* Bug 1207615_: add ``--volume`` and ``--force`` to ``image create`` command
10+
* Bug 1220280_: add ``--property`` to project create and set commands
11+
* Bug 1246310_: add ``role assignments list`` command
12+
* Bug 1285800_: rename ``agent`` to ``compute agent``
13+
* Bug 1289513_: add ``--domain`` to project list
14+
* Bug 1289594_: fix keypair show output
15+
* Bug 1292337_: fix ec2 credentials project ID output
16+
* Bug 1303978_: fix output of ``volume type create`` command
17+
* Bug 1316870_: display all output when ``--lines`` omitted from ``console log show`` command
18+
* add 'interface' and 'url' columns to endpoint list command
19+
* add identity provider create/delete/list/set/show commands
20+
* change ``volume create --volume-type`` option to ``--type``
21+
* fix ``server image create`` command output
22+
* configure appropriate logging levels for ``--verbose``, ``--quiet`` and ``--debug``
23+
* properly handle properties in Image v1 ``create`` and ``set`` commands
24+
* rename Identity v2 ``token create`` to ``token issue``
25+
* add Identity v2 ``token revoke`` command
26+
* refactor the ``group|user|role list`` command filters so that each command
27+
only lists rows of that type of object, ie ``user list`` always lists users, etc.
28+
* add ``role assignment list`` command
29+
* add ``extension list`` command
30+
31+
.. _1184012: https://launchpad.net/bugs/1184012
32+
.. _1207615: https://launchpad.net/bugs/1207615
33+
.. _1220280: https://launchpad.net/bugs/1220280
34+
.. _1246310: https://launchpad.net/bugs/1246310
35+
.. _1285800: https://launchpad.net/bugs/1285800
36+
.. _1289513: https://launchpad.net/bugs/1289513
37+
.. _1289594: https://launchpad.net/bugs/1289594
38+
.. _1292337: https://launchpad.net/bugs/1292337
39+
.. _1303978: https://launchpad.net/bugs/1303978
40+
.. _1316870: https://launchpad.net/bugs/1316870
41+
542
0.3.1 (28 Feb 2014)
643
===================
744

0 commit comments

Comments
 (0)