openstack/python-openstackclient
Code Issues Proposed changes

update heat object and command doc

Browse Source 
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
This commit is contained in:
Mark Vanderwiel 2015-12-10 15:14:01 -06:00
parent ad93e9f933
commit 69d5bc4e55
3 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/commands.rst
View File

@ -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

4
doc/source/plugin-commands.rst
View File

@ -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

2
doc/source/plugins.rst
View File

@ -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