/
cloudprovisioner_man_node_aws.html
460 lines (344 loc) · 17.6 KB
/
cloudprovisioner_man_node_aws.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
---
layout: default
title: "PE 2.5 » Cloud Provisioning » Man » node_aws"
subtitle: "Man Page: node_aws"
---
<div class='mp'>
<h2 id="NAME">NAME</h2>
<p class="man-name">
<code>puppet-node_aws</code> - <span class="man-whatis">View and manage Amazon AWS EC2 nodes.</span>
</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
<p>puppet node_aws <var>action</var></p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
<p>This subcommand provides a command line interface to work with Amazon EC2
machine instances. The goal of these actions is to easily create new
machines, install Puppet onto them, and tear them down when they're no longer
required.</p>
<h2 id="OPTIONS">OPTIONS</h2>
<p>Note that any configuration parameter that's valid in the configuration
file is also a valid long argument, although it may or may not be
relevant to the present action. For example, <code>server</code> is a valid
configuration parameter, so you can specify <code>--server <servername></code> as
an argument.</p>
<p>See the configuration file documentation at
<a href="http://docs.puppetlabs.com/references/stable/configuration.html" data-bare-link="true">http://docs.puppetlabs.com/references/stable/configuration.html</a> for the
full list of acceptable parameters. A commented list of all
configuration options can also be generated by running puppet with
<code>--genconfig</code>.</p>
<dl>
<dt>--mode MODE</dt><dd>The run mode to use for the current action. Valid modes are <code>user</code>, <code>agent</code>,
and <code>master</code>.</dd>
<dt>--render-as FORMAT</dt><dd>The format in which to render output. The most common formats are <code>json</code>,
<code>s</code> (string), <code>yaml</code>, and <code>console</code>, but other options such as <code>dot</code> are
sometimes available.</dd>
<dt>--verbose</dt><dd>Whether to log verbosely.</dd>
<dt class="flush">--debug</dt><dd>Whether to log debug information.</dd>
</dl>
<h2 id="ACTIONS">ACTIONS</h2>
<dl>
<dt><code>bootstrap</code> - Create and initialize an EC2 instance using Puppet.</dt><dd><p><code>SYNOPSIS</code></p>
<p>puppet node_aws bootstrap [--platform=]
[--region=]
<var>--image= | -i=</var>
<var>--type=</var>
<var>--keyname=</var>
[--group= | -g= | --security-group=]
<var>--login= | -l= | --username=</var>
<var>--keyfile=</var>
[--installer-payload=]
[--installer-answers=]
[--puppetagent-certname=]
[--install-script=]
[--puppet-version=]
[--pe-version=]
[--facter-version=]
[--enc-ssl]
[--enc-server=]
[--enc-port=]
[--enc-auth-user=]
[--enc-auth-passwd=]
[--node-group= | --as=]</p>
<p><code>DESCRIPTION</code></p>
<p>Creates an instance, classifies it, and signs its certificate. The
classification is currently done using Puppet Dashboard or Puppet
Enterprise's console.</p>
<p><code>OPTIONS</code></p>
<p><var>--enc-auth-passwd=</var> -
PE's console and Puppet Dashboard can be secured using HTTP
authentication. If the console or dashboard is configured with HTTP
authentication, use this option to supply credentials for accessing it.</p>
<p>Note: This option will default to the PUPPET_ENC_AUTH_PASSWD
environment variable. Please use this environment variable if you
are concerned about usernames and passwords being exposed via the
Unix process table.</p>
<p><var>--enc-auth-user=</var> -
PE's console and Puppet Dashboard can be secured using HTTP
authentication. If the console or dashboard is configured with HTTP
authentication, use this option to supply credentials for accessing it.</p>
<p>Note: This option will default to the PUPPET_ENC_AUTH_USER
environment variable. Please use this environment variable if you
are concerned about usernames and passwords being exposed via the
Unix process table.</p>
<p><var>--enc-port=</var> -
The port of the External Node Classifier. This currently only
supports Puppet Enterprise's console and Puppet Dashboard as external
node classifiers.</p>
<p><var>--enc-server=</var> -
The hostname of the external node classifier. This currently only
supports Puppet Enterprise's console and Puppet Dashboard as external
node classifiers.</p>
<p><var>--enc-ssl</var> -
By default, we do not connect to the ENC over SSL. This option
configures all HTTP connections to the ENC to use SSL in order to
provide encryption. This option should be set when using Puppet
Enterprise 2.0 and higher.</p>
<p><var>--facter-version=</var> -
The version of facter that should be installed.
This only makes sense in open source installation
mode.</p>
<p><var>--group=</var> | <var>-g=</var> | <var>--security-group=</var> -
The security group(s) that the machine will be associated with. A
security group determines the rules for both inbound and outbound
connections.</p>
<p>Multiple groups can be specified as a colon-separated list.</p>
<p><var>--image=</var> | <var>-i=</var> -
The pre-configured operating system image to use when creating this
machine instance. Currently, only AMI images are supported. Example
of a Redhat 5.6 32bit image: ami-b241bfdb</p>
<p><var>--install-script=</var> -
Name of the installation template to use when installing Puppet. The current
list of supported templates is: gems, puppet-enterprise</p>
<p><var>--installer-answers=</var> -
Location of the answers file that should be copied to the machine
to install Puppet Enterprise.</p>
<p><var>--installer-payload=</var> -
Location of the Puppet enterprise universal tarball to be used for
the installation. Can be a local file path or a URL. This option is
only required if Puppet should be installed on the machine. The
tarball specified must be gzipped.</p>
<p><var>--keyfile=</var> -
The filesystem path to a local private key that can be used to SSH
into the node. If the node was created with the <code>node_aws</code> <code>create</code>
action, this should be the path to the private key file downloaded
from the Amazon EC2 interface.</p>
<p>Specify 'agent' if you have the key loaded in ssh-agent and
available via the SSH_AUTH_SOCK variable.</p>
<p><var>--keyname=</var> -
The name of the SSH key pair to use, as listed in the Amazon AWS
console. When creating the instance, Amazon will install the
requested SSH public key into the instance's authorized_keys file.
Not to be confused with the --keyfile option of the <code>node</code>
subcommand's <code>install</code> action.</p>
<p>You can use the <code>list_keynames</code> action to get a list of valid key
pairs.</p>
<p><var>--login=</var> | <var>-l=</var> | <var>--username=</var> -
The name of the user Puppet should use when logging in to the node.
This user should configured to allow passwordless access via the SSH
key supplied in the --keyfile option.</p>
<p>This is usually the root user.</p>
<p><var>--node-group=</var> | <var>--as=</var> -
The PE console or Puppet Dashboard group to associate the node with.
The group must already exist in the ENC, or an error will be
returned. If the node has not been registered with the ENC, it will
automatically be registered when assigning it to a group.</p>
<p><var>--pe-version=</var> -
Version of Puppet Enterprise to be passed to the installer script.
Defaults to 1.1.</p>
<p><var>--platform=</var> -
The Cloud platform used to create new machine instances.
Currently, AWS (Amazon Web Services) is the only supported platform.</p>
<p><var>--puppet-version=</var> -
Version of Puppet to be installed. This version is
passed to the Puppet installer script.</p>
<p><var>--puppetagent-certname=</var> -
This option allows you to specify an optional puppet agent
certificate name to configure on the target system. This option
applies to the puppet-enterprise and puppet-enterprise-http
installation scripts. If provided, this option will replace any
puppet agent certificate name provided in the puppet enterprise
answers file. This certificate name will show up in the console (or
Puppet Dashboard) when the agent checks in for the first time.</p>
<p><var>--region=</var> -
The instance may run in any region EC2 operates within. The regions at the
time of this documentation are: US East (Northern Virginia), US West (Northern
California), EU (Ireland), Asia Pacific (Singapore), and Asia Pacific (Tokyo).</p>
<p>The region names for this command are: eu-west-1, us-east-1,
ap-northeast-1, us-west-1, ap-southeast-1</p>
<p>Note: to use another region, you will need to copy your keypair and reconfigure the
security groups to allow SSH access.</p>
<p><var>--type=</var> -
Type of instance to be launched. The type specifies characteristics that
a machine will have, such as architecture, memory, processing power, storage,
and IO performance. The type selected will determine the cost of a machine instance.
Supported types are: 'm1.small','m1.large','m1.xlarge','t1.micro','m2.xlarge',
'm2.2xlarge','x2.4xlarge','c1.medium','c1.xlarge','cc1.4xlarge'.</p></dd>
<dt><code>create</code> - Create a new EC2 machine instance.</dt><dd><p><code>SYNOPSIS</code></p>
<p>puppet node_aws create [--platform=]
[--region=]
<var>--image= | -i=</var>
<var>--type=</var>
<var>--keyname=</var>
[--group= | -g= | --security-group=]</p>
<p><code>DESCRIPTION</code></p>
<p>This action launches a new Amazon EC2 instance and returns the public
DNS name suitable for SSH access.</p>
<p>A newly created system may not be immediately ready after launch while
it boots. You can use the <code>fingerprint</code> action to wait for the system to
become ready after launch.</p>
<p>If creation of the instance fails, Puppet will automatically clean up
after itself and tear down the instance.</p>
<p><code>OPTIONS</code></p>
<p><var>--group=</var> | <var>-g=</var> | <var>--security-group=</var> -
The security group(s) that the machine will be associated with. A
security group determines the rules for both inbound and outbound
connections.</p>
<p>Multiple groups can be specified as a colon-separated list.</p>
<p><var>--image=</var> | <var>-i=</var> -
The pre-configured operating system image to use when creating this
machine instance. Currently, only AMI images are supported. Example
of a Redhat 5.6 32bit image: ami-b241bfdb</p>
<p><var>--keyname=</var> -
The name of the SSH key pair to use, as listed in the Amazon AWS
console. When creating the instance, Amazon will install the
requested SSH public key into the instance's authorized_keys file.
Not to be confused with the --keyfile option of the <code>node</code>
subcommand's <code>install</code> action.</p>
<p>You can use the <code>list_keynames</code> action to get a list of valid key
pairs.</p>
<p><var>--platform=</var> -
The Cloud platform used to create new machine instances.
Currently, AWS (Amazon Web Services) is the only supported platform.</p>
<p><var>--region=</var> -
The instance may run in any region EC2 operates within. The regions at the
time of this documentation are: US East (Northern Virginia), US West (Northern
California), EU (Ireland), Asia Pacific (Singapore), and Asia Pacific (Tokyo).</p>
<p>The region names for this command are: eu-west-1, us-east-1,
ap-northeast-1, us-west-1, ap-southeast-1</p>
<p>Note: to use another region, you will need to copy your keypair and reconfigure the
security groups to allow SSH access.</p>
<p><var>--type=</var> -
Type of instance to be launched. The type specifies characteristics that
a machine will have, such as architecture, memory, processing power, storage,
and IO performance. The type selected will determine the cost of a machine instance.
Supported types are: 'm1.small','m1.large','m1.xlarge','t1.micro','m2.xlarge',
'm2.2xlarge','x2.4xlarge','c1.medium','c1.xlarge','cc1.4xlarge'.</p></dd>
<dt><code>fingerprint</code> - Make a best effort to securely obtain the SSH host key fingerprint.</dt><dd><p><code>SYNOPSIS</code></p>
<p>puppet node_aws fingerprint [--platform=] [--region=] <var>instance_name</var></p>
<p><code>DESCRIPTION</code></p>
<p>This action attempts to retrieve a host key fingerprint by using the EC2
API to search the console output. This provides a secure way to retrieve
the fingerprint from an EC2 instance. You should run the <code>fingerprint</code>
action immediately after creating an instance, as you wait for it to
finish booting.</p>
<p>This action can only retrieve a fingerprint if the instance's original
image was configured to print the fingerprint to the system console.
Note that many machine images do not print the fingerprint to the
console. If this action is unable to find a fingerprint, it will display
a warning.</p>
<p>In either case, if this command returns without an error, then the
instance being checked is ready for use.</p>
<p><code>OPTIONS</code></p>
<p><var>--platform=</var> -
The Cloud platform used to create new machine instances.
Currently, AWS (Amazon Web Services) is the only supported platform.</p>
<p><var>--region=</var> -
The instance may run in any region EC2 operates within. The regions at the
time of this documentation are: US East (Northern Virginia), US West (Northern
California), EU (Ireland), Asia Pacific (Singapore), and Asia Pacific (Tokyo).</p>
<p>The region names for this command are: eu-west-1, us-east-1,
ap-northeast-1, us-west-1, ap-southeast-1</p>
<p>Note: to use another region, you will need to copy your keypair and reconfigure the
security groups to allow SSH access.</p></dd>
<dt><code>list</code> - List AWS EC2 machine instances.</dt><dd><p><code>SYNOPSIS</code></p>
<p>puppet node_aws list [--platform=] [--region=]</p>
<p><code>DESCRIPTION</code></p>
<p>This action obtains a list of instances from the cloud provider and
displays them on the console output. For EC2 instances, only the instances in
a specific region are provided.</p>
<p><code>OPTIONS</code></p>
<p><var>--platform=</var> -
The Cloud platform used to create new machine instances.
Currently, AWS (Amazon Web Services) is the only supported platform.</p>
<p><var>--region=</var> -
The instance may run in any region EC2 operates within. The regions at the
time of this documentation are: US East (Northern Virginia), US West (Northern
California), EU (Ireland), Asia Pacific (Singapore), and Asia Pacific (Tokyo).</p>
<p>The region names for this command are: eu-west-1, us-east-1,
ap-northeast-1, us-west-1, ap-southeast-1</p>
<p>Note: to use another region, you will need to copy your keypair and reconfigure the
security groups to allow SSH access.</p>
<p><code>RETURNS</code></p>
<p>Array of attribute hashes containing information about each EC2 instance.</p></dd>
<dt><code>list_keynames</code> - List available AWS EC2 key names.</dt><dd><p><code>SYNOPSIS</code></p>
<p>puppet node_aws list_keynames [--platform=] [--region=]</p>
<p><code>DESCRIPTION</code></p>
<p>This action lists the available AWS EC2 key names and their fingerprints.
Any key name from this list is a valid argument for the create action's
--keyname option.</p>
<p><code>OPTIONS</code></p>
<p><var>--platform=</var> -
The Cloud platform used to create new machine instances.
Currently, AWS (Amazon Web Services) is the only supported platform.</p>
<p><var>--region=</var> -
The instance may run in any region EC2 operates within. The regions at the
time of this documentation are: US East (Northern Virginia), US West (Northern
California), EU (Ireland), Asia Pacific (Singapore), and Asia Pacific (Tokyo).</p>
<p>The region names for this command are: eu-west-1, us-east-1,
ap-northeast-1, us-west-1, ap-southeast-1</p>
<p>Note: to use another region, you will need to copy your keypair and reconfigure the
security groups to allow SSH access.</p>
<p><code>RETURNS</code></p>
<p>Array of attribute hashes containing information about each key pair</p></dd>
<dt><code>terminate</code> - Terminate an EC2 machine instance.</dt><dd><p><code>SYNOPSIS</code></p>
<p>puppet node_aws terminate [--region=]
[--platform=]
[--force | -f]
<var>instance_name</var></p>
<p><code>DESCRIPTION</code></p>
<p>Terminate the instance identified by <var>instance_name</var>.</p>
<p><code>OPTIONS</code></p>
<p><var>--force</var> | <var>-f</var> -
Forces termination of an instance.
<var>--platform=</var> -
The Cloud platform used to create new machine instances.
Currently, AWS (Amazon Web Services) is the only supported platform.</p>
<p><var>--region=</var> -
The instance may run in any region EC2 operates within. The regions at the
time of this documentation are: US East (Northern Virginia), US West (Northern
California), EU (Ireland), Asia Pacific (Singapore), and Asia Pacific (Tokyo).</p>
<p>The region names for this command are: eu-west-1, us-east-1,
ap-northeast-1, us-west-1, ap-southeast-1</p>
<p>Note: to use another region, you will need to copy your keypair and reconfigure the
security groups to allow SSH access.</p></dd>
</dl>
<h2 id="EXAMPLES">EXAMPLES</h2>
<p><code>list</code></p>
<p>List every instance in the US East region:</p>
<pre><code>$ puppet node_aws list --region=us-east-1
i-e8e04588:
created_at: Tue Sep 13 01:21:16 UTC 2011
dns_name: ec2-184-72-85-208.compute-1.amazonaws.com
id: i-e8e04588
state: running
</code></pre>
<p><code>list_keynames</code></p>
<p>List the available key pairs:</p>
<pre><code>$ puppet node_aws list_keynames
cody (58:c6:4f:3e:b5:51:e0:ec:49:55:4e:98:43:8f:28:f3:9a:14:c8:a3)
jeff (6e:b6:0a:27:5b:67:cd:8b:47:74:9c:f7:b2:b0:b9:ab:3a:25:d0:28)
matt (4b:8c:8d:a9:e5:88:6a:47:b7:8b:97:c5:77:e7:b7:6f:fd:b9:64:b3)
</code></pre>
<p>Get the key pair list as an array of JSON hashes:</p>
<pre><code>$ puppet node_aws list_keynames --render-as json
[{"name":"cody","fingerprint":"58:c6:4f:3e:b5:51:e0:ec:49:55:4e:98:43:8f:28:f3:9a:14:c8:a3"},
{"name":"jeff","fingerprint":"6e:b6:0a:27:5b:67:cd:8b:47:74:9c:f7:b2:b0:b9:ab:3a:25:d0:28"},
{"name":"matt","fingerprint":"4b:8c:8d:a9:e5:88:6a:47:b7:8b:97:c5:77:e7:b7:6f:fd:b9:64:b3"}]
</code></pre>
<h2 id="COPYRIGHT-AND-LICENSE">COPYRIGHT AND LICENSE</h2>
<p>Copyright 2011 by Puppet Labs
Apache 2 license; see COPYING</p>
</div>
<hr>
<p><a href="./cloudprovisioner_man_node.html">Next: Man Page: puppet node</a> </p>
<hr />