openstack/heat
Code Issues Proposed changes

Fix docs for Hello World and WP Single templates

Browse Source 
This fixes the existing parameter names and adds missing ones for the
HOT Hello World doc page. It also updates the description of parameters
for the CFN WP Single Instance to match those of the template.

Closes-Bug: #1461515
Change-Id: Ic8ac05c1dcc3f54ec1a88dc391d32ce877931084
This commit is contained in:
Anderson Mesquita 2015-08-27 11:16:30 -07:00
parent f8f4307f66
commit 31e970c45d
2 changed files with 29 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/source/templates/cfn/WordPress_Single_Instance.rst
View File

@ -17,7 +17,10 @@ https://github.com/openstack/heat-templates/blob/master/cfn/F18/WordPress_Single
Description Description
----------- -----------
AWS CloudFormation Sample Template WordPress_Single_Instance: WordPress is web software you can use to create a beautiful website or blog. This template installs a single-instance WordPress deployment using a local MySQL database to store the data. AWS CloudFormation Sample Template WordPress_Single_Instance: WordPress is web
software you can use to create a beautiful website or blog. This template
installs a single-instance WordPress deployment using a local MySQL database to
store the data.
Parameters Parameters
@ -26,34 +29,34 @@ Parameters
*type* *type*
*string* *string*
*description* *description*
*Name* of an existing key pair to use for the instance Name of an existing EC2 KeyPair to enable SSH access to the instance
*InstanceType* :mod:`(optional)` *InstanceType* :mod:`(optional)`
*type* *type*
*string* *string*
*description* *description*
*Instance type* for the instance to be created The EC2 instance type
*DBName* :mod:`(optional)` *DBName* :mod:`(optional)`
*type* *type*
*string* *string*
*description* *description*
*The WordPress database name* The WordPress database name
*DBUsernameName* :mod:`(optional)` *DBUsernameName* :mod:`(optional)`
*type* *type*
*string* *string*
*description* *description*
*The WordPress database admin account username* The WordPress database admin account username
*DBPassword* :mod:`(optional)` *DBPassword* :mod:`(optional)`
*type* *type*
*string* *string*
*description* *description*
*The WordPress database admin account password* The WordPress database admin account password
*DBRootPassword* :mod:`(optional)` *DBRootPassword* :mod:`(optional)`
*type* *type*
*string* *string*
*description* *description*
*Root password for MySQL* Root password for MySQL
*LinuxDistribution* :mod:`(optional)` *LinuxDistribution* :mod:`(optional)`
*type* *type*
*string* *string*
*description* *description*
*Distribution of choice* Linux distribution of choice

26
doc/source/templates/hot/hello_world.rst
View File

@ -17,24 +17,34 @@ https://github.com/openstack/heat-templates/blob/master/hot/hello_world.yaml
Description Description
----------- -----------
Hello world HOT template that just defines a single compute instance. Hello world HOT template that just defines a single compute instance. Contains
Contains just base features to verify base HOT support. just base features to verify base HOT support.
Parameters Parameters
---------- ----------
*KeyName* :mod:`(required)` *key_name* :mod:`(required)`
*type* *type*
*string* *string*
*description* *description*
*Name* of an existing key pair to use for the instance Name of an existing key pair to use for the instance
*InstanceType* :mod:`(required)` *flavor* :mod:`(optional)`
*type* *type*
*string* *string*
*description* *description*
*Instance type* for the instance to be created Flavor for the instance to be created
*ImageId* :mod:`(required)` *image* :mod:`(required)`
*type* *type*
*string* *string*
*description* *description*
*ID* of the image to use for the instance Image *ID* or image name to use for the instance
*admin_pass* :mod:`(required)`
*type*
*string*
*description*
The admin password for the instance
*db_port* :mod:`(optional)`
*type*
*number*
*description*
The database port number