heat/doc/source/getting_started/on_devstack.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

82 lines
3.1 KiB
ReStructuredText

..
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
Heat and DevStack
=================
Heat is fully integrated into DevStack. This is a convenient way to try out or develop heat alongside the current development state of all the other OpenStack projects. Heat on DevStack works on both Ubuntu and Fedora.
These instructions assume you already have a working DevStack installation which can launch basic instances.
Configure DevStack to enable Heat
---------------------------------
Heat is configured by default on devstack for Icehouse and Juno releases.
Newer versions of OpenStack require enabling heat services in devstack
`local.conf`.
Add the following to `[[local|localrc]]` section of `local.conf`::
[[local|localrc]]
#Enable heat services
enable_service h-eng h-api h-api-cfn h-api-cw
It would also be useful to automatically download and register
a VM image that Heat can launch. To do that add the following to your
devstack `localrc`::
IMAGE_URLS+=",http://download.fedoraproject.org/pub/fedora/linux/releases/21/Cloud/Images/x86_64/Fedora-Cloud-Base-20141203-21.x86_64.qcow2"
URLs for any cloud image may be specified, but fedora images from F20 contain the heat-cfntools package which is required for some heat functionality.
That is all the configuration that is required. When you run `./stack.sh` the Heat processes will be launched in `screen` with the labels prefixed with `h-`.
Configure DevStack to enable Ceilometer (if using Alarms)
---------------------------------------------------------
To use Ceilometer Alarms you need to enable Ceilometer in devstack.
Adding the following lines to your `localrc` file will enable the ceilometer services::
CEILOMETER_BACKEND=mongodb
enable_plugin ceilometer git://git.openstack.org/openstack/ceilometer
Configure DevStack to enable OSprofiler
---------------------------------------
Add the profiler notifier to your Ceilometer to your config::
CEILOMETER_NOTIFICATION_TOPICS=notifications,profiler
Enable the profiler in /etc/heat/heat.conf::
$ echo -e "[profiler]\nprofiler_enabled = True\ntrace_sqlalchemy = True\n" >> /etc/heat/heat.conf
Change the default hmac_key in /etc/heat/api-paste.ini::
$ sed -i "s/hmac_keys =.*/hmac_keys = SECRET_KEY/" /etc/heat/api-paste.ini
Run any command with --profile SECRET_KEY::
$ heat --profile SECRET_KEY stack-list
# it will print <Trace ID>
Get pretty HTML with traces::
$ osprofiler trace show --html <Profile ID>
Note that osprofiler should be run with the admin user name & tenant.
Create a stack
--------------
Now that you have a working Heat environment you can go to
:ref:`create-a-stack`.