Skip to content

Commit 518ef26

Browse files
committed
Add commands of clustering service to doc
This patch adds the 'objects'/'resources' provided by the clustering service (senlin) to the commands doc. Change-Id: I028bd919f5b357d1b6e806c85e83a1a63c42839c
1 parent 38759f3 commit 518ef26

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

doc/source/commands.rst

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,17 @@ list check out :doc:`plugin-commands`.
145145
* ``action definition``: (**Workflow Engine (Mistral)**)
146146
* ``action execution``: (**Workflow Engine (Mistral)**)
147147
* ``baremetal``: (**Baremetal (Ironic)**)
148+
* ``cluster``: (**Clustering (Senlin)**)
149+
* ``cluster action``: (**Clustering (Senlin)**)
150+
* ``cluster event``: (**Clustering (Senlin)**)
151+
* ``cluster members``: (**Clustering (Senlin)**)
152+
* ``cluster node``: (**Clustering (Senlin)**)
153+
* ``cluster policy``: (**CLustering (Senlin)**)
154+
* ``cluster policy binding``: (**Clustering (Senlin)**)
155+
* ``cluster policy type``: (**Clustering (Senlin)**)
156+
* ``cluster profile``: (**Clustering (Senlin)**)
157+
* ``cluster profile type``: (**Clustering (Senlin)**)
158+
* ``cluster receiver``: (**Clustering (Senlin)**)
148159
* ``congress datasource``: (**Policy (Congress)**)
149160
* ``congress driver``: (**Policy (Congress)**)
150161
* ``congress policy``: (**Policy (Congress)**)
@@ -196,6 +207,7 @@ Those actions with an opposite action are noted in parens if applicable.
196207
the positional arguments appear in the same order
197208
* ``create`` (``delete``) - create a new occurrence of the specified object
198209
* ``delete`` (``create``) - delete specific occurrences of the specified objects
210+
* ``expand`` (``shrink``) - increase the capacity of a cluster
199211
* ``issue`` (``revoke``) - issue a token
200212
* ``list`` - display summary information about multiple objects
201213
* ``lock`` (``unlock``) - lock one or more servers so that non-admin user won't be able to execute actions
@@ -206,14 +218,15 @@ Those actions with an opposite action are noted in parens if applicable.
206218
* ``rebuild`` - rebuild a server using (most of) the same arguments as in the original create
207219
* ``remove`` (``add``) - remove an object from a group of objects
208220
* ``rescue`` (``unrescue``) - reboot a server in a special rescue mode allowing access to the original disks
209-
* ``resize`` - change a server's flavor
221+
* ``resize`` - change a server's flavor or a cluster's capacity
210222
* ``restore`` - restore a heat stack snapshot or restore a server in soft-deleted state
211223
* ``resume`` (``suspend``) - return one or more suspended servers to running state
212224
* ``revoke`` (``issue``) - revoke a token
213225
* ``save`` - download an object locally
214226
* ``set`` (``unset``) - set a property on the object, formerly called metadata
215227
* ``shelve`` (``unshelve``) - shelve one or more servers
216228
* ``show`` - display detailed information about the specific object
229+
* ``shrink`` (``expand``) - reduce the capacity of a cluster
217230
* ``start`` (``stop``) - start one or more servers
218231
* ``stop`` (``start``) - stop one or more servers
219232
* ``suspend`` (``resume``) - stop one or more servers and save to disk freeing memory

0 commit comments

Comments
 (0)