aws-must 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83a3b8fd5dea520c1d5531c6346279f428945533
-  data.tar.gz: ff8eb51f3a9c3f0e07eb77356c58e3693ef03136
+  metadata.gz: b89b1de055c4e34d2236dfc4cf7b9e76b1b092ad
+  data.tar.gz: a225139880451b8b2509b1c20e78fa578d585d0d
 SHA512:
-  metadata.gz: f5cbb6189e5aa14f9cbc8e136ea0603e0a33919729edcbbe8705a9a0924a9a58e046b7cb1730be854b4f8d89ae82878994593a2b647408d52e2bcbc598042301
-  data.tar.gz: 7bf6fb2a8410596e44a0619d7e3a2baa938d36800c66a92d1a2ba0d3da0ec5b608680011a29502f2a320ef87ad522a5c410cf11652fa572d574d8c7afde9a98a
+  metadata.gz: 9429a6f6b26fb185849cb335c3ac0cbc8f99ac38a9aa42a40eb3686eb195ed6faff1d6c1eba5ab08d9b49abd8c8e6fa535018ed244c78ec26f6febef8a0759c3
+  data.tar.gz: e9b056172c1fa74ceaa799fcaaebef1908cc5681793e11dbd5cc954d73ce335b0f7ad843b3751237a2ce9c58ae3a1fe8d571c4938edc263b843009dbda21cd4f

data/README.md

@@ -1,4 +1,4 @@
-# aws-must - Minimum Viable Solution to Manage CloudFormation Templates - $Release:0.0.4$
+# aws-must - Minimum Viable Solution to Manage CloudFormation Templates - $Release:0.0.5$
 
 `aws-must` is a tool, which allows separating infrastructure
 configuration and Amazon related syntax in CloudFormation JSON

data/demo/1/root.mustache

@@ -1,9 +1,10 @@
 {{!
 +++start+++
 
-# <a id="top">aws-must demo 1 templates</a>
+# <a id="top">aws-must demo 1 template</a>
 
-**No documentation yet**
+Create a `t2.micro` EC2 instance for AMI `ami-00dae61d`.  Supports
+only region `eu-central-1`. No ssh connection allowed by default.
 
 +++close+++
 }}

data/demo/2/root.mustache

@@ -17,7 +17,7 @@ body {
 </style>
 
 
-# <a id="top">aws-must demo 2 templates</a>
+# <a id="top">aws-must demo 2 template</a>
 
 ## root.mustache
 
@@ -26,7 +26,38 @@ Create an EC2 with following fixed parameters
 * `ImageId` : "ami-00dae61d",
 * `InstanceType` : "t2.micro"
 
-**Attributes**:
+Supports only region `eu-central-1`. No ssh connection allowed by
+default.
+
+**Parameters**:
+
+* no parameters
+
+
+## Document Content
+
+This document is generated automically from `aws-must` -demo
+templates. 
+
+
+Output contains markdown syntax between
+**&plus;&plus;start&plus;&plus;** and
+**&plus;&plus;close&plus;&plus;** -tags from the template files. For
+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
+
+* 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>
+
+
+**Attributes**: context= `.`
 
 * `description`: description for the CF template
 

data/demo/3/root.mustache

@@ -27,10 +27,26 @@ CONTENT section
 
 ++start++
 
-# <a id="top">aws-must demo 3 templates</a>
+# <a id="top">aws-must demo 3 template</a>
+
+Create an EC2 with following fixed parnameters
+
+* `ImageId` : "ami-00dae61d",
+* `InstanceType` : "t2.micro"
+
+
+Supports only region `eu-central-1`. No ssh connection allowed by
+default.
+
+**Parameters**:
+
+* no parameters
+
+
+## Document Content
 
 This document is generated automically from `aws-must` -demo
-templates. 
+templates.
 
 
 Output contains markdown syntax between

data/demo/4/root.mustache

@@ -35,7 +35,21 @@ CONTENT section
 
 ++start++
 
-# <a id="top">aws-must demo 4 templates</a>
+# <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).
+
+
+Supports only region `eu-central-1`. No ssh connection allowed by
+default.
+
+**Parameters**:
+
+* `InstanceType`: EC2 resource instance type, (default: t2.micro)
+
+
+## Document Content
 
 This document is generated automically from `aws-must` -demo
 templates. 

data/demo/5/root.mustache

@@ -35,7 +35,24 @@ CONTENT section
 
 ++start++
 
-# <a id="top">aws-must demo 5 templates</a>
+# <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.
+
+**Parameters**:
+
+* `InstanceType`: EC2 resource instance type, (default: t2.micro)
+
+
+
+
+## Document Content
 
 This document is generated automically from `aws-must` -demo
 templates. 

data/demo/6/root.mustache

@@ -37,7 +37,24 @@ CONTENT section
 
 ++start++
 
-# <a id="top">aws-must demo 6 templates</a>
+# <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.
+
+**Parameters**:
+
+* `InstanceType`: EC2 resource instance type, (default: t2.micro)
+
+
+No ssh connection allowed by default.
+
+## Document Content
 
 This document is generated automically from `aws-must` -demo
 templates. 

data/demo/7/root.mustache

@@ -37,7 +37,33 @@ CONTENT section
 
 ++start++
 
-# <a id="top">aws-must demo 7 templates</a>
+# <a id="top">aws-must demo 7 template</a>
+
+Creates 
+
+* **EC2 SecurityGroup** allowing ssh via port 22 from a location given
+    as `SSHLocation` parameter
+
+* **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.
+
+
+**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
 
 This document is generated automically from `aws-must` -demo
 templates. 

data/demo/8/root.mustache

@@ -37,7 +37,38 @@ CONTENT section
 
 ++start++
 
-# <a id="top">aws-must demo 8 templates</a>
+# <a id="top">aws-must demo 8 template</a>
+
+Creates 
+
+* **EC2 SecurityGroup** allowing ssh via port 22 from a location
+    given as `SSHLocation` parameter
+
+
+* **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.  
+
+  * optionally installs Chef to the EC2 instance with a version given
+    as `ChefVersion` parameter
+
+  * output section contains references to InstanceId and PublicId of
+    the newly created EC2 instance.
+
+**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)
+* `ChefVersion`: Chef version to install, (default: 11.18)
+
+
+## Document Content
 
 This document is generated automically from `aws-must` -demo
 templates. 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-must
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - jarjuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-11 00:00:00.000000000 Z
+date: 2015-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mustache