From 31e970c45df249800cc22afa239ab5512f680e40 Mon Sep 17 00:00:00 2001 From: Anderson Mesquita Date: Thu, 27 Aug 2015 11:16:30 -0700 Subject: [PATCH] Fix docs for Hello World and WP Single templates 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 --- .../cfn/WordPress_Single_Instance.rst | 19 ++++++++------ doc/source/templates/hot/hello_world.rst | 26 +++++++++++++------ 2 files changed, 29 insertions(+), 16 deletions(-) diff --git a/doc/source/templates/cfn/WordPress_Single_Instance.rst b/doc/source/templates/cfn/WordPress_Single_Instance.rst index e49412ae6..2a7c68630 100644 --- a/doc/source/templates/cfn/WordPress_Single_Instance.rst +++ b/doc/source/templates/cfn/WordPress_Single_Instance.rst @@ -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 diff --git a/doc/source/templates/hot/hello_world.rst b/doc/source/templates/hot/hello_world.rst index 1da82daca..8cff0adbf 100644 --- a/doc/source/templates/hot/hello_world.rst +++ b/doc/source/templates/hot/hello_world.rst @@ -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