Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 549 lines (280 sloc) 14.347 kb
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
1 ---
2 title: "BoxGrinder Build plugins"
3 layout: one-column
4 ---
5
096e5d0 @goldmann Limit levels for TOC generation, cleanup in tutorials, added TOC to p…
goldmann authored
6 ((TOC))
7
8 ***
9
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
10 # Plugin introduction
11
12 There are three types of BoxGrinder plugins:
13
14 1. Operating system plugins
15 2. Platform plugins
16 3. Delivery plugins
17
18 ## Operating system plugins
19
20 The goal of this kind of plugin is to create a base image for the selected operating system. Each plugin must inherit the BaseOperatingSystemPlugin class.
21
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
22 * [Fedora plugin][fedora]
23 * [CentOS plugin][centos]
24 * [RHEL plugin][rhel]
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
25
26 ## Platform plugins
27
28 Platform plugins convert intermediary deliverables produced by the operating system plugin into a selected platform. A platform could be VMware vSphere or Amazon EC2 for example.
29
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
30 * [VMware plugin][vmware]
31 * [VirtualBox Plugin][virtualbox]
32 * [EC2 plugin][ec2]
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
33
34 ## Delivery plugins
35
36 A delivery plugin moves the deliverables from a platfrorm or operating system plugin to a selected location type. This could be a local directory, SFTP server, Amazon CloudFront or an Amazon S3 bucket.
37
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
38 * [Local plugin][local]
39 * [SFTP plugin][sftp]
40 * [S3 plugin][s3]
41 * [EBS Plugin][ebs]
39049eb @msavy Update plugin user documentation
msavy authored
42 * [ElasticHosts plugin][elastichosts]
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
43
44 # Plugin configuration
45
46 Some of above plugins require additional configuration after install. Please refer to selected plugin documentation for more information on this.
47
48 If a plugin configuration is needed, please place it it BoxGrinder configuration file, by default located in `~/.boxgrinder/config`. Example configuration for vmware and local plugins:
49
50 plugins:
51 vmware:
52 type: personal
53 thin_disk: true
54 local:
55 path: /mnt/builds
56
57 # Plugins
58
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
59 ## Operating system plugins
60
61
62
63 ### Fedora Operating System Plugin
64
65 ***
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
66
67 This plugin creates base disk image with Fedora operating system installed.
68
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
69 #### Fedora Operating System Plugin Configuration
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
70
71 plugins:
72 fedora:
73 format: qcow2 # Disk format to use. Default: raw.
74
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
75 #### Fedora Operating System Plugin Examples
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
76
77 `fedora-13.appl`:
78
79 name: fedora-13
80 os:
81 name: fedora
82 version: 13
83
84 [...]
85
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
86 #### Fedora Operating System Plugin Usage
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
87
0e95b43 @goldmann updated BG executable name
goldmann authored
88 boxgrinder-build fedora-13.appl
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
89
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
90
91
92
93
94
95
96
97
98 ### CentOS Operating System Plugin
99
100 ***
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
101
102 This plugin creates base disk image with CentOS operating system installed.
103
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
104 #### CentOS Operating System Plugin Configuration
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
105
106 plugins:
107 centos:
108 format: qcow2 # Disk format to use. Default: raw.
109
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
110 #### CentOS Operating System Plugin Examples
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
111
112 `centos-5.appl`:
113
114 name: centos-5
115 os:
116 name: centos
117 version: 5
118
119 [...]
120
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
121 #### CentOS Operating System Plugin Usage
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
122
0e95b43 @goldmann updated BG executable name
goldmann authored
123 boxgrinder-build centos-5.appl
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
124
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
125
126
127
128
129
130
131
132
133 ### RHEL Operating System Plugin
134
135 ***
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
136
137 This plugin creates base disk image with RHEL operating system installed.
138
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
139 #### RHEL Operating System Plugin Configuration
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
140
141 plugins:
142 rhel:
143 format: qcow2 # Disk format to use. Default: raw.
144
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
145 #### RHEL Operating System Plugin Examples
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
146
147 `rhel-6.appl`:
148
149 name: rhel-6
150 os:
151 name: rhel
152 version: 6
153
154 [...]
155
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
156 #### RHEL Operating System Plugin Usage
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
157
0e95b43 @goldmann updated BG executable name
goldmann authored
158 boxgrinder-build rhel-6.appl
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
159
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
160
161
162
163
164 ## Platform plugins
165
166
167
168
169
170 ### VMware Platform Plugin
171
172 ***
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
173
174 This plugin creates disk image and descriptors consumable by VMware virtualization software. There are two types of disk and virtual machine descriptors created:
175
176 1. personal,
177 2. enterprise.
178
179 Personal is meant to use with VMware Fusion, Player, Workstation. Enterprise should be used with VMware vSphere, ESX/i.
180
181 > Note: Read README file created along with the image before you launch it for detailed instructions
182
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
183 #### VMware Platform Plugin Supported operating systems
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
184
7214aaa @goldmann Site prepared for 0.9.0 release with announcement, docs fix and some …
goldmann authored
185 * Fedora - all versions
186 * RHEL - all versions
187 * CentOS - all versions
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
188
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
189 #### VMware Platform Plugin Configuration
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
190
191 plugins:
192 vmware:
193 type: personal # or enterprise (required)
194 thin_disk: true # default: false
195
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
196 #### VMware Platform Plugin Examples
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
197
0e95b43 @goldmann updated BG executable name
goldmann authored
198 boxgrinder-build jeos.appl -p vmware
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
199
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
200
201
202
203
204
205
206
207
208
209
210
211 ### VirtualBox Platform Plugin
212
213 ***
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
214
215 This plugin creates disk image and descriptors consumable by VirtualBox virtualization software. Created disk is in vmdk format, you need to import it to your library, create new virtual machine and use imported disk.
216
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
217 #### VirtualBox Platform Plugin Supported operating systems
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
218
7214aaa @goldmann Site prepared for 0.9.0 release with announcement, docs fix and some …
goldmann authored
219 * Fedora - all versions
220 * RHEL - all versions
221 * CentOS - all versions
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
222
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
223 #### VirtualBox Platform Plugin Configuration
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
224
225 > No configuration required
226
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
227 #### VirtualBox Platform Plugin Examples
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
228
0e95b43 @goldmann updated BG executable name
goldmann authored
229 boxgrinder-build jeos.appl -p virtualbox
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
230
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
231
232
233
234
235
236
237
238
239
240 ### EC2 Platform Plugin
241
242 ***
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
243
244 This plugin creates a EC2 disk image.
245
246 > Note: Created image **isn't a bundled AMI** – it is a disk image prepared to be bundled and delivered by the S3 plugin.
247
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
248 #### EC2 Platform Plugin Supported operating systems
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
249
7214aaa @goldmann Site prepared for 0.9.0 release with announcement, docs fix and some …
goldmann authored
250 * Fedora - all versions
251 * RHEL - all versions
252 * CentOS - all versions
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
253
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
254 #### EC2 Platform Plugin Configuration
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
255
256 > No configuration required
257
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
258 #### EC2 Platform Plugin Examples
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
259
0e95b43 @goldmann updated BG executable name
goldmann authored
260 boxgrinder-build jeos.appl -p ec2
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
261
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
262
263
264
265
266 ## Delivery plugins
267
268
269
270
271
272
273
274 ### Local delivery plugin
275
276 ***
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
277
278 This plugin delivers the artifacts to specified path on local filesystem.
279
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
280 #### Local delivery plugin Supported operating systems
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
281
7214aaa @goldmann Site prepared for 0.9.0 release with announcement, docs fix and some …
goldmann authored
282 * Fedora - all versions
283 * RHEL - all versions
284 * CentOS - all versions
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
285
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
286 #### Local delivery plugin Supported platforms
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
287
7214aaa @goldmann Site prepared for 0.9.0 release with announcement, docs fix and some …
goldmann authored
288 All platforms.
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
289
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
290 #### Local delivery plugin Configuration
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
291
292 plugins:
293 local:
294 path: /home/oddthesis/builds # (required)
295 overwrite: false # default: false
296 package: false # default: true
297
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
298 #### Local delivery plugin Examples
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
299
300 VMware appliance delivered to local filesystem:
301
0e95b43 @goldmann updated BG executable name
goldmann authored
302 boxgrinder-build jeos.appl -p vmware -d local
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
303
304 VirtualBox appliance delivered to local filesystem:
305
0e95b43 @goldmann updated BG executable name
goldmann authored
306 boxgrinder-build jeos.appl -p virtualbox -d local
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
307
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
308
309
310
311
312
313
314
315
316
317
318
319 ### SFTP Delivery Plugin
320
321 ***
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
322
323 This plugin copies artifacts to a remote location using SFTP protocol.
324
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
325 #### SFTP Delivery Plugin Supported operating systems
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
326
7214aaa @goldmann Site prepared for 0.9.0 release with announcement, docs fix and some …
goldmann authored
327 * Fedora - all versions
328 * RHEL - all versions
329 * CentOS - all versions
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
330
7214aaa @goldmann Site prepared for 0.9.0 release with announcement, docs fix and some …
goldmann authored
331 #### SFTP Delivery Plugin Supported platforms
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
332
7214aaa @goldmann Site prepared for 0.9.0 release with announcement, docs fix and some …
goldmann authored
333 All platforms.
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
334
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
335 #### SFTP Delivery Plugin Configuration
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
336
337 plugins:
338 sftp:
339 path: /var/uploads # required
340 username: stormgrind # required
341 host: myhost.com # required
342
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
343 #### SFTP Delivery Plugin Examples
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
344
345 VMware appliance delivered to remote SFTP server:
346
0e95b43 @goldmann updated BG executable name
goldmann authored
347 boxgrinder-build jeos.appl -p vmware -d sftp
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
348
349 VirtualBox appliance delivered to remote SFTP server:
350
0e95b43 @goldmann updated BG executable name
goldmann authored
351 boxgrinder-build jeos.appl -p virtualbox -d sftp
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
352
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
353
354
355
356
357
358
359
360
361
362
363 ### S3 Delivery Plugin
364
365 ***
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
366
367 This plugin delivers artifacts to a S3 bucket. The plugin is able to deliver artifact in three types:
368
369 * **s3** - a packaged (.tgz) image with metadata - good for distribution,
370 * **cloudfront** - a packaged image with metadata (same as for s3 type) for public download using CloudFront - great for distribution, you need to have CloudFront enabled for your account,
371 * **ami** - creates an AMI from selected image and registers it in Amazon EC2. After that the AMI will be visible for you as a private image and ready to run. This type is only available for images in EC2 format (converted using "-p ec2" switch).
372
7214aaa @goldmann Site prepared for 0.9.0 release with announcement, docs fix and some …
goldmann authored
373 #### S3 Delivery Plugin supported operating systems
374
375 * Fedora - all versions
376 * RHEL - all versions
377 * CentOS - all versions
378
379 #### S3 Delivery Plugin Supported platforms
380
381 * EC2
382
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
383 #### S3 Delivery Plugin Configuration
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
384
385 plugins:
386 s3:
387 access_key: AWS_ACCESS_KEY # (required)
388 secret_access_key: AWS_SECRET_ACCESS_KEY # (required)
389 bucket: stormgrind-test # (required)
390 account_number: 0000-0000-0000 # (required)
391 path: /images # default: /
392 cert_file: /home/a/cert-ABCD.pem # required only for ami type
393 key_file: /home/a/pk-ABCD.pem # required only for ami type
394 host: http://host:8773/services/Walrus # default: http://s3.amazonaws.com; host used to upload AMI
39049eb @msavy Update plugin user documentation
msavy authored
395 snapshot: true # default: false
396 overwrite: false # default: false
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
397
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
398 #### S3 Delivery Plugin Examples
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
399
400 EC2 AMI for `jeos.appl`:
401
0e95b43 @goldmann updated BG executable name
goldmann authored
402 boxgrinder-build jeos.appl -p ec2 -d ami
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
403
404 Packaged VirtualBox appliance delivered to CloudFront server:
405
0e95b43 @goldmann updated BG executable name
goldmann authored
406 boxgrinder-build jeos.appl -p virtualbox -d cloudfront
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
407
408 Packaged VirtualBox appliance delivered to S3 bucket:
409
0e95b43 @goldmann updated BG executable name
goldmann authored
410 boxgrinder-build jeos.appl -p virtualbox -d s3
39049eb @msavy Update plugin user documentation
msavy authored
411
412 Use overwrite to delete the existing resource with the same name. This works with AMI, S3 and EBS.
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
413
39049eb @msavy Update plugin user documentation
msavy authored
414 boxgrinder-build jeos.appl -d ec2 --delivery-config overwrite:true
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
415
39049eb @msavy Update plugin user documentation
msavy authored
416 You can use overwrite with snapshot, this will overwrite only the _last_ snapshot delivered
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
417
39049eb @msavy Update plugin user documentation
msavy authored
418 boxgrinder-build jeos.appl -p ec2 -d s3 --delivery-config snapshot:true,overwrite:true
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
419
39049eb @msavy Update plugin user documentation
msavy authored
420 If you enable snapshotted delivery, each version delivered version will have an incremented snapshot number to guarantee naming uniqueness.
421
422 boxgrinder-build jeos.appl -p ec2 -d ami --delivery-config snapshot:true
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
423
424
425
426
427
428
429
430
431 ### EBS Delivery Plugin
432
433 ***
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
434
435 This plugin delivers appliance as EBS-based AMI to AWS.
436
437 > Note: Only appliances converted to EC2 format using EC2 platform plugin can be delivered as EBS AMI's.
438
439 > **Warning:** You can use this plugin only on instances running on EC2. This plugin will not work on your local host because we need to mount EBS volume to copy the data and we cannot do a remote mount. You can use meta appliance AMI to create EBS AMI's.
440
7214aaa @goldmann Site prepared for 0.9.0 release with announcement, docs fix and some …
goldmann authored
441 #### EBS Delivery Plugin supported operating systems
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
442
7214aaa @goldmann Site prepared for 0.9.0 release with announcement, docs fix and some …
goldmann authored
443 * Fedora - all versions
444 * RHEL - 6
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
445
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
446 #### EBS Delivery Plugin Supported platforms
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
447
7214aaa @goldmann Site prepared for 0.9.0 release with announcement, docs fix and some …
goldmann authored
448 * EC2
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
449
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
450 #### EBS Delivery Plugin Configuration
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
451
452 plugins:
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
453 ebs:
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
454 access_key: AWS_ACCESS_KEY # required
455 secret_access_key: AWS_SECRET_ACCESS_KEY # required
456 account_number: AWS_ACCOUNT_NUMBER # required
457 delete_on_termination: false # default: true
39049eb @msavy Update plugin user documentation
msavy authored
458 snapshot: true # default: false
459 overwrite: false # default: false
460 preserve_snapshots: false # default: false
461
462 > Note: The delete\_on\_termination flag is used to specify if the root volume should be deleted after the instance is terminated.
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
463
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
464 #### EBS Delivery Plugin Examples
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
465
7214aaa @goldmann Site prepared for 0.9.0 release with announcement, docs fix and some …
goldmann authored
466 EBS-based AMI for `jeos.appl`:
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
467
0e95b43 @goldmann updated BG executable name
goldmann authored
468 boxgrinder-build jeos.appl -p ec2 -d ebs
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
469
39049eb @msavy Update plugin user documentation
msavy authored
470 Overwrite any previous EBS backed AMI with the same name, version and release as specified in `jeos.appl`, but preserve any snapshot associated with the previous build.
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
471
39049eb @msavy Update plugin user documentation
msavy authored
472 boxgrinder-build jeos.appl -p ec2 -d ebs --delivery-config overwrite:true,preserve_snapshots:true
23a9545 @goldmann imported all blog posts from cloudpress.org and most of articles at j…
goldmann authored
473
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
474
c5dbc4d @goldmann elastichosts delviery plugin usage
goldmann authored
475
476 ### ElasticHosts Delivery Plugin
477
b95b79c @goldmann specified minimal BG version to use elastichosts plugin
goldmann authored
478 Added in BoxGrinder **0.9.1**
479
c5dbc4d @goldmann elastichosts delviery plugin usage
goldmann authored
480 ***
481
32591fa @goldmann time update + cloudsigma plugin config update
goldmann authored
482 This plugin delivers an appliance to [ElasticHosts](http://www.elastichosts.com/) Cloud. It can be used for any Cloud using the ElasticHosts API, such as [SKALI Cloud](http://www.skalicloud.com/), [Open Hosting](http://www.openhosting.com/), [Serverlove](http://www.serverlove.com/) and [CloudSigma](http://www.cloudsigma.com/).
c5dbc4d @goldmann elastichosts delviery plugin usage
goldmann authored
483
82505e4 @goldmann Support for new clouds blog post and map!
goldmann authored
484 > Note: Only base appliances (output of [Operating System plugins][os_plugins]) can be used by this plugin.
c5dbc4d @goldmann elastichosts delviery plugin usage
goldmann authored
485
486 #### ElasticHosts Delivery Plugin supported operating systems
487
488 All operating systems are supported.
489
490 #### ElasticHosts Delivery Plugin Supported platforms
491
492 * See above note.
493
0b39ede @tobias A little polish.
tobias authored
494 #### ElasticHosts Delivery Plugin Configuration
c5dbc4d @goldmann elastichosts delviery plugin usage
goldmann authored
495
496 plugins:
497 elastichosts:
498 endpoint: api.lon-p.elastichosts.com # required
18c3d03 @goldmann Updated ElasticHosts plugin configuration.
goldmann authored
499 username: your-user-id # required
500 password: your-secret-access-key # required
c5dbc4d @goldmann elastichosts delviery plugin usage
goldmann authored
501 chunk: 128 # default: 64 (in MB)
502 start_part: 6 # default: 0
503 wait: 30 # default: 5 (in s)
504 retry: 2 # default: 3
c7caf61 @goldmann added ssl property to elastichosts
goldmann authored
505 ssl: true # default: false
c5dbc4d @goldmann elastichosts delviery plugin usage
goldmann authored
506 drive_uuid: b161fd8b-d56s-4eea-9055-669daaec8aa4
507 drive_name: my-bg-drive
508
32591fa @goldmann time update + cloudsigma plugin config update
goldmann authored
509 > Note: `username` parameter is in most cases called *User UUID* wheras `password` is in most cases *Secret API Key*. For CloudSigma you need to specify your e-mail address and password instead of UUID/key combination.
18c3d03 @goldmann Updated ElasticHosts plugin configuration.
goldmann authored
510
0b39ede @tobias A little polish.
tobias authored
511 The appliance is **uploaded in chunks**. By default we set the chunk size to 64 MB; you are free to change this setting `chunk` property.
c5dbc4d @goldmann elastichosts delviery plugin usage
goldmann authored
512
0b39ede @tobias A little polish.
tobias authored
513 If the plugin encounters any errors while uploading the image it retries the operation up to **three times** (set the `retry` property to adjust, set 0 to disable) starting with the failed chunk. You can use the `wait` property (in seconds) to adjust the time between retries (default: 5). If it still fails you can try to execute the BoxGrinder Build command specifying the chunk to start with using the `start_part` property (default: 0). See examples below.
c5dbc4d @goldmann elastichosts delviery plugin usage
goldmann authored
514
0b39ede @tobias A little polish.
tobias authored
515 By default a new remote drive will be created with the name of appliance as the default name. The name is adjustable with `drive_name` property. You may also upload the appliance to an existing drive. In this case you specify the drive UUID as `drive_uuid`. Note that if you specify both `drive_uuid` and `drive_name` the latter will be ignored.
c5dbc4d @goldmann elastichosts delviery plugin usage
goldmann authored
516
c7caf61 @goldmann added ssl property to elastichosts
goldmann authored
517 Set `ssl` to true if you want establish a secure SSL connection to the server.
518
0b39ede @tobias A little polish.
tobias authored
519 #### ElasticHosts Delivery Plugin Examples
c5dbc4d @goldmann elastichosts delviery plugin usage
goldmann authored
520
521 Standard delivery for a sample JEOS appliance:
522
0e95b43 @goldmann updated BG executable name
goldmann authored
523 boxgrinder-build jeos.appl -d elastichosts
c5dbc4d @goldmann elastichosts delviery plugin usage
goldmann authored
524
0b39ede @tobias A little polish.
tobias authored
525 Start delivery with the 6th chunk:
c5dbc4d @goldmann elastichosts delviery plugin usage
goldmann authored
526
527 boxgrinder-build jeos.appl -d elastichosts --delivery-config start_part:6
528
0b39ede @tobias A little polish.
tobias authored
529 Use an already existing disk:
c5dbc4d @goldmann elastichosts delviery plugin usage
goldmann authored
530
82505e4 @goldmann Support for new clouds blog post and map!
goldmann authored
531 boxgrinder-build jeos.appl -d elastichosts --delivery-config chunk:128,disk_uuid:b161fd8b-d56s-4eea-9055-669daaec8aa4
c5dbc4d @goldmann elastichosts delviery plugin usage
goldmann authored
532
533
82505e4 @goldmann Support for new clouds blog post and map!
goldmann authored
534 [os_plugins]: #Operating_system_plugins
c5dbc4d @goldmann elastichosts delviery plugin usage
goldmann authored
535
6ec942b @goldmann Much more readable plugin list page.
goldmann authored
536 [fedora]: #Fedora_Operating_System_Plugin
537 [centos]: #CentOS_Operating_System_Plugin
538 [rhel]: #RHEL_Operating_System_Plugin
539
540 [vmware]: #VMware_Platform_Plugin
541 [virtualbox]: #VirtualBox_Platform_Plugin
542 [ec2]: #EC2_Platform_Plugin
543
544 [local]: #Local_delivery_plugin
545 [sftp]: #SFTP_Delivery_Plugin
546 [s3]: #S3_Delivery_Plugin
7214aaa @goldmann Site prepared for 0.9.0 release with announcement, docs fix and some …
goldmann authored
547 [ebs]: #EBS_Delivery_Plugin
39049eb @msavy Update plugin user documentation
msavy authored
548 [elastichosts]: #ElasticHosts_Delivery_Plugin
Something went wrong with that request. Please try again.