beaker-aws 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,15 @@
1
+ ---
2
+ !binary "U0hBMQ==":
3
+ metadata.gz: !binary |-
4
+ ZWM4ODk4Njc3ZmYzMmJjNDdmNjYwZGYzNDEyYTQ3MzY4ZjJhOWI5NA==
5
+ data.tar.gz: !binary |-
6
+ MTNjOGQxY2VhZDIxNDRjODBjYzQ0Y2VhN2UwYWY3ZTkyOTEyY2FhNg==
7
+ SHA512:
8
+ metadata.gz: !binary |-
9
+ NmFiMzEyMDFhNTU2NTYyYzAzM2NhZGIzODJkYTRmOWQ0ZDI2YThiOTNhZjgx
10
+ YWNkZTVlZGFlYTc3ODU4Mjc5YmE3OGRmMmFmNmU4ODBjNTlhYzNjNmJmMzU3
11
+ ODBjZWVjMzE4NTdlNTM3YTFlMThjYjU3MWQ4NTRmNTY4ZGYwNzQ=
12
+ data.tar.gz: !binary |-
13
+ ZDQzNTM5Y2FkNjZlOTFjZGIwOTNiYmVkNTM4YmM0Zjk0YTExZTkwM2Y2YmFj
14
+ Y2YxZDA3Mjg2Mjk1NGZjMmNjMjcwY2Q3NDk2N2RkNzdiYjIwODI4Nzk2N2Rk
15
+ NDY0MzRiYTFmZDJlOWQ2NmI3M2UzYzFkNWNjZDc0MDI5NzBjZWI=
data/.gitignore ADDED
@@ -0,0 +1,25 @@
1
+ *.swp
2
+ log/*
3
+ !.gitignore
4
+ junit
5
+ acceptance-tests
6
+ pkg
7
+ Gemfile.lock
8
+ options.rb
9
+ test.cfg
10
+ .yardoc
11
+ coverage
12
+ .bundle
13
+ .vendor
14
+ _vendor
15
+ tmp/
16
+ doc
17
+ # JetBrains IDEA
18
+ *.iml
19
+ .idea/
20
+ # rbenv file
21
+ .ruby-version
22
+ .ruby-gemset
23
+ # Vagrant folder
24
+ .vagrant/
25
+ .vagrant_files/
data/.simplecov ADDED
@@ -0,0 +1,9 @@
1
+ SimpleCov.configure do
2
+ add_filter 'spec/'
3
+ add_filter 'vendor/'
4
+ add_filter do |file|
5
+ file.lines_of_code < 10
6
+ end
7
+ end
8
+
9
+ SimpleCov.start if ENV['BEAKER_AWS_COVERAGE']
data/Gemfile ADDED
@@ -0,0 +1,27 @@
1
+ source ENV['GEM_SOURCE'] || "https://rubygems.org"
2
+
3
+ gemspec
4
+
5
+
6
+
7
+ def location_for(place, fake_version = nil)
8
+ if place =~ /^git:([^#]*)#(.*)/
9
+ [fake_version, { :git => $1, :branch => $2, :require => false }].compact
10
+ elsif place =~ /^file:\/\/(.*)/
11
+ ['>= 0', { :path => File.expand_path($1), :require => false }]
12
+ else
13
+ [place, { :require => false }]
14
+ end
15
+ end
16
+
17
+
18
+ # We don't put beaker in as a test dependency because we
19
+ # don't want to create a transitive dependency
20
+ group :acceptance_testing do
21
+ gem "beaker", *location_for(ENV['BEAKER_VERSION'] || '~> 3.0')
22
+ end
23
+
24
+
25
+ if File.exists? "#{__FILE__}.local"
26
+ eval(File.read("#{__FILE__}.local"), binding)
27
+ end
data/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "{}"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright {yyyy} {name of copyright owner}
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
202
+
data/README.md ADDED
@@ -0,0 +1,37 @@
1
+ # beaker-aws
2
+
3
+ Beaker library to use aws hypervisor
4
+
5
+ # How to use this wizardry
6
+
7
+ This gem that allows you to use hosts with [aws](aws.md) hypervisor with [beaker](https://github.com/puppetlabs/beaker).
8
+ Please checkout our [aws](aws.md) and [ec2](ec2.md) docs.
9
+
10
+ ### Right Now? (beaker 3.x)
11
+
12
+ This gem is already included as [beaker dependency](https://github.com/puppetlabs/beaker/blob/master/beaker.gemspec) for you, so you don't need to do anything special to use this gem's functionality with beaker.
13
+
14
+ ### In beaker's Next Major Version? (beaker 4.x)
15
+
16
+ In beaker's next major version, the requirement for beaker-aws will be pulled
17
+ from that repo. When that happens, then the usage pattern will change. In order
18
+ to use this then, you'll need to include beaker-aws as a dependency right
19
+ next to beaker itself.
20
+
21
+ # Spec tests
22
+
23
+ Spec test live under the `spec` folder. There are the default rake task and therefore can run with a simple command:
24
+ ```bash
25
+ bundle exec rake test:spec
26
+ ```
27
+
28
+ # Acceptance tests
29
+
30
+ We run beaker's base acceptance tests with this library to see if the hypervisor is working with beaker. There is a simple rake task to invoke acceptance test for the library:
31
+ ```bash
32
+ bundle exec rake test:acceptance
33
+ ```
34
+
35
+ # Contributing
36
+
37
+ Please refer to puppetlabs/beaker's [contributing](https://github.com/puppetlabs/beaker/blob/master/CONTRIBUTING.md) guide.
data/Rakefile ADDED
@@ -0,0 +1,160 @@
1
+ require 'rspec/core/rake_task'
2
+
3
+ namespace :test do
4
+
5
+ namespace :spec do
6
+
7
+ desc "Run spec tests"
8
+ RSpec::Core::RakeTask.new(:run) do |t|
9
+ t.rspec_opts = ['--color']
10
+ t.pattern = 'spec/'
11
+ end
12
+
13
+ desc "Run spec tests with coverage"
14
+ RSpec::Core::RakeTask.new(:coverage) do |t|
15
+ ENV['BEAKER_TEMPLATE_COVERAGE'] = 'y'
16
+ t.rspec_opts = ['--color']
17
+ t.pattern = 'spec/'
18
+ end
19
+
20
+ end
21
+
22
+ namespace :acceptance do
23
+
24
+ desc <<-EOS
25
+ A quick acceptance test, named because it has no pre-suites to run
26
+ EOS
27
+ task :quick do
28
+
29
+ # setup & load_path of beaker's acceptance base and lib directory
30
+ beaker_gem_spec = Gem::Specification.find_by_name('beaker')
31
+ beaker_gem_dir = beaker_gem_spec.gem_dir
32
+ beaker_test_base_dir = File.join(beaker_gem_dir, 'acceptance/tests/base')
33
+ load_path_option = File.join(beaker_gem_dir, 'acceptance/lib')
34
+
35
+ sh("beaker",
36
+ "--hosts", "acceptance/config/nodes/hosts.yml",
37
+ "--tests", beaker_test_base_dir,
38
+ "--log-level", "debug",
39
+ "--load-path", load_path_option)
40
+ end
41
+
42
+ end
43
+
44
+ end
45
+
46
+ # namespace-named default tasks.
47
+ # these are the default tasks invoked when only the namespace is referenced.
48
+ # they're needed because `task :default` in those blocks doesn't work as expected.
49
+ task 'test:spec' => 'test:spec:run'
50
+ task 'test:acceptance' => 'test:acceptance:quick'
51
+
52
+ # global defaults
53
+ task :test => 'test:spec'
54
+ task :default => :test
55
+
56
+ ###########################################################
57
+ #
58
+ # Documentation Tasks
59
+ #
60
+ ###########################################################
61
+ DOCS_DAEMON = "yard server --reload --daemon --server thin"
62
+ FOREGROUND_SERVER = 'bundle exec yard server --reload --verbose --server thin lib/beaker'
63
+
64
+ def running?( cmdline )
65
+ ps = `ps -ef`
66
+ found = ps.lines.grep( /#{Regexp.quote( cmdline )}/ )
67
+ if found.length > 1
68
+ raise StandardError, "Found multiple YARD Servers. Don't know what to do."
69
+ end
70
+
71
+ yes = found.empty? ? false : true
72
+ return yes, found.first
73
+ end
74
+
75
+ def pid_from( output )
76
+ output.squeeze(' ').strip.split(' ')[1]
77
+ end
78
+
79
+ desc 'Start the documentation server in the foreground'
80
+ task :docs => 'docs:clear' do
81
+ original_dir = Dir.pwd
82
+ Dir.chdir( File.expand_path(File.dirname(__FILE__)) )
83
+ sh FOREGROUND_SERVER
84
+ Dir.chdir( original_dir )
85
+ end
86
+
87
+ namespace :docs do
88
+
89
+ desc 'Clear the generated documentation cache'
90
+ task :clear do
91
+ original_dir = Dir.pwd
92
+ Dir.chdir( File.expand_path(File.dirname(__FILE__)) )
93
+ sh 'rm -rf docs'
94
+ Dir.chdir( original_dir )
95
+ end
96
+
97
+ desc 'Generate static documentation'
98
+ task :gen => 'docs:clear' do
99
+ original_dir = Dir.pwd
100
+ Dir.chdir( File.expand_path(File.dirname(__FILE__)) )
101
+ output = `bundle exec yard doc`
102
+ puts output
103
+ if output =~ /\[warn\]|\[error\]/
104
+ fail "Errors/Warnings during yard documentation generation"
105
+ end
106
+ Dir.chdir( original_dir )
107
+ end
108
+
109
+ desc 'Run the documentation server in the background, alias `bg`'
110
+ task :background => 'docs:clear' do
111
+ yes, output = running?( DOCS_DAEMON )
112
+ if yes
113
+ puts "Not starting a new YARD Server..."
114
+ puts "Found one running with pid #{pid_from( output )}."
115
+ else
116
+ original_dir = Dir.pwd
117
+ Dir.chdir( File.expand_path(File.dirname(__FILE__)) )
118
+ sh "bundle exec #{DOCS_DAEMON}"
119
+ Dir.chdir( original_dir )
120
+ end
121
+ end
122
+
123
+ task(:bg) { Rake::Task['docs:background'].invoke }
124
+
125
+ desc 'Check the status of the documentation server'
126
+ task :status do
127
+ yes, output = running?( DOCS_DAEMON )
128
+ if yes
129
+ pid = pid_from( output )
130
+ puts "Found a YARD Server running with pid #{pid}"
131
+ else
132
+ puts "Could not find a running YARD Server."
133
+ end
134
+ end
135
+
136
+ desc "Stop a running YARD Server"
137
+ task :stop do
138
+ yes, output = running?( DOCS_DAEMON )
139
+ if yes
140
+ pid = pid_from( output )
141
+ puts "Found a YARD Server running with pid #{pid}"
142
+ `kill #{pid}`
143
+ puts "Stopping..."
144
+ yes, output = running?( DOCS_DAEMON )
145
+ if yes
146
+ `kill -9 #{pid}`
147
+ yes, output = running?( DOCS_DAEMON )
148
+ if yes
149
+ puts "Could not Stop Server!"
150
+ else
151
+ puts "Server stopped."
152
+ end
153
+ else
154
+ puts "Server stopped."
155
+ end
156
+ else
157
+ puts "Could not find a running YARD Server"
158
+ end
159
+ end
160
+ end
@@ -0,0 +1,40 @@
1
+ ---
2
+ HOSTS:
3
+ ubuntu1604-64-1:
4
+ pe_dir:
5
+ pe_ver:
6
+ pe_upgrade_dir:
7
+ pe_upgrade_ver:
8
+ platform: ubuntu-1604-x86_64
9
+ hypervisor: ec2
10
+ amisize: c4.large
11
+ snapshot: base
12
+ user: ubuntu
13
+ vmname: ubuntu-1604-x86_64
14
+ roles:
15
+ - master
16
+ - agent
17
+ - dashboard
18
+ - database
19
+ - classifier
20
+ - default
21
+ host_tags:
22
+ lifetime: 2h
23
+ ubuntu1604-64-2:
24
+ pe_dir:
25
+ pe_ver:
26
+ pe_upgrade_dir:
27
+ pe_upgrade_ver:
28
+ platform: ubuntu-1604-x86_64
29
+ hypervisor: ec2
30
+ amisize: c4.large
31
+ snapshot: base
32
+ user: ubuntu
33
+ vmname: ubuntu-1604-x86_64
34
+ roles:
35
+ - agent
36
+ host_tags:
37
+ lifetime: 2h
38
+ CONFIG:
39
+ nfs_server: none
40
+ consoleport: 443
data/aws.md ADDED
@@ -0,0 +1,149 @@
1
+ # Amazon Web Services - Elastic Compute Cloud (EC2)
2
+
3
+ EC2 is a "web service that provides resizable compute capacity in the cloud."
4
+
5
+ [EC2 site](https://aws.amazon.com/ec2/).
6
+
7
+ # Getting Started
8
+
9
+ ### Requirements
10
+
11
+ - Get EC2 access from your IT dept, particularly your `aws_access_key_id` & `aws_secret_access_key`.
12
+ - put these values into your [~/.fog file](http://fog.io/about/getting_started.html).
13
+
14
+ ### Setup Amazon Image Config
15
+
16
+ The Amazon Image Config file in Beaker is the file that specifies which Amazon
17
+ Machine Image (AMI) should be used for a host and which EC2 region that host
18
+ should be generated into.
19
+
20
+ The text in this file follows this form:
21
+
22
+ AMI:
23
+ <host-vmname-value>:
24
+ :image:
25
+ :<type>: <ami-id>
26
+ :<type>: <ami-id>
27
+ :region: <region-id>
28
+ <host-vmname-value>:
29
+ ...
30
+
31
+ The `host-vmname-value` is an ID used to reference one of these particular AMI
32
+ definitions. It is applied to a host via the `vmname` key in the hosts file.
33
+
34
+ The `type` variable is an arbitrary key that you can use to specify the different
35
+ types of that host platform that you can be testing with. Note that this value
36
+ will be grabbed automatically via the value for the host's `snapshot` key.
37
+ For example, we tend to use `:pe` and `:foss` for these values.
38
+
39
+ The `ami-id` variable is the AMI ID as specified by Amazon. You can see the AMI
40
+ ID pattern in EC2's
41
+ [Find a Linux AMI]
42
+ (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html)
43
+ page, particularly in the "using the Images page" section's step 7. For some
44
+ examples of AMI IDs, check out their
45
+ [Amazon Linux AMI page](https://aws.amazon.com/amazon-linux-ami/).
46
+
47
+ The `region-id` variable represents the EC2 region ID from AWS. For reference,
48
+ checkout EC2's
49
+ [Regions and Availability Zones page]
50
+ (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html).
51
+ An example of a region ID is `eu-west-1` for the Ireland data center.
52
+
53
+ This file is by default located at `config/image_templates/ec2.yaml`. This is a
54
+ relative path from Beaker's execution location, and can be overridden using the
55
+ `:ec2_yaml` key in a CONFIG section of a host file if required.
56
+
57
+ ### Create a Hosts File to Use
58
+
59
+ An EC2 hosts file looks like a typical hosts file, except that there are a
60
+ number of required properties that need to be added to every host in order for
61
+ the AWS hypervisor to provision hosts properly. They come in this form:
62
+
63
+ <hostname>:
64
+ <usual stuff, roles, etc>
65
+ vmname: <host-vmname-value>
66
+ hypervisor: ec2
67
+ snapshot: <type>
68
+ amisize: <ami-size>
69
+ platform: <platform-name>
70
+
71
+ The `host-vmname-value` references the ID created in the Amazon Image Config file
72
+ above. If not provided, Beaker will try to name an AMI Config using the host's
73
+ platform string.
74
+
75
+ **Note:** If you are using `amazon-6-x86_64` as `vmname`, you have to specify `platform` as `el-6-x86_64`. Similarly for `amazon-6-i386` use `el-6-i386` as `platform`.
76
+
77
+ The `type` references the type variable in the Amazon Image Config file as well,
78
+ so this key picks out the particular AMI ID from the set available for this type
79
+ of host platform.
80
+
81
+ The `ami-size` variable refers to
82
+ [instance types](https://aws.amazon.com/ec2/instance-types/) by their model name.
83
+ Some examples of these values are "m3.large", "c4.xlarge", and "r3.8xlarge". The
84
+ default value if this key is not provided used by Beaker is "m1.small".
85
+
86
+ ### ec2 VM Hostnames
87
+
88
+ By default, beaker will set the hostnames of the VMs to the 'Public DNS' hostname supplied by ec2 (and which is normally based on the Public IP address). If your test requires the hosts be named identically to the `<hostname>:` from your beaker hosts file, set `:use_beaker_hostnames: true` in the beaker hosts file.
89
+
90
+ # AWS Keys
91
+
92
+ For any particular Beaker run, a new EC2 ssh key with a name of the form
93
+
94
+ Beaker-<username>-<sanitized_hostname>-<aws_keyname_modifier>-<readable_timestamp>
95
+
96
+ will be created at the beginning of the run, & cleaned up at the end of the run.
97
+
98
+ Everything up to `aws_keyname_modifier` will be the same if run from the same
99
+ user on the same machine no matter when it's run. This means that if you're
100
+ running from a CI system, all of these values will usually be the same, depending
101
+ on your setup.
102
+
103
+ `aws_keyname_modifier` will by default be a 10 digit random number string.
104
+ `readable_timestamp`'s most fine grained unit is nanoseconds. Between the two of
105
+ these, every Beaker run will generate a unique ssh key name.
106
+
107
+ These keys are deleted automatically as a part of the cleanup process at the end
108
+ of a Beaker run.
109
+
110
+ # Zombie Killing
111
+
112
+ If an EC2 host stays around after a Beaker run, we refer to it as a zombie :).
113
+ Normal Beaker execution should not create zombies, but a common use case that
114
+ can result in zombies is using the `--preserve-hosts` options.
115
+
116
+ If you would like to be sure that you're not running up your EC2 bill via any
117
+ leftover preserved hosts in your EC2 system, we recommend creating a zombie
118
+ killing Beaker job.
119
+
120
+ To setup a zombie killing job, you'll need a Beaker test that kills all the
121
+ zombies (referred to later as `kill.rb`):
122
+
123
+ ec2 = AwsSdk.new( [], options )
124
+ ec2.kill_zombies( 0 )
125
+
126
+ Refer to the
127
+ [Rubydoc for the `kill_zombies` method]
128
+ (http://www.rubydoc.info/github/puppetlabs/beaker/Beaker/AwsSdk#kill_zombies-instance_method)
129
+ to learn more about it's
130
+ parameters. Running this should be as simple as this:
131
+
132
+ # beaker --tests kill.rb
133
+
134
+ Note that the second argument is tested as a regex against key names, so you
135
+ could use the key pattern described above to wipeout machines that match a
136
+ pattern such as "Beaker-johnsmith", and it will catch all keys for the "johnsmith"
137
+ user.
138
+
139
+ ### How Do I Find Out My Key Prefix?
140
+
141
+ In order to find out your key pattern as used by Beaker, just kick off a Beaker
142
+ run to generate an EC2 host. When you do this, you should see lines that look
143
+ like so:
144
+
145
+ aws-sdk: Launch instance
146
+ aws-sdk: Ensure key pair exists, create if not
147
+ [AWS EC2 200 0.142666 0 retries] describe_key_pairs(:filters=>[{:name=>"key-name",:values=>["Beaker-johnsmith-Johns-Ubuntu-2-local"]}])
148
+
149
+ The values string in that line is what you're looking for.