From d5622fee4b38aa461526c657ccd54f6d9e7e0870 Mon Sep 17 00:00:00 2001 From: sdake Date: Sat, 16 Feb 2013 14:12:24 -0700 Subject: [PATCH] Add information about using the python-heatclient to the documentation Adds information about using python-heatclient. Fixes Bug: #127498 Change-Id: I77d161a5a7c8f0bed9653681d8f4b5aa513e7086 --- docs/GettingStarted.rst | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/docs/GettingStarted.rst b/docs/GettingStarted.rst index faab1fdd..911efd7e 100644 --- a/docs/GettingStarted.rst +++ b/docs/GettingStarted.rst @@ -344,6 +344,35 @@ Further information on using the heat cloudwatch features is available in the Us .. _Using-Cloudwatch: http://wiki.openstack.org/Heat/Using-CloudWatch +Using the OpenStack Heat API +============================ + +CloudFormation (heat-api-cfn) and a native OpenStack Heat API (heat-api) are provided. To use the recommended Heat API, a python client library is necessary. To use this library, clone the python-heatclient repository_ from GitHub at ``git://github.com/openstack/python-heatclient.git`. + +Install python-heatclient from source +------------------------------------- + +In the python-heatclient directory, run the install script:: + + sudo ./setup.py install + +Note that python-heatclient may be installed on a different server than heat itself. +Note that pip can be used to install python-heatclient, but the instructions vary for each distribution. Read your distribution documentation if you wish to install with pip. + +Start the OpenStack specific Heat API +------------------------------------- + +When using heat-pythonclient, the OpenStack API service provided by heat must be started:: + + sudo bash -c 'heat-api &' + +List stacks +----------- + +:: + + heat stack-list + Troubleshooting =============== -- 2.45.2