openstack/heat
Code Issues Proposed changes

Fix various Sphinx errors/warnings

Browse Source 
Change-Id: If34202291b5605302baf47c210b07ffc4ffad094
This commit is contained in:
Dirk Mueller 2013-06-10 23:49:40 +02:00
parent 9f40fa3e61
commit f4df0b186a
4 changed files with 26 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
doc/source/getting_started/on_devstack.rst
View File

@ -19,12 +19,13 @@ These instructions assume you already have a working DevStack installation which
Configure DevStack to enable Heat Configure DevStack to enable Heat
--------------------------------- ---------------------------------
Adding the following line to your `localrc` file will enable the heat services Adding the following line to your `localrc` file will enable the heat services::
::
ENABLED_SERVICES+=,heat,h-api,h-api-cfn,h-api-cw,h-eng ENABLED_SERVICES+=,heat,h-api,h-api-cfn,h-api-cw,h-eng
It would also be useful to automatically download and register a VM image that Heat can launch. It would also be useful to automatically download and register
:: a VM image that Heat can launch::
IMAGE_URLS+=",http://fedorapeople.org/groups/heat/prebuilt-jeos-images/F17-x86_64-cfntools.qcow2,http://fedorapeople.org/groups/heat/prebuilt-jeos-images/F17-i386-cfntools.qcow2" IMAGE_URLS+=",http://fedorapeople.org/groups/heat/prebuilt-jeos-images/F17-x86_64-cfntools.qcow2,http://fedorapeople.org/groups/heat/prebuilt-jeos-images/F17-i386-cfntools.qcow2"
URLs for any of [http://fedorapeople.org/groups/heat/prebuilt-jeos-images/ these prebuilt JEOS images] can be specified. URLs for any of [http://fedorapeople.org/groups/heat/prebuilt-jeos-images/ these prebuilt JEOS images] can be specified.
@ -33,25 +34,30 @@ That is all the configuration that is required. When you run `./stack.sh` the He
Confirming heat is responding Confirming heat is responding
----------------------------- -----------------------------
Before any heat commands can be run, the authentication environment needs to be loaded
:: Before any heat commands can be run, the authentication environment
needs to be loaded::
source openrc source openrc
You can confirm that Heat is running and responding with this command You can confirm that Heat is running and responding
:: with this command::
heat stack-list heat stack-list
This should return an empty line This should return an empty line
Preparing Nova for running stacks Preparing Nova for running stacks
--------------------------------- ---------------------------------
Enabling Heat in devstack will replace the default Nova flavors with flavours that the Heat example templates expect. You can see what those flavors are by running
:: Enabling Heat in devstack will replace the default Nova flavors with
flavours that the Heat example templates expect. You can see what
those flavors are by running::
nova flavor-list nova flavor-list
Heat needs to launch instances with a keypair, so we need to generate one Heat needs to launch instances with a keypair, so we need
:: to generate one::
nova keypair-add heat_key > heat_key.priv nova keypair-add heat_key > heat_key.priv
chmod 600 heat_key.priv chmod 600 heat_key.priv

3
doc/source/getting_started/on_ubuntu.rst
View File

@ -124,7 +124,8 @@ Create the keystone authentication parameters
sudo -E ./bin/heat-keystone-setup sudo -E ./bin/heat-keystone-setup
Download or alternatively generate a JEOS image Download or alternatively generate a JEOS image
---------------------------------------------- ------------------------------------------------
It is possible to either use an image-building tool to create an image or download a prebuilt image of a desired distribution. It is possible to either use an image-building tool to create an image or download a prebuilt image of a desired distribution.
Download a prebuilt image and copy to libvirt images location Download a prebuilt image and copy to libvirt images location

4
doc/source/man/heat-keystone-setup.rst
View File

@ -1,6 +1,6 @@
======== ===================
heat-keystone-setup heat-keystone-setup
======== ===================
.. program:: heat-keystone-setup .. program:: heat-keystone-setup

4
doc/source/man/index.rst
View File

@ -22,3 +22,7 @@ Heat utilities
:maxdepth: 2 :maxdepth: 2
heat-cfn heat-cfn
heat-boto
heat-watch
heat-db-setup
heat-keystone-setup