From da864c8fa39b1036128a6c54d36d6cd66b0a81ea Mon Sep 17 00:00:00 2001 From: huangtianhua Date: Thu, 22 Dec 2016 11:56:17 +0800 Subject: [PATCH] Use 'openstack' commands instead in docs Use 'openstack' commands instead of 'heat' commands. Change-Id: I493487d4cfa7279460bed5d267150408854044a5 --- doc/source/getting_started/create_a_stack.rst | 18 +++++++++--------- doc/source/template_guide/composition.rst | 4 ++-- doc/source/template_guide/environment.rst | 12 +++++++----- doc/source/template_guide/functions.rst | 2 +- 4 files changed, 19 insertions(+), 17 deletions(-) diff --git a/doc/source/getting_started/create_a_stack.rst b/doc/source/getting_started/create_a_stack.rst index c20128e65f..86d5f79ff0 100644 --- a/doc/source/getting_started/create_a_stack.rst +++ b/doc/source/getting_started/create_a_stack.rst @@ -26,7 +26,7 @@ sourced:: You can confirm that Heat is available with this command:: - $ heat stack-list + $ openstack stack list This should return an empty line @@ -50,7 +50,7 @@ Launching a stack ----------------- Now lets launch a stack, using an example template from the heat-templates repository:: - $ heat stack-create -u http://git.openstack.org/cgit/openstack/heat-templates/plain/hot/F20/WordPress_Native.yaml -P key_name=heat_key -P image_id=my-fedora-image -P instance_type=m1.small teststack + $ openstack stack create -t http://git.openstack.org/cgit/openstack/heat-templates/plain/hot/F20/WordPress_Native.yaml --parameter key_name=heat_key --parameter image_id=my-fedora-image --parameter instance_type=m1.small teststack Which will respond:: @@ -70,19 +70,19 @@ List stacks ~~~~~~~~~~~ List the stacks in your tenant:: - $ heat stack-list + $ openstack stack list List stack events ~~~~~~~~~~~~~~~~~ List the events related to a particular stack:: - $ heat event-list teststack + $ openstack stack event list teststack Describe the wordpress stack ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Show detailed state of a stack:: - $ heat stack-show teststack + $ openstack stack show teststack Note: After a few seconds, the stack_status should change from ``IN_PROGRESS`` to ``CREATE_COMPLETE``. @@ -93,17 +93,17 @@ Because the software takes some time to install from the repository, it may be a few minutes before the Wordpress instance is in a running state. Point a web browser at the location given by the ``WebsiteURL`` output as shown -by ``heat output-show``:: +by ``openstack stack output show``:: - $ WebsiteURL=$(heat output-show --format raw teststack WebsiteURL) + $ WebsiteURL=$(openstack stack output show teststack WebsiteURL -c output_value -f value) $ curl $WebsiteURL Delete the instance when done ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Note: The list operation will show no running stack.:: - $ heat stack-delete teststack - $ heat stack-list + $ openstack stack delete teststack + $ openstack stack list You can explore other heat commands by referring to the `Heat chapter diff --git a/doc/source/template_guide/composition.rst b/doc/source/template_guide/composition.rst index 71cf207a9e..1176cf8cab 100644 --- a/doc/source/template_guide/composition.rst +++ b/doc/source/template_guide/composition.rst @@ -91,7 +91,7 @@ the ``key_name`` property of the new template. To create the stack run:: - $ heat stack-create -f main.yaml stack1 + $ openstack stack create -t main.yaml stack1 Define a new resource type @@ -128,7 +128,7 @@ You can now use the new ``OS::Nova::Server`` in your new template To create the stack run:: - $ heat stack-create -f main.yaml -e env.yaml example-two + $ openstack stack create -t main.yaml -e env.yaml example-two Get access to nested attributes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/source/template_guide/environment.rst b/doc/source/template_guide/environment.rst index 3ba3b57a23..b7faed80dd 100644 --- a/doc/source/template_guide/environment.rst +++ b/doc/source/template_guide/environment.rst @@ -52,16 +52,18 @@ It also can contain some other sections: Merge strategies for merging parameters and parameter defaults from the environment file. -Use the :option:`-e` option of the :command:`heat stack-create` command to +Use the :option:`-e` option of the :command:`openstack stack create` command to create a stack using the environment defined in such a file. You can also provide environment parameters as a list of key/value pairs using -the :option:`-P` option of the :command:`heat stack-create` command. +the :option:`--parameter` option of the :command:`openstack stack create` +command. In the following example the environment is read from the :file:`my_env.yaml` -file and an extra parameter is provided using the :option:`-P` option:: +file and an extra parameter is provided using the :option:`--parameter` +option:: - $ heat stack-create my_stack -e my_env.yaml -P "param1=val1;param2=val2" -f my_tmpl.yaml + $ openstack stack create my_stack -e my_env.yaml --parameter "param1=val1;param2=val2" -t my_tmpl.yaml Environment Merging ~~~~~~~~~~~~~~~~~~~ @@ -116,7 +118,7 @@ which is the time when these files are read. If the :file:`my_env.yaml` file from the example above had been put in the ``environment_dir`` then the user's command line could be this:: - heat stack-create my_stack -P "some_parm=bla" -f my_tmpl.yaml + openstack stack create my_stack --parameter "some_parm=bla" -t my_tmpl.yaml Global templates ---------------- diff --git a/doc/source/template_guide/functions.rst b/doc/source/template_guide/functions.rst index 7813ef637f..a220f4cd8d 100644 --- a/doc/source/template_guide/functions.rst +++ b/doc/source/template_guide/functions.rst @@ -303,7 +303,7 @@ To use it :: - $ heat stack-create -f top.yaml -e env.yaml + $ openstack stack create -t top.yaml -e env.yaml mystack What happened is the metadata in ``top.yaml`` (key: value, some: more