admiral-cloudformation 0.0.2 → 0.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (3) hide show
  1. data/README.md +16 -2
  2. data/admiral.gemspec +3 -2
  3. metadata +6 -6
data/README.md CHANGED
@@ -41,7 +41,11 @@ Options:
41
41
  [--params=PARAMS] # Path to override parameter definitions file. Defaults to <environment>.json
42
42
  ```
43
43
 
44
- # Setup and Configuration
44
+ Some commands have additional options you can discover with:
45
+
46
+ # admiral cf help [COMMAND]
47
+
48
+ # Configuration
45
49
 
46
50
  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.
47
51
 
@@ -59,7 +63,7 @@ CloudFormation provides a facility to parameterize templates via the [`Parameter
59
63
  ...
60
64
  ```
61
65
 
62
- Admiral CloudFormation let's you specify specific values. For example:
66
+ You then specify specific values for each environment. For example:
63
67
 
64
68
  ```javascript
65
69
  {
@@ -68,12 +72,22 @@ Admiral CloudFormation let's you specify specific values. For example:
68
72
  }
69
73
  ```
70
74
 
75
+ Admiral then applies the parameters for a given environment to your CloudFormation templates as required by whatever action you are performing.
76
+
71
77
  ## Examples
72
78
 
73
79
  To create a new CloudFormation stack (and its associated resources) using a staging configuration:
74
80
 
75
81
  $ admiral cf create --environment staging --template ./CloudFormation.template
76
82
 
83
+ Create a stack using the default template (./CloudFormation.template) using a custom JSON file:
84
+
85
+ $ admiral cf create --params /usr/local/config/custom.json
86
+
87
+ Update the default stack using the default environment (./production.json):
88
+
89
+ $ admiral cf update
90
+
77
91
  # CloudFormation Templates
78
92
 
79
93
  Example CloudFormation templates for ElasticSearch, Meteor and MongoDB are included in the `examples` directory.
data/admiral.gemspec CHANGED
@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
4
 
5
5
  Gem::Specification.new do |spec|
6
6
  spec.name = "admiral-cloudformation"
7
- spec.version = '0.0.2'
7
+ spec.version = '0.0.3'
8
8
  spec.authors = ["Peter T. Brown"]
9
9
  spec.email = ["p@ptb.io"]
10
10
  spec.description = %q{An Admiral module that implements tasks for wielding AWS CloudFormation templates. Use it to manage CloudFormation templates and their parameters.}
@@ -18,7 +18,8 @@ Gem::Specification.new do |spec|
18
18
 
19
19
  spec.add_development_dependency "bundler", "~> 1.3"
20
20
  spec.add_development_dependency "rake"
21
+
21
22
  spec.add_dependency 'aws-sdk', '< 2'
22
23
  spec.add_dependency 'thor', '~> 0.19'
23
- spec.add_dependency 'admiral', '~> 0.0.1'
24
+ spec.add_dependency 'admiral'
24
25
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: admiral-cloudformation
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.2
4
+ version: 0.0.3
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -9,7 +9,7 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2015-05-03 00:00:00.000000000 Z
12
+ date: 2015-05-04 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: bundler
@@ -80,17 +80,17 @@ dependencies:
80
80
  requirement: !ruby/object:Gem::Requirement
81
81
  none: false
82
82
  requirements:
83
- - - ~>
83
+ - - ! '>='
84
84
  - !ruby/object:Gem::Version
85
- version: 0.0.1
85
+ version: '0'
86
86
  type: :runtime
87
87
  prerelease: false
88
88
  version_requirements: !ruby/object:Gem::Requirement
89
89
  none: false
90
90
  requirements:
91
- - - ~>
91
+ - - ! '>='
92
92
  - !ruby/object:Gem::Version
93
- version: 0.0.1
93
+ version: '0'
94
94
  description: An Admiral module that implements tasks for wielding AWS CloudFormation
95
95
  templates. Use it to manage CloudFormation templates and their parameters.
96
96
  email: