summaryrefslogtreecommitdiffabout
path: root/doc/eclat-mkimg.1
blob: f5da86866179d2b45f8f7819aedfaa6513d7393c (plain)
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
.\" This file is part of Eclat -*- nroff -*-
.\" Copyright (C) 2012-2015 Sergey Poznyakoff
.\"
.\" Eclat is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3, or (at your option)
.\" any later version.
.\"
.\" Eclat is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with Eclat.  If not, see <http://www.gnu.org/licenses/>.
.TH ECLAT-MKIMG 1 "January 26, 2015" "ECLAT" "Eclat User Reference"
.SH NAME
eclat-mkimg, eclat-create-image \- create an AMI image
.SH SYNOPSIS
.nh
.na
\fBeclat mkimg\fR\
 [\fB\-N\fR]\
 [\fB\-d\fR \fIDESCR\fR]\
 [\fB\-m\fR \fIDEV\fR=\fISPEC\fR]\
 [\fB\-\-noreboot\fR]\
 [\fB\-\-no\-reboot\fR]\
 [\fB\-\-description\fR=\fISTRING\fR]\
 [\fB\-\-devmap\fR=\fIDEV\fR=\fISPEC\fR]\
 [\fB\-\-block\-device\-mapping\fR=\fIDEV\fR=\fISPEC\fR]\
 \fINAME\fR \fIINSTANCE\-ID\fR
.PP
\fBeclat mkimg\fR \fB\-\-help\fR
.ad
.hy
.SH DESCRIPTION
This command creates an Amazon EBS-backed AMI from an existing
instance \fIINSTANCE\-ID\fR.  If the instance is running it will be
rebooted, unless the \fB\-N\fR (\fB\-\-noreboot\fR) option is used.
.PP
The \fINAME\fR argument sets the name of the new AMI.
.PP
Upon successful completion the ID of the newly created AMI is printed
on the stdandard output.
.SH OPTIONS
.TP
\fB\-N\fB, \fB\-\-noreboot\fR, \fB\-\-no\-reboot\fR
Don't shut down the instance before creating the image.
.TP
\fB\-d\fR, \fB\-\-description\fR=\fISTRING\fR
Set a description for the new image.
.TP
\fB\-m\fR, \fB\-\-devmap\fR, \fB\-\-block\-device\-mapping\fR=\fIDEV\fR=\fISPEC\fR
Set block device mapping for the instances to be created from that
AMI.  The \fIDEV\fR part is the device name of the physical device on
the instance to map.  The \fISPEC\fR sets the mapping specification
and can be one of:
.RS 4
.TP
.B none
Disable the existing mapping.  E.g. \fB\-m /dev/xvdb=none\fR disables
the mapping for the device \fB/dev/xvdb\fR.
.TP
.BR ephemeral [0-3]
Map an instance store volume to the device.  E.g. \fB\-m
/dev/xvdb=ephemeral1\fR.
.TP
[\fIsnapshot\-id\fR]:\
[\fIvolume\-size\fR]:\
[\fIDOT\fR]:\
[\fIstandard\fR|\fIio1\fR[:\fIiops\fR]]
Specifies an EBS volume to be mapped to the device.  The
\fIsnapshot\-id\fR specifies the ID of the snapshot to create the
volume from, \fIvolume\-size\fR gives the desired size of the volume
in gigabytes.  The \fIDOT\fR parameter (\fBdelete on termination\fR)
specifies whether the device should be deleted after the instance is
terminated.  Possible values are \fBtrue\fR and \fBfalse\fR.  The last
parameter defines the volume type.  The value \fBstandard\fR instructs
Amazon to create a standard volume.  This is the default.  To create a
provisioned IOPS volume, specify \fBio1\fR.  In that case you can also
supply the number of IOPS that the volume supports in the 
\fIiops\fR argument.  For example, \fB\-m
/dev/xvdf=snap-12345abc::false:io1:500\fR.
.RE
.TP
\fB\-h\fR, \fB\-\-help\fR
Display a short usage summary.
.SH "SEE ALSO"
.BR eclat (1),
.BR eclat\-lsimg (1),
.BR eclat\-deimg (1).
.SH AUTHORS
Sergey Poznyakoff
.SH "BUG REPORTS"
Report bugs to <bug\-eclat@gnu.org.ua>.
.SH COPYRIGHT
Copyright \(co 2012-2015 Sergey Poznyakoff
.br
.na
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
.br
.ad
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.\" Local variables:
.\" eval: (add-hook 'write-file-hooks 'time-stamp)
.\" time-stamp-start: ".TH [A-Z_][A-Z0-9_.\\-]* [0-9] \""
.\" time-stamp-format: "%:B %:d, %:y"
.\" time-stamp-end: "\""
.\" time-stamp-line-limit: 20
.\" end:

Return to:

Send suggestions and report system problems to the System administrator.