summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorMark Vanderwiel <vanderwl@us.ibm.com>2015-12-10 15:14:01 -0600
committerMark Vanderwiel <vanderwl@us.ibm.com>2016-02-25 00:48:15 +0000
commit69d5bc4e554542735da4a277473251ec6ac47e6c (patch)
tree43dd1b4a5acb990b7db18fb2fa566fc9c7fe601a /doc/source
parentad93e9f9333ad04ad10058332c5a97570bf8f038 (diff)
downloadpython-openstackclient-69d5bc4e554542735da4a277473251ec6ac47e6c.tar.gz
update heat object and command doc
Many OpenStack client heat command patches are in progress, seems like good time to also update some of the highlevel doc. Added new objects for orchestration and software openstack orchestration resource type list/show openstack software config create/delete/show/list Added new action for restore openstack stack snapshot create/delete/list/show/restore Added link to CLI reference for complete plugin syntax and details Removed deprecated tasker client Change-Id: I2c94a5981954edcba95f364a0f909c799f1c403b Blueprint: heat-support-python-openstackclient
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/commands.rst12
-rw-r--r--doc/source/plugin-commands.rst4
-rw-r--r--doc/source/plugins.rst2
3 files changed, 16 insertions, 2 deletions
diff --git a/doc/source/commands.rst b/doc/source/commands.rst
index 3598c284..2195720f 100644
--- a/doc/source/commands.rst
+++ b/doc/source/commands.rst
@@ -148,6 +148,8 @@ list check out :doc:`plugin-commands`.
* ``dataprocessing plugin``: (**Data Processing (Sahara)**)
* ``message-broker cluster``: (**Message Broker (Cue)**)
* ``message flavor``: (**Messaging (Zaqar)**)
+* ``orchestration resource``: (**Orchestration (Heat)**)
+* ``orchestration template``: (**Orchestration (Heat)**)
* ``pool``: (**Messaging (Zaqar)**)
* ``ptr record``: (**DNS (Designate)**)
* ``queue``: (**Messaging (Zaqar)**)
@@ -155,7 +157,14 @@ list check out :doc:`plugin-commands`.
* ``secret``: (**Key Manager (Barbican)**)
* ``secret container``: (**Key Manager (Barbican)**)
* ``secret order``: (**Key Manager (Barbican)**)
-* ``stack``: (**Orchestration (Heat)**)
+* ``software config``: (**Orchestration (Heat)**)
+* ``software deployment``: (**Orchestration (Heat)**)
+* ``stack event``: (**Orchestration (Heat)**)
+* ``stack hook``: (**Orchestration (Heat)**)
+* ``stack output``: (**Orchestration (Heat)**)
+* ``stack resource``: (**Orchestration (Heat)**)
+* ``stack snapshot``: (**Orchestration (Heat)**)
+* ``stack template``: (**Orchestration (Heat)**)
* ``task exeuction``: (**Workflow Engine (Mistral)**)
* ``tld``: (**DNS (Designate)**)
* ``workbook``: (**Workflow Engine (Mistral)**)
@@ -190,6 +199,7 @@ Those actions with an opposite action are noted in parens if applicable.
* ``remove`` (``add``) - remove an object from a group of objects
* ``rescue`` (``unrescue``) - reboot a server in a special rescue mode allowing access to the original disks
* ``resize`` - change a server's flavor
+* ``restore`` - restore a heat stack snapshot
* ``resume`` (``suspend``) - return one or more suspended servers to running state
* ``revoke`` (``issue``) - revoke a token
* ``save`` - download an object locally
diff --git a/doc/source/plugin-commands.rst b/doc/source/plugin-commands.rst
index 893c4c49..a3f41521 100644
--- a/doc/source/plugin-commands.rst
+++ b/doc/source/plugin-commands.rst
@@ -2,6 +2,8 @@
Plugin Commands
=================
+Note: To see the complete syntax for the plugin commands, see the `CLI_Ref`_
+
.. list-plugins:: openstack.cli.extension
.. list-plugins:: openstack.key_manager.v1
@@ -30,3 +32,5 @@
.. list-plugins:: openstack.orchestration.v1
:detailed:
+
+.. _CLI_Ref: http://docs.openstack.org/cli-reference/openstack.html \ No newline at end of file
diff --git a/doc/source/plugins.rst b/doc/source/plugins.rst
index 0c838ec5..32a40599 100644
--- a/doc/source/plugins.rst
+++ b/doc/source/plugins.rst
@@ -30,7 +30,7 @@ python-ceilometerclient using argparse
python-congressclient using OpenStackClient
python-cueclient using OpenStackClient
python-designateclient using OpenStackClient
-python-heatclient patch in progress (https://review.openstack.org/#/c/195867/)
+python-heatclient using OpenStackClient
python-ironicclient Using OpenStackClient
python-magnumclient using argparse
python-manilaclient using argparse