From 9c00546da871fd877646029dc0843191bd4e22ae Mon Sep 17 00:00:00 2001 From: Peter Stachowski Date: Tue, 15 Mar 2016 22:21:30 +0000 Subject: [PATCH] New heading style (plus) A recent change in openstack-doc-tools caused the heading style to change. This changeset updates the clients where that change is present and where small additional other changes exist (such as minor changes in formatting options, etc.) namely: barbican designate glance heat mistral senlin This is done to ensure consistency as recent client updates have already switched to this mode. Change-Id: I45d40eb7a07b38ce3c0241094c27195f253a4893 --- doc/cli-reference/source/barbican.rst | 146 ++++----- doc/cli-reference/source/designate.rst | 252 ++++++--------- doc/cli-reference/source/glance.rst | 262 ++++++---------- doc/cli-reference/source/heat.rst | 209 +++++-------- doc/cli-reference/source/mistral.rst | 408 +++++++++---------------- doc/cli-reference/source/senlin.rst | 206 +++++-------- 6 files changed, 538 insertions(+), 945 deletions(-) diff --git a/doc/cli-reference/source/barbican.rst b/doc/cli-reference/source/barbican.rst index 02d263d4ae..ca6bda6be2 100644 --- a/doc/cli-reference/source/barbican.rst +++ b/doc/cli-reference/source/barbican.rst @@ -167,14 +167,12 @@ barbican acl delete Delete ACLs for a secret or container as identified by its href. -Positional arguments --------------------- +**Positional arguments:** ``URI`` The URI reference for the secret or container. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -186,21 +184,19 @@ barbican acl get .. code-block:: console - usage: barbican acl get [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN] + usage: barbican acl get [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] URI Retrieve ACLs for a secret or container by providing its href. -Positional arguments --------------------- +**Positional arguments:** ``URI`` The URI reference for the secret or container. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -212,8 +208,8 @@ barbican acl submit .. code-block:: console - usage: barbican acl submit [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] + usage: barbican acl submit [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] + [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--user [USERS]] [--project-access | --no-project-access] @@ -222,14 +218,12 @@ barbican acl submit Submit ACL on a secret or container as identified by its href. -Positional arguments --------------------- +**Positional arguments:** ``URI`` The URI reference for the secret or container. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -253,8 +247,8 @@ barbican acl user add .. code-block:: console - usage: barbican acl user add [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] + usage: barbican acl user add [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] + [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--user [USERS]] [--project-access | --no-project-access] @@ -263,14 +257,12 @@ barbican acl user add Add ACL users to a secret or container as identified by its href. -Positional arguments --------------------- +**Positional arguments:** ``URI`` The URI reference for the secret or container. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -294,7 +286,7 @@ barbican acl user remove .. code-block:: console - usage: barbican acl user remove [-h] [-f {csv,html,json,table,value,yaml}] + usage: barbican acl user remove [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] @@ -305,14 +297,12 @@ barbican acl user remove Remove ACL users from a secret or container as identified by its href. -Positional arguments --------------------- +**Positional arguments:** ``URI`` The URI reference for the secret or container. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -336,21 +326,18 @@ barbican ca get .. code-block:: console - usage: barbican ca get [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--prefix PREFIX] + usage: barbican ca get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] + [--max-width ] [--noindent] [--prefix PREFIX] URI Retrieve a CA by providing its URI. -Positional arguments --------------------- +**Positional arguments:** ``URI`` The URI reference for the CA. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -362,15 +349,14 @@ barbican ca list .. code-block:: console - usage: barbican ca list [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN] + usage: barbican ca list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--limit LIMIT] [--offset OFFSET] [--name NAME] List cas. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -393,7 +379,7 @@ barbican secret container create .. code-block:: console usage: barbican secret container create [-h] - [-f {html,json,shell,table,value,yaml}] + [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--name NAME] [--type TYPE] @@ -401,8 +387,7 @@ barbican secret container create Store a container in Barbican. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -429,14 +414,12 @@ barbican secret container delete Delete a container by providing its href. -Positional arguments --------------------- +**Positional arguments:** ``URI`` The URI reference for the container -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -448,22 +431,19 @@ barbican secret container get .. code-block:: console - usage: barbican secret container get [-h] - [-f {html,json,shell,table,value,yaml}] + usage: barbican secret container get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] URI Retrieve a container by providing its URI. -Positional arguments --------------------- +**Positional arguments:** ``URI`` The URI reference for the container. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -475,8 +455,7 @@ barbican secret container list .. code-block:: console - usage: barbican secret container list [-h] - [-f {csv,html,json,table,value,yaml}] + usage: barbican secret container list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] @@ -485,8 +464,7 @@ barbican secret container list List containers. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -515,14 +493,12 @@ barbican secret delete Delete a secret by providing its URI. -Positional arguments --------------------- +**Positional arguments:** ``URI`` The URI reference for the secret -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -534,22 +510,20 @@ barbican secret get .. code-block:: console - usage: barbican secret get [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] + usage: barbican secret get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] + [--max-width ] [--noindent] [--prefix PREFIX] [--decrypt] [--payload] [--payload_content_type PAYLOAD_CONTENT_TYPE] URI Retrieve a secret by providing its URI. -Positional arguments --------------------- +**Positional arguments:** ``URI`` The URI reference for the secret. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -577,8 +551,8 @@ barbican secret list .. code-block:: console - usage: barbican secret list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] + usage: barbican secret list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] + [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--limit LIMIT] [--offset OFFSET] [--name NAME] [--algorithm ALGORITHM] [--bit-length BIT_LENGTH] @@ -586,8 +560,7 @@ barbican secret list List secrets. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -619,8 +592,7 @@ barbican secret order create .. code-block:: console - usage: barbican secret order create [-h] - [-f {html,json,shell,table,value,yaml}] + usage: barbican secret order create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--name NAME] [--algorithm ALGORITHM] @@ -636,14 +608,12 @@ barbican secret order create Create a new order. -Positional arguments --------------------- +**Positional arguments:** ``type`` the type of the order to create. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -701,14 +671,12 @@ barbican secret order delete Delete an order by providing its href. -Positional arguments --------------------- +**Positional arguments:** ``URI`` The URI reference for the order -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -720,21 +688,19 @@ barbican secret order get .. code-block:: console - usage: barbican secret order get [-h] [-f {html,json,shell,table,value,yaml}] + usage: barbican secret order get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] URI Retrieve an order by providing its URI. -Positional arguments --------------------- +**Positional arguments:** ``URI`` The URI reference order. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -746,7 +712,7 @@ barbican secret order list .. code-block:: console - usage: barbican secret order list [-h] [-f {csv,html,json,table,value,yaml}] + usage: barbican secret order list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] @@ -754,8 +720,7 @@ barbican secret order list List orders. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -774,7 +739,7 @@ barbican secret store .. code-block:: console - usage: barbican secret store [-h] [-f {html,json,shell,table,value,yaml}] + usage: barbican secret store [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--name NAME] [--payload PAYLOAD] [--secret-type SECRET_TYPE] @@ -785,8 +750,7 @@ barbican secret store Store a secret in Barbican. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -837,8 +801,7 @@ barbican secret update Update a secret with no payload in Barbican. -Positional arguments --------------------- +**Positional arguments:** ``URI`` The URI reference for the secret. @@ -846,8 +809,7 @@ Positional arguments ``payload`` the unencrypted secret -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit diff --git a/doc/cli-reference/source/designate.rst b/doc/cli-reference/source/designate.rst index 43ab47b4b7..c7d341410e 100644 --- a/doc/cli-reference/source/designate.rst +++ b/doc/cli-reference/source/designate.rst @@ -24,7 +24,7 @@ designate usage .. code-block:: console - usage: designate [--version] [-v] [--log-file LOG_FILE] [-q] [-h] [--debug] + usage: designate [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug] [--os-username OS_USERNAME] [--os-user-id OS_USER_ID] [--os-user-domain-id OS_USER_DOMAIN_ID] [--os-user-domain-name OS_USER_DOMAIN_NAME] @@ -52,12 +52,12 @@ designate optional arguments ``-v, --verbose`` Increase verbosity of output. Can be repeated. -``--log-file LOG_FILE`` - Specify a file to log output. Disabled by default. - ``-q, --quiet`` Suppress output except warnings and errors. +``--log-file LOG_FILE`` + Specify a file to log output. Disabled by default. + ``-h, --help`` Show this help message and exit. @@ -155,16 +155,14 @@ designate diagnostics-ping .. code-block:: console - usage: designate diagnostics-ping [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] + usage: designate diagnostics-ping [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] --service SERVICE --host HOST Ping a service on a given host -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -182,8 +180,7 @@ designate domain-create .. code-block:: console - usage: designate domain-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] + usage: designate domain-create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] --name NAME --email EMAIL [--ttl TTL] @@ -191,8 +188,7 @@ designate domain-create Create Domain -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -216,22 +212,19 @@ designate domain-delete .. code-block:: console - usage: designate domain-delete [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] + usage: designate domain-delete [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] id Delete Domain -Positional arguments --------------------- +**Positional arguments:** ``id`` Domain ID or name. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -243,22 +236,19 @@ designate domain-get .. code-block:: console - usage: designate domain-get [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] + usage: designate domain-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] id Get Domain -Positional arguments --------------------- +**Positional arguments:** ``id`` Domain ID or name. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -270,15 +260,13 @@ designate domain-list .. code-block:: console - usage: designate domain-list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width ] [--noindent] + usage: designate domain-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] + [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List Domains -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -290,8 +278,7 @@ designate domain-servers-list .. code-block:: console - usage: designate domain-servers-list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] + usage: designate domain-servers-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] @@ -299,14 +286,12 @@ designate domain-servers-list List Domain Servers -Positional arguments --------------------- +**Positional arguments:** ``id`` Domain ID or name. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -318,8 +303,7 @@ designate domain-update .. code-block:: console - usage: designate domain-update [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] + usage: designate domain-update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--name NAME] [--email EMAIL] [--ttl TTL] @@ -328,14 +312,12 @@ designate domain-update Update Domain -Positional arguments --------------------- +**Positional arguments:** ``id`` Domain ID or name. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -361,22 +343,19 @@ designate quota-get .. code-block:: console - usage: designate quota-get [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width ] [--noindent] + usage: designate quota-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] + [--max-width ] [--noindent] [--prefix PREFIX] tenant_id Get Quota -Positional arguments --------------------- +**Positional arguments:** ``tenant_id`` Tenant ID -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -388,22 +367,19 @@ designate quota-reset .. code-block:: console - usage: designate quota-reset [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] + usage: designate quota-reset [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] tenant_id Reset Quota -Positional arguments --------------------- +**Positional arguments:** ``tenant_id`` Tenant ID. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -415,8 +391,7 @@ designate quota-update .. code-block:: console - usage: designate quota-update [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] + usage: designate quota-update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--domains DOMAINS] [--domain-recordsets DOMAIN_RECORDSETS] @@ -427,14 +402,12 @@ designate quota-update Update Quota -Positional arguments --------------------- +**Positional arguments:** ``tenant_id`` Tenant ID. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -461,8 +434,7 @@ designate record-create .. code-block:: console - usage: designate record-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] + usage: designate record-create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] --name NAME --type TYPE --data DATA [--ttl TTL] @@ -472,14 +444,12 @@ designate record-create Create Record -Positional arguments --------------------- +**Positional arguments:** ``domain_id`` Domain ID or name. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -509,16 +479,14 @@ designate record-delete .. code-block:: console - usage: designate record-delete [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] + usage: designate record-delete [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] domain_id id Delete Record -Positional arguments --------------------- +**Positional arguments:** ``domain_id`` Domain ID or name. @@ -526,8 +494,7 @@ Positional arguments ``id`` Record ID. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -539,16 +506,14 @@ designate record-get .. code-block:: console - usage: designate record-get [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] + usage: designate record-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] domain_id id Get Record -Positional arguments --------------------- +**Positional arguments:** ``domain_id`` Domain ID or name. @@ -556,8 +521,7 @@ Positional arguments ``id`` Record ID. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -569,22 +533,19 @@ designate record-list .. code-block:: console - usage: designate record-list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width ] [--noindent] + usage: designate record-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] + [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] domain_id List Records -Positional arguments --------------------- +**Positional arguments:** ``domain_id`` Domain ID or name. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -596,8 +557,7 @@ designate record-update .. code-block:: console - usage: designate record-update [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] + usage: designate record-update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--name NAME] [--type TYPE] [--data DATA] @@ -608,8 +568,7 @@ designate record-update Update Record -Positional arguments --------------------- +**Positional arguments:** ``domain_id`` Domain ID or name. @@ -617,8 +576,7 @@ Positional arguments ``id`` Record ID. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -654,15 +612,13 @@ designate report-count-all .. code-block:: console - usage: designate report-count-all [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] + usage: designate report-count-all [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Get count totals for all tenants, domains and records -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -674,15 +630,13 @@ designate report-count-domains .. code-block:: console - usage: designate report-count-domains [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] + usage: designate report-count-domains [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Get counts for total domains -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -694,15 +648,13 @@ designate report-count-records .. code-block:: console - usage: designate report-count-records [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] + usage: designate report-count-records [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Get counts for total records -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -714,15 +666,13 @@ designate report-count-tenants .. code-block:: console - usage: designate report-count-tenants [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] + usage: designate report-count-tenants [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Get counts for total tenants -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -734,8 +684,7 @@ designate report-tenant-domains .. code-block:: console - usage: designate report-tenant-domains [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] + usage: designate report-tenant-domains [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] @@ -743,8 +692,7 @@ designate report-tenant-domains Get a list of domains for given tenant -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -759,16 +707,14 @@ designate report-tenants-all .. code-block:: console - usage: designate report-tenants-all [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] + usage: designate report-tenants-all [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] Get list of tenants and domain count for each -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -780,15 +726,13 @@ designate server-create .. code-block:: console - usage: designate server-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] + usage: designate server-create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] --name NAME Create Server -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -803,22 +747,19 @@ designate server-delete .. code-block:: console - usage: designate server-delete [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] + usage: designate server-delete [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] id Delete Server -Positional arguments --------------------- +**Positional arguments:** ``id`` Server ID. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -830,22 +771,19 @@ designate server-get .. code-block:: console - usage: designate server-get [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] + usage: designate server-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] id Get Server -Positional arguments --------------------- +**Positional arguments:** ``id`` Server ID. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -857,15 +795,13 @@ designate server-list .. code-block:: console - usage: designate server-list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width ] [--noindent] + usage: designate server-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] + [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List Servers -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -877,22 +813,19 @@ designate server-update .. code-block:: console - usage: designate server-update [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] + usage: designate server-update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--name NAME] id Update Server -Positional arguments --------------------- +**Positional arguments:** ``id`` Server ID. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -907,15 +840,13 @@ designate sync-all .. code-block:: console - usage: designate sync-all [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width ] [--noindent] + usage: designate sync-all [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] + [--max-width ] [--noindent] [--prefix PREFIX] Sync Everything -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -927,22 +858,19 @@ designate sync-domain .. code-block:: console - usage: designate sync-domain [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] + usage: designate sync-domain [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] domain_id Sync a single Domain -Positional arguments --------------------- +**Positional arguments:** ``domain_id`` Domain ID -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -954,16 +882,14 @@ designate sync-record .. code-block:: console - usage: designate sync-record [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] + usage: designate sync-record [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] domain_id record_id Sync a single Record -Positional arguments --------------------- +**Positional arguments:** ``domain_id`` Domain ID @@ -971,8 +897,7 @@ Positional arguments ``record_id`` Record ID -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -984,22 +909,19 @@ designate touch-domain .. code-block:: console - usage: designate touch-domain [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] + usage: designate touch-domain [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] domain_id Touch a single Domain -Positional arguments --------------------- +**Positional arguments:** ``domain_id`` Domain ID -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit diff --git a/doc/cli-reference/source/glance.rst b/doc/cli-reference/source/glance.rst index a83398d80b..be55cb1ee1 100644 --- a/doc/cli-reference/source/glance.rst +++ b/doc/cli-reference/source/glance.rst @@ -26,9 +26,9 @@ glance usage usage: glance [--version] [-d] [-v] [--get-schema] [--no-ssl-compression] [-f] [--os-image-url OS_IMAGE_URL] - [--os-image-api-version OS_IMAGE_API_VERSION] [--insecure] - [--os-cacert ] [--os-cert ] - [--os-key ] [--timeout ] + [--os-image-api-version OS_IMAGE_API_VERSION] + [--profile HMAC_KEY] [--insecure] [--os-cacert ] + [--os-cert ] [--os-key ] [--timeout ] [--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID] [--os-domain-name OS_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID] @@ -85,6 +85,16 @@ glance optional arguments ``--os-image-api-version OS_IMAGE_API_VERSION`` Defaults to ``env[OS_IMAGE_API_VERSION]`` or 2. +``--profile HMAC_KEY`` + HMAC key to use for encrypting context data for + performance profiling of operation. This key should be + the value of HMAC key configured in osprofiler + middleware in glance, it is specified in paste + configuration file at /etc/glance/api-paste.ini and + /etc/glance/registry-paste.ini. Without key the + profiling will not be triggered even if osprofiler is + enabled on server side. + ``--insecure`` Explicitly allow client to perform "insecure" TLS (https) requests. The server's certificate will not be @@ -195,8 +205,7 @@ glance image-create (v1) Create a new image. -Optional arguments ------------------- +**Optional arguments:** ``--id `` ID of image to reserve. @@ -278,8 +287,7 @@ glance image-delete (v1) Delete specified image(s). -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of image(s) to delete. @@ -295,14 +303,12 @@ glance image-download (v1) Download a specific image. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of image to download. -Optional arguments ------------------- +**Optional arguments:** ``--file `` Local file to save downloaded image data to. If this is not @@ -331,8 +337,7 @@ glance image-list (v1) List images you can access. -Optional arguments ------------------- +**Optional arguments:** ``--name `` Filter images to those that have this name. @@ -406,14 +411,12 @@ glance image-show (v1) Describe a specific image. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of image to describe. -Optional arguments ------------------- +**Optional arguments:** ``--human-readable`` Print image size in a human-friendly format. @@ -442,14 +445,12 @@ glance image-update (v1) Update a specific image. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of image to modify. -Optional arguments ------------------- +**Optional arguments:** ``--name `` Name of image. @@ -531,8 +532,7 @@ glance member-create (v1) Share a specific image with a tenant. -Positional arguments --------------------- +**Positional arguments:** ```` Image to add member to. @@ -540,8 +540,7 @@ Positional arguments ```` Tenant to add as member. -Optional arguments ------------------- +**Optional arguments:** ``--can-share`` Allow the specified tenant to share this image. @@ -557,8 +556,7 @@ glance member-delete (v1) Remove a shared image from a tenant. -Positional arguments --------------------- +**Positional arguments:** ```` Image from which to remove member. @@ -577,8 +575,7 @@ glance member-list (v1) Describe sharing permissions by image or tenant. -Optional arguments ------------------- +**Optional arguments:** ``--image-id `` Filter results by an image ID. @@ -609,8 +606,7 @@ glance explain (v2) Describe a specific model. -Positional arguments --------------------- +**Positional arguments:** ```` Name of model to describe. @@ -639,8 +635,7 @@ glance image-create (v2) Create a new image. -Optional arguments ------------------- +**Optional arguments:** ``--architecture `` Operating system architecture as specified in @@ -725,8 +720,7 @@ glance image-deactivate (v2) Deactivate specified image. -Positional arguments --------------------- +**Positional arguments:** ```` ID of image to deactivate. @@ -742,8 +736,7 @@ glance image-delete (v2) Delete specified image. -Positional arguments --------------------- +**Positional arguments:** ```` ID of image(s) to delete. @@ -759,14 +752,12 @@ glance image-download (v2) Download a specific image. -Positional arguments --------------------- +**Positional arguments:** ```` ID of image to download. -Optional arguments ------------------- +**Optional arguments:** ``--file `` Local file to save downloaded image data to. If this is not @@ -793,8 +784,7 @@ glance image-list (v2) List images you can access. -Optional arguments ------------------- +**Optional arguments:** ``--limit `` Maximum number of images to get. @@ -846,8 +836,7 @@ glance image-reactivate (v2) Reactivate specified image. -Positional arguments --------------------- +**Positional arguments:** ```` ID of image to reactivate. @@ -864,14 +853,12 @@ glance image-show (v2) Describe a specific image. -Positional arguments --------------------- +**Positional arguments:** ```` ID of image to describe. -Optional arguments ------------------- +**Optional arguments:** ``--human-readable`` Print image size in a human-friendly format. @@ -890,8 +877,7 @@ glance image-tag-delete (v2) Delete the tag associated with the given image. -Positional arguments --------------------- +**Positional arguments:** ```` ID of the image from which to delete tag. @@ -910,8 +896,7 @@ glance image-tag-update (v2) Update an image with the given tag. -Positional arguments --------------------- +**Positional arguments:** ```` Image to be updated with the given tag. @@ -941,14 +926,12 @@ glance image-update (v2) Update an existing image. -Positional arguments --------------------- +**Positional arguments:** ```` ID of image to update. -Optional arguments ------------------- +**Optional arguments:** ``--architecture `` Operating system architecture as specified in @@ -1024,14 +1007,12 @@ glance image-upload (v2) Upload data for a specific image. -Positional arguments --------------------- +**Positional arguments:** ```` ID of image to upload data to. -Optional arguments ------------------- +**Optional arguments:** ``--file `` Local file that contains disk image to be uploaded. @@ -1057,14 +1038,12 @@ glance location-add (v2) Add a location (and related metadata) to an image. -Positional arguments --------------------- +**Positional arguments:** ```` ID of image to which the location is to be added. -Optional arguments ------------------- +**Optional arguments:** ``--url `` URL of location to add. @@ -1084,14 +1063,12 @@ glance location-delete (v2) Remove locations (and related metadata) from an image. -Positional arguments --------------------- +**Positional arguments:** ```` ID of image whose locations are to be removed. -Optional arguments ------------------- +**Optional arguments:** ``--url `` URL of location to remove. May be used multiple times. @@ -1107,14 +1084,12 @@ glance location-update (v2) Update metadata of an image's location. -Positional arguments --------------------- +**Positional arguments:** ```` ID of image whose location is to be updated. -Optional arguments ------------------- +**Optional arguments:** ``--url `` URL of location to update. @@ -1134,8 +1109,7 @@ glance md-namespace-create (v2) Create a new metadata definitions namespace. -Positional arguments --------------------- +**Positional arguments:** ```` Name of the namespace. @@ -1155,8 +1129,7 @@ glance md-namespace-delete (v2) Delete specified metadata definitions namespace with its contents. -Positional arguments --------------------- +**Positional arguments:** ```` Name of namespace to delete. @@ -1172,8 +1145,7 @@ glance md-namespace-import (v2) Import a metadata definitions namespace from file or standard input. -Optional arguments ------------------- +**Optional arguments:** ``--file `` Path to file with namespace schema to import. @@ -1193,8 +1165,7 @@ glance md-namespace-list (v2) List metadata definitions namespaces. -Optional arguments ------------------- +**Optional arguments:** ``--resource-types `` Resource type to filter namespaces. @@ -1217,8 +1188,7 @@ glance md-namespace-objects-delete (v2) Delete all metadata definitions objects inside a specific namespace. -Positional arguments --------------------- +**Positional arguments:** ```` Name of namespace. @@ -1234,8 +1204,7 @@ glance md-namespace-properties-delete (v2) Delete all metadata definitions property inside a specific namespace. -Positional arguments --------------------- +**Positional arguments:** ```` Name of namespace. @@ -1251,8 +1220,7 @@ glance md-namespace-resource-type-list (v2) List resource types associated to specific namespace. -Positional arguments --------------------- +**Positional arguments:** ```` Name of namespace. @@ -1271,14 +1239,12 @@ glance md-namespace-show (v2) Describe a specific metadata definitions namespace. Lists also the namespace properties, objects and resource type associations. -Positional arguments --------------------- +**Positional arguments:** ```` Name of namespace to describe. -Optional arguments ------------------- +**Optional arguments:** ``--resource-type `` Applies prefix of given resource type associated to a @@ -1298,8 +1264,7 @@ glance md-namespace-tags-delete (v2) Delete all metadata definitions tags inside a specific namespace. -Positional arguments --------------------- +**Positional arguments:** ```` Name of namespace. @@ -1315,8 +1280,7 @@ glance md-namespace-update (v2) Update an existing metadata definitions namespace. -Positional arguments --------------------- +**Positional arguments:** ```` Name of namespace to update. @@ -1336,14 +1300,12 @@ glance md-object-create (v2) Create a new metadata definitions object inside a namespace. -Positional arguments --------------------- +**Positional arguments:** ```` Name of namespace the object will belong. -Optional arguments ------------------- +**Optional arguments:** ``--name `` Internal name of an object. @@ -1362,8 +1324,7 @@ glance md-object-delete (v2) Delete a specific metadata definitions object inside a namespace. -Positional arguments --------------------- +**Positional arguments:** ```` Name of namespace the object belongs. @@ -1382,8 +1343,7 @@ glance md-object-list (v2) List metadata definitions objects inside a specific namespace. -Positional arguments --------------------- +**Positional arguments:** ```` Name of namespace. @@ -1400,8 +1360,7 @@ glance md-object-property-show (v2) Describe a specific metadata definitions property inside an object. -Positional arguments --------------------- +**Positional arguments:** ```` Name of namespace the object belongs. @@ -1412,8 +1371,7 @@ Positional arguments ```` Name of a property. -Optional arguments ------------------- +**Optional arguments:** ``--max-column-width `` The max column width of the printed table. @@ -1430,8 +1388,7 @@ glance md-object-show (v2) Describe a specific metadata definitions object inside a namespace. -Positional arguments --------------------- +**Positional arguments:** ```` Name of namespace the object belongs. @@ -1439,8 +1396,7 @@ Positional arguments ```` Name of an object. -Optional arguments ------------------- +**Optional arguments:** ``--max-column-width `` The max column width of the printed table. @@ -1457,8 +1413,7 @@ glance md-object-update (v2) Update metadata definitions object inside a namespace. -Positional arguments --------------------- +**Positional arguments:** ```` Name of namespace the object belongs. @@ -1466,8 +1421,7 @@ Positional arguments ```` Name of an object. -Optional arguments ------------------- +**Optional arguments:** ``--name `` New name of an object. @@ -1488,14 +1442,12 @@ glance md-property-create (v2) Create a new metadata definitions property inside a namespace. -Positional arguments --------------------- +**Positional arguments:** ```` Name of namespace the property will belong. -Optional arguments ------------------- +**Optional arguments:** ``--name `` Internal name of a property. @@ -1517,8 +1469,7 @@ glance md-property-delete (v2) Delete a specific metadata definitions property inside a namespace. -Positional arguments --------------------- +**Positional arguments:** ```` Name of namespace the property belongs. @@ -1537,8 +1488,7 @@ glance md-property-list (v2) List metadata definitions properties inside a specific namespace. -Positional arguments --------------------- +**Positional arguments:** ```` Name of namespace. @@ -1555,8 +1505,7 @@ glance md-property-show (v2) Describe a specific metadata definitions property inside a namespace. -Positional arguments --------------------- +**Positional arguments:** ```` Name of namespace the property belongs. @@ -1564,8 +1513,7 @@ Positional arguments ```` Name of a property. -Optional arguments ------------------- +**Optional arguments:** ``--max-column-width `` The max column width of the printed table. @@ -1583,8 +1531,7 @@ glance md-property-update (v2) Update metadata definitions property inside a namespace. -Positional arguments --------------------- +**Positional arguments:** ```` Name of namespace the property belongs. @@ -1592,8 +1539,7 @@ Positional arguments ```` Name of a property. -Optional arguments ------------------- +**Optional arguments:** ``--name `` New name of a property. @@ -1615,8 +1561,7 @@ glance md-resource-type-associate (v2) Associate resource type with a metadata definitions namespace. -Positional arguments --------------------- +**Positional arguments:** ```` Name of namespace. @@ -1636,8 +1581,7 @@ glance md-resource-type-deassociate (v2) Deassociate resource type with a metadata definitions namespace. -Positional arguments --------------------- +**Positional arguments:** ```` Name of namespace. @@ -1667,14 +1611,12 @@ glance md-tag-create (v2) Add a new metadata definitions tag inside a namespace. -Positional arguments --------------------- +**Positional arguments:** ```` Name of the namespace the tag will belong to. -Optional arguments ------------------- +**Optional arguments:** ``--name `` The name of the new tag to add. @@ -1691,14 +1633,12 @@ glance md-tag-create-multiple (v2) Create new metadata definitions tags inside a namespace. -Positional arguments --------------------- +**Positional arguments:** ```` Name of the namespace the tags will belong to. -Optional arguments ------------------- +**Optional arguments:** ``--names `` A comma separated list of tag names. @@ -1718,8 +1658,7 @@ glance md-tag-delete (v2) Delete a specific metadata definitions tag inside a namespace. -Positional arguments --------------------- +**Positional arguments:** ```` Name of the namespace to which the tag belongs. @@ -1738,8 +1677,7 @@ glance md-tag-list (v2) List metadata definitions tags inside a specific namespace. -Positional arguments --------------------- +**Positional arguments:** ```` Name of namespace. @@ -1755,8 +1693,7 @@ glance md-tag-show (v2) Describe a specific metadata definitions tag inside a namespace. -Positional arguments --------------------- +**Positional arguments:** ```` Name of the namespace to which the tag belongs. @@ -1775,8 +1712,7 @@ glance md-tag-update (v2) Rename a metadata definitions tag inside a namespace. -Positional arguments --------------------- +**Positional arguments:** ```` Name of the namespace to which the tag belongs. @@ -1784,8 +1720,7 @@ Positional arguments ```` Name of the old tag. -Optional arguments ------------------- +**Optional arguments:** ``--name `` New name of the new tag. @@ -1801,8 +1736,7 @@ glance member-create (v2) Create member for a given image. -Positional arguments --------------------- +**Positional arguments:** ```` Image with which to create member. @@ -1821,8 +1755,7 @@ glance member-delete (v2) Delete image member. -Positional arguments --------------------- +**Positional arguments:** ```` Image from which to remove member. @@ -1841,8 +1774,7 @@ glance member-list (v2) Describe sharing permissions by image. -Optional arguments ------------------- +**Optional arguments:** ``--image-id `` Image to display members of. @@ -1858,8 +1790,7 @@ glance member-update (v2) Update the status of a member for a given image. -Positional arguments --------------------- +**Positional arguments:** ```` Image from which to update member. @@ -1882,8 +1813,7 @@ glance task-create (v2) Create a new task. -Optional arguments ------------------- +**Optional arguments:** ``--type `` Type of Task. Please refer to Glance schema or @@ -1905,8 +1835,7 @@ glance task-list (v2) List tasks you can access. -Optional arguments ------------------- +**Optional arguments:** ``--sort-key {id,type,status}`` Sort task list by specified field. @@ -1934,8 +1863,7 @@ glance task-show (v2) Describe a specific task. -Positional arguments --------------------- +**Positional arguments:** ```` ID of task to describe. diff --git a/doc/cli-reference/source/heat.rst b/doc/cli-reference/source/heat.rst index 9969c26517..9a94e58149 100644 --- a/doc/cli-reference/source/heat.rst +++ b/doc/cli-reference/source/heat.rst @@ -40,11 +40,10 @@ heat usage [--os-tenant-name OS_TENANT_NAME] [--os-auth-url OS_AUTH_URL] [--os-region-name OS_REGION_NAME] [--os-auth-token OS_AUTH_TOKEN] [--os-service-type OS_SERVICE_TYPE] - [--os-endpoint-type OS_ENDPOINT_TYPE] + [--os-endpoint-type OS_ENDPOINT_TYPE] [--profile HMAC_KEY] ... -Subcommands ------------ +**Subcommands:** ``action-check`` Check that stack resources are in expected states. @@ -314,6 +313,15 @@ heat optional arguments ``--os-endpoint-type OS_ENDPOINT_TYPE`` Defaults to ``env[OS_ENDPOINT_TYPE]``. +``--profile HMAC_KEY`` + HMAC key to use for encrypting context data for + performance profiling of operation. This key should be + the value of HMAC key configured in osprofiler + middleware in heat, it is specified in the paste + configuration (/etc/heat/api-paste.ini). Without the + key, profiling will not be triggered even if + osprofiler is enabled on server side. + .. _heat_action-check: heat action-check @@ -325,8 +333,7 @@ heat action-check Check that stack resources are in expected states. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of stack to check. @@ -342,8 +349,7 @@ heat action-resume Resume the stack. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of stack to resume. @@ -359,8 +365,7 @@ heat action-suspend Suspend the stack. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of stack to suspend. @@ -389,14 +394,12 @@ heat config-create Create a software configuration. -Positional arguments --------------------- +**Positional arguments:** ```` Name of the configuration to create. -Optional arguments ------------------- +**Optional arguments:** ``-f , --definition-file `` Path to JSON/YAML containing map defining , @@ -420,8 +423,7 @@ heat config-delete Delete the software configuration(s). -Positional arguments --------------------- +**Positional arguments:** ```` ID of the configuration(s) to delete. @@ -437,8 +439,7 @@ heat config-list List software configs. -Optional arguments ------------------- +**Optional arguments:** ``-l , --limit `` Limit the number of configs returned. @@ -457,14 +458,12 @@ heat config-show View details of a software configuration. -Positional arguments --------------------- +**Positional arguments:** ```` ID of the config. -Optional arguments ------------------- +**Optional arguments:** ``-c, --config-only`` Only display the value of the property. @@ -484,8 +483,7 @@ heat deployment-create Create a software deployment. -Positional arguments --------------------- +**Positional arguments:** ```` Name of the derived config associated with this @@ -493,8 +491,7 @@ Positional arguments list of configurations currently deployed to the server. -Optional arguments ------------------- +**Optional arguments:** ``-i , --input-value `` Input value to set on the deployment. This can be @@ -537,8 +534,7 @@ heat deployment-delete Delete the software deployment(s). -Positional arguments --------------------- +**Positional arguments:** ```` ID of the deployment(s) to delete. @@ -554,8 +550,7 @@ heat deployment-list List software deployments. -Optional arguments ------------------- +**Optional arguments:** ``-s , --server `` ID of the server to fetch deployments for. @@ -571,8 +566,7 @@ heat deployment-metadata-show Get deployment configuration metadata for the specified server. -Positional arguments --------------------- +**Positional arguments:** ```` ID of the server to fetch deployments for. @@ -588,8 +582,7 @@ heat deployment-output-show Show a specific deployment output. -Positional arguments --------------------- +**Positional arguments:** ```` ID deployment to show the output for. @@ -597,8 +590,7 @@ Positional arguments ```` Name of an output to display. -Optional arguments ------------------- +**Optional arguments:** ``-a, --all`` Display all deployment outputs. @@ -617,8 +609,7 @@ heat deployment-show Show the details of a software deployment. -Positional arguments --------------------- +**Positional arguments:** ```` ID of the deployment. @@ -636,14 +627,12 @@ heat event-list List events for a stack. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of stack to show the events for. -Optional arguments ------------------- +**Optional arguments:** ``-r , --resource `` Name of the resource to filter events by. @@ -678,8 +667,7 @@ heat event-show Describe the event. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of stack to show the events for. @@ -702,8 +690,7 @@ heat hook-clear Clear hooks on a given stack. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of the stack these resources belong to. @@ -715,8 +702,7 @@ Positional arguments match multiple stacks or resources: nested_stack/an\*/\*_resource -Optional arguments ------------------- +**Optional arguments:** ``--pre-create`` Clear the pre-create hooks (optional) @@ -735,14 +721,12 @@ heat hook-poll List resources with pending hook for a stack. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of stack to show the pending hooks for. -Optional arguments ------------------- +**Optional arguments:** ``-n , --nested-depth `` Depth of nested stacks from which to display hooks. @@ -758,8 +742,7 @@ heat output-list Show available outputs. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of stack to query. @@ -776,8 +759,7 @@ heat output-show Show a specific stack output. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of stack to query. @@ -785,8 +767,7 @@ Positional arguments ```` Name of an output to display. -Optional arguments ------------------- +**Optional arguments:** ``-F , --format `` The output value format, one of: json, raw. @@ -810,14 +791,12 @@ heat resource-list Show list of resources belonging to a stack. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of stack to show the resources for. -Optional arguments ------------------- +**Optional arguments:** ``-n , --nested-depth `` Depth of nested stacks from which to display @@ -844,8 +823,7 @@ heat resource-mark-unhealthy Set resource's health. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of stack the resource belongs to. @@ -856,8 +834,7 @@ Positional arguments ``reason`` Reason for state change. -Optional arguments ------------------- +**Optional arguments:** ``--reset`` Set the resource as healthy. @@ -873,8 +850,7 @@ heat resource-metadata List resource metadata. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of stack to show the resource metadata for. @@ -893,8 +869,7 @@ heat resource-show Describe the resource. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of stack to show the resource for. @@ -902,8 +877,7 @@ Positional arguments ```` Name of the resource to show the details for. -Optional arguments ------------------- +**Optional arguments:** ``-a , --with-attr `` Attribute to show, it can be specified multiple times. @@ -919,8 +893,7 @@ heat resource-signal Send a signal to a resource. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of stack the resource belongs to. @@ -928,8 +901,7 @@ Positional arguments ```` Name of the resource to signal. -Optional arguments ------------------- +**Optional arguments:** ``-D , --data `` JSON Data to send to the signal handler. @@ -949,8 +921,7 @@ heat resource-type-list List the available resource types. -Optional arguments ------------------- +**Optional arguments:** ``-f , --filters `` Filter parameters to apply on returned resource types. @@ -969,8 +940,7 @@ heat resource-type-show Show the resource type. -Positional arguments --------------------- +**Positional arguments:** ```` Resource type to get the details for. @@ -987,14 +957,12 @@ heat resource-type-template Generate a template based on a resource type. -Positional arguments --------------------- +**Positional arguments:** ```` Resource type to generate a template for. -Optional arguments ------------------- +**Optional arguments:** ``-t , --template-type `` Template type to generate, hot or cfn. @@ -1024,8 +992,7 @@ heat snapshot-delete Delete a snapshot of a stack. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of the stack containing the snapshot. @@ -1044,8 +1011,7 @@ heat snapshot-list List the snapshots of a stack. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of the stack containing the snapshots. @@ -1061,8 +1027,7 @@ heat snapshot-show Show a snapshot of a stack. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of the stack containing the snapshot. @@ -1083,14 +1048,12 @@ Abandon the stack. This will delete the record of the stack from Heat, but will not delete any of the underlying resources. Prints an adoptable JSON representation of the stack to stdout or a file on success. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of stack to abandon. -Optional arguments ------------------- +**Optional arguments:** ``-O , --output-file `` file to output abandon result. If the option is @@ -1110,14 +1073,12 @@ heat stack-adopt Adopt a stack. -Positional arguments --------------------- +**Positional arguments:** ```` Name of the stack to adopt. -Optional arguments ------------------- +**Optional arguments:** ``-e , --environment-file `` Path to the environment, it can be specified multiple @@ -1152,8 +1113,7 @@ heat stack-cancel-update Cancel currently running update of the stack. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of stack to cancel update for. @@ -1174,14 +1134,12 @@ heat stack-create Create the stack. -Positional arguments --------------------- +**Positional arguments:** ```` Name of the stack to create. -Optional arguments ------------------- +**Optional arguments:** ``-f , --template-file `` Path to the template. @@ -1243,14 +1201,12 @@ heat stack-delete Delete the stack(s). -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of stack(s) to delete. -Optional arguments ------------------- +**Optional arguments:** ``-y, --yes`` Skip yes/no prompt (assume yes). @@ -1270,8 +1226,7 @@ heat stack-list List the user's stacks. -Optional arguments ------------------- +**Optional arguments:** ``-s, --show-deleted`` Include soft-deleted stacks in the stack listing. @@ -1345,14 +1300,12 @@ heat stack-preview Preview the stack. -Positional arguments --------------------- +**Positional arguments:** ```` Name of the stack to preview. -Optional arguments ------------------- +**Optional arguments:** ``-f , --template-file `` Path to the template. @@ -1400,8 +1353,7 @@ heat stack-restore Restore a snapshot of a stack. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of the stack containing the snapshot. @@ -1420,14 +1372,12 @@ heat stack-show Describe the stack. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of stack to describe. -Optional arguments ------------------- +**Optional arguments:** ``--no-resolve-outputs`` Do not resolve outputs of the stack. @@ -1443,14 +1393,12 @@ heat stack-snapshot Make a snapshot of a stack. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of stack to snapshot. -Optional arguments ------------------- +**Optional arguments:** ``-n , --name `` If specified, the name given to the snapshot. @@ -1471,14 +1419,12 @@ heat stack-update Update the stack. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of stack to update. -Optional arguments ------------------- +**Optional arguments:** ``-f , --template-file `` Path to the template. @@ -1564,8 +1510,7 @@ heat template-function-list List the available functions. -Positional arguments --------------------- +**Positional arguments:** ```` Template version to get the functions for. @@ -1581,8 +1526,7 @@ heat template-show Get the template for the specified stack. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of stack to get the template for. @@ -1601,8 +1545,7 @@ heat template-validate Validate a template with parameters. -Optional arguments ------------------- +**Optional arguments:** ``-u , --template-url `` URL of template. diff --git a/doc/cli-reference/source/mistral.rst b/doc/cli-reference/source/mistral.rst index 0e95d3ee85..6e8a11759a 100644 --- a/doc/cli-reference/source/mistral.rst +++ b/doc/cli-reference/source/mistral.rst @@ -109,22 +109,20 @@ mistral action-create .. code-block:: console - usage: mistral action-create [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] + usage: mistral action-create [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] + [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--public] definition Create new action. -Positional arguments --------------------- +**Positional arguments:** ``definition`` Action definition file -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -143,14 +141,12 @@ mistral action-delete Delete action. -Positional arguments --------------------- +**Positional arguments:** ``name`` Name of action(s). -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -166,14 +162,12 @@ mistral action-execution-delete Delete action execution. -Positional arguments --------------------- +**Positional arguments:** ``id`` Id of action execution identifier(s). -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -185,22 +179,19 @@ mistral action-execution-get .. code-block:: console - usage: mistral action-execution-get [-h] - [-f {html,json,shell,table,value,yaml}] + usage: mistral action-execution-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] id Show specific Action execution. -Positional arguments --------------------- +**Positional arguments:** ``id`` Action execution ID. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -216,14 +207,12 @@ mistral action-execution-get-input Show Action execution input data. -Positional arguments --------------------- +**Positional arguments:** ``id`` Action execution ID. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -239,14 +228,12 @@ mistral action-execution-get-output Show Action execution output data. -Positional arguments --------------------- +**Positional arguments:** ``id`` Action execution ID. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -258,8 +245,7 @@ mistral action-execution-list .. code-block:: console - usage: mistral action-execution-list [-h] - [-f {csv,html,json,table,value,yaml}] + usage: mistral action-execution-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] @@ -267,14 +253,12 @@ mistral action-execution-list List all Action executions. -Positional arguments --------------------- +**Positional arguments:** ``task_execution_id`` Task execution ID. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -286,8 +270,7 @@ mistral action-execution-update .. code-block:: console - usage: mistral action-execution-update [-h] - [-f {html,json,shell,table,value,yaml}] + usage: mistral action-execution-update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--state {IDLE,RUNNING,SUCCESS,ERROR}] @@ -296,14 +279,12 @@ mistral action-execution-update Update specific Action execution. -Positional arguments --------------------- +**Positional arguments:** ``id`` Action execution ID. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -321,21 +302,19 @@ mistral action-get .. code-block:: console - usage: mistral action-get [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] + usage: mistral action-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] + [--max-width ] [--noindent] [--prefix PREFIX] name Show specific action. -Positional arguments --------------------- +**Positional arguments:** ``name`` Action name -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -351,14 +330,12 @@ mistral action-get-definition Show action definition. -Positional arguments --------------------- +**Positional arguments:** ``name`` Action name -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -370,14 +347,13 @@ mistral action-list .. code-block:: console - usage: mistral action-list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] + usage: mistral action-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] + [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List all actions. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -389,22 +365,20 @@ mistral action-update .. code-block:: console - usage: mistral action-update [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] + usage: mistral action-update [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] + [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--public] definition Update action. -Positional arguments --------------------- +**Positional arguments:** ``definition`` Action definition file -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -419,8 +393,7 @@ mistral cron-trigger-create .. code-block:: console - usage: mistral cron-trigger-create [-h] - [-f {html,json,shell,table,value,yaml}] + usage: mistral cron-trigger-create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--params PARAMS] [--pattern <* * * * *>] @@ -430,8 +403,7 @@ mistral cron-trigger-create Create new trigger. -Positional arguments --------------------- +**Positional arguments:** ``name`` Cron trigger name @@ -442,8 +414,7 @@ Positional arguments ``workflow_input`` Workflow input -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -471,14 +442,12 @@ mistral cron-trigger-delete Delete trigger. -Positional arguments --------------------- +**Positional arguments:** ``name`` Name of cron trigger(s). -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -490,21 +459,19 @@ mistral cron-trigger-get .. code-block:: console - usage: mistral cron-trigger-get [-h] [-f {html,json,shell,table,value,yaml}] + usage: mistral cron-trigger-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] name Show specific cron trigger. -Positional arguments --------------------- +**Positional arguments:** ``name`` Cron trigger name -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -516,15 +483,14 @@ mistral cron-trigger-list .. code-block:: console - usage: mistral cron-trigger-list [-h] [-f {csv,html,json,table,value,yaml}] + usage: mistral cron-trigger-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List all cron triggers. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -536,21 +502,19 @@ mistral environment-create .. code-block:: console - usage: mistral environment-create [-h] [-f {html,json,shell,table,value,yaml}] + usage: mistral environment-create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] file Create new environment. -Positional arguments --------------------- +**Positional arguments:** ``file`` Environment configuration file in JSON or YAML -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -566,14 +530,12 @@ mistral environment-delete Delete environment. -Positional arguments --------------------- +**Positional arguments:** ``name`` Name of environment(s). -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -585,21 +547,19 @@ mistral environment-get .. code-block:: console - usage: mistral environment-get [-h] [-f {html,json,shell,table,value,yaml}] + usage: mistral environment-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] name Show specific environment. -Positional arguments --------------------- +**Positional arguments:** ``name`` Environment name -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -611,15 +571,14 @@ mistral environment-list .. code-block:: console - usage: mistral environment-list [-h] [-f {csv,html,json,table,value,yaml}] + usage: mistral environment-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List all environments. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -631,21 +590,19 @@ mistral environment-update .. code-block:: console - usage: mistral environment-update [-h] [-f {html,json,shell,table,value,yaml}] + usage: mistral environment-update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] file Update environment. -Positional arguments --------------------- +**Positional arguments:** ``file`` Environment configuration file in JSON or YAML -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -657,7 +614,7 @@ mistral execution-create .. code-block:: console - usage: mistral execution-create [-h] [-f {html,json,shell,table,value,yaml}] + usage: mistral execution-create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [-d DESCRIPTION] @@ -665,8 +622,7 @@ mistral execution-create Create new execution. -Positional arguments --------------------- +**Positional arguments:** ``workflow_identifier`` Workflow ID or name. Workflow name will be deprecated @@ -678,8 +634,7 @@ Positional arguments ``params`` Workflow additional parameters -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -698,14 +653,12 @@ mistral execution-delete Delete execution. -Positional arguments --------------------- +**Positional arguments:** ``id`` Id of execution identifier(s). -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -717,21 +670,19 @@ mistral execution-get .. code-block:: console - usage: mistral execution-get [-h] [-f {html,json,shell,table,value,yaml}] + usage: mistral execution-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] id Show specific execution. -Positional arguments --------------------- +**Positional arguments:** ``id`` Execution identifier -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -747,14 +698,12 @@ mistral execution-get-input Show execution input data. -Positional arguments --------------------- +**Positional arguments:** ``id`` Execution ID -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -770,14 +719,12 @@ mistral execution-get-output Show execution output data. -Positional arguments --------------------- +**Positional arguments:** ``id`` Execution ID -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -789,7 +736,7 @@ mistral execution-list .. code-block:: console - usage: mistral execution-list [-h] [-f {csv,html,json,table,value,yaml}] + usage: mistral execution-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--marker [MARKER]] [--limit [LIMIT]] @@ -798,8 +745,7 @@ mistral execution-list List all executions. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -829,7 +775,7 @@ mistral execution-update .. code-block:: console - usage: mistral execution-update [-h] [-f {html,json,shell,table,value,yaml}] + usage: mistral execution-update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [-s {RUNNING,PAUSED,SUCCESS,ERROR}] [-e ENV] @@ -838,14 +784,12 @@ mistral execution-update Update execution. -Positional arguments --------------------- +**Positional arguments:** ``id`` Execution identifier -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -866,15 +810,14 @@ mistral member-create .. code-block:: console - usage: mistral member-create [-h] [-f {html,json,shell,table,value,yaml}] + usage: mistral member-create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] resource_id resource_type member_id Shares a resource to another tenant. -Positional arguments --------------------- +**Positional arguments:** ``resource_id`` Resource ID to be shared. @@ -885,8 +828,7 @@ Positional arguments ``member_id`` Project ID to whom the resource is shared to. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -902,8 +844,7 @@ mistral member-delete Delete a resource sharing relationship. -Positional arguments --------------------- +**Positional arguments:** ``resource_id`` Resource ID to be shared. @@ -914,8 +855,7 @@ Positional arguments ``member_id`` Project ID to whom the resource is shared to. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -927,15 +867,14 @@ mistral member-get .. code-block:: console - usage: mistral member-get [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] + usage: mistral member-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] + [--max-width ] [--noindent] [--prefix PREFIX] [-m MEMBER_ID] resource_id resource_type Show specific member information. -Positional arguments --------------------- +**Positional arguments:** ``resource_id`` Resource ID to be shared. @@ -943,8 +882,7 @@ Positional arguments ``resource_type`` Resource type. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -960,15 +898,14 @@ mistral member-list .. code-block:: console - usage: mistral member-list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] + usage: mistral member-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] + [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] resource_id resource_type List all members. -Positional arguments --------------------- +**Positional arguments:** ``resource_id`` Resource id to be shared. @@ -976,8 +913,7 @@ Positional arguments ``resource_type`` Resource type. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -989,7 +925,7 @@ mistral member-update .. code-block:: console - usage: mistral member-update [-h] [-f {html,json,shell,table,value,yaml}] + usage: mistral member-update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [-m MEMBER_ID] [-s {pending,accepted,rejected}] @@ -997,8 +933,7 @@ mistral member-update Update resource sharing status. -Positional arguments --------------------- +**Positional arguments:** ``resource_id`` Resource ID to be shared. @@ -1006,8 +941,7 @@ Positional arguments ``resource_type`` Resource type. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -1026,15 +960,14 @@ mistral run-action .. code-block:: console - usage: mistral run-action [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] + usage: mistral run-action [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] + [--max-width ] [--noindent] [--prefix PREFIX] [-s] [-t TARGET] name [input] Create new Action execution or just run specific action. -Positional arguments --------------------- +**Positional arguments:** ``name`` Action name to execute. @@ -1042,8 +975,7 @@ Positional arguments ``input`` Action input. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -1061,14 +993,13 @@ mistral service-list .. code-block:: console - usage: mistral service-list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] + usage: mistral service-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] + [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List all services. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -1080,21 +1011,18 @@ mistral task-get .. code-block:: console - usage: mistral task-get [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--prefix PREFIX] + usage: mistral task-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] + [--max-width ] [--noindent] [--prefix PREFIX] id Show specific task. -Positional arguments --------------------- +**Positional arguments:** ``id`` Task identifier -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -1110,14 +1038,12 @@ mistral task-get-published Show task published variables. -Positional arguments --------------------- +**Positional arguments:** ``id`` Task ID -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -1133,14 +1059,12 @@ mistral task-get-result Show task output data. -Positional arguments --------------------- +**Positional arguments:** ``id`` Task ID -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -1152,21 +1076,19 @@ mistral task-list .. code-block:: console - usage: mistral task-list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] + usage: mistral task-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] + [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [workflow_execution] List all tasks. -Positional arguments --------------------- +**Positional arguments:** ``workflow_execution`` Workflow execution ID associated with list of Tasks. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -1178,21 +1100,19 @@ mistral task-rerun .. code-block:: console - usage: mistral task-rerun [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] + usage: mistral task-rerun [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] + [--max-width ] [--noindent] [--prefix PREFIX] [--resume] [-e ENV] id Rerun an existing task. -Positional arguments --------------------- +**Positional arguments:** ``id`` Task identifier -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -1211,21 +1131,19 @@ mistral workbook-create .. code-block:: console - usage: mistral workbook-create [-h] [-f {html,json,shell,table,value,yaml}] + usage: mistral workbook-create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] definition Create new workbook. -Positional arguments --------------------- +**Positional arguments:** ``definition`` Workbook definition file -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -1241,14 +1159,12 @@ mistral workbook-delete Delete workbook. -Positional arguments --------------------- +**Positional arguments:** ``name`` Name of workbook(s). -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -1260,21 +1176,19 @@ mistral workbook-get .. code-block:: console - usage: mistral workbook-get [-h] [-f {html,json,shell,table,value,yaml}] + usage: mistral workbook-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] name Show specific workbook. -Positional arguments --------------------- +**Positional arguments:** ``name`` Workbook name -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -1290,14 +1204,12 @@ mistral workbook-get-definition Show workbook definition. -Positional arguments --------------------- +**Positional arguments:** ``name`` Workbook name -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -1309,14 +1221,13 @@ mistral workbook-list .. code-block:: console - usage: mistral workbook-list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] + usage: mistral workbook-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] + [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List all workbooks. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -1328,21 +1239,19 @@ mistral workbook-update .. code-block:: console - usage: mistral workbook-update [-h] [-f {html,json,shell,table,value,yaml}] + usage: mistral workbook-update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] definition Update workbook. -Positional arguments --------------------- +**Positional arguments:** ``definition`` Workbook definition file -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -1354,21 +1263,19 @@ mistral workbook-validate .. code-block:: console - usage: mistral workbook-validate [-h] [-f {html,json,shell,table,value,yaml}] + usage: mistral workbook-validate [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] definition Validate workbook. -Positional arguments --------------------- +**Positional arguments:** ``definition`` Workbook definition file -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -1380,7 +1287,7 @@ mistral workflow-create .. code-block:: console - usage: mistral workflow-create [-h] [-f {csv,html,json,table,value,yaml}] + usage: mistral workflow-create [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] @@ -1389,14 +1296,12 @@ mistral workflow-create Create new workflow. -Positional arguments --------------------- +**Positional arguments:** ``definition`` Workflow definition file. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -1415,14 +1320,12 @@ mistral workflow-delete Delete workflow. -Positional arguments --------------------- +**Positional arguments:** ``identifier`` Name or ID of workflow(s). -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -1434,21 +1337,19 @@ mistral workflow-get .. code-block:: console - usage: mistral workflow-get [-h] [-f {html,json,shell,table,value,yaml}] + usage: mistral workflow-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] identifier Show specific workflow. -Positional arguments --------------------- +**Positional arguments:** ``identifier`` Workflow ID or name. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -1464,14 +1365,12 @@ mistral workflow-get-definition Show workflow definition. -Positional arguments --------------------- +**Positional arguments:** ``identifier`` Workflow ID or name. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -1483,14 +1382,13 @@ mistral workflow-list .. code-block:: console - usage: mistral workflow-list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] + usage: mistral workflow-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] + [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List all workflows. -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -1502,7 +1400,7 @@ mistral workflow-update .. code-block:: console - usage: mistral workflow-update [-h] [-f {csv,html,json,table,value,yaml}] + usage: mistral workflow-update [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] @@ -1511,14 +1409,12 @@ mistral workflow-update Update workflow. -Positional arguments --------------------- +**Positional arguments:** ``definition`` Workflow definition -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit @@ -1536,21 +1432,19 @@ mistral workflow-validate .. code-block:: console - usage: mistral workflow-validate [-h] [-f {html,json,shell,table,value,yaml}] + usage: mistral workflow-validate [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] definition Validate workflow. -Positional arguments --------------------- +**Positional arguments:** ``definition`` Workflow definition file -Optional arguments ------------------- +**Optional arguments:** ``-h, --help`` show this help message and exit diff --git a/doc/cli-reference/source/senlin.rst b/doc/cli-reference/source/senlin.rst index 4dfd68150d..ea4cc34d83 100644 --- a/doc/cli-reference/source/senlin.rst +++ b/doc/cli-reference/source/senlin.rst @@ -41,11 +41,10 @@ senlin usage [--os-api-name =] [--os-api-region =] [--os-api-version =] - [--os-api-interface =] + [--os-api-interface =] [--profile HMAC_KEY] ... -Subcommands ------------ +**Subcommands:** ``action-list`` List actions. @@ -295,6 +294,15 @@ senlin optional arguments ``--os-api-interface =`` Desired API interface, defaults to ``env[OS_INTERFACE]`` +``--profile HMAC_KEY`` + HMAC key to use for encrypting context data for + performance profiling of operation. This key should be + the value of HMAC key configured in osprofiler + middleware in senlin, it is specified in the paste + deploy configuration (/etc/senlin/api-paste.ini). + Without the key, profiling will not be triggered even + if osprofiler is enabled on server side. + .. _senlin_action-list: senlin action-list @@ -307,8 +315,7 @@ senlin action-list List actions. -Optional arguments ------------------- +**Optional arguments:** ``-f , --filters `` Filter parameters to apply on returned actions. This @@ -341,8 +348,7 @@ senlin action-show Show detailed info about the specified action. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of the action to show the details for. @@ -373,14 +379,12 @@ senlin cluster-create Create the cluster. -Positional arguments --------------------- +**Positional arguments:** ```` Name of the cluster to create. -Optional arguments ------------------- +**Optional arguments:** ``-p , --profile `` Profile Id used for this cluster. @@ -415,8 +419,7 @@ senlin cluster-delete Delete the cluster(s). -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of cluster(s) to delete. @@ -433,8 +436,7 @@ senlin cluster-list List the user's clusters. -Optional arguments ------------------- +**Optional arguments:** ``-f , --filters `` Filter parameters to apply on returned clusters. This @@ -472,14 +474,12 @@ senlin cluster-node-add Add specified nodes to cluster. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of cluster to operate on. -Optional arguments ------------------- +**Optional arguments:** ``-n , --nodes `` ID of nodes to be added; multiple nodes can be @@ -496,14 +496,12 @@ senlin cluster-node-del Delete specified nodes from cluster. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of cluster to operate on. -Optional arguments ------------------- +**Optional arguments:** ``-n , --nodes `` ID of nodes to be deleted; multiple nodes can be @@ -522,14 +520,12 @@ senlin cluster-node-list List nodes from cluster. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of cluster to nodes from. -Optional arguments ------------------- +**Optional arguments:** ``-f , --filters `` Filter parameters to apply on returned nodes. This can @@ -556,14 +552,12 @@ senlin cluster-policy-attach Attach policy to cluster. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of cluster to operate on. -Optional arguments ------------------- +**Optional arguments:** ``-p , --policy `` ID or name of policy to be attached. @@ -583,14 +577,12 @@ senlin cluster-policy-detach Detach policy from cluster. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of cluster to operate on. -Optional arguments ------------------- +**Optional arguments:** ``-p , --policy `` ID or name of policy to be detached. @@ -608,14 +600,12 @@ senlin cluster-policy-list List policies from cluster. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of cluster to query on. -Optional arguments ------------------- +**Optional arguments:** ``-f , --filters `` Filter parameters to apply on returned results. This @@ -641,14 +631,12 @@ senlin cluster-policy-show Show a specific policy that is bound to the specified cluster. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the cluster to query on. -Optional arguments ------------------- +**Optional arguments:** ``-p , --policy `` ID or name of the policy to query on. @@ -664,14 +652,12 @@ senlin cluster-policy-update Update a policy's properties on a cluster. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of cluster to operate on. -Optional arguments ------------------- +**Optional arguments:** ``-p , --policy `` ID or name of policy to be updated. @@ -693,14 +679,12 @@ senlin cluster-resize Resize a cluster. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of cluster to operate on. -Optional arguments ------------------- +**Optional arguments:** ``-c , --capacity `` The desired number of nodes of the cluster. @@ -741,14 +725,12 @@ senlin cluster-scale-in Scale in a cluster by the specified number of nodes. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of cluster to operate on. -Optional arguments ------------------- +**Optional arguments:** ``-c , --count `` Number of nodes to be deleted from the specified @@ -765,14 +747,12 @@ senlin cluster-scale-out Scale out a cluster by the specified number of nodes. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of cluster to operate on. -Optional arguments ------------------- +**Optional arguments:** ``-c , --count `` Number of nodes to be added to the specified cluster. @@ -788,8 +768,7 @@ senlin cluster-show Show details of the cluster. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of cluster to show. @@ -807,14 +786,12 @@ senlin cluster-update Update the cluster. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of cluster to be updated. -Optional arguments ------------------- +**Optional arguments:** ``-p , --profile `` ID of new profile to use. @@ -842,8 +819,7 @@ senlin event-list List events. -Optional arguments ------------------- +**Optional arguments:** ``-f , --filters `` Filter parameters to apply on returned events. This @@ -881,8 +857,7 @@ senlin event-show Describe the event. -Positional arguments --------------------- +**Positional arguments:** ```` ID of event to display details for. @@ -900,14 +875,12 @@ senlin node-create Create the node. -Positional arguments --------------------- +**Positional arguments:** ```` Name of the node to create. -Optional arguments ------------------- +**Optional arguments:** ``-p , --profile `` Profile Id used for this node. @@ -934,8 +907,7 @@ senlin node-delete Delete the node(s). -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of node(s) to delete. @@ -952,8 +924,7 @@ senlin node-list Show list of nodes. -Optional arguments ------------------- +**Optional arguments:** ``-c , --cluster `` ID or name of cluster from which nodes are to be @@ -994,14 +965,12 @@ senlin node-show Show detailed info about the specified node. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of the node to show the details for. -Optional arguments ------------------- +**Optional arguments:** ``-D, --details`` Include physical object details. @@ -1019,14 +988,12 @@ senlin node-update Update the node. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of node to update. -Optional arguments ------------------- +**Optional arguments:** ``-n , --name `` New name for the node. @@ -1053,14 +1020,12 @@ senlin policy-create Create a policy. -Positional arguments --------------------- +**Positional arguments:** ```` Name of the policy to create. -Optional arguments ------------------- +**Optional arguments:** ``-s , --spec-file `` The spec file used to create the policy. @@ -1076,8 +1041,7 @@ senlin policy-delete Delete policy(s). -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of policy(s) to delete. @@ -1094,8 +1058,7 @@ senlin policy-list List policies that meet the criteria. -Optional arguments ------------------- +**Optional arguments:** ``-f , --filters `` Filter parameters to apply on returned policies. This @@ -1132,8 +1095,7 @@ senlin policy-show Show the policy details. -Positional arguments --------------------- +**Positional arguments:** ```` Name of the policy to be updated. @@ -1160,14 +1122,12 @@ senlin policy-type-show Get the details about a policy type. -Positional arguments --------------------- +**Positional arguments:** ```` Policy type to retrieve. -Optional arguments ------------------- +**Optional arguments:** ``-F , --format `` The template output format, one of: yaml, json. @@ -1183,14 +1143,12 @@ senlin policy-update Update a policy. -Positional arguments --------------------- +**Positional arguments:** ```` Name of the policy to be updated. -Optional arguments ------------------- +**Optional arguments:** ``-n , --name `` New name of the policy to be updated. @@ -1207,14 +1165,12 @@ senlin profile-create Create a profile. -Positional arguments --------------------- +**Positional arguments:** ```` Name of the profile to create. -Optional arguments ------------------- +**Optional arguments:** ``-s , --spec-file `` The spec file used to create the profile. @@ -1235,8 +1191,7 @@ senlin profile-delete Delete profile(s). -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of profile(s) to delete. @@ -1253,8 +1208,7 @@ senlin profile-list List profiles that meet the criteria. -Optional arguments ------------------- +**Optional arguments:** ``-f , --filters `` Filter parameters to apply on returned profiles. This @@ -1291,8 +1245,7 @@ senlin profile-show Show the profile details. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of profile to show. @@ -1320,14 +1273,12 @@ senlin profile-type-show Get the details about a profile type. -Positional arguments --------------------- +**Positional arguments:** ```` Profile type to retrieve. -Optional arguments ------------------- +**Optional arguments:** ``-F , --format `` The template output format, one of: yaml, json. @@ -1344,14 +1295,12 @@ senlin profile-update Update a profile. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of the profile to update. -Optional arguments ------------------- +**Optional arguments:** ``-n , --name `` The new name for the profile. @@ -1374,14 +1323,12 @@ senlin receiver-create Create a receiver. -Positional arguments --------------------- +**Positional arguments:** ```` Name of the receiver to create. -Optional arguments ------------------- +**Optional arguments:** ``-t , --type `` Type of the receiver to create. @@ -1407,8 +1354,7 @@ senlin receiver-delete Delete receiver(s). -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of receiver(s) to delete. @@ -1425,8 +1371,7 @@ senlin receiver-list List receivers that meet the criteria. -Optional arguments ------------------- +**Optional arguments:** ``-f , --filters `` Filter parameters to apply on returned receivers. This @@ -1463,8 +1408,7 @@ senlin receiver-show Show the receiver details. -Positional arguments --------------------- +**Positional arguments:** ```` Name or ID of the receiver to show.