summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/source/backwards-incompatible.rst54
-rw-r--r--doc/source/command-objects/backup.rst11
-rw-r--r--doc/source/command-objects/compute-agent.rst4
-rw-r--r--doc/source/command-objects/compute-service.rst10
-rw-r--r--doc/source/command-objects/host.rst4
-rw-r--r--doc/source/command-objects/keypair.rst6
-rw-r--r--doc/source/command-objects/network.rst4
-rw-r--r--doc/source/command-objects/subnet.rst7
-rw-r--r--doc/source/commands.rst9
-rw-r--r--doc/source/humaninterfaceguide.rst2
10 files changed, 66 insertions, 45 deletions
diff --git a/doc/source/backwards-incompatible.rst b/doc/source/backwards-incompatible.rst
index f86cfce4..da3c1b64 100644
--- a/doc/source/backwards-incompatible.rst
+++ b/doc/source/backwards-incompatible.rst
@@ -124,7 +124,7 @@ Releases Before 3.0
8. `region` commands no longer support `url`
- The Keystone team removed support for thr `url` attribute from the client
+ The Keystone team removed support for the `url` attribute from the client
and server side. Changes to the `create`, `set` and `list` commands for
regions have been affected.
@@ -184,27 +184,41 @@ Releases Before 3.0
14. Output of `ip floating list` command has changed.
- When using Compute v2, the original output of `ip floating list` command is:
- +----+--------+------------+----------+-------------+
- | ID | Pool | IP | Fixed IP | Instance ID |
- +----+--------+-----------------------+-------------+
- | 1 | public | 172.24.4.1 | None | None |
- +----+--------+------------+----------+-------------+
+ When using Compute v2, the original output is:
+
+ .. code-block:: bash
+
+ # ip floating list
+
+ +----+--------+------------+----------+-------------+
+ | ID | Pool | IP | Fixed IP | Instance ID |
+ +----+--------+-----------------------+-------------+
+ | 1 | public | 172.24.4.1 | None | None |
+ +----+--------+------------+----------+-------------+
Now it changes to:
- +----+---------------------+------------------+-----------+--------+
- | ID | Floating IP Address | Fixed IP Address | Server ID | Pool |
- +----+---------------------+------------------+-----------+--------+
- | 1 | 172.24.4.1 | None | None | public |
- +----+---------------------+------------------+-----------+--------+
-
- When using Network v2, the output of `ip floating list` command is:
- +--------------------------------------+---------------------+------------------+------+
- | ID | Floating IP Address | Fixed IP Address | Port |
- +--------------------------------------+---------------------+------------------+------+
- | 1976df86-e66a-4f96-81bd-c6ffee6407f1 | 172.24.4.3 | None | None |
- +--------------------------------------+---------------------+------------------+------+
- which is different from Compute v2.
+
+ .. code-block:: bash
+
+ # ip floating list
+
+ +----+---------------------+------------------+-----------+--------+
+ | ID | Floating IP Address | Fixed IP Address | Server ID | Pool |
+ +----+---------------------+------------------+-----------+--------+
+ | 1 | 172.24.4.1 | None | None | public |
+ +----+---------------------+------------------+-----------+--------+
+
+ When using Network v2, which is different from Compute v2. The output is:
+
+ .. code-block:: bash
+
+ # ip floating list
+
+ +--------------------------------------+---------------------+------------------+------+
+ | ID | Floating IP Address | Fixed IP Address | Port |
+ +--------------------------------------+---------------------+------------------+------+
+ | 1976df86-e66a-4f96-81bd-c6ffee6407f1 | 172.24.4.3 | None | None |
+ +--------------------------------------+---------------------+------------------+------+
* In favor of: Use `ip floating list` command
* As of: NA
diff --git a/doc/source/command-objects/backup.rst b/doc/source/command-objects/backup.rst
index 9d7fb95d..8e657b32 100644
--- a/doc/source/command-objects/backup.rst
+++ b/doc/source/command-objects/backup.rst
@@ -16,6 +16,7 @@ Create new backup
[--container <container>]
[--name <name>]
[--description <description>]
+ [--force]
<volume>
.. option:: --container <container>
@@ -30,6 +31,10 @@ Create new backup
Description of the backup
+.. option:: --force
+
+ Allow to back up an in-use volume
+
.. _backup_create-backup:
.. describe:: <volume>
@@ -49,7 +54,7 @@ Delete backup(s)
.. _backup_delete-backup:
.. describe:: <backup>
- Backup(s) to delete (ID only)
+ Backup(s) to delete (name or ID)
backup list
-----------
@@ -81,7 +86,7 @@ Restore backup
.. _backup_restore-backup:
.. describe:: <backup>
- Backup to restore (ID only)
+ Backup to restore (name or ID)
.. describe:: <volume>
@@ -101,4 +106,4 @@ Display backup details
.. _backup_show-backup:
.. describe:: <backup>
- Backup to display (ID only)
+ Backup to display (name or ID)
diff --git a/doc/source/command-objects/compute-agent.rst b/doc/source/command-objects/compute-agent.rst
index b00a981d..ae057dc9 100644
--- a/doc/source/command-objects/compute-agent.rst
+++ b/doc/source/command-objects/compute-agent.rst
@@ -59,7 +59,7 @@ Delete compute agent(s)
compute agent list
------------------
-List compute agent command
+List compute agents
.. program:: compute agent list
.. code:: bash
@@ -74,7 +74,7 @@ List compute agent command
compute agent set
-----------------
-Set compute agent command
+Set compute agent properties
.. program:: agent set
.. code:: bash
diff --git a/doc/source/command-objects/compute-service.rst b/doc/source/command-objects/compute-service.rst
index f43b5fa6..57dd2ba5 100644
--- a/doc/source/command-objects/compute-service.rst
+++ b/doc/source/command-objects/compute-service.rst
@@ -7,23 +7,23 @@ Compute v2
compute service delete
----------------------
-Delete service command
+Delete compute service(s)
.. program:: compute service delete
.. code:: bash
os compute service delete
- <service>
+ <service> [<service> ...]
.. _compute-service-delete:
.. describe:: <service>
- Compute service to delete (ID only)
+ Compute service(s) to delete (ID only)
compute service list
--------------------
-List service command
+List compute services
.. program:: compute service list
.. code:: bash
@@ -50,7 +50,7 @@ List service command
compute service set
-------------------
-Set service command
+Set compute service properties
.. program:: compute service set
.. code:: bash
diff --git a/doc/source/command-objects/host.rst b/doc/source/command-objects/host.rst
index 8c34d3fb..409b834b 100644
--- a/doc/source/command-objects/host.rst
+++ b/doc/source/command-objects/host.rst
@@ -9,7 +9,7 @@ The physical computer running a hypervisor.
host list
---------
-List all hosts
+List hosts
.. program:: host list
.. code:: bash
@@ -24,7 +24,7 @@ List all hosts
host set
--------
-Set host command
+Set host properties
.. program:: host set
.. code:: bash
diff --git a/doc/source/command-objects/keypair.rst b/doc/source/command-objects/keypair.rst
index 6638b8c9..64cc20cd 100644
--- a/doc/source/command-objects/keypair.rst
+++ b/doc/source/command-objects/keypair.rst
@@ -30,17 +30,17 @@ Create new public key
keypair delete
--------------
-Delete public key
+Delete public key(s)
.. program:: keypair delete
.. code:: bash
os keypair delete
- <key>
+ <key> [<key> ...]
.. describe:: <key>
- Public key to delete (name only)
+ Public key(s) to delete (name only)
keypair list
------------
diff --git a/doc/source/command-objects/network.rst b/doc/source/command-objects/network.rst
index 1cf442f2..0c472e7f 100644
--- a/doc/source/command-objects/network.rst
+++ b/doc/source/command-objects/network.rst
@@ -108,7 +108,7 @@ Create new network
.. option:: --provider-network-type <provider-network-type>
The physical mechanism by which the virtual network is implemented.
- The supported options are: flat, geneve, gre, local, vlan, vxlan
+ The supported options are: flat, geneve, gre, local, vlan, vxlan.
*Network version 2 only*
@@ -238,7 +238,7 @@ Set network properties
.. option:: --provider-network-type <provider-network-type>
The physical mechanism by which the virtual network is implemented.
- The supported options are: flat, gre, local, vlan, vxlan
+ The supported options are: flat, gre, local, vlan, vxlan.
.. option:: --provider-physical-network <provider-physical-network>
diff --git a/doc/source/command-objects/subnet.rst b/doc/source/command-objects/subnet.rst
index fe77ccfd..1137940f 100644
--- a/doc/source/command-objects/subnet.rst
+++ b/doc/source/command-objects/subnet.rst
@@ -83,7 +83,7 @@ Create new subnet
'auto': Gateway address should automatically be chosen from
within the subnet itself, 'none': This subnet will not use
a gateway, e.g.: ``--gateway 192.168.9.1``, ``--gateway auto``,
- ``--gateway none`` (default is 'auto')
+ ``--gateway none`` (default is 'auto').
.. option:: --host-route destination=<subnet>,gateway=<ip-address>
@@ -158,7 +158,8 @@ List subnets
.. option:: --ip-version {4, 6}
- List only subnets of given IP version in output
+ List only subnets of given IP version in output.
+ Allowed values for IP version are 4 and 6.
subnet set
----------
@@ -200,7 +201,7 @@ Set subnet properties
Specify a gateway for the subnet. The options are:
<ip-address>: Specific IP address to use as the gateway,
'none': This subnet will not use a gateway,
- e.g.: ``--gateway 192.168.9.1``, ``--gateway none``
+ e.g.: ``--gateway 192.168.9.1``, ``--gateway none``.
.. option:: --host-route destination=<subnet>,gateway=<ip-address>
diff --git a/doc/source/commands.rst b/doc/source/commands.rst
index 9fb0555d..9d8ad6fd 100644
--- a/doc/source/commands.rst
+++ b/doc/source/commands.rst
@@ -8,11 +8,12 @@ Commands take the form::
openstack [<global-options>] <object-1> <action> [<object-2>] [<command-arguments>]
-* All long options names begin with two dashes (``--``) and use a single dash
+.. NOTE::
+
+ All long options names begin with two dashes (``--``) and use a single dash
(``-``) internally between words (``--like-this``). Underscores (``_``) are
not used in option names.
-
Global Options
--------------
@@ -78,7 +79,7 @@ referring to both Compute and Volume quotas.
* ``command``: (**Internal**) installed commands in the OSC process
* ``compute agent``: (**Compute**) a cloud Compute agent available to a hypervisor
* ``compute service``: (**Compute**) a cloud Compute process running on a host
-* ``configuration``: (**Internal**) openstack client configuration
+* ``configuration``: (**Internal**) OpenStack client configuration
* ``console log``: (**Compute**) server console text dump
* ``console url``: (**Compute**) server remote console URL
* ``consumer``: (**Identity**) OAuth-based delegatee
@@ -89,7 +90,7 @@ referring to both Compute and Volume quotas.
* ``endpoint``: (**Identity**) the base URL used to contact a specific service
* ``extension``: (**Compute**, **Identity**, **Network**, **Volume**) OpenStack server API extensions
* ``federation protocol``: (**Identity**) the underlying protocol used while federating identities
-* ``flavor``: (**Compute**) predefined server configurations: ram, root disk, etc
+* ``flavor``: (**Compute**) predefined server configurations: ram, root disk and so on
* ``group``: (**Identity**) a grouping of users
* ``host``: (**Compute**) - the physical computer running compute services
* ``hypervisor``: (**Compute**) the virtual machine manager
diff --git a/doc/source/humaninterfaceguide.rst b/doc/source/humaninterfaceguide.rst
index 9cca5aa7..5d3c48dc 100644
--- a/doc/source/humaninterfaceguide.rst
+++ b/doc/source/humaninterfaceguide.rst
@@ -85,7 +85,7 @@ Simplicity
To best support new users and create straight forward interactions, designs
should be as simple as possible. When crafting new commands, designs should
minimize the amount of noise present in output: large amounts of
-nonessential data, overabundance of possible actions, etc. Designs should
+nonessential data, overabundance of possible actions and so on. Designs should
focus on the intent of the command, requiring only the necessary components
and either removing superfluous elements or making
them accessible through optional arguments. An example of this principle occurs
View Lorry Controller Status