deb-heat/doc/source/getting_started/create_a_stack.rst
Steve Baker a2d1b7ee38 Aim first doc link list at end users
This change renames the first doc link section Getting Started to
Using Heat and makes the content relevant to end users of Heat.

End users author templates, create stacks, and use the heat CLI.
They are not necessarily interested in installing heat from packages or
devstack.

This change breaks out the basic create-stack content into its own page
and links to that from the first Using Heat contents list. The rest of
the getting started content is moved to the Developers section for now,
pending later changes aimed at developers and operators.

Change-Id: I79988e08864c5a87ebc4f8f5a39102d50b26f748
2015-10-06 11:38:14 +13:00

3.5 KiB

Creating your first stack

Confirming you can access a Heat endpoint

Before any Heat commands can be run, your cloud credentials need to be sourced:

$ source openrc

You can confirm that Heat is available with this command:

$ heat stack-list

This should return an empty line

Preparing to create a stack

Your cloud will have different flavors and images available for launching instances, you can discover what is available by running:

$ openstack flavor list
$ openstack image list

To allow you to SSH into instances launched by Heat, a keypair will be generated:

$ openstack keypair create heat_key > heat_key.priv
$ chmod 600 heat_key.priv

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

Which will respond:

+--------------------------------------+-----------+--------------------+----------------------+
| ID                                   | Name      | Status             | Created              |
+--------------------------------------+-----------+--------------------+----------------------+
| (uuid)                               | teststack | CREATE_IN_PROGRESS | (timestamp)          |
+--------------------------------------+-----------+--------------------+----------------------+

List stacks

List the stacks in your tenant:

$ heat stack-list

List stack events

List the events related to a particular stack:

$ heat event-list teststack

Describe the wordpress stack

Show detailed state of a stack:

$ heat stack-show teststack

Note: After a few seconds, the stack_status should change from IN_PROGRESS to CREATE_COMPLETE.

Verify instance creation

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:

$ WebsiteURL=$(heat output-show --format raw teststack WebsiteURL)
$ curl $WebsiteURL

Delete the instance when done

Note: The list operation will show no running stack.:

$ heat stack-delete teststack
$ heat stack-list

You can explore other heat commands by refering to the Heat chapter of the OpenStack Command-Line Interface Reference then read the template-guide and start authoring your own templates.