openstack/heat
Code Issues Proposed changes

Merge "Fix docs for Hello World and WP Single templates"

Browse Source
This commit is contained in:
Jenkins 2015-09-01 06:26:48 +00:00 committed by Gerrit Code Review
commit a1575bfe95
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
-----------
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
@ -26,34 +29,34 @@ Parameters
*type*
*string*
*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)`
*type*
*string*
*description*
*Instance type* for the instance to be created
The EC2 instance type
*DBName* :mod:`(optional)`
*type*
*string*
*description*
*The WordPress database name*
The WordPress database name
*DBUsernameName* :mod:`(optional)`
*type*
*string*
*description*
*The WordPress database admin account username*
The WordPress database admin account username
*DBPassword* :mod:`(optional)`
*type*
*string*
*description*
*The WordPress database admin account password*
The WordPress database admin account password
*DBRootPassword* :mod:`(optional)`
*type*
*string*
*description*
*Root password for MySQL*
Root password for MySQL
*LinuxDistribution* :mod:`(optional)`
*type*
*string*
*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
-----------
Hello world HOT template that just defines a single compute instance.
Contains just base features to verify base HOT support.
Hello world HOT template that just defines a single compute instance. Contains
just base features to verify base HOT support.
Parameters
----------
*KeyName* :mod:`(required)`
*key_name* :mod:`(required)`
*type*
*string*
*description*
*Name* of an existing key pair to use for the instance
*InstanceType* :mod:`(required)`
Name of an existing key pair to use for the instance
*flavor* :mod:`(optional)`
*type*
*string*
*description*
*Instance type* for the instance to be created
*ImageId* :mod:`(required)`
Flavor for the instance to be created
*image* :mod:`(required)`
*type*
*string*
*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