aws-must 0.0.5 → 0.0.6

data/demo/4/resourceInstance.mustache

@@ -3,6 +3,8 @@
 
 ++start++
 
+
+
 ## <a id="resourceInstance.mustache"></a>resourceInstance.mustache <a class='navigator' href='#top'">[top]</a>
 
 Create an EC2 instance
@@ -10,13 +12,15 @@ Create an EC2 instance
 **Attributes**: context=  `./resources/Instance`
 
 * `Name`: name of the EC2 instance to create
-* `ImageId`: AIM id to create
+* `InstanceType` : The instance type, such as t2.micro. 
 
 **Actions**:
 
+
 * **Name**:  `Name`
 * **Type**: 'AWS::EC2::Instance'
 * **ImageId**: `ImageId`
+* **SecurityGroups.Ref**: `SecurityGroup` if `SecurityGroup`
 
 ++close++
 
@@ -26,7 +30,8 @@ Create an EC2 instance
     "{{Name}}" : {
       "Type" : "AWS::EC2::Instance",
       "Properties" : {
-        "ImageId" : "{{ImageId}}",
-        "InstanceType" : "{{InstanceType}}"
-      } {{! Propertites }}
-    }{{_comma}}
+        "ImageId" : "{{ImageId}}"
+        , "InstanceType" : "{{InstanceType}}"
+        {{#SecurityGroup}}, "SecurityGroups" : [ { "Ref" : "{{SecurityGroup}}" } ]{{/SecurityGroup}}
+      }
+    }{{_comma}}

data/demo/4/resourceSecurityGroup.mustache

@@ -0,0 +1,37 @@
+{{!
+
+
+++start++
+
+
+## <a id="resourceSecurityGroup.mustache"></a>resourceSecurityGroup.mustache <a class='navigator' href='#top'">[top]</a>
+
+Create an EC2 Security Group
+
+**Attributes**: context=  `./resources/InstanceSecurityGroup`
+
+* `Name` : of the security group
+* `IngressCidrIp`: CIDR for to inbound traffic (ingress)
+
+**Actions**:
+
+* **Name**:  `Name`
+* **Type**: "AWS::EC2::SecurityGroup"
+* **Properties.SecurityGroupIngress[0].CidrIp**: `IngressCidrIp`
+
+++close++
+
+}}
+
+    "{{Name}}" : {
+      "Type" : "AWS::EC2::SecurityGroup",
+      "Properties" : {
+        "GroupDescription" : "Enable SSH access via port 22",
+        "SecurityGroupIngress" : [ {
+          "IpProtocol" : "tcp",
+          "FromPort" : "22",
+          "ToPort" : "22",
+          "CidrIp" : "{{IngressCidrIp}}"
+        } ]
+      }
+    }{{_comma}}

data/demo/4/root.mustache

@@ -37,9 +37,10 @@ CONTENT section
 
 # <a id="top">aws-must demo 4 template</a>
 
-Creates a EC2 instances using YAML configuration defining `ImageId`
-(e.g. ami-00dae61d) and `InstanceType` (e.g. t2.micro).
-
+Creates EC2 instances using YAML configuration defining `ImageId`
+(e.g. ami-00dae61d) and `InstanceType` (e.g. t2.micro).  Output
+section contains references to InstanceId and PublicId of the newly
+created EC2 instance.
 
 Supports only region `eu-central-1`. No ssh connection allowed by
 default.
@@ -49,6 +50,7 @@ default.
 * `InstanceType`: EC2 resource instance type, (default: t2.micro)
 
 
+
 ## Document Content
 
 This document is generated automically from `aws-must` -demo
@@ -68,25 +70,26 @@ each template, it
 * lists template actions, i.e.  output from template, or template
   inclusion
 
-## <a id="root.mustache"></a>root.mustache <a class='navigator' href='#top'">[top]</a>
-
 
-Root template 
+## <a id="root.mustache"></a>root.mustache <a class='navigator' href='#top'">[top]</a>
 
+Starting point of template rendering.
 
 **Attributes**: context= `.`
 
 * `description`: description for the CF template
 
-
 **Actions**:
 
 * **Description**: `description`
 * **include** <a href="#resources.mustache">resources.mustache</a>
 * **for** `resource` **in** `resource` **include** <a href="#resource.mustache">resource.mustache</a>
+* **for** `output` **in** `outputs` **include** <a href="#output.mustache">output.mustache</a>
+
 
 > resources
 > resource
+> output
 
 ++close++
 
@@ -97,13 +100,17 @@ Root template
 
   "Description" : "{{description}}",
 
-
-
   "Resources" : {
 
     {{> resources }}
     {{# resources }}{{> resource }}{{/ resources }}
 
+  },
+
+  "Outputs" : {
+
+    {{# outputs }}{{> output }}{{/ outputs }}
+
   }
 
 }

data/demo/5/conf.yaml

@@ -1,10 +1,10 @@
 -- demo/2 : added description property
 
 
-description: "demo/5: A simple Amazon EC2 instance created using aws-must tool
+description: "demo/6 - A simple Amazon EC2 instance created using aws-must tool
              - Minimum Viable Solution to Manage CloudFormation
-             Templates. This version adds Output section with references
-             to InstanceId and PublicId of the newly created EC2 instance'."
+             Templates. This version uses AWSInstanceType2Arch and AWSRegionArch2AMI 
+             to define 64bit hmv 't2.micro' instances AMIs for several Amazon regions."
 
 
 parameters:
@@ -19,7 +19,6 @@ resources:
 
         -  Instance: 
                  Name: &Resource_1 MyEC2Instance
-                 ImageId: ami-00dae61d
                  InstanceType: *Param_InstanceType
 
 

data/demo/5/output.mustache

@@ -5,7 +5,6 @@
 
 ## <a id="output.mustache"></a>output.mustache <a class='navigator' href='#top'">[top]</a>
 
-
 Create one output entry to CloudFormation JSON output section
 
 **Attributes**: context= `./outputs`
@@ -26,6 +25,8 @@ Create one output entry to CloudFormation JSON output section
 * **Value**: **Ref** if `Ref`
 * **Value**: `Attr.Ref`, `Attr.Name` if `Attr`
 
+
+
 ++close++
 
 }}

data/demo/5/resource.mustache

@@ -6,12 +6,14 @@
 
 ## <a id="resource.mustache"></a>resource.mustache <a class='navigator' href='#top'">[top]</a>
 
+
 Dispatches resource sub-type templates based resource Type propertys
 
 **Attributes**: context=  `./resources`
 
 * `Instance`: sub-document defining an EC instance
 
+
 **Actions**:
 
 * include <a href="#resourceInstance.mustache">resourceInstance.mustache</a> if `Instance` 
@@ -21,6 +23,7 @@ Dispatches resource sub-type templates based resource Type propertys
 ++close++
 
 
+
 }}
 
 {{# Instance }}{{> resourceInstance}}{{/ Instance }}

data/demo/5/resourceInstance.mustache

@@ -4,7 +4,6 @@
 ++start++
 
 
-
 ## <a id="resourceInstance.mustache"></a>resourceInstance.mustache <a class='navigator' href='#top'">[top]</a>
 
 Create an EC2 instance
@@ -14,12 +13,12 @@ Create an EC2 instance
 * `Name`: name of the EC2 instance to create
 * `InstanceType` : The instance type, such as t2.micro. 
 
-**Actions**:
 
+**Actions**:
 
 * **Name**:  `Name`
 * **Type**: 'AWS::EC2::Instance'
-* **ImageId**: `ImageId`
+* **ImageId**: **AWSRegionArch2AMI**( 'AWS::Region', **AWSInstanceType2Arch**(`InstanceType`))
 
 ++close++
 
@@ -29,7 +28,8 @@ Create an EC2 instance
     "{{Name}}" : {
       "Type" : "AWS::EC2::Instance",
       "Properties" : {
-        "ImageId" : "{{ImageId}}",
+        "ImageId" : { "Fn::FindInMap" : [ "AWSRegionArch2AMI", { "Ref" : "AWS::Region" },
+	 	    { "Fn::FindInMap" : [ "AWSInstanceType2Arch", "{{InstanceType}}", "Arch" ] } ] },
         "InstanceType" : "{{InstanceType}}"
       } {{! Propertites }}
     }{{_comma}}

data/demo/5/resources.mustache

@@ -2,9 +2,19 @@
 
 ++start++
 
-## resources.mustache
+## <a id="resources.mustache"></a>resources.mustache <a class='navigator' href='#top'">[top]</a>
+
+Empty template.
+
+**Attributes**: context=  `.`
+
+* none
+
+
+**Actions**:
+
+* no action (i.e. empty template)
 
-Nothing created here
 
 ++close++
 

data/demo/5/root.mustache

@@ -7,7 +7,6 @@ STYLE section
 ==================================================================
 
 ++start++
-
 <style>
 h1 {
     color:blue; 
@@ -21,6 +20,9 @@ h3 {
       color:blue;
       font-size: 1.5em;
    }
+.navigator {
+      font-size: 0.5em;
+   }
 body {
     background-color: #b0c4de;
 } 
@@ -37,20 +39,20 @@ CONTENT section
 
 # <a id="top">aws-must demo 5 template</a>
 
-Creates EC2 instances using YAML configuration defining `ImageId`
-(e.g. ami-00dae61d) and `InstanceType` (e.g. t2.micro).  Output
-section contains references to InstanceId and PublicId of the newly
-created EC2 instance.
-
-Supports only region `eu-central-1`. No ssh connection allowed by
-default.
+Creates EC2 instances using YAML configuration defining `InstanceType`
+(e.g. t2.micro).  `ImageId` of the AMI is determined using
+CloudFormation mapping on `InstanceType` and region. Supported regions
+are ap-northeast-1, ap-southeast-1, ap-southeast-2, cn-north-1,
+eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1,
+us-west-1, us-west-2.  Output section contains references to
+InstanceId and PublicId of the newly created EC2 instance.
 
 **Parameters**:
 
 * `InstanceType`: EC2 resource instance type, (default: t2.micro)
 
 
-
+No ssh connection allowed by default.
 
 ## Document Content
 
@@ -71,6 +73,30 @@ each template, it
 * lists template actions, i.e.  output from template, or template
   inclusion
 
+### Table of contents
+<ul>
+
+<li><a href="#root.mustache">root.mustache</a>: root template =
+starting point of template rendering</li>
+
+<li><a href="#mappings.mustache">mappings.mustache</a>matches a key to
+a corresponding set of named values</li>
+
+<li>Resources</li>
+
+<ul>
+
+<li><a href="#resources.mustache">resources.mustache</a>: fixed
+resources</li>
+
+<li><a href="#resource.mustache">resource.mustache</a>: dispatch
+resource based on resource type</li> <li><a
+href="#resourceInstance.mustache">resourceInstance.mustache</a>create
+an EC2 instance</li>
+
+</ul><li><a href="#output.mustache">output.mustache</a>:values in
+response to describe stack calls </li> </ul>
+
 
 ## <a id="root.mustache"></a>root.mustache <a class='navigator' href='#top'">[top]</a>
 
@@ -83,15 +109,18 @@ Starting point of template rendering.
 **Actions**:
 
 * **Description**: `description`
+* **include** <a href="#mappings.mustache">mappings.mustache</a>
 * **include** <a href="#resources.mustache">resources.mustache</a>
 * **for** `resource` **in** `resource` **include** <a href="#resource.mustache">resource.mustache</a>
 * **for** `output` **in** `outputs` **include** <a href="#output.mustache">output.mustache</a>
 
 
+> mappings
 > resources
 > resource
 > output
 
+
 ++close++
 
 }}
@@ -101,6 +130,10 @@ Starting point of template rendering.
 
   "Description" : "{{description}}",
 
+  "Mappings" : {
+    {{> mappings }}
+   },
+
   "Resources" : {
 
     {{> resources }}

data/demo/6/conf.yaml

@@ -1,11 +1,5 @@
--- demo/2 : added description property
-
-
-description: "demo/6 - A simple Amazon EC2 instance created using aws-must tool
-             - Minimum Viable Solution to Manage CloudFormation
-             Templates. This version uses AWSInstanceType2Arch and AWSRegionArch2AMI 
-             to define 64bit hmv 't2.micro' instances AMIs for several Amazon regions."
 
+description: "demo/6 - A simple Amazon EC2 instance created using aws-must tool"
 
 parameters:
 
@@ -14,18 +8,43 @@ parameters:
            Description: EC2 reousrce instance type
            Value: &Param_InstanceType t2.micro
 
+        -  Name: &Param_KeyName KeyName
+           Type: "AWS::EC2::KeyPair::KeyName"
+           Description: Name of an existing EC2 KeyPair to enable SSH access to the instance
+           Value: demo-key
+
+        -  Name: &Param_SSHLocation  SSHLocation
+           Type: String
+           Description: The IP address range that can be used to SSH to the EC2 instances
+           Value: "0.0.0.0/0"
+
 
 resources:
 
+        - InstanceSecurityGroup:
+                 Name: &DefaultSG MyDefaultSecurityGroup
+                 IngressRef: *Param_SSHLocation
+
         -  Instance: 
                  Name: &Resource_1 MyEC2Instance
                  InstanceType: *Param_InstanceType
+                 KeyName: *Param_KeyName
+                 SecurityGroup: *DefaultSG
+                 tags:
+                    - Key: demotag1
+                      Value: demotag1 value
 
 
 outputs:
 
-        -  Name: InstanceId1
+        -  Name: Instance1
            Description: InstanceId of the newly created EC2 instance
            Ref:  *Resource_1
 
 
+        -  Name: IP1
+           Description: Public IP address of the newly created EC2 instance
+           Attr: 
+                 Ref: *Resource_1
+                 Name: PublicIp
+

data/demo/6/resource.mustache

@@ -12,13 +12,21 @@ Dispatches resource sub-type templates based resource Type propertys
 **Attributes**: context=  `./resources`
 
 * `Instance`: sub-document defining an EC instance
+* `SecurityGroup`: sub-document defining an <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html">AWS::EC2::SecurityGroup</a>
 
 
 **Actions**:
 
-* include <a href="#resourceInstance.mustache">resourceInstance.mustache</a> if `Instance` 
+* **include** <a href="#resourceInstance.mustache">resourceInstance.mustache</a> **if** `Instance` 
+* **include** <a href="#resourceSecurityGroup.mustache">resourceSecurityGroup.mustache</a> **if** `SecurityGroup` 
+
+
+**Included resources**
+
+* `resourceInstance`
 
 > resourceInstance
+> resourceSecurityGroup.mustache
 
 ++close++
 
@@ -27,3 +35,4 @@ Dispatches resource sub-type templates based resource Type propertys
 }}
 
 {{# Instance }}{{> resourceInstance}}{{/ Instance }}
+{{# InstanceSecurityGroup }}{{> resourceSecurityGroup}}{{/ InstanceSecurityGroup }}

data/demo/6/resourceInstance.mustache

@@ -12,13 +12,20 @@ Create an EC2 instance
 
 * `Name`: name of the EC2 instance to create
 * `InstanceType` : The instance type, such as t2.micro. 
+* `tags` : array of tag sub-documents for EC2 instance
 
 
 **Actions**:
 
 * **Name**:  `Name`
 * **Type**: 'AWS::EC2::Instance'
+* **for** `tag` **in** `tags` **include**  <a href="#tag.mustache">tag.mustache</a>
+* **SecurityGroups.Ref**: `SecurityGroup` if `SecurityGroup`
 * **ImageId**: **AWSRegionArch2AMI**( 'AWS::Region', **AWSInstanceType2Arch**(`InstanceType`))
+* **KeyName**: `KeyName` if `KeyName`
+
+> tag
+
 
 ++close++
 
@@ -29,7 +36,10 @@ Create an EC2 instance
       "Type" : "AWS::EC2::Instance",
       "Properties" : {
         "ImageId" : { "Fn::FindInMap" : [ "AWSRegionArch2AMI", { "Ref" : "AWS::Region" },
-	 	    { "Fn::FindInMap" : [ "AWSInstanceType2Arch", "{{InstanceType}}", "Arch" ] } ] },
-        "InstanceType" : "{{InstanceType}}"
-      } {{! Propertites }}
+	 	    { "Fn::FindInMap" : [ "AWSInstanceType2Arch", "{{InstanceType}}", "Arch" ] } ] }
+        , "InstanceType" : "{{InstanceType}}"
+        , "Tags" : [ {{#tags}}{{>tag}}{{/tags}} ]
+        {{#SecurityGroup}}, "SecurityGroups" : [ { "Ref" : "{{SecurityGroup}}" } ]{{/SecurityGroup}}
+        {{#KeyName}}, "KeyName" : { "Ref" : "{{KeyName}}" }{{/KeyName}}
+      } 
     }{{_comma}}

data/demo/6/root.mustache

@@ -39,20 +39,29 @@ CONTENT section
 
 # <a id="top">aws-must demo 6 template</a>
 
-Creates EC2 instances using YAML configuration defining `InstanceType`
-(e.g. t2.micro).  `ImageId` of the AMI is determined using
-CloudFormation mapping on `InstanceType` and region. Supported regions
-are ap-northeast-1, ap-southeast-1, ap-southeast-2, cn-north-1,
-eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1,
-us-west-1, us-west-2.  Output section contains references to
-InstanceId and PublicId of the newly created EC2 instance.
+Creates 
 
-**Parameters**:
+* **EC2 SecurityGroup** allowing ssh via port 22 from a location given
+    as `SSHLocation` parameter
 
-* `InstanceType`: EC2 resource instance type, (default: t2.micro)
+* **EC2 instances** using YAML parameter `InstanceType`
+  (e.g. t2.micro).
+
+  * `ImageId` of the AMI is determined using CloudFormation mapping on
+    `InstanceType` and region. Supported regions are ap-northeast-1,
+    ap-southeast-1, ap-southeast-2, cn-north-1, eu-central-1,
+    eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1,
+    us-west-2.  
+
+  * output section contains references to InstanceId and PublicId of
+    the newly created EC2 instance.
 
 
-No ssh connection allowed by default.
+**Parameters**:
+
+* `InstanceType`: EC2 resource instance type, (default: t2.micro)
+* `KeyName` : Name of an existing EC2 KeyPair to enable SSH access to the instance, (default: demo-key)
+* `SSHLocation`: The IP address range that can be used to SSH to the EC2 instances default: 0.0.0.0/0)
 
 ## Document Content
 
@@ -68,7 +77,7 @@ each template, it
 * gives a general description of the template
 
 * documents the attribute context e.g. `.` or `./resources/Instance`,
-  and attributes references of the template
+  and attributes referenced within the template
 
 * lists template actions, i.e.  output from template, or template
   inclusion
@@ -79,6 +88,9 @@ each template, it
 <li><a href="#root.mustache">root.mustache</a>: root template =
 starting point of template rendering</li>
 
+<li><a href="#parameter.mustache">parameter.mustache</a>: create one
+parameter entry to CloudFormation JSON parameter section</li>
+
 <li><a href="#mappings.mustache">mappings.mustache</a>matches a key to
 a corresponding set of named values</li>
 
@@ -90,11 +102,22 @@ a corresponding set of named values</li>
 resources</li>
 
 <li><a href="#resource.mustache">resource.mustache</a>: dispatch
-resource based on resource type</li> <li><a
-href="#resourceInstance.mustache">resourceInstance.mustache</a>create
-an EC2 instance</li>
+resource based on resource type</li>
 
-</ul><li><a href="#output.mustache">output.mustache</a>:values in
+<ul> <li><a
+href="#resourceSecurityGroup.mustache">resourceSecurityGroup.mustache.mustache</a>:
+create an security group for accessing EC2 instances</li>
+
+<li><a
+href="#resourceInstance.mustache">resourceInstance.mustache</a>:
+create an EC2 instance</li>
+
+<ul><li><a href="#tag.mustache">tag.mustache</a>: add key-value tag property
+to an</li><ul>
+
+</ul></ul></ul></ul>
+
+<li><a href="#output.mustache">output.mustache</a>: values in
 response to describe stack calls </li> </ul>
 
 
@@ -105,16 +128,22 @@ Starting point of template rendering.
 **Attributes**: context= `.`
 
 * `description`: description for the CF template
+* `parameters`: array of parameter sub-documents for CloudFormation Parameters -section
+* `resources`: array of resource sub-documents for CloudFormation Resources -section
+* `outputs`: array of output sub-documents for CloudFormation Outputs -section
+
 
 **Actions**:
 
 * **Description**: `description`
+* **for** `parameter` **in** `parameters`  **include** <a href="#parameter.mustache">parameter.mustache</a>
 * **include** <a href="#mappings.mustache">mappings.mustache</a>
 * **include** <a href="#resources.mustache">resources.mustache</a>
 * **for** `resource` **in** `resource` **include** <a href="#resource.mustache">resource.mustache</a>
 * **for** `output` **in** `outputs` **include** <a href="#output.mustache">output.mustache</a>
 
 
+> parameter
 > mappings
 > resources
 > resource
@@ -130,6 +159,10 @@ Starting point of template rendering.
 
   "Description" : "{{description}}",
 
+  "Parameters" : {
+    {{# parameters }}{{> parameter }}{{/ parameters }}
+  },
+
   "Mappings" : {
     {{> mappings }}
    },

data/demo/7/conf.yaml

@@ -1,9 +1,7 @@
--- demo/2 : added description property
-
 
 description: "demo/7 - A simple Amazon EC2 instance created using aws-must tool
              - Minimum Viable Solution to Manage CloudFormation
-             Templates. This adds support for EC2 intance tags, parameters, and security group"
+             Templates. Adds support installing Chef"
 
 parameters:
 
@@ -22,6 +20,11 @@ parameters:
            Description: The IP address range that can be used to SSH to the EC2 instances
            Value: "0.0.0.0/0"
 
+        -  Name: ChefVersion
+           Type: String
+           Description: Chef version to install
+           Value: &Param_ChefVersion 11.18
+
 
 resources:
 
@@ -34,6 +37,8 @@ resources:
                  InstanceType: *Param_InstanceType
                  KeyName: *Param_KeyName
                  SecurityGroup: *DefaultSG
+                 InstallChef: 
+                    - Version: *Param_ChefVersion
                  tags:
                     - Key: demotag1
                       Value: demotag1 value