summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/command-objects/image.rst3
-rw-r--r--doc/source/command-objects/network-auto-allocated-topology.rst69
-rw-r--r--doc/source/command-objects/network-flavor.rst14
-rw-r--r--doc/source/command-objects/volume.rst9
-rw-r--r--doc/source/commands.rst1
-rw-r--r--doc/source/plugin-commands.rst8
-rw-r--r--doc/source/plugins.rst2
7 files changed, 94 insertions, 12 deletions
diff --git a/doc/source/command-objects/image.rst b/doc/source/command-objects/image.rst
index 7a9ead5c..c39d9a28 100644
--- a/doc/source/command-objects/image.rst
+++ b/doc/source/command-objects/image.rst
@@ -53,8 +53,7 @@ Create/upload an image
[--min-ram <ram-mb>]
[--location <image-url>]
[--copy-from <image-url>]
- [--file <file>]
- [--volume <volume>]
+ [--file <file> | --volume <volume>]
[--force]
[--checksum <checksum>]
[--protected | --unprotected]
diff --git a/doc/source/command-objects/network-auto-allocated-topology.rst b/doc/source/command-objects/network-auto-allocated-topology.rst
new file mode 100644
index 00000000..4ed68cda
--- /dev/null
+++ b/doc/source/command-objects/network-auto-allocated-topology.rst
@@ -0,0 +1,69 @@
+===============================
+network auto allocated topology
+===============================
+
+An **auto allocated topology** allows admins to quickly set up external
+connectivity for end-users. Only one auto allocated topology is allowed per
+project. For more information on how to set up the resources required
+for auto allocated topology review the documentation at:
+http://docs.openstack.org/newton/networking-guide/config-auto-allocation.html
+
+Network v2
+
+network auto allocated topology create
+--------------------------------------
+
+Create the auto allocated topology for project
+
+.. program:: network auto allocated topology create
+.. code:: bash
+
+ openstack network auto allocated topology create
+ [--or-show]
+ [--check-resources]
+ [--project <project> [--project-domain <project-domain>]]
+
+.. option:: --or-show
+
+ If topology exists returns the topologies information (Default).
+
+.. option:: --check-resources
+
+ Validate the requirements for auto allocated topology.
+ Does not return a topology.
+
+.. option:: --project <project>
+
+ Return the auto allocated topology for a given project.
+ Default is current project.
+
+.. option:: --project-domain <project-domain>
+
+ Domain the project belongs to (name or ID).
+ This can be used in case collisions between project names exist.
+
+.. _network_auto_allocated_topology_create:
+
+
+network auto allocated topology delete
+--------------------------------------
+
+Delete auto allocated topology for project
+
+.. program:: network auto allocated topology delete
+.. code:: bash
+
+ openstack network auto allocated topology delete
+ [--project <project> [--project-domain <project-domain>]]
+
+.. option:: --project <project>
+
+ Delete auto allocated topology for a given project.
+ Default is the current project.
+
+.. option:: --project-domain <project-domain>
+
+ Domain the project belongs to (name or ID).
+ This can be used in case collisions between project names exist.
+
+.. _network_auto_allocated_topology_delete:
diff --git a/doc/source/command-objects/network-flavor.rst b/doc/source/command-objects/network-flavor.rst
index 1324499e..d5c011f6 100644
--- a/doc/source/command-objects/network-flavor.rst
+++ b/doc/source/command-objects/network-flavor.rst
@@ -8,7 +8,6 @@ service flavors.
Network v2
-.. _network_flavor_create:
network flavor create
---------------------
@@ -55,7 +54,8 @@ Create network flavor
Name for the flavor
-.. _network_flavor_delete:
+.. _network_flavor_create:
+
network flavor delete
---------------------
@@ -71,6 +71,8 @@ Delete network flavor(s)
Flavor(s) to delete (name or ID)
+.. _network_flavor_delete:
+
network flavor list
-------------------
@@ -81,7 +83,8 @@ List network flavors
openstack network flavor list
-.. _network_flavor_set:
+.. _network_flavor_list:
+
network flavor set
------------------
@@ -116,7 +119,8 @@ Set network flavor properties
Flavor to update (name or ID)
-.. _network_flavor_show:
+.. _network_flavor_set:
+
network flavor show
-------------------
@@ -131,3 +135,5 @@ Show network flavor
.. describe:: <flavor>
Flavor to display (name or ID)
+
+.. _network_flavor_show:
diff --git a/doc/source/command-objects/volume.rst b/doc/source/command-objects/volume.rst
index 56c54552..67598e63 100644
--- a/doc/source/command-objects/volume.rst
+++ b/doc/source/command-objects/volume.rst
@@ -269,6 +269,7 @@ Set volume properties
[--name <name>]
[--size <size>]
[--description <description>]
+ [--no-property]
[--property <key=value> [...] ]
[--image-property <key=value> [...] ]
[--state <state>]
@@ -290,6 +291,12 @@ Set volume properties
New volume description
+.. option:: --no-property
+
+ Remove all properties from :ref:`\<volume\> <volume_set-volume>`
+ (specify both :option:`--no-property` and :option:`--property` to
+ remove the current properties before setting new properties.)
+
.. option:: --property <key=value>
Set a property on this volume (repeat option to set multiple properties)
@@ -304,7 +311,7 @@ Set volume properties
Migration policy while re-typing volume
("never" or "on-demand", default is "never" )
- (available only when "--type" option is specified)
+ (available only when :option:`--type` option is specified)
*Volume version 2 only*
diff --git a/doc/source/commands.rst b/doc/source/commands.rst
index 68c50d24..a0c67cd4 100644
--- a/doc/source/commands.rst
+++ b/doc/source/commands.rst
@@ -111,6 +111,7 @@ referring to both Compute and Volume quotas.
* ``module``: (**Internal**) - installed Python modules in the OSC process
* ``network``: (**Compute**, **Network**) - a virtual network for connecting servers and other resources
* ``network agent``: (**Network**) - A network agent is an agent that handles various tasks used to implement virtual networks
+* ``network auto allocated topology``: (**Network**) - an auto-allocated topology for a project
* ``network flavor``: (**Network**) - allows the user to choose the type of service by a set of advertised service capabilities (e.g., LOADBALANCER, FWAAS, L3, VPN, etc) rather than by a provider type or named vendor
* ``network meter``: (**Network**) - allow traffic metering in a network
* ``network meter rule``: (**Network**) - rules for network traffic metering
diff --git a/doc/source/plugin-commands.rst b/doc/source/plugin-commands.rst
index 844c48a7..182f5392 100644
--- a/doc/source/plugin-commands.rst
+++ b/doc/source/plugin-commands.rst
@@ -33,10 +33,10 @@ designate
.. list-plugins:: openstack.dns.v1
:detailed:
-.. gnocchi
-.. # gnocchiclient is not in global-requirements
-.. # list-plugins:: openstack.metric.v1
-.. # :detailed:
+gnocchi
+-------
+.. list-plugins:: openstack.metric.v1
+ :detailed:
heat
----
diff --git a/doc/source/plugins.rst b/doc/source/plugins.rst
index 054e552f..7dda52a0 100644
--- a/doc/source/plugins.rst
+++ b/doc/source/plugins.rst
@@ -22,7 +22,7 @@ OpenStackClient.
The following is a list of projects that are an OpenStackClient plugin.
- aodhclient
-- gnocchiclient\*\*
+- gnocchiclient
- python-barbicanclient
- python-congressclient
- python-designateclient