Update CLI reference for python-heatclient 0.4.0
Change-Id: If939bfd38e1add52cae965f703a47807454c828a
This commit is contained in:
Andreas Jaeger
parent
186bcaf23c
commit
2a4fb564ba
@ -15,7 +15,7 @@
|
||||
interface (CLI) for the Orchestration API and its extensions.
|
||||
|
||||
This chapter documents <command>heat</command> version
|
||||
<literal>0.3.0</literal>.
|
||||
<literal>0.4.0</literal>.
|
||||
</para>
|
||||
|
||||
<para>For help on a specific <command>heat</command>
|
||||
@ -117,6 +117,13 @@
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>deployment-create</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>deployment-delete</command></term>
|
||||
<listitem>
|
||||
@ -134,6 +141,14 @@
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>deployment-output-show</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Show a specific stack output.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>deployment-show</command></term>
|
||||
<listitem>
|
||||
@ -182,6 +197,14 @@
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>hook-clear</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Clear hooks on a given stack.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>list</command></term>
|
||||
<listitem>
|
||||
@ -866,6 +889,97 @@ View details of a software configuration.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="heatclient_subcommand_deployment-create">
|
||||
<title>heat deployment-create</title>
|
||||
<screen><computeroutput>usage: heat deployment-create [-i <KEY=VALUE>] [-a <ACTION>] [-c <CONFIG>]
|
||||
[-s <SERVER>] [-t <TRANSPORT>]
|
||||
[--container <CONTAINER_NAME>]
|
||||
[--timeout <TIMEOUT>]
|
||||
<DEPLOY_NAME></computeroutput></screen>
|
||||
<para>
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><DEPLOY_NAME></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of the derived config associated with this
|
||||
deployment. This is used to apply a sort order to the
|
||||
list of configurations currently deployed to the
|
||||
server.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-i <KEY=VALUE>, --input-value <KEY=VALUE></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Input value to set on the deployment. This can be
|
||||
specified multiple times.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-a <ACTION>, --action <ACTION></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of action for this deployment. Can be a custom
|
||||
action, or one of: CREATE, UPDATE, DELETE, SUSPEND,
|
||||
RESUME
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-c <CONFIG>, --config <CONFIG></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
ID of the configuration to deploy.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-s <SERVER>, --server <SERVER></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
ID of the server being deployed to.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-t <TRANSPORT>, --signal-transport <TRANSPORT></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
How the server should signal to heat with the
|
||||
deployment output values. TEMP_URL_SIGNAL will create
|
||||
a Swift TempURL to be signaled via HTTP PUT. NO_SIGNAL
|
||||
will result in the resource going to the COMPLETE
|
||||
state without waiting for any signal.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--container <CONTAINER_NAME></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Optional name of container to store TEMP_URL_SIGNAL
|
||||
objects in. If not specified a container will be
|
||||
created with a name derived from the DEPLOY_NAME
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--timeout <TIMEOUT></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Deployment timeout in minutes.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="heatclient_subcommand_deployment-delete">
|
||||
@ -900,6 +1014,50 @@ Get deployment configuration metadata for the specified server.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="heatclient_subcommand_deployment-output-show">
|
||||
<title>heat deployment-output-show</title>
|
||||
<screen><computeroutput>usage: heat deployment-output-show [-a] [-F <FORMAT>] <ID> [<OUTPUT NAME>]</computeroutput></screen>
|
||||
<para>
|
||||
Show a specific stack output.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><ID></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
ID deployment to show the output for.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command><OUTPUT NAME></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of an output to display.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-a, --all</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Display all deployment outputs.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-F <FORMAT>, --format <FORMAT></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The output value format, one of: raw, json
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="heatclient_subcommand_deployment-show">
|
||||
@ -1007,6 +1165,55 @@ Describe the event.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="heatclient_subcommand_hook-clear">
|
||||
<title>heat hook-clear</title>
|
||||
<screen><computeroutput>usage: heat hook-clear [--pre-create] [--pre-update]
|
||||
<NAME or ID> <RESOURCE> [<RESOURCE> ...]</computeroutput></screen>
|
||||
<para>
|
||||
Clear hooks on a given stack.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><NAME or ID></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name or ID of the stack these resources belong to.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command><RESOURCE></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Resource names with hooks to clear. Resources in nested stacks
|
||||
can be set using slash as a separator:
|
||||
nested_stack/another/my_resource. You can use wildcards to
|
||||
match multiple stacks or resources:
|
||||
nested_stack/an*/*_resource
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>--pre-create</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Clear the pre-create hooks
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--pre-update</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Clear the pre-update hooks
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="heatclient_subcommand_output-list">
|
||||
@ -1473,9 +1680,10 @@ Cancel currently running update of the stack.
|
||||
</section>
|
||||
<section xml:id="heatclient_subcommand_stack-create">
|
||||
<title>heat stack-create</title>
|
||||
<screen><computeroutput>usage: heat stack-create [-f <FILE>] [-e <FILE or URL>] [-u <URL>] [-o <URL>]
|
||||
<screen><computeroutput>usage: heat stack-create [-f <FILE>] [-e <FILE or URL>]
|
||||
[--pre-create <RESOURCE>] [-u <URL>] [-o <URL>]
|
||||
[-c <TIMEOUT>] [-t <TIMEOUT>] [-r]
|
||||
[-P <KEY1=VALUE1;KEY2=VALUE2...>]
|
||||
[-P <KEY1=VALUE1;KEY2=VALUE2...>] [-Pf <KEY=VALUE>]
|
||||
<STACK_NAME></computeroutput></screen>
|
||||
<para>
|
||||
Create the stack.
|
||||
@ -1509,6 +1717,19 @@ Create the stack.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--pre-create <RESOURCE></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of a resource to set a pre-create hook to.
|
||||
Resources in nested stacks can be set using slash as a
|
||||
separator: nested_stack/another/my_resource. You can
|
||||
use wildcards to match multiple stacks or resources:
|
||||
nested_stack/an*/*_resource. This can be specified
|
||||
multiple times
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-u <URL>, --template-url <URL></command></term>
|
||||
<listitem>
|
||||
@ -1560,6 +1781,16 @@ Create the stack.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-Pf <KEY=VALUE>, --parameter-file <KEY=VALUE></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Parameter values from file used to create the stack.
|
||||
This can be specified multiple times. Parameter value
|
||||
would be the content of the file
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="heatclient_subcommand_stack-delete">
|
||||
@ -1655,7 +1886,7 @@ List the user's stacks.
|
||||
<title>heat stack-preview</title>
|
||||
<screen><computeroutput>usage: heat stack-preview [-f <FILE>] [-e <FILE or URL>] [-u <URL>] [-o <URL>]
|
||||
[-t <TIMEOUT>] [-r]
|
||||
[-P <KEY1=VALUE1;KEY2=VALUE2...>]
|
||||
[-P <KEY1=VALUE1;KEY2=VALUE2...>] [-Pf <KEY=VALUE>]
|
||||
<STACK_NAME></computeroutput></screen>
|
||||
<para>
|
||||
Preview the stack.
|
||||
@ -1734,6 +1965,16 @@ Preview the stack.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-Pf <KEY=VALUE>, --parameter-file <KEY=VALUE></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Parameter values from file used to create the stack.
|
||||
This can be specified multiple times. Parameter value
|
||||
would be the content of the file
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="heatclient_subcommand_stack-restore">
|
||||
@ -1808,10 +2049,11 @@ Make a snapshot of a stack.
|
||||
</section>
|
||||
<section xml:id="heatclient_subcommand_stack-update">
|
||||
<title>heat stack-update</title>
|
||||
<screen><computeroutput>usage: heat stack-update [-f <FILE>] [-e <FILE or URL>] [-u <URL>] [-o <URL>]
|
||||
<screen><computeroutput>usage: heat stack-update [-f <FILE>] [-e <FILE or URL>]
|
||||
[--pre-update <RESOURCE>] [-u <URL>] [-o <URL>]
|
||||
[-t <TIMEOUT>] [-r] [--rollback <VALUE>]
|
||||
[-P <KEY1=VALUE1;KEY2=VALUE2...>] [-x]
|
||||
[-c <PARAMETER>]
|
||||
[-P <KEY1=VALUE1;KEY2=VALUE2...>] [-Pf <KEY=VALUE>]
|
||||
[-x] [-c <PARAMETER>]
|
||||
<NAME or ID></computeroutput></screen>
|
||||
<para>
|
||||
Update the stack.
|
||||
@ -1845,6 +2087,19 @@ Update the stack.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--pre-update <RESOURCE></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of a resource to set a pre-update hook to.
|
||||
Resources in nested stacks can be set using slash as a
|
||||
separator: nested_stack/another/my_resource. You can
|
||||
use wildcards to match multiple stacks or resources:
|
||||
nested_stack/an*/*_resource. This can be specified
|
||||
multiple times
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-u <URL>, --template-url <URL></command></term>
|
||||
<listitem>
|
||||
@ -1902,6 +2157,16 @@ Update the stack.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-Pf <KEY=VALUE>, --parameter-file <KEY=VALUE></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Parameter values from file used to create the stack.
|
||||
This can be specified multiple times. Parameter value
|
||||
would be the content of the file
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-x, --existing</command></term>
|
||||
<listitem>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user