admiral-cloudformation 0.0.3 → 0.0.4

data/README.md

@@ -1,6 +1,10 @@
 # Admiral for AWS CloudFormation
 
-An Admiral module that implements tasks for wielding AWS CloudFormation templates. Use it to manage CloudFormation templates and their parameters.
+An Admiral module that implements tasks for wielding AWS CloudFormation templates and configuration.
+
+For additional modules, see the [Admiral base project](https://github.com/flippyhead/admiral).
+
+Developed in Seattle at [Fetching](http://fetching.io).
 
 ## Installation
 
@@ -18,11 +22,11 @@ Or install it yourself as:
 
 ## Usage
 
-On your command line type:
+To see a list of available commands, on the command line enter:
 
     $ admiral cf help
 
-To see a list of available commands. Make sure your bundle bin is in your PATH.
+Make sure your bundle bin is in your PATH.
 
 The following commands are available:
 
@@ -31,6 +35,7 @@ Commands:
   admiral cf create          # Create new CloudFormation stack for environment.
   admiral cf destroy         # Destroy the existing CloudFormation stack.
   admiral cf help [COMMAND]  # Describe subcommands or one specific subcommand
+  admiral cf init TYPE       # Create CloudFormation template and configuration files for TYPE. TYPE is one of "mongo", "meteor", or "elasticsearch"
   admiral cf update          # Update the existing CloudFormation stack
 
 Options:
@@ -43,17 +48,33 @@ Options:
 
 Some commands have additional options you can discover with:
 
-    # admiral cf help [COMMAND]
+    $ admiral cf help [COMMAND]
+
+## Setup
+
+It is recommended that you create a distinct repository for each cluster type. For example you might have: `server-elasticsearch`, `server-mongodb`, and `server-meteor` repositories each which specific cluster configurations.
+
+Within each repo simply run the `init` command to get started (see below).
+
+## Easy Setup
 
-# Configuration
+Admiral CloudFormation provides complete CloudFormation templates for some common server configurations. To initialize your project you can use:
 
-Admiral CloudFormation is designed around the concept of deployment environments. You parameterize your CloudFormation templates, then encode specific parameter values in JSON files for each distinct environment.
+      $ admiral cf init <type>
+
+Where type is one of `mongo`, `elasticsearch` or `meteor`. In the current working directory, this will create a `CloudFormation.template` and `staging.json` and `production.json` files. These are complete configurations using best practices for each server type. You'll need to customize a few things including SSL certificate and security group names.
+
+More example templates will be added in the future.
+
+## Configuration
+
+Admiral CloudFormation is designed around the concept of the deployment `environment`. You parameterize your CloudFormation templates, then encode specific parameter values in JSON files for each distinct environment.
 
 For example you may have CloudFormation templates for your database servers and your web application servers, and distinct configurations for production, staging and test environments.
 
 CloudFormation provides a facility to parameterize templates via the [`Parameters`](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html) section. For example:
 
-```javascript
+```json
   ...
   "InstanceType": {
       "Description": "The type of instance to launch.",
@@ -63,9 +84,9 @@ CloudFormation provides a facility to parameterize templates via the [`Parameter
   ...
 ```
 
-You then specify specific values for each environment. For example:
+You then specify specific values for each environment. For example, in the `production.json` file:
 
-```javascript
+```json
   {
     "InstanceCount":"2",
     "InstanceType": "t2.medium",
@@ -84,10 +105,16 @@ Create a stack using the default template (./CloudFormation.template) using a cu
 
       $ admiral cf create --params /usr/local/config/custom.json
 
-Update the default stack using the default environment (./production.json):
+Update using the default template (./CloudFormation.template) and the default environment config (./production.json):
 
       $ admiral cf update
 
-# CloudFormation Templates
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
 
-Example CloudFormation templates for ElasticSearch, Meteor and MongoDB are included in the `examples` directory.
+This project was heavily inspired by [this blog post](http://www.thoughtworks.com/mingle/news/scaling/2015/01/06/How-Mingle-Built-ElasticSearch-Cluster.html) -- thanks ThoughtWorks!

data/admiral.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "admiral-cloudformation"
-  spec.version       = '0.0.3'
+  spec.version       = '0.0.4'
   spec.authors       = ["Peter T. Brown"]
   spec.email         = ["p@ptb.io"]
   spec.description   = %q{An Admiral module that implements tasks for wielding AWS CloudFormation templates. Use it to manage CloudFormation templates and their parameters.}

data/examples/elasticsearch/production.json

@@ -4,13 +4,13 @@
   "SSLCertificateName": "search.example.io",
   "SshKeyName": "production",
   "InstanceCount":"2",
-  "InstanceType": "t2.medium",
+  "InstanceType": "c3.large",
   "ElasticSearchVersion": "1.4.4",
   "ElasticSearchAWSCloudPluginVersion": "2.4.1",
   "SearchUser":"admin",
   "SearchPassword":"example-password",
-  "ClusterName": "staging-cluster",
+  "ClusterName": "production-cluster",
   "MinMasterNodes": "1",
-  "SecurityGroupLoadBalancer": "sg-8aab365ef",
-  "SecurityGroupSearchLayer": "sg-9e9d35f8"
+  "SecurityGroupLoadBalancer": "sg-8aab365abc",
+  "SecurityGroupSearchLayer": "sg-9e9d3abc"
 }

data/examples/elasticsearch/staging.json

@@ -0,0 +1,16 @@
+{
+  "Route53ZoneName": "staging.example.io.",
+  "SearchDomainName": "search.staging.example.io",
+  "SSLCertificateName": "search.staging.example.io",
+  "SshKeyName": "staging",
+  "InstanceCount":"2",
+  "InstanceType": "t2.medium",
+  "ElasticSearchVersion": "1.4.4",
+  "ElasticSearchAWSCloudPluginVersion": "2.4.1",
+  "SearchUser":"admin",
+  "SearchPassword":"example-password",
+  "ClusterName": "staging-cluster",
+  "MinMasterNodes": "1",
+  "SecurityGroupLoadBalancer": "sg-8aa123",
+  "SecurityGroupSearchLayer": "sg-9e9123"
+}

data/examples/meteor/CloudFormation.template

@@ -69,13 +69,13 @@
         },
 
         "PrimaryAppId": {
-            "Description": "fetching app id ",
-            "Value": { "Ref": "FetchingApp"}
+            "Description": "primary app id ",
+            "Value": { "Ref": "PrimaryApp"}
         },
 
          "SecondaryAppId": {
             "Description": "exporter app id ",
-            "Value": { "Ref": "FetchingExporter"}
+            "Value": { "Ref": "SecondaryApp"}
         }
 
     },
@@ -213,8 +213,8 @@
             "Type":"AWS::OpsWorks::App",
             "Properties": {
                 "Type": "nodejs",
-                "Name": "Fetching Application",
-                "Shortname": "fetching-app",
+                "Name": "Primary Application",
+                "Shortname": "primary-app",
                 "StackId": {
                     "Ref": "MeteorStack"
                 },
@@ -231,8 +231,8 @@
             "Type":"AWS::OpsWorks::App",
             "Properties": {
                 "Type": "nodejs",
-                "Name": "Fetching Exporter",
-                "Shortname": "fetching-exporter",
+                "Name": "Secondary App",
+                "Shortname": "secondary-app",
                 "StackId": {
                     "Ref": "MeteorStack"
                 },

data/examples/meteor/production.json

@@ -4,7 +4,7 @@
   "SSLCertificateName": "app.example.io",
   "SshKeyName": "production",
   "InstanceCount":"1",
-  "InstanceType": "t2.small",
+  "InstanceType": "c3.large",
   "SecurityGroupLoadBalancer": "sg-8ad62234ef",
   "SecurityGroupMeteorLayer": "sg-2265dsd7"
 }

data/examples/meteor/staging.json

@@ -0,0 +1,10 @@
+{
+  "Route53ZoneName": "staging.example.io.",
+  "AppDomainName": "app.staging.example.io",
+  "SSLCertificateName": "app.staging.example.io",
+  "SshKeyName": "staging",
+  "InstanceCount":"1",
+  "InstanceType": "t2.small",
+  "SecurityGroupLoadBalancer": "sg-8ad62234ef",
+  "SecurityGroupMeteorLayer": "sg-2265dsd7"
+}

data/examples/mongo/production.json

@@ -1,7 +1,7 @@
 {
   "SshKeyName": "production",
   "InstanceCount":"1",
-  "InstanceType": "t2.small",
+  "InstanceType": "c3.large",
   "MongoVersion": "2.6.1",
   "SecurityGroupMongoLayer": "sg-334rt5fc"
 }

data/examples/mongo/staging.json

@@ -0,0 +1,7 @@
+{
+  "SshKeyName": "staging",
+  "InstanceCount":"1",
+  "InstanceType": "t2.small",
+  "MongoVersion": "2.6.1",
+  "SecurityGroupMongoLayer": "sg-334rtxyz"
+}

data/lib/admiral-cloudformation/tasks.rb

@@ -9,6 +9,7 @@ module Admiral
       extend Admiral::Base
       include Util::CloudFormation
 
+      EXAMPLES = ['elasticsearch', 'meteor', 'mongo']
       NAME = 'cf'
       USAGE = 'cf <command> <options>'
       DESCRIPTION = 'Commands for wielding AWS CloudFormation templates.'
@@ -45,6 +46,16 @@ module Admiral
         super stack_name options[:environment]
       end
 
+      desc 'init TYPE', 'Create CloudFormation template and configuration files for TYPE. TYPE is one of "mongo", "meteor", or "elasticsearch"'
+
+      def init(type)
+        raise ArgumentError, "#{type} must be one of #{EXAMPLES.join(',')}" unless EXAMPLES.include?(type)
+
+        path = File.expand_path("../../../examples/#{type}", __FILE__)
+        FileUtils.cp Dir.glob("#{path}/*"), Dir.getwd
+        puts "[admiral] #{type} CloudFormation setup initialized."
+      end
+
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: admiral-cloudformation
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-04 00:00:00.000000000 Z
+date: 2015-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,10 +108,13 @@ files:
 - admiral.gemspec
 - examples/elasticsearch/CloudFormation.template
 - examples/elasticsearch/production.json
+- examples/elasticsearch/staging.json
 - examples/meteor/CloudFormation.template
 - examples/meteor/production.json
+- examples/meteor/staging.json
 - examples/mongo/CloudFormation.template
 - examples/mongo/production.json
+- examples/mongo/staging.json
 - lib/admiral-cloudformation.rb
 - lib/admiral-cloudformation/tasks.rb
 - lib/admiral-cloudformation/util.rb