Skip to content

Commit 69d5bc4

Browse files
committed
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
1 parent ad93e9f commit 69d5bc4

3 files changed

Lines changed: 16 additions & 2 deletions

File tree

doc/source/commands.rst

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,14 +148,23 @@ list check out :doc:`plugin-commands`.
148148
* ``dataprocessing plugin``: (**Data Processing (Sahara)**)
149149
* ``message-broker cluster``: (**Message Broker (Cue)**)
150150
* ``message flavor``: (**Messaging (Zaqar)**)
151+
* ``orchestration resource``: (**Orchestration (Heat)**)
152+
* ``orchestration template``: (**Orchestration (Heat)**)
151153
* ``pool``: (**Messaging (Zaqar)**)
152154
* ``ptr record``: (**DNS (Designate)**)
153155
* ``queue``: (**Messaging (Zaqar)**)
154156
* ``recordset``: (**DNS (Designate)**)
155157
* ``secret``: (**Key Manager (Barbican)**)
156158
* ``secret container``: (**Key Manager (Barbican)**)
157159
* ``secret order``: (**Key Manager (Barbican)**)
158-
* ``stack``: (**Orchestration (Heat)**)
160+
* ``software config``: (**Orchestration (Heat)**)
161+
* ``software deployment``: (**Orchestration (Heat)**)
162+
* ``stack event``: (**Orchestration (Heat)**)
163+
* ``stack hook``: (**Orchestration (Heat)**)
164+
* ``stack output``: (**Orchestration (Heat)**)
165+
* ``stack resource``: (**Orchestration (Heat)**)
166+
* ``stack snapshot``: (**Orchestration (Heat)**)
167+
* ``stack template``: (**Orchestration (Heat)**)
159168
* ``task exeuction``: (**Workflow Engine (Mistral)**)
160169
* ``tld``: (**DNS (Designate)**)
161170
* ``workbook``: (**Workflow Engine (Mistral)**)
@@ -190,6 +199,7 @@ Those actions with an opposite action are noted in parens if applicable.
190199
* ``remove`` (``add``) - remove an object from a group of objects
191200
* ``rescue`` (``unrescue``) - reboot a server in a special rescue mode allowing access to the original disks
192201
* ``resize`` - change a server's flavor
202+
* ``restore`` - restore a heat stack snapshot
193203
* ``resume`` (``suspend``) - return one or more suspended servers to running state
194204
* ``revoke`` (``issue``) - revoke a token
195205
* ``save`` - download an object locally

doc/source/plugin-commands.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
Plugin Commands
33
=================
44

5+
Note: To see the complete syntax for the plugin commands, see the `CLI_Ref`_
6+
57
.. list-plugins:: openstack.cli.extension
68

79
.. list-plugins:: openstack.key_manager.v1
@@ -30,3 +32,5 @@
3032

3133
.. list-plugins:: openstack.orchestration.v1
3234
:detailed:
35+
36+
.. _CLI_Ref: http://docs.openstack.org/cli-reference/openstack.html

doc/source/plugins.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ python-ceilometerclient using argparse
3030
python-congressclient using OpenStackClient
3131
python-cueclient using OpenStackClient
3232
python-designateclient using OpenStackClient
33-
python-heatclient patch in progress (https://review.openstack.org/#/c/195867/)
33+
python-heatclient using OpenStackClient
3434
python-ironicclient Using OpenStackClient
3535
python-magnumclient using argparse
3636
python-manilaclient using argparse

0 commit comments

Comments
 (0)