root / man / gnt-instance.rst @ e37f47d3
History | View | Annotate | Download (61.5 kB)
1 | 1b7f2c85 | Iustin Pop | gnt-instance(8) Ganeti | Version @GANETI_VERSION@ |
---|---|---|---|
2 | 1b7f2c85 | Iustin Pop | ================================================= |
3 | 1b7f2c85 | Iustin Pop | |
4 | 1b7f2c85 | Iustin Pop | Name |
5 | 1b7f2c85 | Iustin Pop | ---- |
6 | 1b7f2c85 | Iustin Pop | |
7 | 1b7f2c85 | Iustin Pop | gnt-instance - Ganeti instance administration |
8 | 1b7f2c85 | Iustin Pop | |
9 | 1b7f2c85 | Iustin Pop | Synopsis |
10 | 1b7f2c85 | Iustin Pop | -------- |
11 | 1b7f2c85 | Iustin Pop | |
12 | 1b7f2c85 | Iustin Pop | **gnt-instance** {command} [arguments...] |
13 | 1b7f2c85 | Iustin Pop | |
14 | 1b7f2c85 | Iustin Pop | DESCRIPTION |
15 | 1b7f2c85 | Iustin Pop | ----------- |
16 | 1b7f2c85 | Iustin Pop | |
17 | 1b7f2c85 | Iustin Pop | The **gnt-instance** command is used for instance administration in |
18 | 1b7f2c85 | Iustin Pop | the Ganeti system. |
19 | 1b7f2c85 | Iustin Pop | |
20 | 1b7f2c85 | Iustin Pop | COMMANDS |
21 | 1b7f2c85 | Iustin Pop | -------- |
22 | 1b7f2c85 | Iustin Pop | |
23 | 1b7f2c85 | Iustin Pop | Creation/removal/querying |
24 | 1b7f2c85 | Iustin Pop | ~~~~~~~~~~~~~~~~~~~~~~~~~ |
25 | 1b7f2c85 | Iustin Pop | |
26 | 1b7f2c85 | Iustin Pop | ADD |
27 | 1b7f2c85 | Iustin Pop | ^^^ |
28 | 1b7f2c85 | Iustin Pop | |
29 | 1b7f2c85 | Iustin Pop | | **add** |
30 | e8f936b0 | Iustin Pop | | {-t|\--disk-template {diskless | file \| plain \| drbd \| rbd}} |
31 | e8f936b0 | Iustin Pop | | {\--disk=*N*: {size=*VAL* \| adopt=*LV*}[,vg=*VG*][,metavg=*VG*][,mode=*ro\|rw*] |
32 | e8f936b0 | Iustin Pop | | \| {-s|\--os-size} *SIZE*} |
33 | e8f936b0 | Iustin Pop | | [\--no-ip-check] [\--no-name-check] [\--no-start] [\--no-install] |
34 | e8f936b0 | Iustin Pop | | [\--net=*N* [:options...] \| \--no-nics] |
35 | e8f936b0 | Iustin Pop | | [{-B|\--backend-parameters} *BEPARAMS*] |
36 | e8f936b0 | Iustin Pop | | [{-H|\--hypervisor-parameters} *HYPERVISOR* [: option=*value*... ]] |
37 | e8f936b0 | Iustin Pop | | [{-O|\--os-parameters} *param*=*value*... ] |
38 | e8f936b0 | Iustin Pop | | [\--file-storage-dir *dir\_path*] [\--file-driver {loop \| blktap}] |
39 | e8f936b0 | Iustin Pop | | {{-n|\--node} *node[:secondary-node]* \| {-I|\--iallocator} *name*} |
40 | e8f936b0 | Iustin Pop | | {{-o|\--os-type} *os-type*} |
41 | e8f936b0 | Iustin Pop | | [\--submit] |
42 | e8f936b0 | Iustin Pop | | [\--ignore-ipolicy] |
43 | 1b7f2c85 | Iustin Pop | | {*instance*} |
44 | 1b7f2c85 | Iustin Pop | |
45 | 1b7f2c85 | Iustin Pop | Creates a new instance on the specified host. The *instance* argument |
46 | 1b7f2c85 | Iustin Pop | must be in DNS, but depending on the bridge/routing setup, need not be |
47 | 1b7f2c85 | Iustin Pop | in the same network as the nodes in the cluster. |
48 | 1b7f2c85 | Iustin Pop | |
49 | 1b7f2c85 | Iustin Pop | The ``disk`` option specifies the parameters for the disks of the |
50 | 1b7f2c85 | Iustin Pop | instance. The numbering of disks starts at zero, and at least one disk |
51 | 1b7f2c85 | Iustin Pop | needs to be passed. For each disk, either the size or the adoption |
52 | 1b7f2c85 | Iustin Pop | source needs to be given, and optionally the access mode (read-only or |
53 | 87001920 | Iustin Pop | the default of read-write) and the LVM volume group can also be |
54 | 87001920 | Iustin Pop | specified (via the ``vg`` key). For DRBD devices, a different VG can |
55 | 87001920 | Iustin Pop | be specified for the metadata device using the ``metavg`` key. The |
56 | 87001920 | Iustin Pop | size is interpreted (when no unit is given) in mebibytes. You can also |
57 | 87001920 | Iustin Pop | use one of the suffixes *m*, *g* or *t* to specify the exact the units |
58 | 87001920 | Iustin Pop | used; these suffixes map to mebibytes, gibibytes and tebibytes. |
59 | 1b7f2c85 | Iustin Pop | |
60 | 1b7f2c85 | Iustin Pop | When using the ``adopt`` key in the disk definition, Ganeti will |
61 | 1b7f2c85 | Iustin Pop | reuse those volumes (instead of creating new ones) as the |
62 | 1b7f2c85 | Iustin Pop | instance's disks. Ganeti will rename these volumes to the standard |
63 | 1b7f2c85 | Iustin Pop | format, and (without installing the OS) will use them as-is for the |
64 | 1b7f2c85 | Iustin Pop | instance. This allows migrating instances from non-managed mode |
65 | 1cdc9dbb | Bernardo Dal Seno | (e.g. plain KVM with LVM) to being managed via Ganeti. Please note that |
66 | 1b7f2c85 | Iustin Pop | this works only for the \`plain' disk template (see below for |
67 | 1b7f2c85 | Iustin Pop | template details). |
68 | 1b7f2c85 | Iustin Pop | |
69 | 1b7f2c85 | Iustin Pop | Alternatively, a single-disk instance can be created via the ``-s`` |
70 | 1b7f2c85 | Iustin Pop | option which takes a single argument, the size of the disk. This is |
71 | 1b7f2c85 | Iustin Pop | similar to the Ganeti 1.2 version (but will only create one disk). |
72 | 1b7f2c85 | Iustin Pop | |
73 | 1b7f2c85 | Iustin Pop | The minimum disk specification is therefore ``--disk 0:size=20G`` (or |
74 | 1b7f2c85 | Iustin Pop | ``-s 20G`` when using the ``-s`` option), and a three-disk instance |
75 | 1b7f2c85 | Iustin Pop | can be specified as ``--disk 0:size=20G --disk 1:size=4G --disk |
76 | 1b7f2c85 | Iustin Pop | 2:size=100G``. |
77 | 1b7f2c85 | Iustin Pop | |
78 | 1b7f2c85 | Iustin Pop | The ``--no-ip-check`` skips the checks that are done to see if the |
79 | 1b7f2c85 | Iustin Pop | instance's IP is not already alive (i.e. reachable from the master |
80 | 1b7f2c85 | Iustin Pop | node). |
81 | 1b7f2c85 | Iustin Pop | |
82 | 1b7f2c85 | Iustin Pop | The ``--no-name-check`` skips the check for the instance name via |
83 | 1b7f2c85 | Iustin Pop | the resolver (e.g. in DNS or /etc/hosts, depending on your setup). |
84 | 1b7f2c85 | Iustin Pop | Since the name check is used to compute the IP address, if you pass |
85 | 1b7f2c85 | Iustin Pop | this option you must also pass the ``--no-ip-check`` option. |
86 | 1b7f2c85 | Iustin Pop | |
87 | 50c1e351 | Bernardo Dal Seno | If you don't want the instance to automatically start after |
88 | 1b7f2c85 | Iustin Pop | creation, this is possible via the ``--no-start`` option. This will |
89 | 1b7f2c85 | Iustin Pop | leave the instance down until a subsequent **gnt-instance start** |
90 | 1b7f2c85 | Iustin Pop | command. |
91 | 1b7f2c85 | Iustin Pop | |
92 | 1b7f2c85 | Iustin Pop | The NICs of the instances can be specified via the ``--net`` |
93 | 1b7f2c85 | Iustin Pop | option. By default, one NIC is created for the instance, with a |
94 | 1b7f2c85 | Iustin Pop | random MAC, and set up according the the cluster level nic |
95 | 1b7f2c85 | Iustin Pop | parameters. Each NIC can take these parameters (all optional): |
96 | 1b7f2c85 | Iustin Pop | |
97 | 1b7f2c85 | Iustin Pop | mac |
98 | 1b7f2c85 | Iustin Pop | either a value or 'generate' to generate a new unique MAC |
99 | 1b7f2c85 | Iustin Pop | |
100 | 1b7f2c85 | Iustin Pop | ip |
101 | 1b7f2c85 | Iustin Pop | specifies the IP address assigned to the instance from the Ganeti |
102 | 1b7f2c85 | Iustin Pop | side (this is not necessarily what the instance will use, but what |
103 | 1b7f2c85 | Iustin Pop | the node expects the instance to use) |
104 | 1b7f2c85 | Iustin Pop | |
105 | 1b7f2c85 | Iustin Pop | mode |
106 | 1b7f2c85 | Iustin Pop | specifies the connection mode for this nic: routed or bridged. |
107 | 1b7f2c85 | Iustin Pop | |
108 | 1b7f2c85 | Iustin Pop | link |
109 | 1b7f2c85 | Iustin Pop | in bridged mode specifies the bridge to attach this NIC to, in |
110 | 1b7f2c85 | Iustin Pop | routed mode it's intended to differentiate between different |
111 | 9d0671ba | Iustin Pop | routing tables/instance groups (but the meaning is dependent on |
112 | 9d0671ba | Iustin Pop | the network script, see gnt-cluster(8) for more details) |
113 | 1b7f2c85 | Iustin Pop | |
114 | 1b7f2c85 | Iustin Pop | |
115 | 1b7f2c85 | Iustin Pop | Of these "mode" and "link" are nic parameters, and inherit their |
116 | 9d0671ba | Iustin Pop | default at cluster level. Alternatively, if no network is desired for |
117 | 9d0671ba | Iustin Pop | the instance, you can prevent the default of one NIC with the |
118 | 9d0671ba | Iustin Pop | ``--no-nics`` option. |
119 | 1b7f2c85 | Iustin Pop | |
120 | 0a68e0ff | Iustin Pop | The ``-o (--os-type)`` option specifies the operating system to be |
121 | 0a68e0ff | Iustin Pop | installed. The available operating systems can be listed with |
122 | 0a68e0ff | Iustin Pop | **gnt-os list**. Passing ``--no-install`` will however skip the OS |
123 | 0a68e0ff | Iustin Pop | installation, allowing a manual import if so desired. Note that the |
124 | 1b7f2c85 | Iustin Pop | no-installation mode will automatically disable the start-up of the |
125 | 1b7f2c85 | Iustin Pop | instance (without an OS, it most likely won't be able to start-up |
126 | 1b7f2c85 | Iustin Pop | successfully). |
127 | 1b7f2c85 | Iustin Pop | |
128 | 0a68e0ff | Iustin Pop | The ``-B (--backend-parameters)`` option specifies the backend |
129 | 0a68e0ff | Iustin Pop | parameters for the instance. If no such parameters are specified, the |
130 | 0a68e0ff | Iustin Pop | values are inherited from the cluster. Possible parameters are: |
131 | 1b7f2c85 | Iustin Pop | |
132 | 90bb3fe1 | Guido Trotter | maxmem |
133 | 90bb3fe1 | Guido Trotter | the maximum memory size of the instance; as usual, suffixes can be |
134 | 1cdc9dbb | Bernardo Dal Seno | used to denote the unit, otherwise the value is taken in mebibytes |
135 | 90bb3fe1 | Guido Trotter | |
136 | 90bb3fe1 | Guido Trotter | minmem |
137 | 90bb3fe1 | Guido Trotter | the minimum memory size of the instance; as usual, suffixes can be |
138 | 1cdc9dbb | Bernardo Dal Seno | used to denote the unit, otherwise the value is taken in mebibytes |
139 | 1b7f2c85 | Iustin Pop | |
140 | 1b7f2c85 | Iustin Pop | vcpus |
141 | 1b7f2c85 | Iustin Pop | the number of VCPUs to assign to the instance (if this value makes |
142 | 1b7f2c85 | Iustin Pop | sense for the hypervisor) |
143 | 1b7f2c85 | Iustin Pop | |
144 | 1b7f2c85 | Iustin Pop | auto\_balance |
145 | 1b7f2c85 | Iustin Pop | whether the instance is considered in the N+1 cluster checks |
146 | 1b7f2c85 | Iustin Pop | (enough redundancy in the cluster to survive a node failure) |
147 | 1b7f2c85 | Iustin Pop | |
148 | 11dc66f3 | Bernardo Dal Seno | always\_failover |
149 | 11dc66f3 | Bernardo Dal Seno | ``True`` or ``False``, whether the instance must be failed over |
150 | 11dc66f3 | Bernardo Dal Seno | (shut down and rebooted) always or it may be migrated (briefly |
151 | 11dc66f3 | Bernardo Dal Seno | suspended) |
152 | 11dc66f3 | Bernardo Dal Seno | |
153 | 90bb3fe1 | Guido Trotter | Note that before 2.6 Ganeti had a ``memory`` parameter, which was the |
154 | 90bb3fe1 | Guido Trotter | only value of memory an instance could have. With the |
155 | 90bb3fe1 | Guido Trotter | ``maxmem``/``minmem`` change Ganeti guarantees that at least the minimum |
156 | 90bb3fe1 | Guido Trotter | memory is always available for an instance, but allows more memory to be |
157 | 90bb3fe1 | Guido Trotter | used (up to the maximum memory) should it be free. |
158 | 1b7f2c85 | Iustin Pop | |
159 | 0a68e0ff | Iustin Pop | The ``-H (--hypervisor-parameters)`` option specified the hypervisor |
160 | 0a68e0ff | Iustin Pop | to use for the instance (must be one of the enabled hypervisors on the |
161 | 0a68e0ff | Iustin Pop | cluster) and optionally custom parameters for this instance. If not |
162 | 0a68e0ff | Iustin Pop | other options are used (i.e. the invocation is just -H *NAME*) the |
163 | 0a68e0ff | Iustin Pop | instance will inherit the cluster options. The defaults below show the |
164 | 0a68e0ff | Iustin Pop | cluster defaults at cluster creation time. |
165 | 1b7f2c85 | Iustin Pop | |
166 | 1b7f2c85 | Iustin Pop | The possible hypervisor options are as follows: |
167 | 1b7f2c85 | Iustin Pop | |
168 | 1b7f2c85 | Iustin Pop | boot\_order |
169 | 1b7f2c85 | Iustin Pop | Valid for the Xen HVM and KVM hypervisors. |
170 | 1b7f2c85 | Iustin Pop | |
171 | 1b7f2c85 | Iustin Pop | A string value denoting the boot order. This has different meaning |
172 | 1b7f2c85 | Iustin Pop | for the Xen HVM hypervisor and for the KVM one. |
173 | 1b7f2c85 | Iustin Pop | |
174 | 1b7f2c85 | Iustin Pop | For Xen HVM, The boot order is a string of letters listing the boot |
175 | 1b7f2c85 | Iustin Pop | devices, with valid device letters being: |
176 | 1b7f2c85 | Iustin Pop | |
177 | 1b7f2c85 | Iustin Pop | a |
178 | 1b7f2c85 | Iustin Pop | floppy drive |
179 | 1b7f2c85 | Iustin Pop | |
180 | 1b7f2c85 | Iustin Pop | c |
181 | 1b7f2c85 | Iustin Pop | hard disk |
182 | 1b7f2c85 | Iustin Pop | |
183 | 1b7f2c85 | Iustin Pop | d |
184 | 1b7f2c85 | Iustin Pop | CDROM drive |
185 | 1b7f2c85 | Iustin Pop | |
186 | 1b7f2c85 | Iustin Pop | n |
187 | 1b7f2c85 | Iustin Pop | network boot (PXE) |
188 | 1b7f2c85 | Iustin Pop | |
189 | 1cdc9dbb | Bernardo Dal Seno | The default is not to set an HVM boot order, which is interpreted |
190 | 9d0671ba | Iustin Pop | as 'dc'. |
191 | 1b7f2c85 | Iustin Pop | |
192 | 9d0671ba | Iustin Pop | For KVM the boot order is either "floppy", "cdrom", "disk" or |
193 | 2b846304 | Iustin Pop | "network". Please note that older versions of KVM couldn't netboot |
194 | 2b846304 | Iustin Pop | from virtio interfaces. This has been fixed in more recent versions |
195 | 2b846304 | Iustin Pop | and is confirmed to work at least with qemu-kvm 0.11.1. Also note |
196 | 2b846304 | Iustin Pop | that if you have set the ``kernel_path`` option, that will be used |
197 | 2b846304 | Iustin Pop | for booting, and this setting will be silently ignored. |
198 | 1b7f2c85 | Iustin Pop | |
199 | 525011bc | Maciej Bliziński | blockdev\_prefix |
200 | 525011bc | Maciej Bliziński | Valid for the Xen HVM and PVM hypervisors. |
201 | 525011bc | Maciej Bliziński | |
202 | f7b769b1 | Iustin Pop | Relevant to non-pvops guest kernels, in which the disk device names |
203 | f7b769b1 | Iustin Pop | are given by the host. Allows one to specify 'xvd', which helps run |
204 | 9d0671ba | Iustin Pop | Red Hat based installers, driven by anaconda. |
205 | 525011bc | Maciej Bliziński | |
206 | 81dd9bd1 | Marco Casavecchia | floppy\_image\_path |
207 | 81dd9bd1 | Marco Casavecchia | Valid for the KVM hypervisor. |
208 | 81dd9bd1 | Marco Casavecchia | |
209 | 9d0671ba | Iustin Pop | The path to a floppy disk image to attach to the instance. This |
210 | 9d0671ba | Iustin Pop | is useful to install Windows operating systems on Virt/IO disks |
211 | 9d0671ba | Iustin Pop | because you can specify here the floppy for the drivers at |
212 | 9d0671ba | Iustin Pop | installation time. |
213 | 525011bc | Maciej Bliziński | |
214 | 1b7f2c85 | Iustin Pop | cdrom\_image\_path |
215 | 1b7f2c85 | Iustin Pop | Valid for the Xen HVM and KVM hypervisors. |
216 | 1b7f2c85 | Iustin Pop | |
217 | 1b7f2c85 | Iustin Pop | The path to a CDROM image to attach to the instance. |
218 | 1b7f2c85 | Iustin Pop | |
219 | 81dd9bd1 | Marco Casavecchia | cdrom2\_image\_path |
220 | 81dd9bd1 | Marco Casavecchia | Valid for the KVM hypervisor. |
221 | 81dd9bd1 | Marco Casavecchia | |
222 | 81dd9bd1 | Marco Casavecchia | The path to a second CDROM image to attach to the instance. |
223 | 81dd9bd1 | Marco Casavecchia | **NOTE**: This image can't be used to boot the system. To do that |
224 | 81dd9bd1 | Marco Casavecchia | you have to use the 'cdrom\_image\_path' option. |
225 | 81dd9bd1 | Marco Casavecchia | |
226 | 1b7f2c85 | Iustin Pop | nic\_type |
227 | 1b7f2c85 | Iustin Pop | Valid for the Xen HVM and KVM hypervisors. |
228 | 1b7f2c85 | Iustin Pop | |
229 | 1b7f2c85 | Iustin Pop | This parameter determines the way the network cards are presented |
230 | 1b7f2c85 | Iustin Pop | to the instance. The possible options are: |
231 | 1b7f2c85 | Iustin Pop | |
232 | 0a68e0ff | Iustin Pop | - rtl8139 (default for Xen HVM) (HVM & KVM) |
233 | 0a68e0ff | Iustin Pop | - ne2k\_isa (HVM & KVM) |
234 | 0a68e0ff | Iustin Pop | - ne2k\_pci (HVM & KVM) |
235 | 0a68e0ff | Iustin Pop | - i82551 (KVM) |
236 | 0a68e0ff | Iustin Pop | - i82557b (KVM) |
237 | 0a68e0ff | Iustin Pop | - i82559er (KVM) |
238 | 0a68e0ff | Iustin Pop | - pcnet (KVM) |
239 | 0a68e0ff | Iustin Pop | - e1000 (KVM) |
240 | 0a68e0ff | Iustin Pop | - paravirtual (default for KVM) (HVM & KVM) |
241 | 1b7f2c85 | Iustin Pop | |
242 | 1b7f2c85 | Iustin Pop | disk\_type |
243 | 1b7f2c85 | Iustin Pop | Valid for the Xen HVM and KVM hypervisors. |
244 | 1b7f2c85 | Iustin Pop | |
245 | 1b7f2c85 | Iustin Pop | This parameter determines the way the disks are presented to the |
246 | 1b7f2c85 | Iustin Pop | instance. The possible options are: |
247 | 1b7f2c85 | Iustin Pop | |
248 | 9d0671ba | Iustin Pop | - ioemu [default] (HVM & KVM) |
249 | 9d0671ba | Iustin Pop | - ide (HVM & KVM) |
250 | 9d0671ba | Iustin Pop | - scsi (KVM) |
251 | 9d0671ba | Iustin Pop | - sd (KVM) |
252 | 9d0671ba | Iustin Pop | - mtd (KVM) |
253 | 9d0671ba | Iustin Pop | - pflash (KVM) |
254 | 1b7f2c85 | Iustin Pop | |
255 | 1b7f2c85 | Iustin Pop | |
256 | 81dd9bd1 | Marco Casavecchia | cdrom\_disk\_type |
257 | 81dd9bd1 | Marco Casavecchia | Valid for the KVM hypervisor. |
258 | 1b7f2c85 | Iustin Pop | |
259 | 9d0671ba | Iustin Pop | This parameter determines the way the cdroms disks are presented |
260 | 9d0671ba | Iustin Pop | to the instance. The default behavior is to get the same value of |
261 | 50c1e351 | Bernardo Dal Seno | the earlier parameter (disk_type). The possible options are: |
262 | 1b7f2c85 | Iustin Pop | |
263 | 9d0671ba | Iustin Pop | - paravirtual |
264 | 9d0671ba | Iustin Pop | - ide |
265 | 9d0671ba | Iustin Pop | - scsi |
266 | 9d0671ba | Iustin Pop | - sd |
267 | 9d0671ba | Iustin Pop | - mtd |
268 | 9d0671ba | Iustin Pop | - pflash |
269 | 1b7f2c85 | Iustin Pop | |
270 | 1b7f2c85 | Iustin Pop | |
271 | 1b7f2c85 | Iustin Pop | vnc\_bind\_address |
272 | 1b7f2c85 | Iustin Pop | Valid for the Xen HVM and KVM hypervisors. |
273 | 1b7f2c85 | Iustin Pop | |
274 | 1b7f2c85 | Iustin Pop | Specifies the address that the VNC listener for this instance |
275 | 1b7f2c85 | Iustin Pop | should bind to. Valid values are IPv4 addresses. Use the address |
276 | 1b7f2c85 | Iustin Pop | 0.0.0.0 to bind to all available interfaces (this is the default) |
277 | 1b7f2c85 | Iustin Pop | or specify the address of one of the interfaces on the node to |
278 | 1b7f2c85 | Iustin Pop | restrict listening to that interface. |
279 | 1b7f2c85 | Iustin Pop | |
280 | 1b7f2c85 | Iustin Pop | vnc\_tls |
281 | 1b7f2c85 | Iustin Pop | Valid for the KVM hypervisor. |
282 | 1b7f2c85 | Iustin Pop | |
283 | 1b7f2c85 | Iustin Pop | A boolean option that controls whether the VNC connection is |
284 | 1b7f2c85 | Iustin Pop | secured with TLS. |
285 | 1b7f2c85 | Iustin Pop | |
286 | 1b7f2c85 | Iustin Pop | vnc\_x509\_path |
287 | 1b7f2c85 | Iustin Pop | Valid for the KVM hypervisor. |
288 | 1b7f2c85 | Iustin Pop | |
289 | 1b7f2c85 | Iustin Pop | If ``vnc_tls`` is enabled, this options specifies the path to the |
290 | 1b7f2c85 | Iustin Pop | x509 certificate to use. |
291 | 1b7f2c85 | Iustin Pop | |
292 | 1b7f2c85 | Iustin Pop | vnc\_x509\_verify |
293 | 1b7f2c85 | Iustin Pop | Valid for the KVM hypervisor. |
294 | 1b7f2c85 | Iustin Pop | |
295 | c7570029 | Andrea Spadaccini | spice\_bind |
296 | c7570029 | Andrea Spadaccini | Valid for the KVM hypervisor. |
297 | c7570029 | Andrea Spadaccini | |
298 | c7570029 | Andrea Spadaccini | Specifies the address or interface on which the SPICE server will |
299 | c7570029 | Andrea Spadaccini | listen. Valid values are: |
300 | c7570029 | Andrea Spadaccini | |
301 | c7570029 | Andrea Spadaccini | - IPv4 addresses, including 0.0.0.0 and 127.0.0.1 |
302 | c7570029 | Andrea Spadaccini | - IPv6 addresses, including :: and ::1 |
303 | c7570029 | Andrea Spadaccini | - names of network interfaces |
304 | c7570029 | Andrea Spadaccini | |
305 | c7570029 | Andrea Spadaccini | If a network interface is specified, the SPICE server will be bound |
306 | c7570029 | Andrea Spadaccini | to one of the addresses of that interface. |
307 | c7570029 | Andrea Spadaccini | |
308 | c7570029 | Andrea Spadaccini | spice\_ip\_version |
309 | c7570029 | Andrea Spadaccini | Valid for the KVM hypervisor. |
310 | c7570029 | Andrea Spadaccini | |
311 | c7570029 | Andrea Spadaccini | Specifies which version of the IP protocol should be used by the |
312 | c7570029 | Andrea Spadaccini | SPICE server. |
313 | c7570029 | Andrea Spadaccini | |
314 | c7570029 | Andrea Spadaccini | It is mainly intended to be used for specifying what kind of IP |
315 | c7570029 | Andrea Spadaccini | addresses should be used if a network interface with both IPv4 and |
316 | c7570029 | Andrea Spadaccini | IPv6 addresses is specified via the ``spice_bind`` parameter. In |
317 | c7570029 | Andrea Spadaccini | this case, if the ``spice_ip_version`` parameter is not used, the |
318 | c7570029 | Andrea Spadaccini | default IP version of the cluster will be used. |
319 | c7570029 | Andrea Spadaccini | |
320 | b451c4c7 | Andrea Spadaccini | spice\_password\_file |
321 | b451c4c7 | Andrea Spadaccini | Valid for the KVM hypervisor. |
322 | b451c4c7 | Andrea Spadaccini | |
323 | b451c4c7 | Andrea Spadaccini | Specifies a file containing the password that must be used when |
324 | b451c4c7 | Andrea Spadaccini | connecting via the SPICE protocol. If the option is not specified, |
325 | b451c4c7 | Andrea Spadaccini | passwordless connections are allowed. |
326 | b451c4c7 | Andrea Spadaccini | |
327 | ea064d24 | Andrea Spadaccini | spice\_image\_compression |
328 | ea064d24 | Andrea Spadaccini | Valid for the KVM hypervisor. |
329 | ea064d24 | Andrea Spadaccini | |
330 | ea064d24 | Andrea Spadaccini | Configures the SPICE lossless image compression. Valid values are: |
331 | ea064d24 | Andrea Spadaccini | |
332 | ea064d24 | Andrea Spadaccini | - auto_glz |
333 | ea064d24 | Andrea Spadaccini | - auto_lz |
334 | ea064d24 | Andrea Spadaccini | - quic |
335 | ea064d24 | Andrea Spadaccini | - glz |
336 | ea064d24 | Andrea Spadaccini | - lz |
337 | ea064d24 | Andrea Spadaccini | - off |
338 | ea064d24 | Andrea Spadaccini | |
339 | ea064d24 | Andrea Spadaccini | spice\_jpeg\_wan\_compression |
340 | ea064d24 | Andrea Spadaccini | Valid for the KVM hypervisor. |
341 | ea064d24 | Andrea Spadaccini | |
342 | ea064d24 | Andrea Spadaccini | Configures how SPICE should use the jpeg algorithm for lossy image |
343 | ea064d24 | Andrea Spadaccini | compression on slow links. Valid values are: |
344 | ea064d24 | Andrea Spadaccini | |
345 | ea064d24 | Andrea Spadaccini | - auto |
346 | ea064d24 | Andrea Spadaccini | - never |
347 | ea064d24 | Andrea Spadaccini | - always |
348 | ea064d24 | Andrea Spadaccini | |
349 | ea064d24 | Andrea Spadaccini | spice\_zlib\_glz\_wan\_compression |
350 | ea064d24 | Andrea Spadaccini | Valid for the KVM hypervisor. |
351 | ea064d24 | Andrea Spadaccini | |
352 | ea064d24 | Andrea Spadaccini | Configures how SPICE should use the zlib-glz algorithm for lossy image |
353 | ea064d24 | Andrea Spadaccini | compression on slow links. Valid values are: |
354 | ea064d24 | Andrea Spadaccini | |
355 | ea064d24 | Andrea Spadaccini | - auto |
356 | ea064d24 | Andrea Spadaccini | - never |
357 | ea064d24 | Andrea Spadaccini | - always |
358 | ea064d24 | Andrea Spadaccini | |
359 | ea064d24 | Andrea Spadaccini | spice\_streaming\_video |
360 | ea064d24 | Andrea Spadaccini | Valid for the KVM hypervisor. |
361 | ea064d24 | Andrea Spadaccini | |
362 | ea064d24 | Andrea Spadaccini | Configures how SPICE should detect video streams. Valid values are: |
363 | ea064d24 | Andrea Spadaccini | |
364 | ea064d24 | Andrea Spadaccini | - off |
365 | ea064d24 | Andrea Spadaccini | - all |
366 | ea064d24 | Andrea Spadaccini | - filter |
367 | ea064d24 | Andrea Spadaccini | |
368 | ea064d24 | Andrea Spadaccini | spice\_playback\_compression |
369 | ea064d24 | Andrea Spadaccini | Valid for the KVM hypervisor. |
370 | ea064d24 | Andrea Spadaccini | |
371 | ea064d24 | Andrea Spadaccini | Configures whether SPICE should compress audio streams or not. |
372 | ea064d24 | Andrea Spadaccini | |
373 | b8a10435 | Andrea Spadaccini | spice\_use\_tls |
374 | b8a10435 | Andrea Spadaccini | Valid for the KVM hypervisor. |
375 | b8a10435 | Andrea Spadaccini | |
376 | b8a10435 | Andrea Spadaccini | Specifies that the SPICE server must use TLS to encrypt all the |
377 | b8a10435 | Andrea Spadaccini | traffic with the client. |
378 | b8a10435 | Andrea Spadaccini | |
379 | 3e40b587 | Andrea Spadaccini | spice\_tls\_ciphers |
380 | 3e40b587 | Andrea Spadaccini | Valid for the KVM hypervisor. |
381 | 3e40b587 | Andrea Spadaccini | |
382 | 3e40b587 | Andrea Spadaccini | Specifies a list of comma-separated ciphers that SPICE should use |
383 | 3e40b587 | Andrea Spadaccini | for TLS connections. For the format, see man cipher(1). |
384 | 3e40b587 | Andrea Spadaccini | |
385 | 3e40b587 | Andrea Spadaccini | spice\_use\_vdagent |
386 | 3e40b587 | Andrea Spadaccini | Valid for the KVM hypervisor. |
387 | 3e40b587 | Andrea Spadaccini | |
388 | 3e40b587 | Andrea Spadaccini | Enables or disables passing mouse events via SPICE vdagent. |
389 | 3e40b587 | Andrea Spadaccini | |
390 | 7cb42171 | Nikita Staroverov | cpu\_type |
391 | 7cb42171 | Nikita Staroverov | Valid for the KVM hypervisor. |
392 | 7cb42171 | Nikita Staroverov | |
393 | 7cb42171 | Nikita Staroverov | This parameter determines the emulated cpu for the instance. If this |
394 | 7cb42171 | Nikita Staroverov | parameter is empty (which is the default configuration), it will not |
395 | 7cb42171 | Nikita Staroverov | be passed to KVM. |
396 | 7cb42171 | Nikita Staroverov | |
397 | 7cb42171 | Nikita Staroverov | Be aware of setting this parameter to ``"host"`` if you have nodes |
398 | 7cb42171 | Nikita Staroverov | with different CPUs from each other. Live migration may stop working |
399 | 7cb42171 | Nikita Staroverov | in this situation. |
400 | 7cb42171 | Nikita Staroverov | |
401 | 7cb42171 | Nikita Staroverov | For more information please refer to the KVM manual. |
402 | 7cb42171 | Nikita Staroverov | |
403 | 1b7f2c85 | Iustin Pop | acpi |
404 | 1b7f2c85 | Iustin Pop | Valid for the Xen HVM and KVM hypervisors. |
405 | 1b7f2c85 | Iustin Pop | |
406 | 1b7f2c85 | Iustin Pop | A boolean option that specifies if the hypervisor should enable |
407 | 1b7f2c85 | Iustin Pop | ACPI support for this instance. By default, ACPI is disabled. |
408 | 1b7f2c85 | Iustin Pop | |
409 | 1b7f2c85 | Iustin Pop | pae |
410 | 1b7f2c85 | Iustin Pop | Valid for the Xen HVM and KVM hypervisors. |
411 | 1b7f2c85 | Iustin Pop | |
412 | 1b7f2c85 | Iustin Pop | A boolean option that specifies if the hypervisor should enabled |
413 | 1b7f2c85 | Iustin Pop | PAE support for this instance. The default is false, disabling PAE |
414 | 1b7f2c85 | Iustin Pop | support. |
415 | 1b7f2c85 | Iustin Pop | |
416 | 1b7f2c85 | Iustin Pop | use\_localtime |
417 | 1b7f2c85 | Iustin Pop | Valid for the Xen HVM and KVM hypervisors. |
418 | 1b7f2c85 | Iustin Pop | |
419 | 1b7f2c85 | Iustin Pop | A boolean option that specifies if the instance should be started |
420 | 1b7f2c85 | Iustin Pop | with its clock set to the localtime of the machine (when true) or |
421 | 1b7f2c85 | Iustin Pop | to the UTC (When false). The default is false, which is useful for |
422 | 1b7f2c85 | Iustin Pop | Linux/Unix machines; for Windows OSes, it is recommended to enable |
423 | 1b7f2c85 | Iustin Pop | this parameter. |
424 | 1b7f2c85 | Iustin Pop | |
425 | 1b7f2c85 | Iustin Pop | kernel\_path |
426 | 1b7f2c85 | Iustin Pop | Valid for the Xen PVM and KVM hypervisors. |
427 | 1b7f2c85 | Iustin Pop | |
428 | 1b7f2c85 | Iustin Pop | This option specifies the path (on the node) to the kernel to boot |
429 | 2b846304 | Iustin Pop | the instance with. Xen PVM instances always require this, while for |
430 | 2b846304 | Iustin Pop | KVM if this option is empty, it will cause the machine to load the |
431 | 2b846304 | Iustin Pop | kernel from its disks (and the boot will be done accordingly to |
432 | 2b846304 | Iustin Pop | ``boot_order``). |
433 | 1b7f2c85 | Iustin Pop | |
434 | 1b7f2c85 | Iustin Pop | kernel\_args |
435 | 1b7f2c85 | Iustin Pop | Valid for the Xen PVM and KVM hypervisors. |
436 | 1b7f2c85 | Iustin Pop | |
437 | 1b7f2c85 | Iustin Pop | This options specifies extra arguments to the kernel that will be |
438 | 1b7f2c85 | Iustin Pop | loaded. device. This is always used for Xen PVM, while for KVM it |
439 | 1b7f2c85 | Iustin Pop | is only used if the ``kernel_path`` option is also specified. |
440 | 1b7f2c85 | Iustin Pop | |
441 | 9d0671ba | Iustin Pop | The default setting for this value is simply ``"ro"``, which |
442 | 9d0671ba | Iustin Pop | mounts the root disk (initially) in read-only one. For example, |
443 | 9d0671ba | Iustin Pop | setting this to single will cause the instance to start in |
444 | 9d0671ba | Iustin Pop | single-user mode. |
445 | 1b7f2c85 | Iustin Pop | |
446 | 1b7f2c85 | Iustin Pop | initrd\_path |
447 | 1b7f2c85 | Iustin Pop | Valid for the Xen PVM and KVM hypervisors. |
448 | 1b7f2c85 | Iustin Pop | |
449 | 1b7f2c85 | Iustin Pop | This option specifies the path (on the node) to the initrd to boot |
450 | 9d0671ba | Iustin Pop | the instance with. Xen PVM instances can use this always, while |
451 | 9d0671ba | Iustin Pop | for KVM if this option is only used if the ``kernel_path`` option |
452 | 9d0671ba | Iustin Pop | is also specified. You can pass here either an absolute filename |
453 | 9d0671ba | Iustin Pop | (the path to the initrd) if you want to use an initrd, or use the |
454 | 9d0671ba | Iustin Pop | format no\_initrd\_path for no initrd. |
455 | 1b7f2c85 | Iustin Pop | |
456 | 1b7f2c85 | Iustin Pop | root\_path |
457 | 1b7f2c85 | Iustin Pop | Valid for the Xen PVM and KVM hypervisors. |
458 | 1b7f2c85 | Iustin Pop | |
459 | 1b7f2c85 | Iustin Pop | This options specifies the name of the root device. This is always |
460 | 1b7f2c85 | Iustin Pop | needed for Xen PVM, while for KVM it is only used if the |
461 | 1b7f2c85 | Iustin Pop | ``kernel_path`` option is also specified. |
462 | 1b7f2c85 | Iustin Pop | |
463 | 7adf7814 | René Nussbaumer | Please note, that if this setting is an empty string and the |
464 | 7adf7814 | René Nussbaumer | hypervisor is Xen it will not be written to the Xen configuration |
465 | 7adf7814 | René Nussbaumer | file |
466 | 7adf7814 | René Nussbaumer | |
467 | 1b7f2c85 | Iustin Pop | serial\_console |
468 | 1b7f2c85 | Iustin Pop | Valid for the KVM hypervisor. |
469 | 1b7f2c85 | Iustin Pop | |
470 | 1b7f2c85 | Iustin Pop | This boolean option specifies whether to emulate a serial console |
471 | 1b7f2c85 | Iustin Pop | for the instance. |
472 | 1b7f2c85 | Iustin Pop | |
473 | 1b7f2c85 | Iustin Pop | disk\_cache |
474 | 1b7f2c85 | Iustin Pop | Valid for the KVM hypervisor. |
475 | 1b7f2c85 | Iustin Pop | |
476 | 9d0671ba | Iustin Pop | The disk cache mode. It can be either default to not pass any |
477 | 9d0671ba | Iustin Pop | cache option to KVM, or one of the KVM cache modes: none (for |
478 | 9d0671ba | Iustin Pop | direct I/O), writethrough (to use the host cache but report |
479 | 9d0671ba | Iustin Pop | completion to the guest only when the host has committed the |
480 | 9d0671ba | Iustin Pop | changes to disk) or writeback (to use the host cache and report |
481 | 9d0671ba | Iustin Pop | completion as soon as the data is in the host cache). Note that |
482 | 9d0671ba | Iustin Pop | there are special considerations for the cache mode depending on |
483 | 9d0671ba | Iustin Pop | version of KVM used and disk type (always raw file under Ganeti), |
484 | 9d0671ba | Iustin Pop | please refer to the KVM documentation for more details. |
485 | 1b7f2c85 | Iustin Pop | |
486 | 1b7f2c85 | Iustin Pop | security\_model |
487 | 1b7f2c85 | Iustin Pop | Valid for the KVM hypervisor. |
488 | 1b7f2c85 | Iustin Pop | |
489 | 9d0671ba | Iustin Pop | The security model for kvm. Currently one of *none*, *user* or |
490 | 9d0671ba | Iustin Pop | *pool*. Under *none*, the default, nothing is done and instances |
491 | 1b7f2c85 | Iustin Pop | are run as the Ganeti daemon user (normally root). |
492 | 1b7f2c85 | Iustin Pop | |
493 | 9d0671ba | Iustin Pop | Under *user* kvm will drop privileges and become the user |
494 | 9d0671ba | Iustin Pop | specified by the security\_domain parameter. |
495 | 1b7f2c85 | Iustin Pop | |
496 | 9d0671ba | Iustin Pop | Under *pool* a global cluster pool of users will be used, making |
497 | 1b7f2c85 | Iustin Pop | sure no two instances share the same user on the same node. (this |
498 | 1b7f2c85 | Iustin Pop | mode is not implemented yet) |
499 | 1b7f2c85 | Iustin Pop | |
500 | 1b7f2c85 | Iustin Pop | security\_domain |
501 | 1b7f2c85 | Iustin Pop | Valid for the KVM hypervisor. |
502 | 1b7f2c85 | Iustin Pop | |
503 | 9d0671ba | Iustin Pop | Under security model *user* the username to run the instance |
504 | 9d0671ba | Iustin Pop | under. It must be a valid username existing on the host. |
505 | 1b7f2c85 | Iustin Pop | |
506 | 9d0671ba | Iustin Pop | Cannot be set under security model *none* or *pool*. |
507 | 1b7f2c85 | Iustin Pop | |
508 | 1b7f2c85 | Iustin Pop | kvm\_flag |
509 | 1b7f2c85 | Iustin Pop | Valid for the KVM hypervisor. |
510 | 1b7f2c85 | Iustin Pop | |
511 | 9d0671ba | Iustin Pop | If *enabled* the -enable-kvm flag is passed to kvm. If *disabled* |
512 | 9d0671ba | Iustin Pop | -disable-kvm is passed. If unset no flag is passed, and the |
513 | 9d0671ba | Iustin Pop | default running mode for your kvm binary will be used. |
514 | 1b7f2c85 | Iustin Pop | |
515 | 1b7f2c85 | Iustin Pop | mem\_path |
516 | 1b7f2c85 | Iustin Pop | Valid for the KVM hypervisor. |
517 | 1b7f2c85 | Iustin Pop | |
518 | 1b7f2c85 | Iustin Pop | This option passes the -mem-path argument to kvm with the path (on |
519 | 1b7f2c85 | Iustin Pop | the node) to the mount point of the hugetlbfs file system, along |
520 | 1b7f2c85 | Iustin Pop | with the -mem-prealloc argument too. |
521 | 1b7f2c85 | Iustin Pop | |
522 | 1b7f2c85 | Iustin Pop | use\_chroot |
523 | 1b7f2c85 | Iustin Pop | Valid for the KVM hypervisor. |
524 | 1b7f2c85 | Iustin Pop | |
525 | 50c1e351 | Bernardo Dal Seno | This boolean option determines whether to run the KVM instance in a |
526 | 1b7f2c85 | Iustin Pop | chroot directory. |
527 | 1b7f2c85 | Iustin Pop | |
528 | 1b7f2c85 | Iustin Pop | If it is set to ``true``, an empty directory is created before |
529 | 1b7f2c85 | Iustin Pop | starting the instance and its path is passed via the -chroot flag |
530 | 1b7f2c85 | Iustin Pop | to kvm. The directory is removed when the instance is stopped. |
531 | 1b7f2c85 | Iustin Pop | |
532 | 1b7f2c85 | Iustin Pop | It is set to ``false`` by default. |
533 | 1b7f2c85 | Iustin Pop | |
534 | 1b7f2c85 | Iustin Pop | migration\_downtime |
535 | 1b7f2c85 | Iustin Pop | Valid for the KVM hypervisor. |
536 | 1b7f2c85 | Iustin Pop | |
537 | 1b7f2c85 | Iustin Pop | The maximum amount of time (in ms) a KVM instance is allowed to be |
538 | 1b7f2c85 | Iustin Pop | frozen during a live migration, in order to copy dirty memory |
539 | 1b7f2c85 | Iustin Pop | pages. Default value is 30ms, but you may need to increase this |
540 | 1b7f2c85 | Iustin Pop | value for busy instances. |
541 | 1b7f2c85 | Iustin Pop | |
542 | 1b7f2c85 | Iustin Pop | This option is only effective with kvm versions >= 87 and qemu-kvm |
543 | 1b7f2c85 | Iustin Pop | versions >= 0.11.0. |
544 | 1b7f2c85 | Iustin Pop | |
545 | 1b7f2c85 | Iustin Pop | cpu\_mask |
546 | ff39194f | Iustin Pop | Valid for the Xen, KVM and LXC hypervisors. |
547 | 1b7f2c85 | Iustin Pop | |
548 | 9d0671ba | Iustin Pop | The processes belonging to the given instance are only scheduled |
549 | 9d0671ba | Iustin Pop | on the specified CPUs. |
550 | 1b7f2c85 | Iustin Pop | |
551 | ff39194f | Iustin Pop | The format of the mask can be given in three forms. First, the word |
552 | ff39194f | Iustin Pop | "all", which signifies the common case where all VCPUs can live on |
553 | ff39194f | Iustin Pop | any CPU, based on the hypervisor's decisions. |
554 | ff39194f | Iustin Pop | |
555 | ff39194f | Iustin Pop | Second, a comma-separated list of CPU IDs or CPU ID ranges. The |
556 | ff39194f | Iustin Pop | ranges are defined by a lower and higher boundary, separated by a |
557 | ff39194f | Iustin Pop | dash, and the boundaries are inclusive. In this form, all VCPUs of |
558 | ff39194f | Iustin Pop | the instance will be mapped on the selected list of CPUs. Example: |
559 | ff39194f | Iustin Pop | ``0-2,5``, mapping all VCPUs (no matter how many) onto physical CPUs |
560 | ff39194f | Iustin Pop | 0, 1, 2 and 5. |
561 | ff39194f | Iustin Pop | |
562 | ff39194f | Iustin Pop | The last form is used for explicit control of VCPU-CPU pinnings. In |
563 | ff39194f | Iustin Pop | this form, the list of VCPU mappings is given as a colon (:) |
564 | ff39194f | Iustin Pop | separated list, whose elements are the possible values for the |
565 | ff39194f | Iustin Pop | second or first form above. In this form, the number of elements in |
566 | ff39194f | Iustin Pop | the colon-separated list _must_ equal the number of VCPUs of the |
567 | ff39194f | Iustin Pop | instance. |
568 | ff39194f | Iustin Pop | |
569 | 29fbe62e | Iustin Pop | Example: |
570 | 29fbe62e | Iustin Pop | |
571 | 29fbe62e | Iustin Pop | .. code-block:: Bash |
572 | ff39194f | Iustin Pop | |
573 | ff39194f | Iustin Pop | # Map the entire instance to CPUs 0-2 |
574 | ff39194f | Iustin Pop | gnt-instance modify -H cpu_mask=0-2 my-inst |
575 | ff39194f | Iustin Pop | |
576 | ff39194f | Iustin Pop | # Map vCPU 0 to physical CPU 1 and vCPU 1 to CPU 3 (assuming 2 vCPUs) |
577 | ff39194f | Iustin Pop | gnt-instance modify -H cpu_mask=1:3 my-inst |
578 | ff39194f | Iustin Pop | |
579 | ff39194f | Iustin Pop | # Pin vCPU 0 to CPUs 1 or 2, and vCPU 1 to any CPU |
580 | ff39194f | Iustin Pop | gnt-instance modify -H cpu_mask=1-2:all my-inst |
581 | ff39194f | Iustin Pop | |
582 | ff39194f | Iustin Pop | # Pin vCPU 0 to any CPU, vCPU 1 to CPUs 1, 3, 4 or 5, and CPU 2 to |
583 | ff39194f | Iustin Pop | # CPU 0 (backslashes for escaping the comma) |
584 | ff39194f | Iustin Pop | gnt-instance modify -H cpu_mask=all:1\\,3-5:0 my-inst |
585 | ff39194f | Iustin Pop | |
586 | ff39194f | Iustin Pop | # Pin entire VM to CPU 0 |
587 | ff39194f | Iustin Pop | gnt-instance modify -H cpu_mask=0 my-inst |
588 | ff39194f | Iustin Pop | |
589 | ff39194f | Iustin Pop | # Turn off CPU pinning (default setting) |
590 | ff39194f | Iustin Pop | gnt-instance modify -H cpu_mask=all my-inst |
591 | 1b7f2c85 | Iustin Pop | |
592 | 8bd977e9 | Sébastien Bocahu | cpu\_cap |
593 | 8bd977e9 | Sébastien Bocahu | Valid for the Xen hypervisor. |
594 | 8bd977e9 | Sébastien Bocahu | |
595 | 8bd977e9 | Sébastien Bocahu | Set the maximum amount of cpu usage by the VM. The value is a percentage |
596 | 8bd977e9 | Sébastien Bocahu | between 0 and (100 * number of VCPUs). Default cap is 0: unlimited. |
597 | 8bd977e9 | Sébastien Bocahu | |
598 | 8bd977e9 | Sébastien Bocahu | cpu\_weight |
599 | 8bd977e9 | Sébastien Bocahu | Valid for the Xen hypervisor. |
600 | 8bd977e9 | Sébastien Bocahu | |
601 | 8bd977e9 | Sébastien Bocahu | Set the cpu time ratio to be allocated to the VM. Valid values are |
602 | 8bd977e9 | Sébastien Bocahu | between 1 and 65535. Default weight is 256. |
603 | 8bd977e9 | Sébastien Bocahu | |
604 | 1b7f2c85 | Iustin Pop | usb\_mouse |
605 | 1b7f2c85 | Iustin Pop | Valid for the KVM hypervisor. |
606 | 1b7f2c85 | Iustin Pop | |
607 | 1b7f2c85 | Iustin Pop | This option specifies the usb mouse type to be used. It can be |
608 | 1b7f2c85 | Iustin Pop | "mouse" or "tablet". When using VNC it's recommended to set it to |
609 | 1b7f2c85 | Iustin Pop | "tablet". |
610 | 1b7f2c85 | Iustin Pop | |
611 | 4f580fef | Sébastien Bocahu | keymap |
612 | 4f580fef | Sébastien Bocahu | Valid for the KVM hypervisor. |
613 | 4f580fef | Sébastien Bocahu | |
614 | 4f580fef | Sébastien Bocahu | This option specifies the keyboard mapping to be used. It is only |
615 | 4f580fef | Sébastien Bocahu | needed when using the VNC console. For example: "fr" or "en-gb". |
616 | 4f580fef | Sébastien Bocahu | |
617 | 990ade2d | Stephen Shirley | reboot\_behavior |
618 | 990ade2d | Stephen Shirley | Valid for Xen PVM, Xen HVM and KVM hypervisors. |
619 | 990ade2d | Stephen Shirley | |
620 | 990ade2d | Stephen Shirley | Normally if an instance reboots, the hypervisor will restart it. If |
621 | 990ade2d | Stephen Shirley | this option is set to ``exit``, the hypervisor will treat a reboot |
622 | 990ade2d | Stephen Shirley | as a shutdown instead. |
623 | 990ade2d | Stephen Shirley | |
624 | 990ade2d | Stephen Shirley | It is set to ``reboot`` by default. |
625 | 990ade2d | Stephen Shirley | |
626 | 1b7f2c85 | Iustin Pop | |
627 | 0a68e0ff | Iustin Pop | The ``-O (--os-parameters)`` option allows customisation of the OS |
628 | a53cd1f4 | Iustin Pop | parameters. The actual parameter names and values depends on the OS |
629 | a53cd1f4 | Iustin Pop | being used, but the syntax is the same key=value. For example, setting |
630 | a53cd1f4 | Iustin Pop | a hypothetical ``dhcp`` parameter to yes can be achieved by:: |
631 | a53cd1f4 | Iustin Pop | |
632 | a53cd1f4 | Iustin Pop | gnt-instance add -O dhcp=yes ... |
633 | a53cd1f4 | Iustin Pop | |
634 | 1a770ce5 | Bernardo Dal Seno | The ``-I (--iallocator)`` option specifies the instance allocator plugin |
635 | 1a770ce5 | Bernardo Dal Seno | to use (``.`` means the default allocator). If you pass in this option |
636 | 1a770ce5 | Bernardo Dal Seno | the allocator will select nodes for this instance automatically, so you |
637 | 1a770ce5 | Bernardo Dal Seno | don't need to pass them with the ``-n`` option. For more information |
638 | 1a770ce5 | Bernardo Dal Seno | please refer to the instance allocator documentation. |
639 | 1b7f2c85 | Iustin Pop | |
640 | 0a68e0ff | Iustin Pop | The ``-t (--disk-template)`` options specifies the disk layout type |
641 | 0a68e0ff | Iustin Pop | for the instance. The available choices are: |
642 | 1b7f2c85 | Iustin Pop | |
643 | 1b7f2c85 | Iustin Pop | diskless |
644 | 1b7f2c85 | Iustin Pop | This creates an instance with no disks. Its useful for testing only |
645 | 1b7f2c85 | Iustin Pop | (or other special cases). |
646 | 1b7f2c85 | Iustin Pop | |
647 | 1b7f2c85 | Iustin Pop | file |
648 | 1b7f2c85 | Iustin Pop | Disk devices will be regular files. |
649 | 1b7f2c85 | Iustin Pop | |
650 | 1b7f2c85 | Iustin Pop | plain |
651 | 1b7f2c85 | Iustin Pop | Disk devices will be logical volumes. |
652 | 1b7f2c85 | Iustin Pop | |
653 | 1b7f2c85 | Iustin Pop | drbd |
654 | 1b7f2c85 | Iustin Pop | Disk devices will be drbd (version 8.x) on top of lvm volumes. |
655 | 1b7f2c85 | Iustin Pop | |
656 | 7ed400f0 | Stratos Psomadakis | rbd |
657 | 7ed400f0 | Stratos Psomadakis | Disk devices will be rbd volumes residing inside a RADOS cluster. |
658 | 7ed400f0 | Stratos Psomadakis | |
659 | 1b7f2c85 | Iustin Pop | |
660 | 0a68e0ff | Iustin Pop | The optional second value of the ``-n (--node)`` is used for the drbd |
661 | 1b7f2c85 | Iustin Pop | template type and specifies the remote node. |
662 | 1b7f2c85 | Iustin Pop | |
663 | 1b7f2c85 | Iustin Pop | If you do not want gnt-instance to wait for the disk mirror to be |
664 | 1b7f2c85 | Iustin Pop | synced, use the ``--no-wait-for-sync`` option. |
665 | 1b7f2c85 | Iustin Pop | |
666 | 1b7f2c85 | Iustin Pop | The ``--file-storage-dir`` specifies the relative path under the |
667 | 56956bcb | Iustin Pop | cluster-wide file storage directory to store file-based disks. It is |
668 | 56956bcb | Iustin Pop | useful for having different subdirectories for different |
669 | 1b7f2c85 | Iustin Pop | instances. The full path of the directory where the disk files are |
670 | 56956bcb | Iustin Pop | stored will consist of cluster-wide file storage directory + optional |
671 | 56956bcb | Iustin Pop | subdirectory + instance name. Example: |
672 | 56956bcb | Iustin Pop | ``@RPL_FILE_STORAGE_DIR@``*/mysubdir/instance1.example.com*. This |
673 | 56956bcb | Iustin Pop | option is only relevant for instances using the file storage backend. |
674 | 1b7f2c85 | Iustin Pop | |
675 | 1b7f2c85 | Iustin Pop | The ``--file-driver`` specifies the driver to use for file-based |
676 | 9d0671ba | Iustin Pop | disks. Note that currently these drivers work with the xen hypervisor |
677 | 9d0671ba | Iustin Pop | only. This option is only relevant for instances using the file |
678 | 9d0671ba | Iustin Pop | storage backend. The available choices are: |
679 | 1b7f2c85 | Iustin Pop | |
680 | 1b7f2c85 | Iustin Pop | loop |
681 | 9d0671ba | Iustin Pop | Kernel loopback driver. This driver uses loopback devices to |
682 | 9d0671ba | Iustin Pop | access the filesystem within the file. However, running I/O |
683 | 9d0671ba | Iustin Pop | intensive applications in your instance using the loop driver |
684 | 9d0671ba | Iustin Pop | might result in slowdowns. Furthermore, if you use the loopback |
685 | 9d0671ba | Iustin Pop | driver consider increasing the maximum amount of loopback devices |
686 | 9d0671ba | Iustin Pop | (on most systems it's 8) using the max\_loop param. |
687 | 1b7f2c85 | Iustin Pop | |
688 | 1b7f2c85 | Iustin Pop | blktap |
689 | 9d0671ba | Iustin Pop | The blktap driver (for Xen hypervisors). In order to be able to |
690 | 9d0671ba | Iustin Pop | use the blktap driver you should check if the 'blktapctrl' user |
691 | 9d0671ba | Iustin Pop | space disk agent is running (usually automatically started via |
692 | 9d0671ba | Iustin Pop | xend). This user-level disk I/O interface has the advantage of |
693 | 9d0671ba | Iustin Pop | better performance. Especially if you use a network file system |
694 | 9d0671ba | Iustin Pop | (e.g. NFS) to store your instances this is the recommended choice. |
695 | 1b7f2c85 | Iustin Pop | |
696 | 10889e0c | René Nussbaumer | If ``--ignore-ipolicy`` is given any instance policy violations occuring |
697 | 10889e0c | René Nussbaumer | during this operation are ignored. |
698 | 10889e0c | René Nussbaumer | |
699 | 13ddcb50 | Michael Hanselmann | See **ganeti(7)** for a description of ``--submit`` and other common |
700 | 13ddcb50 | Michael Hanselmann | options. |
701 | 13ddcb50 | Michael Hanselmann | |
702 | 1b7f2c85 | Iustin Pop | Example:: |
703 | 1b7f2c85 | Iustin Pop | |
704 | 90bb3fe1 | Guido Trotter | # gnt-instance add -t file --disk 0:size=30g -B maxmem=512 -o debian-etch \ |
705 | 1b7f2c85 | Iustin Pop | -n node1.example.com --file-storage-dir=mysubdir instance1.example.com |
706 | 90bb3fe1 | Guido Trotter | # gnt-instance add -t plain --disk 0:size=30g -B maxmem=1024,minmem=512 \ |
707 | 90bb3fe1 | Guido Trotter | -o debian-etch -n node1.example.com instance1.example.com |
708 | 7af3534e | Dmitry Chernyak | # gnt-instance add -t plain --disk 0:size=30g --disk 1:size=100g,vg=san \ |
709 | 90bb3fe1 | Guido Trotter | -B maxmem=512 -o debian-etch -n node1.example.com instance1.example.com |
710 | 90bb3fe1 | Guido Trotter | # gnt-instance add -t drbd --disk 0:size=30g -B maxmem=512 -o debian-etch \ |
711 | 1b7f2c85 | Iustin Pop | -n node1.example.com:node2.example.com instance2.example.com |
712 | 1b7f2c85 | Iustin Pop | |
713 | 1b7f2c85 | Iustin Pop | |
714 | 1b7f2c85 | Iustin Pop | BATCH-CREATE |
715 | 1b7f2c85 | Iustin Pop | ^^^^^^^^^^^^ |
716 | 1b7f2c85 | Iustin Pop | |
717 | 1b7f2c85 | Iustin Pop | **batch-create** {instances\_file.json} |
718 | 1b7f2c85 | Iustin Pop | |
719 | 1b7f2c85 | Iustin Pop | This command (similar to the Ganeti 1.2 **batcher** tool) submits |
720 | 1b7f2c85 | Iustin Pop | multiple instance creation jobs based on a definition file. The |
721 | 9d0671ba | Iustin Pop | instance configurations do not encompass all the possible options for |
722 | 9d0671ba | Iustin Pop | the **add** command, but only a subset. |
723 | 1b7f2c85 | Iustin Pop | |
724 | 1b7f2c85 | Iustin Pop | The instance file should be a valid-formed JSON file, containing a |
725 | 1b7f2c85 | Iustin Pop | dictionary with instance name and instance parameters. The accepted |
726 | 1b7f2c85 | Iustin Pop | parameters are: |
727 | 1b7f2c85 | Iustin Pop | |
728 | 1b7f2c85 | Iustin Pop | disk\_size |
729 | 1b7f2c85 | Iustin Pop | The size of the disks of the instance. |
730 | 1b7f2c85 | Iustin Pop | |
731 | 1b7f2c85 | Iustin Pop | disk\_template |
732 | 1b7f2c85 | Iustin Pop | The disk template to use for the instance, the same as in the |
733 | 1b7f2c85 | Iustin Pop | **add** command. |
734 | 1b7f2c85 | Iustin Pop | |
735 | 1b7f2c85 | Iustin Pop | backend |
736 | 1b7f2c85 | Iustin Pop | A dictionary of backend parameters. |
737 | 1b7f2c85 | Iustin Pop | |
738 | 1b7f2c85 | Iustin Pop | hypervisor |
739 | 1b7f2c85 | Iustin Pop | A dictionary with a single key (the hypervisor name), and as value |
740 | 1b7f2c85 | Iustin Pop | the hypervisor options. If not passed, the default hypervisor and |
741 | 1b7f2c85 | Iustin Pop | hypervisor options will be inherited. |
742 | 1b7f2c85 | Iustin Pop | |
743 | 1b7f2c85 | Iustin Pop | mac, ip, mode, link |
744 | 1b7f2c85 | Iustin Pop | Specifications for the one NIC that will be created for the |
745 | 50c1e351 | Bernardo Dal Seno | instance. 'bridge' is also accepted as a backwards compatible |
746 | 1b7f2c85 | Iustin Pop | key. |
747 | 1b7f2c85 | Iustin Pop | |
748 | 1b7f2c85 | Iustin Pop | nics |
749 | 1b7f2c85 | Iustin Pop | List of nics that will be created for the instance. Each entry |
750 | 1b7f2c85 | Iustin Pop | should be a dict, with mac, ip, mode and link as possible keys. |
751 | 1b7f2c85 | Iustin Pop | Please don't provide the "mac, ip, mode, link" parent keys if you |
752 | 1b7f2c85 | Iustin Pop | use this method for specifying nics. |
753 | 1b7f2c85 | Iustin Pop | |
754 | 1b7f2c85 | Iustin Pop | primary\_node, secondary\_node |
755 | 1b7f2c85 | Iustin Pop | The primary and optionally the secondary node to use for the |
756 | 1b7f2c85 | Iustin Pop | instance (in case an iallocator script is not used). |
757 | 1b7f2c85 | Iustin Pop | |
758 | 1b7f2c85 | Iustin Pop | iallocator |
759 | 1b7f2c85 | Iustin Pop | Instead of specifying the nodes, an iallocator script can be used |
760 | 1b7f2c85 | Iustin Pop | to automatically compute them. |
761 | 1b7f2c85 | Iustin Pop | |
762 | 1b7f2c85 | Iustin Pop | start |
763 | 1b7f2c85 | Iustin Pop | whether to start the instance |
764 | 1b7f2c85 | Iustin Pop | |
765 | 1b7f2c85 | Iustin Pop | ip\_check |
766 | 1b7f2c85 | Iustin Pop | Skip the check for already-in-use instance; see the description in |
767 | 1b7f2c85 | Iustin Pop | the **add** command for details. |
768 | 1b7f2c85 | Iustin Pop | |
769 | 1b7f2c85 | Iustin Pop | name\_check |
770 | 1b7f2c85 | Iustin Pop | Skip the name check for instances; see the description in the |
771 | 1b7f2c85 | Iustin Pop | **add** command for details. |
772 | 1b7f2c85 | Iustin Pop | |
773 | 1b7f2c85 | Iustin Pop | file\_storage\_dir, file\_driver |
774 | 1b7f2c85 | Iustin Pop | Configuration for the file disk type, see the **add** command for |
775 | 1b7f2c85 | Iustin Pop | details. |
776 | 1b7f2c85 | Iustin Pop | |
777 | 1b7f2c85 | Iustin Pop | |
778 | 1b7f2c85 | Iustin Pop | A simple definition for one instance can be (with most of the |
779 | 1b7f2c85 | Iustin Pop | parameters taken from the cluster defaults):: |
780 | 1b7f2c85 | Iustin Pop | |
781 | 1b7f2c85 | Iustin Pop | { |
782 | 1b7f2c85 | Iustin Pop | "instance3": { |
783 | 1b7f2c85 | Iustin Pop | "template": "drbd", |
784 | 1b7f2c85 | Iustin Pop | "os": "debootstrap", |
785 | 1b7f2c85 | Iustin Pop | "disk_size": ["25G"], |
786 | 1b7f2c85 | Iustin Pop | "iallocator": "dumb" |
787 | 1b7f2c85 | Iustin Pop | }, |
788 | 1b7f2c85 | Iustin Pop | "instance5": { |
789 | 1b7f2c85 | Iustin Pop | "template": "drbd", |
790 | 1b7f2c85 | Iustin Pop | "os": "debootstrap", |
791 | 1b7f2c85 | Iustin Pop | "disk_size": ["25G"], |
792 | 1b7f2c85 | Iustin Pop | "iallocator": "dumb", |
793 | 1b7f2c85 | Iustin Pop | "hypervisor": "xen-hvm", |
794 | 1b7f2c85 | Iustin Pop | "hvparams": {"acpi": true}, |
795 | 90bb3fe1 | Guido Trotter | "backend": {"maxmem": 512, "minmem": 256} |
796 | 1b7f2c85 | Iustin Pop | } |
797 | 1b7f2c85 | Iustin Pop | } |
798 | 1b7f2c85 | Iustin Pop | |
799 | 1b7f2c85 | Iustin Pop | The command will display the job id for each submitted instance, as |
800 | 1b7f2c85 | Iustin Pop | follows:: |
801 | 1b7f2c85 | Iustin Pop | |
802 | 1b7f2c85 | Iustin Pop | # gnt-instance batch-create instances.json |
803 | 1b7f2c85 | Iustin Pop | instance3: 11224 |
804 | 1b7f2c85 | Iustin Pop | instance5: 11225 |
805 | 1b7f2c85 | Iustin Pop | |
806 | 1b7f2c85 | Iustin Pop | REMOVE |
807 | 1b7f2c85 | Iustin Pop | ^^^^^^ |
808 | 1b7f2c85 | Iustin Pop | |
809 | e8f936b0 | Iustin Pop | **remove** [\--ignore-failures] [\--shutdown-timeout=*N*] [\--submit] |
810 | e8f936b0 | Iustin Pop | [\--force] {*instance*} |
811 | 1b7f2c85 | Iustin Pop | |
812 | 1b7f2c85 | Iustin Pop | Remove an instance. This will remove all data from the instance and |
813 | 1b7f2c85 | Iustin Pop | there is *no way back*. If you are not sure if you use an instance |
814 | 9d0671ba | Iustin Pop | again, use **shutdown** first and leave it in the shutdown state for a |
815 | 9d0671ba | Iustin Pop | while. |
816 | 1b7f2c85 | Iustin Pop | |
817 | 1b7f2c85 | Iustin Pop | The ``--ignore-failures`` option will cause the removal to proceed |
818 | 1b7f2c85 | Iustin Pop | even in the presence of errors during the removal of the instance |
819 | 9d0671ba | Iustin Pop | (e.g. during the shutdown or the disk removal). If this option is not |
820 | 9d0671ba | Iustin Pop | given, the command will stop at the first error. |
821 | 1b7f2c85 | Iustin Pop | |
822 | 1b7f2c85 | Iustin Pop | The ``--shutdown-timeout`` is used to specify how much time to wait |
823 | 1b7f2c85 | Iustin Pop | before forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the |
824 | 1b7f2c85 | Iustin Pop | kvm process for KVM, etc.). By default two minutes are given to each |
825 | 1b7f2c85 | Iustin Pop | instance to stop. |
826 | 1b7f2c85 | Iustin Pop | |
827 | 3ef02bec | Andrea Spadaccini | The ``--force`` option is used to skip the interactive confirmation. |
828 | 3ef02bec | Andrea Spadaccini | |
829 | 13ddcb50 | Michael Hanselmann | See **ganeti(7)** for a description of ``--submit`` and other common |
830 | 13ddcb50 | Michael Hanselmann | options. |
831 | 13ddcb50 | Michael Hanselmann | |
832 | 1b7f2c85 | Iustin Pop | Example:: |
833 | 1b7f2c85 | Iustin Pop | |
834 | 1b7f2c85 | Iustin Pop | # gnt-instance remove instance1.example.com |
835 | 1b7f2c85 | Iustin Pop | |
836 | 1b7f2c85 | Iustin Pop | |
837 | 1b7f2c85 | Iustin Pop | LIST |
838 | 1b7f2c85 | Iustin Pop | ^^^^ |
839 | 1b7f2c85 | Iustin Pop | |
840 | 1b7f2c85 | Iustin Pop | | **list** |
841 | e8f936b0 | Iustin Pop | | [\--no-headers] [\--separator=*SEPARATOR*] [\--units=*UNITS*] [-v] |
842 | e8f936b0 | Iustin Pop | | [{-o|\--output} *[+]FIELD,...*] [\--filter] [instance...] |
843 | 1b7f2c85 | Iustin Pop | |
844 | 1b7f2c85 | Iustin Pop | Shows the currently configured instances with memory usage, disk |
845 | 1b7f2c85 | Iustin Pop | usage, the node they are running on, and their run status. |
846 | 1b7f2c85 | Iustin Pop | |
847 | 1b7f2c85 | Iustin Pop | The ``--no-headers`` option will skip the initial header line. The |
848 | 1b7f2c85 | Iustin Pop | ``--separator`` option takes an argument which denotes what will be |
849 | 1b7f2c85 | Iustin Pop | used between the output fields. Both these options are to help |
850 | 1b7f2c85 | Iustin Pop | scripting. |
851 | 1b7f2c85 | Iustin Pop | |
852 | 1b7f2c85 | Iustin Pop | The units used to display the numeric values in the output varies, |
853 | 1b7f2c85 | Iustin Pop | depending on the options given. By default, the values will be |
854 | 9d0671ba | Iustin Pop | formatted in the most appropriate unit. If the ``--separator`` option |
855 | 9d0671ba | Iustin Pop | is given, then the values are shown in mebibytes to allow parsing by |
856 | 9d0671ba | Iustin Pop | scripts. In both cases, the ``--units`` option can be used to enforce |
857 | 9d0671ba | Iustin Pop | a given output unit. |
858 | 1b7f2c85 | Iustin Pop | |
859 | f0b1bafe | Iustin Pop | The ``-v`` option activates verbose mode, which changes the display of |
860 | f0b1bafe | Iustin Pop | special field states (see **ganeti(7)**). |
861 | f0b1bafe | Iustin Pop | |
862 | 0a68e0ff | Iustin Pop | The ``-o (--output)`` option takes a comma-separated list of output |
863 | 0a68e0ff | Iustin Pop | fields. The available fields and their meaning are: |
864 | 1b7f2c85 | Iustin Pop | |
865 | fcdb582d | Michael Hanselmann | @QUERY_FIELDS_INSTANCE@ |
866 | 1b7f2c85 | Iustin Pop | |
867 | 1b7f2c85 | Iustin Pop | If the value of the option starts with the character ``+``, the new |
868 | f7b769b1 | Iustin Pop | field(s) will be added to the default list. This allows one to quickly |
869 | f7b769b1 | Iustin Pop | see the default list plus a few other fields, instead of retyping the |
870 | 9d0671ba | Iustin Pop | entire list of fields. |
871 | 1b7f2c85 | Iustin Pop | |
872 | 1b7f2c85 | Iustin Pop | There is a subtle grouping about the available output fields: all |
873 | 1b7f2c85 | Iustin Pop | fields except for ``oper_state``, ``oper_ram``, ``oper_vcpus`` and |
874 | 9d0671ba | Iustin Pop | ``status`` are configuration value and not run-time values. So if you |
875 | 9d0671ba | Iustin Pop | don't select any of the these fields, the query will be satisfied |
876 | 9d0671ba | Iustin Pop | instantly from the cluster configuration, without having to ask the |
877 | 9d0671ba | Iustin Pop | remote nodes for the data. This can be helpful for big clusters when |
878 | 9d0671ba | Iustin Pop | you only want some data and it makes sense to specify a reduced set of |
879 | 9d0671ba | Iustin Pop | output fields. |
880 | 1b7f2c85 | Iustin Pop | |
881 | 87e87959 | Michael Hanselmann | If exactly one argument is given and it appears to be a query filter |
882 | 87e87959 | Michael Hanselmann | (see **ganeti(7)**), the query result is filtered accordingly. For |
883 | 87e87959 | Michael Hanselmann | ambiguous cases (e.g. a single field name as a filter) the ``--filter`` |
884 | 87e87959 | Michael Hanselmann | (``-F``) option forces the argument to be treated as a filter (e.g. |
885 | 87e87959 | Michael Hanselmann | ``gnt-instance list -F admin_state``). |
886 | 87e87959 | Michael Hanselmann | |
887 | 87e87959 | Michael Hanselmann | The default output field list is: ``name``, ``os``, ``pnode``, |
888 | 87e87959 | Michael Hanselmann | ``admin_state``, ``oper_state``, ``oper_ram``. |
889 | 1b7f2c85 | Iustin Pop | |
890 | b82c5ff5 | Michael Hanselmann | |
891 | b82c5ff5 | Michael Hanselmann | LIST-FIELDS |
892 | 69d1b79d | Michael Hanselmann | ~~~~~~~~~~~ |
893 | b82c5ff5 | Michael Hanselmann | |
894 | b82c5ff5 | Michael Hanselmann | **list-fields** [field...] |
895 | b82c5ff5 | Michael Hanselmann | |
896 | b82c5ff5 | Michael Hanselmann | Lists available fields for instances. |
897 | b82c5ff5 | Michael Hanselmann | |
898 | b82c5ff5 | Michael Hanselmann | |
899 | 1b7f2c85 | Iustin Pop | INFO |
900 | 1b7f2c85 | Iustin Pop | ^^^^ |
901 | 1b7f2c85 | Iustin Pop | |
902 | e8f936b0 | Iustin Pop | **info** [-s \| \--static] [\--roman] {\--all \| *instance*} |
903 | 1b7f2c85 | Iustin Pop | |
904 | 1b7f2c85 | Iustin Pop | Show detailed information about the given instance(s). This is |
905 | 9d0671ba | Iustin Pop | different from **list** as it shows detailed data about the instance's |
906 | 9d0671ba | Iustin Pop | disks (especially useful for the drbd disk template). |
907 | 1b7f2c85 | Iustin Pop | |
908 | 1b7f2c85 | Iustin Pop | If the option ``-s`` is used, only information available in the |
909 | 1b7f2c85 | Iustin Pop | configuration file is returned, without querying nodes, making the |
910 | 1b7f2c85 | Iustin Pop | operation faster. |
911 | 1b7f2c85 | Iustin Pop | |
912 | 1b7f2c85 | Iustin Pop | Use the ``--all`` to get info about all instances, rather than |
913 | 1b7f2c85 | Iustin Pop | explicitly passing the ones you're interested in. |
914 | 1b7f2c85 | Iustin Pop | |
915 | 9d0671ba | Iustin Pop | The ``--roman`` option can be used to cause envy among people who like |
916 | 9d0671ba | Iustin Pop | ancient cultures, but are stuck with non-latin-friendly cluster |
917 | 9d0671ba | Iustin Pop | virtualization technologies. |
918 | 1b7f2c85 | Iustin Pop | |
919 | 1b7f2c85 | Iustin Pop | MODIFY |
920 | 1b7f2c85 | Iustin Pop | ^^^^^^ |
921 | 1b7f2c85 | Iustin Pop | |
922 | 1b7f2c85 | Iustin Pop | | **modify** |
923 | e8f936b0 | Iustin Pop | | [{-H|\--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*] |
924 | e8f936b0 | Iustin Pop | | [{-B|\--backend-parameters} *BACKEND\_PARAMETERS*] |
925 | e8f936b0 | Iustin Pop | | [{-m|\--runtime-memory} *SIZE*] |
926 | f5720846 | Guido Trotter | | [\--net add*[:options]* \| \--net [*N*:]remove \| \--net *N:options*] |
927 | f5720846 | Guido Trotter | | [\--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \| \--disk [*N*:]remove \| |
928 | e8f936b0 | Iustin Pop | | \--disk *N*:mode=*MODE*] |
929 | e8f936b0 | Iustin Pop | | [{-t|\--disk-template} plain | {-t|\--disk-template} drbd -n *new_secondary*] [\--no-wait-for-sync] |
930 | e8f936b0 | Iustin Pop | | [\--os-type=*OS* [\--force-variant]] |
931 | e8f936b0 | Iustin Pop | | [{-O|\--os-parameters} *param*=*value*... ] |
932 | e8f936b0 | Iustin Pop | | [\--offline \| \--online] |
933 | e8f936b0 | Iustin Pop | | [\--submit] |
934 | e8f936b0 | Iustin Pop | | [\--ignore-ipolicy] |
935 | 1b7f2c85 | Iustin Pop | | {*instance*} |
936 | 1b7f2c85 | Iustin Pop | |
937 | 1b7f2c85 | Iustin Pop | Modifies the memory size, number of vcpus, ip address, MAC address |
938 | 1b7f2c85 | Iustin Pop | and/or nic parameters for an instance. It can also add and remove |
939 | 1b7f2c85 | Iustin Pop | disks and NICs to/from the instance. Note that you need to give at |
940 | 1b7f2c85 | Iustin Pop | least one of the arguments, otherwise the command complains. |
941 | 1b7f2c85 | Iustin Pop | |
942 | 0a68e0ff | Iustin Pop | The ``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)`` |
943 | 0a68e0ff | Iustin Pop | and ``-O (--os-parameters)`` options specifies hypervisor, backend and |
944 | 0a68e0ff | Iustin Pop | OS parameter options in the form of name=value[,...]. For details |
945 | a53cd1f4 | Iustin Pop | which options can be specified, see the **add** command. |
946 | 1b7f2c85 | Iustin Pop | |
947 | 0a68e0ff | Iustin Pop | The ``-t (--disk-template)`` option will change the disk template of |
948 | 0a68e0ff | Iustin Pop | the instance. Currently only conversions between the plain and drbd |
949 | 0a68e0ff | Iustin Pop | disk templates are supported, and the instance must be stopped before |
950 | 0a68e0ff | Iustin Pop | attempting the conversion. When changing from the plain to the drbd |
951 | 0a68e0ff | Iustin Pop | disk template, a new secondary node must be specified via the ``-n`` |
952 | 0a68e0ff | Iustin Pop | option. The option ``--no-wait-for-sync`` can be used when converting |
953 | 0a68e0ff | Iustin Pop | to the ``drbd`` template in order to make the instance available for |
954 | 0a68e0ff | Iustin Pop | startup before DRBD has finished resyncing. |
955 | 1b7f2c85 | Iustin Pop | |
956 | 2c0af7da | Guido Trotter | The ``-m (--runtime-memory)`` option will change an instance's runtime |
957 | 2c0af7da | Guido Trotter | memory to the given size (in MB if a different suffix is not specified), |
958 | 2c0af7da | Guido Trotter | by ballooning it up or down to the new value. |
959 | 2c0af7da | Guido Trotter | |
960 | 1b7f2c85 | Iustin Pop | The ``--disk add:size=``*SIZE* option adds a disk to the instance. The |
961 | a71f835e | Michael Hanselmann | optional ``vg=``*VG* option specifies an LVM volume group other than |
962 | a71f835e | Michael Hanselmann | the default volume group to create the disk on. For DRBD disks, the |
963 | a71f835e | Michael Hanselmann | ``metavg=``*VG* option specifies the volume group for the metadata |
964 | a71f835e | Michael Hanselmann | device. ``--disk`` *N*``:add,size=``**SIZE** can be used to add a |
965 | a71f835e | Michael Hanselmann | disk at a specific index. The ``--disk remove`` option will remove the |
966 | 15b5f9a4 | Iustin Pop | last disk of the instance. Use ``--disk `` *N*``:remove`` to remove a |
967 | a71f835e | Michael Hanselmann | disk by its index. The ``--disk`` *N*``:mode=``*MODE* option will change |
968 | a71f835e | Michael Hanselmann | the mode of the Nth disk of the instance between read-only (``ro``) and |
969 | 1b7f2c85 | Iustin Pop | read-write (``rw``). |
970 | 1b7f2c85 | Iustin Pop | |
971 | a71f835e | Michael Hanselmann | The ``--net add:``*options* and ``--net`` *N*``:add,``*options* option |
972 | a71f835e | Michael Hanselmann | will add a new network interface to the instance. The available options |
973 | a71f835e | Michael Hanselmann | are the same as in the **add** command (``mac``, ``ip``, ``link``, |
974 | a71f835e | Michael Hanselmann | ``mode``). The ``--net remove`` will remove the last network interface |
975 | a71f835e | Michael Hanselmann | of the instance (``--net`` *N*``:remove`` for a specific index), while |
976 | a71f835e | Michael Hanselmann | the ``--net`` *N*``:``*options* option will change the parameters of the Nth |
977 | a71f835e | Michael Hanselmann | instance network interface. |
978 | 1b7f2c85 | Iustin Pop | |
979 | 0a68e0ff | Iustin Pop | The option ``-o (--os-type)`` will change the OS name for the instance |
980 | 9d0671ba | Iustin Pop | (without reinstallation). In case an OS variant is specified that is |
981 | 9d0671ba | Iustin Pop | not found, then by default the modification is refused, unless |
982 | 1b7f2c85 | Iustin Pop | ``--force-variant`` is passed. An invalid OS will also be refused, |
983 | 1b7f2c85 | Iustin Pop | unless the ``--force`` option is given. |
984 | 1b7f2c85 | Iustin Pop | |
985 | bafb5067 | Agata Murawska | The ``--online`` and ``--offline`` options are used to transition an |
986 | bafb5067 | Agata Murawska | instance into and out of the ``offline`` state. An instance can be |
987 | bafb5067 | Agata Murawska | turned offline only if it was previously down. The ``--online`` option |
988 | bafb5067 | Agata Murawska | fails if the instance was not in the ``offline`` state, otherwise it |
989 | bafb5067 | Agata Murawska | changes instance's state to ``down``. These modifications take effect |
990 | bafb5067 | Agata Murawska | immediately. |
991 | bafb5067 | Agata Murawska | |
992 | 1559e1e7 | René Nussbaumer | If ``--ignore-ipolicy`` is given any instance policy violations occuring |
993 | 1559e1e7 | René Nussbaumer | during this operation are ignored. |
994 | 1559e1e7 | René Nussbaumer | |
995 | 13ddcb50 | Michael Hanselmann | See **ganeti(7)** for a description of ``--submit`` and other common |
996 | 13ddcb50 | Michael Hanselmann | options. |
997 | 13ddcb50 | Michael Hanselmann | |
998 | bafb5067 | Agata Murawska | Most of the changes take effect at the next restart. If the instance is |
999 | 1b7f2c85 | Iustin Pop | running, there is no effect on the instance. |
1000 | 1b7f2c85 | Iustin Pop | |
1001 | 1b7f2c85 | Iustin Pop | REINSTALL |
1002 | 1b7f2c85 | Iustin Pop | ^^^^^^^^^ |
1003 | 1b7f2c85 | Iustin Pop | |
1004 | e8f936b0 | Iustin Pop | | **reinstall** [{-o|\--os-type} *os-type*] [\--select-os] [-f *force*] |
1005 | e8f936b0 | Iustin Pop | | [\--force-multiple] |
1006 | e8f936b0 | Iustin Pop | | [\--instance \| \--node \| \--primary \| \--secondary \| \--all] |
1007 | e8f936b0 | Iustin Pop | | [{-O|\--os-parameters} *OS\_PARAMETERS*] [\--submit] {*instance*...} |
1008 | 1b7f2c85 | Iustin Pop | |
1009 | 1b7f2c85 | Iustin Pop | Reinstalls the operating system on the given instance(s). The |
1010 | 0a68e0ff | Iustin Pop | instance(s) must be stopped when running this command. If the ``-o |
1011 | 0a68e0ff | Iustin Pop | (--os-type)`` is specified, the operating system is changed. |
1012 | 1b7f2c85 | Iustin Pop | |
1013 | 1b7f2c85 | Iustin Pop | The ``--select-os`` option switches to an interactive OS reinstall. |
1014 | 1b7f2c85 | Iustin Pop | The user is prompted to select the OS template from the list of |
1015 | 0a68e0ff | Iustin Pop | available OS templates. OS parameters can be overridden using ``-O |
1016 | 0a68e0ff | Iustin Pop | (--os-parameters)`` (more documentation for this option under the |
1017 | 0a68e0ff | Iustin Pop | **add** command). |
1018 | 1b7f2c85 | Iustin Pop | |
1019 | 1b7f2c85 | Iustin Pop | Since this is a potentially dangerous command, the user will be |
1020 | 1b7f2c85 | Iustin Pop | required to confirm this action, unless the ``-f`` flag is passed. |
1021 | 1b7f2c85 | Iustin Pop | When multiple instances are selected (either by passing multiple |
1022 | 9d0671ba | Iustin Pop | arguments or by using the ``--node``, ``--primary``, ``--secondary`` |
1023 | 9d0671ba | Iustin Pop | or ``--all`` options), the user must pass the ``--force-multiple`` |
1024 | 9d0671ba | Iustin Pop | options to skip the interactive confirmation. |
1025 | 1b7f2c85 | Iustin Pop | |
1026 | 13ddcb50 | Michael Hanselmann | See **ganeti(7)** for a description of ``--submit`` and other common |
1027 | 13ddcb50 | Michael Hanselmann | options. |
1028 | 1b7f2c85 | Iustin Pop | |
1029 | 1b7f2c85 | Iustin Pop | RENAME |
1030 | 1b7f2c85 | Iustin Pop | ^^^^^^ |
1031 | 1b7f2c85 | Iustin Pop | |
1032 | e8f936b0 | Iustin Pop | | **rename** [\--no-ip-check] [\--no-name-check] [\--submit] |
1033 | 1b7f2c85 | Iustin Pop | | {*instance*} {*new\_name*} |
1034 | 1b7f2c85 | Iustin Pop | |
1035 | 9d0671ba | Iustin Pop | Renames the given instance. The instance must be stopped when running |
1036 | 9d0671ba | Iustin Pop | this command. The requirements for the new name are the same as for |
1037 | 9d0671ba | Iustin Pop | adding an instance: the new name must be resolvable and the IP it |
1038 | 9d0671ba | Iustin Pop | resolves to must not be reachable (in order to prevent duplicate IPs |
1039 | 9d0671ba | Iustin Pop | the next time the instance is started). The IP test can be skipped if |
1040 | 9d0671ba | Iustin Pop | the ``--no-ip-check`` option is passed. |
1041 | 1b7f2c85 | Iustin Pop | |
1042 | a84d1115 | René Nussbaumer | The ``--no-name-check`` skips the check for the new instance name via |
1043 | a84d1115 | René Nussbaumer | the resolver (e.g. in DNS or /etc/hosts, depending on your setup) and |
1044 | a84d1115 | René Nussbaumer | that the resolved name matches the provided name. Since the name check |
1045 | a84d1115 | René Nussbaumer | is used to compute the IP address, if you pass this option you must also |
1046 | a84d1115 | René Nussbaumer | pass the ``--no-ip-check`` option. |
1047 | 1b7f2c85 | Iustin Pop | |
1048 | 13ddcb50 | Michael Hanselmann | See **ganeti(7)** for a description of ``--submit`` and other common |
1049 | 13ddcb50 | Michael Hanselmann | options. |
1050 | 1b7f2c85 | Iustin Pop | |
1051 | 1b7f2c85 | Iustin Pop | Starting/stopping/connecting to console |
1052 | 1b7f2c85 | Iustin Pop | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
1053 | 1b7f2c85 | Iustin Pop | |
1054 | 1b7f2c85 | Iustin Pop | STARTUP |
1055 | 1b7f2c85 | Iustin Pop | ^^^^^^^ |
1056 | 1b7f2c85 | Iustin Pop | |
1057 | 1b7f2c85 | Iustin Pop | | **startup** |
1058 | e8f936b0 | Iustin Pop | | [\--force] [\--ignore-offline] |
1059 | e8f936b0 | Iustin Pop | | [\--force-multiple] [\--no-remember] |
1060 | e8f936b0 | Iustin Pop | | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \| |
1061 | e8f936b0 | Iustin Pop | | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags] |
1062 | e8f936b0 | Iustin Pop | | [{-H|\--hypervisor-parameters} ``key=value...``] |
1063 | e8f936b0 | Iustin Pop | | [{-B|\--backend-parameters} ``key=value...``] |
1064 | e8f936b0 | Iustin Pop | | [\--submit] [\--paused] |
1065 | 1b7f2c85 | Iustin Pop | | {*name*...} |
1066 | 1b7f2c85 | Iustin Pop | |
1067 | 9d0671ba | Iustin Pop | Starts one or more instances, depending on the following options. The |
1068 | 9d0671ba | Iustin Pop | four available modes are: |
1069 | 1b7f2c85 | Iustin Pop | |
1070 | e8f936b0 | Iustin Pop | \--instance |
1071 | 1b7f2c85 | Iustin Pop | will start the instances given as arguments (at least one argument |
1072 | 1b7f2c85 | Iustin Pop | required); this is the default selection |
1073 | 1b7f2c85 | Iustin Pop | |
1074 | e8f936b0 | Iustin Pop | \--node |
1075 | 1b7f2c85 | Iustin Pop | will start the instances who have the given node as either primary |
1076 | 1b7f2c85 | Iustin Pop | or secondary |
1077 | 1b7f2c85 | Iustin Pop | |
1078 | e8f936b0 | Iustin Pop | \--primary |
1079 | 1b7f2c85 | Iustin Pop | will start all instances whose primary node is in the list of nodes |
1080 | 1b7f2c85 | Iustin Pop | passed as arguments (at least one node required) |
1081 | 1b7f2c85 | Iustin Pop | |
1082 | e8f936b0 | Iustin Pop | \--secondary |
1083 | 1b7f2c85 | Iustin Pop | will start all instances whose secondary node is in the list of |
1084 | 1b7f2c85 | Iustin Pop | nodes passed as arguments (at least one node required) |
1085 | 1b7f2c85 | Iustin Pop | |
1086 | e8f936b0 | Iustin Pop | \--all |
1087 | 1b7f2c85 | Iustin Pop | will start all instances in the cluster (no arguments accepted) |
1088 | 1b7f2c85 | Iustin Pop | |
1089 | e8f936b0 | Iustin Pop | \--tags |
1090 | 1b7f2c85 | Iustin Pop | will start all instances in the cluster with the tags given as |
1091 | 1b7f2c85 | Iustin Pop | arguments |
1092 | 1b7f2c85 | Iustin Pop | |
1093 | e8f936b0 | Iustin Pop | \--node-tags |
1094 | 1b7f2c85 | Iustin Pop | will start all instances in the cluster on nodes with the tags |
1095 | 1b7f2c85 | Iustin Pop | given as arguments |
1096 | 1b7f2c85 | Iustin Pop | |
1097 | e8f936b0 | Iustin Pop | \--pri-node-tags |
1098 | 1b7f2c85 | Iustin Pop | will start all instances in the cluster on primary nodes with the |
1099 | 1b7f2c85 | Iustin Pop | tags given as arguments |
1100 | 1b7f2c85 | Iustin Pop | |
1101 | e8f936b0 | Iustin Pop | \--sec-node-tags |
1102 | 1b7f2c85 | Iustin Pop | will start all instances in the cluster on secondary nodes with the |
1103 | 1b7f2c85 | Iustin Pop | tags given as arguments |
1104 | 1b7f2c85 | Iustin Pop | |
1105 | 1b7f2c85 | Iustin Pop | Note that although you can pass more than one selection option, the |
1106 | 9d0671ba | Iustin Pop | last one wins, so in order to guarantee the desired result, don't pass |
1107 | 9d0671ba | Iustin Pop | more than one such option. |
1108 | 1b7f2c85 | Iustin Pop | |
1109 | 1b7f2c85 | Iustin Pop | Use ``--force`` to start even if secondary disks are failing. |
1110 | 9d0671ba | Iustin Pop | ``--ignore-offline`` can be used to ignore offline primary nodes and |
1111 | 9d0671ba | Iustin Pop | mark the instance as started even if the primary is not available. |
1112 | 1b7f2c85 | Iustin Pop | |
1113 | 9d0671ba | Iustin Pop | The ``--force-multiple`` will skip the interactive confirmation in the |
1114 | 9d0671ba | Iustin Pop | case the more than one instance will be affected. |
1115 | 1b7f2c85 | Iustin Pop | |
1116 | 885a0fc4 | Iustin Pop | The ``--no-remember`` option will perform the startup but not change |
1117 | 885a0fc4 | Iustin Pop | the state of the instance in the configuration file (if it was stopped |
1118 | 88f622e0 | Michael Hanselmann | before, Ganeti will still think it needs to be stopped). This can be |
1119 | 885a0fc4 | Iustin Pop | used for testing, or for a one shot-start where you don't want the |
1120 | 885a0fc4 | Iustin Pop | watcher to restart the instance if it crashes. |
1121 | 885a0fc4 | Iustin Pop | |
1122 | 0a68e0ff | Iustin Pop | The ``-H (--hypervisor-parameters)`` and ``-B (--backend-parameters)`` |
1123 | 0a68e0ff | Iustin Pop | options specify temporary hypervisor and backend parameters that can |
1124 | 0a68e0ff | Iustin Pop | be used to start an instance with modified parameters. They can be |
1125 | 0a68e0ff | Iustin Pop | useful for quick testing without having to modify an instance back and |
1126 | 0a68e0ff | Iustin Pop | forth, e.g.:: |
1127 | 1b7f2c85 | Iustin Pop | |
1128 | fa23cc50 | Stephen Shirley | # gnt-instance start -H kernel_args="single" instance1 |
1129 | 90bb3fe1 | Guido Trotter | # gnt-instance start -B maxmem=2048 instance2 |
1130 | 1b7f2c85 | Iustin Pop | |
1131 | 1b7f2c85 | Iustin Pop | |
1132 | 9d0671ba | Iustin Pop | The first form will start the instance instance1 in single-user mode, |
1133 | 9d0671ba | Iustin Pop | and the instance instance2 with 2GB of RAM (this time only, unless |
1134 | 9d0671ba | Iustin Pop | that is the actual instance memory size already). Note that the values |
1135 | 9d0671ba | Iustin Pop | override the instance parameters (and not extend them): an instance |
1136 | fa23cc50 | Stephen Shirley | with "kernel\_args=ro" when started with -H kernel\_args=single will |
1137 | 13ddcb50 | Michael Hanselmann | result in "single", not "ro single". |
1138 | 1b7f2c85 | Iustin Pop | |
1139 | 323f9095 | Stephen Shirley | The ``--paused`` option is only valid for Xen and kvm hypervisors. This |
1140 | 323f9095 | Stephen Shirley | pauses the instance at the start of bootup, awaiting ``gnt-instance |
1141 | 323f9095 | Stephen Shirley | console`` to unpause it, allowing the entire boot process to be |
1142 | 323f9095 | Stephen Shirley | monitored for debugging. |
1143 | 323f9095 | Stephen Shirley | |
1144 | 13ddcb50 | Michael Hanselmann | See **ganeti(7)** for a description of ``--submit`` and other common |
1145 | 13ddcb50 | Michael Hanselmann | options. |
1146 | 13ddcb50 | Michael Hanselmann | |
1147 | 1b7f2c85 | Iustin Pop | Example:: |
1148 | 1b7f2c85 | Iustin Pop | |
1149 | 1b7f2c85 | Iustin Pop | # gnt-instance start instance1.example.com |
1150 | 1b7f2c85 | Iustin Pop | # gnt-instance start --node node1.example.com node2.example.com |
1151 | 1b7f2c85 | Iustin Pop | # gnt-instance start --all |
1152 | 1b7f2c85 | Iustin Pop | |
1153 | 1b7f2c85 | Iustin Pop | |
1154 | 1b7f2c85 | Iustin Pop | SHUTDOWN |
1155 | 1b7f2c85 | Iustin Pop | ^^^^^^^^ |
1156 | 1b7f2c85 | Iustin Pop | |
1157 | 1b7f2c85 | Iustin Pop | | **shutdown** |
1158 | e8f936b0 | Iustin Pop | | [\--timeout=*N*] |
1159 | e8f936b0 | Iustin Pop | | [\--force-multiple] [\--ignore-offline] [\--no-remember] |
1160 | e8f936b0 | Iustin Pop | | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \| |
1161 | e8f936b0 | Iustin Pop | | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags] |
1162 | e8f936b0 | Iustin Pop | | [\--submit] |
1163 | 1b7f2c85 | Iustin Pop | | {*name*...} |
1164 | 1b7f2c85 | Iustin Pop | |
1165 | 9d0671ba | Iustin Pop | Stops one or more instances. If the instance cannot be cleanly stopped |
1166 | 9d0671ba | Iustin Pop | during a hardcoded interval (currently 2 minutes), it will forcibly |
1167 | 9d0671ba | Iustin Pop | stop the instance (equivalent to switching off the power on a physical |
1168 | 9d0671ba | Iustin Pop | machine). |
1169 | 1b7f2c85 | Iustin Pop | |
1170 | 1b7f2c85 | Iustin Pop | The ``--timeout`` is used to specify how much time to wait before |
1171 | 1b7f2c85 | Iustin Pop | forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the kvm |
1172 | 1b7f2c85 | Iustin Pop | process for KVM, etc.). By default two minutes are given to each |
1173 | 1b7f2c85 | Iustin Pop | instance to stop. |
1174 | 1b7f2c85 | Iustin Pop | |
1175 | 1b7f2c85 | Iustin Pop | The ``--instance``, ``--node``, ``--primary``, ``--secondary``, |
1176 | 1b7f2c85 | Iustin Pop | ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and |
1177 | 9d0671ba | Iustin Pop | ``--sec-node-tags`` options are similar as for the **startup** command |
1178 | 9d0671ba | Iustin Pop | and they influence the actual instances being shutdown. |
1179 | 1b7f2c85 | Iustin Pop | |
1180 | 9d0671ba | Iustin Pop | ``--ignore-offline`` can be used to ignore offline primary nodes and |
1181 | 9d0671ba | Iustin Pop | force the instance to be marked as stopped. This option should be used |
1182 | 9d0671ba | Iustin Pop | with care as it can lead to an inconsistent cluster state. |
1183 | 1b7f2c85 | Iustin Pop | |
1184 | 885a0fc4 | Iustin Pop | The ``--no-remember`` option will perform the shutdown but not change |
1185 | 885a0fc4 | Iustin Pop | the state of the instance in the configuration file (if it was running |
1186 | 885a0fc4 | Iustin Pop | before, Ganeti will still thinks it needs to be running). This can be |
1187 | 885a0fc4 | Iustin Pop | useful for a cluster-wide shutdown, where some instances are marked as |
1188 | 885a0fc4 | Iustin Pop | up and some as down, and you don't want to change the running state: |
1189 | 885a0fc4 | Iustin Pop | you just need to disable the watcher, shutdown all instances with |
1190 | 885a0fc4 | Iustin Pop | ``--no-remember``, and when the watcher is activated again it will |
1191 | 885a0fc4 | Iustin Pop | restore the correct runtime state for all instances. |
1192 | 885a0fc4 | Iustin Pop | |
1193 | 13ddcb50 | Michael Hanselmann | See **ganeti(7)** for a description of ``--submit`` and other common |
1194 | 13ddcb50 | Michael Hanselmann | options. |
1195 | 13ddcb50 | Michael Hanselmann | |
1196 | 1b7f2c85 | Iustin Pop | Example:: |
1197 | 1b7f2c85 | Iustin Pop | |
1198 | 1b7f2c85 | Iustin Pop | # gnt-instance shutdown instance1.example.com |
1199 | 1b7f2c85 | Iustin Pop | # gnt-instance shutdown --all |
1200 | 1b7f2c85 | Iustin Pop | |
1201 | 1b7f2c85 | Iustin Pop | |
1202 | 1b7f2c85 | Iustin Pop | REBOOT |
1203 | 1b7f2c85 | Iustin Pop | ^^^^^^ |
1204 | 1b7f2c85 | Iustin Pop | |
1205 | 1b7f2c85 | Iustin Pop | | **reboot** |
1206 | e8f936b0 | Iustin Pop | | [{-t|\--type} *REBOOT-TYPE*] |
1207 | e8f936b0 | Iustin Pop | | [\--ignore-secondaries] |
1208 | e8f936b0 | Iustin Pop | | [\--shutdown-timeout=*N*] |
1209 | e8f936b0 | Iustin Pop | | [\--force-multiple] |
1210 | e8f936b0 | Iustin Pop | | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \| |
1211 | e8f936b0 | Iustin Pop | | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags] |
1212 | e8f936b0 | Iustin Pop | | [\--submit] |
1213 | 1b7f2c85 | Iustin Pop | | [*name*...] |
1214 | 1b7f2c85 | Iustin Pop | |
1215 | 9d0671ba | Iustin Pop | Reboots one or more instances. The type of reboot depends on the value |
1216 | 0a68e0ff | Iustin Pop | of ``-t (--type)``. A soft reboot does a hypervisor reboot, a hard reboot |
1217 | 9d0671ba | Iustin Pop | does a instance stop, recreates the hypervisor config for the instance |
1218 | 9d0671ba | Iustin Pop | and starts the instance. A full reboot does the equivalent of |
1219 | 9d0671ba | Iustin Pop | **gnt-instance shutdown && gnt-instance startup**. The default is |
1220 | 9d0671ba | Iustin Pop | hard reboot. |
1221 | 1b7f2c85 | Iustin Pop | |
1222 | 9d0671ba | Iustin Pop | For the hard reboot the option ``--ignore-secondaries`` ignores errors |
1223 | 9d0671ba | Iustin Pop | for the secondary node while re-assembling the instance disks. |
1224 | 1b7f2c85 | Iustin Pop | |
1225 | 1b7f2c85 | Iustin Pop | The ``--instance``, ``--node``, ``--primary``, ``--secondary``, |
1226 | 1b7f2c85 | Iustin Pop | ``--all``, ``--tags``, ``--node-tags``, ``--pri-node-tags`` and |
1227 | 9d0671ba | Iustin Pop | ``--sec-node-tags`` options are similar as for the **startup** command |
1228 | 9d0671ba | Iustin Pop | and they influence the actual instances being rebooted. |
1229 | 1b7f2c85 | Iustin Pop | |
1230 | 1b7f2c85 | Iustin Pop | The ``--shutdown-timeout`` is used to specify how much time to wait |
1231 | 1b7f2c85 | Iustin Pop | before forcing the shutdown (xm destroy in xen, killing the kvm |
1232 | 9d0671ba | Iustin Pop | process, for kvm). By default two minutes are given to each instance |
1233 | 9d0671ba | Iustin Pop | to stop. |
1234 | 1b7f2c85 | Iustin Pop | |
1235 | 9d0671ba | Iustin Pop | The ``--force-multiple`` will skip the interactive confirmation in the |
1236 | 9d0671ba | Iustin Pop | case the more than one instance will be affected. |
1237 | 1b7f2c85 | Iustin Pop | |
1238 | 13ddcb50 | Michael Hanselmann | See **ganeti(7)** for a description of ``--submit`` and other common |
1239 | 13ddcb50 | Michael Hanselmann | options. |
1240 | 13ddcb50 | Michael Hanselmann | |
1241 | 1b7f2c85 | Iustin Pop | Example:: |
1242 | 1b7f2c85 | Iustin Pop | |
1243 | 1b7f2c85 | Iustin Pop | # gnt-instance reboot instance1.example.com |
1244 | 1b7f2c85 | Iustin Pop | # gnt-instance reboot --type=full instance1.example.com |
1245 | 1b7f2c85 | Iustin Pop | |
1246 | 1b7f2c85 | Iustin Pop | |
1247 | 1b7f2c85 | Iustin Pop | CONSOLE |
1248 | 1b7f2c85 | Iustin Pop | ^^^^^^^ |
1249 | 1b7f2c85 | Iustin Pop | |
1250 | e8f936b0 | Iustin Pop | **console** [\--show-cmd] {*instance*} |
1251 | 1b7f2c85 | Iustin Pop | |
1252 | 9d0671ba | Iustin Pop | Connects to the console of the given instance. If the instance is not |
1253 | 9d0671ba | Iustin Pop | up, an error is returned. Use the ``--show-cmd`` option to display the |
1254 | 9d0671ba | Iustin Pop | command instead of executing it. |
1255 | 1b7f2c85 | Iustin Pop | |
1256 | 9d0671ba | Iustin Pop | For HVM instances, this will attempt to connect to the serial console |
1257 | 9d0671ba | Iustin Pop | of the instance. To connect to the virtualized "physical" console of a |
1258 | 9d0671ba | Iustin Pop | HVM instance, use a VNC client with the connection info from the |
1259 | 9d0671ba | Iustin Pop | **info** command. |
1260 | 1b7f2c85 | Iustin Pop | |
1261 | 323f9095 | Stephen Shirley | For Xen/kvm instances, if the instance is paused, this attempts to |
1262 | 323f9095 | Stephen Shirley | unpause the instance after waiting a few seconds for the connection to |
1263 | 323f9095 | Stephen Shirley | the console to be made. |
1264 | 323f9095 | Stephen Shirley | |
1265 | 1b7f2c85 | Iustin Pop | Example:: |
1266 | 1b7f2c85 | Iustin Pop | |
1267 | 1b7f2c85 | Iustin Pop | # gnt-instance console instance1.example.com |
1268 | 1b7f2c85 | Iustin Pop | |
1269 | 1b7f2c85 | Iustin Pop | |
1270 | 1b7f2c85 | Iustin Pop | Disk management |
1271 | 1b7f2c85 | Iustin Pop | ~~~~~~~~~~~~~~~ |
1272 | 1b7f2c85 | Iustin Pop | |
1273 | 1b7f2c85 | Iustin Pop | REPLACE-DISKS |
1274 | 1b7f2c85 | Iustin Pop | ^^^^^^^^^^^^^ |
1275 | 1b7f2c85 | Iustin Pop | |
1276 | e8f936b0 | Iustin Pop | **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-p} |
1277 | e8f936b0 | Iustin Pop | [\--disks *idx*] {*instance*} |
1278 | 1b7f2c85 | Iustin Pop | |
1279 | e8f936b0 | Iustin Pop | **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-s} |
1280 | e8f936b0 | Iustin Pop | [\--disks *idx*] {*instance*} |
1281 | 1b7f2c85 | Iustin Pop | |
1282 | e8f936b0 | Iustin Pop | **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] |
1283 | 50c1e351 | Bernardo Dal Seno | {{-I\|\--iallocator} *name* \| {{-n|\--new-secondary} *node* } {*instance*} |
1284 | 1b7f2c85 | Iustin Pop | |
1285 | e8f936b0 | Iustin Pop | **replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] |
1286 | 50c1e351 | Bernardo Dal Seno | {-a\|\--auto} {*instance*} |
1287 | 1b7f2c85 | Iustin Pop | |
1288 | 1b7f2c85 | Iustin Pop | This command is a generalized form for replacing disks. It is |
1289 | 1b7f2c85 | Iustin Pop | currently only valid for the mirrored (DRBD) disk template. |
1290 | 1b7f2c85 | Iustin Pop | |
1291 | 9d0671ba | Iustin Pop | The first form (when passing the ``-p`` option) will replace the disks |
1292 | 9d0671ba | Iustin Pop | on the primary, while the second form (when passing the ``-s`` option |
1293 | 9d0671ba | Iustin Pop | will replace the disks on the secondary node. For these two cases (as |
1294 | 9d0671ba | Iustin Pop | the node doesn't change), it is possible to only run the replace for a |
1295 | 9d0671ba | Iustin Pop | subset of the disks, using the option ``--disks`` which takes a list |
1296 | 9d0671ba | Iustin Pop | of comma-delimited disk indices (zero-based), e.g. 0,2 to replace only |
1297 | 9d0671ba | Iustin Pop | the first and third disks. |
1298 | 1b7f2c85 | Iustin Pop | |
1299 | 1b7f2c85 | Iustin Pop | The third form (when passing either the ``--iallocator`` or the |
1300 | 1a770ce5 | Bernardo Dal Seno | ``--new-secondary`` option) is designed to change secondary node of the |
1301 | 1a770ce5 | Bernardo Dal Seno | instance. Specifying ``--iallocator`` makes the new secondary be |
1302 | 1a770ce5 | Bernardo Dal Seno | selected automatically by the specified allocator plugin (use ``.`` to |
1303 | 1a770ce5 | Bernardo Dal Seno | indicate the default allocator), otherwise the new secondary node will |
1304 | 1a770ce5 | Bernardo Dal Seno | be the one chosen manually via the ``--new-secondary`` option. |
1305 | 1b7f2c85 | Iustin Pop | |
1306 | 13ddcb50 | Michael Hanselmann | Note that it is not possible to select an offline or drained node as a |
1307 | 13ddcb50 | Michael Hanselmann | new secondary. |
1308 | 13ddcb50 | Michael Hanselmann | |
1309 | 9d0671ba | Iustin Pop | The fourth form (when using ``--auto``) will automatically determine |
1310 | 9d0671ba | Iustin Pop | which disks of an instance are faulty and replace them within the same |
1311 | 9d0671ba | Iustin Pop | node. The ``--auto`` option works only when an instance has only |
1312 | 9d0671ba | Iustin Pop | faulty disks on either the primary or secondary node; it doesn't work |
1313 | 9d0671ba | Iustin Pop | when both sides have faulty disks. |
1314 | 1b7f2c85 | Iustin Pop | |
1315 | 1b7f2c85 | Iustin Pop | The ``--early-release`` changes the code so that the old storage on |
1316 | 1b7f2c85 | Iustin Pop | secondary node(s) is removed early (before the resync is completed) |
1317 | 1b7f2c85 | Iustin Pop | and the internal Ganeti locks for the current (and new, if any) |
1318 | 1b7f2c85 | Iustin Pop | secondary node are also released, thus allowing more parallelism in |
1319 | 9d0671ba | Iustin Pop | the cluster operation. This should be used only when recovering from a |
1320 | 9d0671ba | Iustin Pop | disk failure on the current secondary (thus the old storage is already |
1321 | 9d0671ba | Iustin Pop | broken) or when the storage on the primary node is known to be fine |
1322 | 9d0671ba | Iustin Pop | (thus we won't need the old storage for potential recovery). |
1323 | 1b7f2c85 | Iustin Pop | |
1324 | 893e8f49 | René Nussbaumer | The ``--ignore-ipolicy`` let the command ignore instance policy |
1325 | 893e8f49 | René Nussbaumer | violations if replace-disks changes groups and the instance would |
1326 | 893e8f49 | René Nussbaumer | violate the new groups instance policy. |
1327 | 893e8f49 | René Nussbaumer | |
1328 | 13ddcb50 | Michael Hanselmann | See **ganeti(7)** for a description of ``--submit`` and other common |
1329 | 13ddcb50 | Michael Hanselmann | options. |
1330 | 1b7f2c85 | Iustin Pop | |
1331 | 1b7f2c85 | Iustin Pop | ACTIVATE-DISKS |
1332 | 1b7f2c85 | Iustin Pop | ^^^^^^^^^^^^^^ |
1333 | 1b7f2c85 | Iustin Pop | |
1334 | f30d8165 | Iustin Pop | **activate-disks** [\--submit] [\--ignore-size] [\--wait-for-sync] {*instance*} |
1335 | 1b7f2c85 | Iustin Pop | |
1336 | 9d0671ba | Iustin Pop | Activates the block devices of the given instance. If successful, the |
1337 | 9d0671ba | Iustin Pop | command will show the location and name of the block devices:: |
1338 | 1b7f2c85 | Iustin Pop | |
1339 | 1b7f2c85 | Iustin Pop | node1.example.com:disk/0:/dev/drbd0 |
1340 | 1b7f2c85 | Iustin Pop | node1.example.com:disk/1:/dev/drbd1 |
1341 | 1b7f2c85 | Iustin Pop | |
1342 | 1b7f2c85 | Iustin Pop | |
1343 | 9d0671ba | Iustin Pop | In this example, *node1.example.com* is the name of the node on which |
1344 | 9d0671ba | Iustin Pop | the devices have been activated. The *disk/0* and *disk/1* are the |
1345 | 9d0671ba | Iustin Pop | Ganeti-names of the instance disks; how they are visible inside the |
1346 | 9d0671ba | Iustin Pop | instance is hypervisor-specific. */dev/drbd0* and */dev/drbd1* are the |
1347 | 13ddcb50 | Michael Hanselmann | actual block devices as visible on the node. |
1348 | 1b7f2c85 | Iustin Pop | |
1349 | 1b7f2c85 | Iustin Pop | The ``--ignore-size`` option can be used to activate disks ignoring |
1350 | 1b7f2c85 | Iustin Pop | the currently configured size in Ganeti. This can be used in cases |
1351 | 1b7f2c85 | Iustin Pop | where the configuration has gotten out of sync with the real-world |
1352 | 9d0671ba | Iustin Pop | (e.g. after a partially-failed grow-disk operation or due to rounding |
1353 | 9d0671ba | Iustin Pop | in LVM devices). This should not be used in normal cases, but only |
1354 | 9d0671ba | Iustin Pop | when activate-disks fails without it. |
1355 | 1b7f2c85 | Iustin Pop | |
1356 | f30d8165 | Iustin Pop | The ``--wait-for-sync`` option will ensure that the command returns only |
1357 | f30d8165 | Iustin Pop | after the instance's disks are synchronised (mostly for DRBD); this can |
1358 | f30d8165 | Iustin Pop | be useful to ensure consistency, as otherwise there are no commands that |
1359 | f30d8165 | Iustin Pop | can wait until synchronisation is done. However when passing this |
1360 | f30d8165 | Iustin Pop | option, the command will have additional output, making it harder to |
1361 | f30d8165 | Iustin Pop | parse the disk information. |
1362 | f30d8165 | Iustin Pop | |
1363 | 9d0671ba | Iustin Pop | Note that it is safe to run this command while the instance is already |
1364 | 9d0671ba | Iustin Pop | running. |
1365 | 1b7f2c85 | Iustin Pop | |
1366 | 13ddcb50 | Michael Hanselmann | See **ganeti(7)** for a description of ``--submit`` and other common |
1367 | 13ddcb50 | Michael Hanselmann | options. |
1368 | 13ddcb50 | Michael Hanselmann | |
1369 | 1b7f2c85 | Iustin Pop | DEACTIVATE-DISKS |
1370 | 1b7f2c85 | Iustin Pop | ^^^^^^^^^^^^^^^^ |
1371 | 1b7f2c85 | Iustin Pop | |
1372 | e8f936b0 | Iustin Pop | **deactivate-disks** [-f] [\--submit] {*instance*} |
1373 | 1b7f2c85 | Iustin Pop | |
1374 | 9d0671ba | Iustin Pop | De-activates the block devices of the given instance. Note that if you |
1375 | 9d0671ba | Iustin Pop | run this command for an instance with a drbd disk template, while it |
1376 | 9d0671ba | Iustin Pop | is running, it will not be able to shutdown the block devices on the |
1377 | 9d0671ba | Iustin Pop | primary node, but it will shutdown the block devices on the secondary |
1378 | 9d0671ba | Iustin Pop | nodes, thus breaking the replication. |
1379 | 1b7f2c85 | Iustin Pop | |
1380 | c9c41373 | Iustin Pop | The ``-f``/``--force`` option will skip checks that the instance is |
1381 | c9c41373 | Iustin Pop | down; in case the hypervisor is confused and we can't talk to it, |
1382 | c9c41373 | Iustin Pop | normally Ganeti will refuse to deactivate the disks, but with this |
1383 | c9c41373 | Iustin Pop | option passed it will skip this check and directly try to deactivate |
1384 | c9c41373 | Iustin Pop | the disks. This can still fail due to the instance actually running or |
1385 | c9c41373 | Iustin Pop | other issues. |
1386 | c9c41373 | Iustin Pop | |
1387 | 13ddcb50 | Michael Hanselmann | See **ganeti(7)** for a description of ``--submit`` and other common |
1388 | 13ddcb50 | Michael Hanselmann | options. |
1389 | 1b7f2c85 | Iustin Pop | |
1390 | 1b7f2c85 | Iustin Pop | GROW-DISK |
1391 | 1b7f2c85 | Iustin Pop | ^^^^^^^^^ |
1392 | 1b7f2c85 | Iustin Pop | |
1393 | f5e6a62c | Iustin Pop | | **grow-disk** [\--no-wait-for-sync] [\--submit] [\--absolute] |
1394 | f5e6a62c | Iustin Pop | | {*instance*} {*disk*} {*amount*} |
1395 | 1b7f2c85 | Iustin Pop | |
1396 | 9d0671ba | Iustin Pop | Grows an instance's disk. This is only possible for instances having a |
1397 | 7ed400f0 | Stratos Psomadakis | plain, drbd or rbd disk template. |
1398 | 1b7f2c85 | Iustin Pop | |
1399 | 9d0671ba | Iustin Pop | Note that this command only change the block device size; it will not |
1400 | 9d0671ba | Iustin Pop | grow the actual filesystems, partitions, etc. that live on that |
1401 | 1b7f2c85 | Iustin Pop | disk. Usually, you will need to: |
1402 | 1b7f2c85 | Iustin Pop | |
1403 | 1b7f2c85 | Iustin Pop | #. use **gnt-instance grow-disk** |
1404 | 1b7f2c85 | Iustin Pop | |
1405 | 1b7f2c85 | Iustin Pop | #. reboot the instance (later, at a convenient time) |
1406 | 1b7f2c85 | Iustin Pop | |
1407 | 1b7f2c85 | Iustin Pop | #. use a filesystem resizer, such as ext2online(8) or |
1408 | 1b7f2c85 | Iustin Pop | xfs\_growfs(8) to resize the filesystem, or use fdisk(8) to change |
1409 | 1b7f2c85 | Iustin Pop | the partition table on the disk |
1410 | 1b7f2c85 | Iustin Pop | |
1411 | 1b7f2c85 | Iustin Pop | The *disk* argument is the index of the instance disk to grow. The |
1412 | f5e6a62c | Iustin Pop | *amount* argument is given as a number which can have a suffix (like the |
1413 | f5e6a62c | Iustin Pop | disk size in instance create); if the suffix is missing, the value will |
1414 | f5e6a62c | Iustin Pop | be interpreted as mebibytes. |
1415 | f5e6a62c | Iustin Pop | |
1416 | f5e6a62c | Iustin Pop | By default, the *amount* value represents the desired increase in the |
1417 | f5e6a62c | Iustin Pop | disk size (e.g. an amount of 1G will take a disk of size 3G to 4G). If |
1418 | f5e6a62c | Iustin Pop | the optional ``--absolute`` parameter is passed, then the *amount* |
1419 | f5e6a62c | Iustin Pop | argument doesn't represent the delta, but instead the desired final disk |
1420 | f5e6a62c | Iustin Pop | size (e.g. an amount of 8G will take a disk of size 4G to 8G). |
1421 | 1b7f2c85 | Iustin Pop | |
1422 | 7ed400f0 | Stratos Psomadakis | For instances with a drbd template, note that the disk grow operation |
1423 | 7ed400f0 | Stratos Psomadakis | might complete on one node but fail on the other; this will leave the |
1424 | 7ed400f0 | Stratos Psomadakis | instance with different-sized LVs on the two nodes, but this will not |
1425 | 7ed400f0 | Stratos Psomadakis | create problems (except for unused space). |
1426 | 1b7f2c85 | Iustin Pop | |
1427 | 9d0671ba | Iustin Pop | If you do not want gnt-instance to wait for the new disk region to be |
1428 | 9d0671ba | Iustin Pop | synced, use the ``--no-wait-for-sync`` option. |
1429 | 1b7f2c85 | Iustin Pop | |
1430 | 13ddcb50 | Michael Hanselmann | See **ganeti(7)** for a description of ``--submit`` and other common |
1431 | 13ddcb50 | Michael Hanselmann | options. |
1432 | 1b7f2c85 | Iustin Pop | |
1433 | 1b7f2c85 | Iustin Pop | Example (increase the first disk for instance1 by 16GiB):: |
1434 | 1b7f2c85 | Iustin Pop | |
1435 | 1b7f2c85 | Iustin Pop | # gnt-instance grow-disk instance1.example.com 0 16g |
1436 | 1b7f2c85 | Iustin Pop | |
1437 | f5e6a62c | Iustin Pop | Example for increasing the disk size to a certain size:: |
1438 | f5e6a62c | Iustin Pop | |
1439 | f5e6a62c | Iustin Pop | # gnt-instance grow-disk --absolute instance1.example.com 0 32g |
1440 | 1b7f2c85 | Iustin Pop | |
1441 | 9d0671ba | Iustin Pop | Also note that disk shrinking is not supported; use **gnt-backup |
1442 | 9d0671ba | Iustin Pop | export** and then **gnt-backup import** to reduce the disk size of an |
1443 | 9d0671ba | Iustin Pop | instance. |
1444 | 1b7f2c85 | Iustin Pop | |
1445 | 1b7f2c85 | Iustin Pop | RECREATE-DISKS |
1446 | 1b7f2c85 | Iustin Pop | ^^^^^^^^^^^^^^ |
1447 | 1b7f2c85 | Iustin Pop | |
1448 | 38db4e7c | Adam Ingrassia | | **recreate-disks** [\--submit] |
1449 | 38db4e7c | Adam Ingrassia | | [{-n node1:[node2] \| {-I\|\--iallocator *name*}}] |
1450 | e8f936b0 | Iustin Pop | | [\--disk=*N*[:[size=*VAL*][,mode=*ro\|rw*]]] {*instance*} |
1451 | 1b7f2c85 | Iustin Pop | |
1452 | 735e1318 | Michael Hanselmann | Recreates all or a subset of disks of the given instance. |
1453 | 1b7f2c85 | Iustin Pop | |
1454 | 9d0671ba | Iustin Pop | Note that this functionality should only be used for missing disks; if |
1455 | 9d0671ba | Iustin Pop | any of the given disks already exists, the operation will fail. While |
1456 | 9d0671ba | Iustin Pop | this is suboptimal, recreate-disks should hopefully not be needed in |
1457 | 9d0671ba | Iustin Pop | normal operation and as such the impact of this is low. |
1458 | 1b7f2c85 | Iustin Pop | |
1459 | 735e1318 | Michael Hanselmann | If only a subset should be recreated, any number of ``disk`` options can |
1460 | 735e1318 | Michael Hanselmann | be specified. It expects a disk index and an optional list of disk |
1461 | 735e1318 | Michael Hanselmann | parameters to change. Only ``size`` and ``mode`` can be changed while |
1462 | 735e1318 | Michael Hanselmann | recreating disks. To recreate all disks while changing parameters on |
1463 | 735e1318 | Michael Hanselmann | a subset only, a ``--disk`` option must be given for every disk of the |
1464 | 735e1318 | Michael Hanselmann | instance. |
1465 | 735e1318 | Michael Hanselmann | |
1466 | c8a96ae7 | Iustin Pop | Optionally the instance's disks can be recreated on different |
1467 | c8a96ae7 | Iustin Pop | nodes. This can be useful if, for example, the original nodes of the |
1468 | c8a96ae7 | Iustin Pop | instance have gone down (and are marked offline), so we can't recreate |
1469 | c8a96ae7 | Iustin Pop | on the same nodes. To do this, pass the new node(s) via ``-n`` option, |
1470 | c8a96ae7 | Iustin Pop | with a syntax similar to the **add** command. The number of nodes |
1471 | c8a96ae7 | Iustin Pop | passed must equal the number of nodes that the instance currently |
1472 | 735e1318 | Michael Hanselmann | has. Note that changing nodes is only allowed when all disks are |
1473 | 735e1318 | Michael Hanselmann | replaced, e.g. when no ``--disk`` option is passed. |
1474 | c8a96ae7 | Iustin Pop | |
1475 | 1a770ce5 | Bernardo Dal Seno | Another method of choosing which nodes to place the instance on is by |
1476 | 38db4e7c | Adam Ingrassia | using the specified iallocator, passing the ``--iallocator`` option. |
1477 | 38db4e7c | Adam Ingrassia | The primary and secondary nodes will be chosen by the specified |
1478 | 1a770ce5 | Bernardo Dal Seno | iallocator plugin, or by the default allocator if ``.`` is specified. |
1479 | 38db4e7c | Adam Ingrassia | |
1480 | 13ddcb50 | Michael Hanselmann | See **ganeti(7)** for a description of ``--submit`` and other common |
1481 | 13ddcb50 | Michael Hanselmann | options. |
1482 | 1b7f2c85 | Iustin Pop | |
1483 | 1b7f2c85 | Iustin Pop | Recovery |
1484 | 1b7f2c85 | Iustin Pop | ~~~~~~~~ |
1485 | 1b7f2c85 | Iustin Pop | |
1486 | 1b7f2c85 | Iustin Pop | FAILOVER |
1487 | 1b7f2c85 | Iustin Pop | ^^^^^^^^ |
1488 | 1b7f2c85 | Iustin Pop | |
1489 | e8f936b0 | Iustin Pop | | **failover** [-f] [\--ignore-consistency] [\--ignore-ipolicy] |
1490 | e8f936b0 | Iustin Pop | | [\--shutdown-timeout=*N*] |
1491 | e8f936b0 | Iustin Pop | | [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*] |
1492 | e8f936b0 | Iustin Pop | | [\--submit] |
1493 | 7ed400f0 | Stratos Psomadakis | | {*instance*} |
1494 | 1b7f2c85 | Iustin Pop | |
1495 | a6a3efe4 | Iustin Pop | Failover will stop the instance (if running), change its primary node, |
1496 | a6a3efe4 | Iustin Pop | and if it was originally running it will start it again (on the new |
1497 | a6a3efe4 | Iustin Pop | primary). This only works for instances with drbd template (in which |
1498 | a6a3efe4 | Iustin Pop | case you can only fail to the secondary node) and for externally |
1499 | 7ed400f0 | Stratos Psomadakis | mirrored templates (blockdev and rbd) (which can change to any other |
1500 | a6a3efe4 | Iustin Pop | node). |
1501 | 1b7f2c85 | Iustin Pop | |
1502 | 7ed400f0 | Stratos Psomadakis | If the instance's disk template is of type blockdev or rbd, then you |
1503 | 7ed400f0 | Stratos Psomadakis | can explicitly specify the target node (which can be any node) using |
1504 | 7ed400f0 | Stratos Psomadakis | the ``-n`` or ``--target-node`` option, or specify an iallocator plugin |
1505 | 7ed400f0 | Stratos Psomadakis | using the ``-I`` or ``--iallocator`` option. If you omit both, the default |
1506 | 7ed400f0 | Stratos Psomadakis | iallocator will be used to specify the target node. |
1507 | 7ed400f0 | Stratos Psomadakis | |
1508 | 9d0671ba | Iustin Pop | Normally the failover will check the consistency of the disks before |
1509 | 9d0671ba | Iustin Pop | failing over the instance. If you are trying to migrate instances off |
1510 | 9d0671ba | Iustin Pop | a dead node, this will fail. Use the ``--ignore-consistency`` option |
1511 | 9d0671ba | Iustin Pop | for this purpose. Note that this option can be dangerous as errors in |
1512 | 9d0671ba | Iustin Pop | shutting down the instance will be ignored, resulting in possibly |
1513 | 9d0671ba | Iustin Pop | having the instance running on two machines in parallel (on |
1514 | 9d0671ba | Iustin Pop | disconnected DRBD drives). |
1515 | 1b7f2c85 | Iustin Pop | |
1516 | 1b7f2c85 | Iustin Pop | The ``--shutdown-timeout`` is used to specify how much time to wait |
1517 | 1b7f2c85 | Iustin Pop | before forcing the shutdown (xm destroy in xen, killing the kvm |
1518 | 9d0671ba | Iustin Pop | process, for kvm). By default two minutes are given to each instance |
1519 | 9d0671ba | Iustin Pop | to stop. |
1520 | 1b7f2c85 | Iustin Pop | |
1521 | b6aaf437 | René Nussbaumer | If ``--ignore-ipolicy`` is given any instance policy violations occuring |
1522 | b6aaf437 | René Nussbaumer | during this operation are ignored. |
1523 | b6aaf437 | René Nussbaumer | |
1524 | 13ddcb50 | Michael Hanselmann | See **ganeti(7)** for a description of ``--submit`` and other common |
1525 | 13ddcb50 | Michael Hanselmann | options. |
1526 | 13ddcb50 | Michael Hanselmann | |
1527 | 1b7f2c85 | Iustin Pop | Example:: |
1528 | 1b7f2c85 | Iustin Pop | |
1529 | 1b7f2c85 | Iustin Pop | # gnt-instance failover instance1.example.com |
1530 | 1b7f2c85 | Iustin Pop | |
1531 | 1b7f2c85 | Iustin Pop | |
1532 | 1b7f2c85 | Iustin Pop | MIGRATE |
1533 | 1b7f2c85 | Iustin Pop | ^^^^^^^ |
1534 | 1b7f2c85 | Iustin Pop | |
1535 | f70bb622 | Michael Hanselmann | | **migrate** [-f] [\--allow-failover] [\--non-live] |
1536 | f70bb622 | Michael Hanselmann | | [\--migration-mode=live\|non-live] [\--ignore-ipolicy] |
1537 | f70bb622 | Michael Hanselmann | | [\--no-runtime-changes] [\--submit] |
1538 | f70bb622 | Michael Hanselmann | | [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*] {*instance*} |
1539 | 1b7f2c85 | Iustin Pop | |
1540 | f70bb622 | Michael Hanselmann | | **migrate** [-f] \--cleanup [\--submit] {*instance*} |
1541 | 7ed400f0 | Stratos Psomadakis | |
1542 | 7ed400f0 | Stratos Psomadakis | Migrate will move the instance to its secondary node without shutdown. |
1543 | 7ed400f0 | Stratos Psomadakis | As with failover, it only works for instances having the drbd disk |
1544 | 7ed400f0 | Stratos Psomadakis | template or an externally mirrored disk template type such as blockdev |
1545 | 7ed400f0 | Stratos Psomadakis | or rbd. |
1546 | 7ed400f0 | Stratos Psomadakis | |
1547 | 7ed400f0 | Stratos Psomadakis | If the instance's disk template is of type blockdev or rbd, then you can |
1548 | 7ed400f0 | Stratos Psomadakis | explicitly specify the target node (which can be any node) using the |
1549 | 7ed400f0 | Stratos Psomadakis | ``-n`` or ``--target-node`` option, or specify an iallocator plugin |
1550 | 7ed400f0 | Stratos Psomadakis | using the ``-I`` or ``--iallocator`` option. If you omit both, the |
1551 | 7ed400f0 | Stratos Psomadakis | default iallocator will be used to specify the target node. |
1552 | 1a770ce5 | Bernardo Dal Seno | Alternatively, the default iallocator can be requested by specifying |
1553 | 1a770ce5 | Bernardo Dal Seno | ``.`` as the name of the plugin. |
1554 | 1b7f2c85 | Iustin Pop | |
1555 | 9d0671ba | Iustin Pop | The migration command needs a perfectly healthy instance, as we rely |
1556 | 9d0671ba | Iustin Pop | on the dual-master capability of drbd8 and the disks of the instance |
1557 | 9d0671ba | Iustin Pop | are not allowed to be degraded. |
1558 | 1b7f2c85 | Iustin Pop | |
1559 | 1b7f2c85 | Iustin Pop | The ``--non-live`` and ``--migration-mode=non-live`` options will |
1560 | 1b7f2c85 | Iustin Pop | switch (for the hypervisors that support it) between a "fully live" |
1561 | 9d0671ba | Iustin Pop | (i.e. the interruption is as minimal as possible) migration and one in |
1562 | 9d0671ba | Iustin Pop | which the instance is frozen, its state saved and transported to the |
1563 | 9d0671ba | Iustin Pop | remote node, and then resumed there. This all depends on the |
1564 | 9d0671ba | Iustin Pop | hypervisor support for two different methods. In any case, it is not |
1565 | 9d0671ba | Iustin Pop | an error to pass this parameter (it will just be ignored if the |
1566 | 9d0671ba | Iustin Pop | hypervisor doesn't support it). The option ``--migration-mode=live`` |
1567 | 9d0671ba | Iustin Pop | option will request a fully-live migration. The default, when neither |
1568 | 9d0671ba | Iustin Pop | option is passed, depends on the hypervisor parameters (and can be |
1569 | 9d0671ba | Iustin Pop | viewed with the **gnt-cluster info** command). |
1570 | 1b7f2c85 | Iustin Pop | |
1571 | 1b7f2c85 | Iustin Pop | If the ``--cleanup`` option is passed, the operation changes from |
1572 | 9d0671ba | Iustin Pop | migration to attempting recovery from a failed previous migration. In |
1573 | 9d0671ba | Iustin Pop | this mode, Ganeti checks if the instance runs on the correct node (and |
1574 | 50c1e351 | Bernardo Dal Seno | updates its configuration if not) and ensures the instances' disks |
1575 | 9d0671ba | Iustin Pop | are configured correctly. In this mode, the ``--non-live`` option is |
1576 | 9d0671ba | Iustin Pop | ignored. |
1577 | 1b7f2c85 | Iustin Pop | |
1578 | 1b7f2c85 | Iustin Pop | The option ``-f`` will skip the prompting for confirmation. |
1579 | 1b7f2c85 | Iustin Pop | |
1580 | e9c487be | René Nussbaumer | If ``--allow-failover`` is specified it tries to fallback to failover if |
1581 | 11dc66f3 | Bernardo Dal Seno | it already can determine that a migration won't work (e.g. if the |
1582 | 1cdc9dbb | Bernardo Dal Seno | instance is shut down). Please note that the fallback will not happen |
1583 | e9c487be | René Nussbaumer | during execution. If a migration fails during execution it still fails. |
1584 | e9c487be | René Nussbaumer | |
1585 | 3ed23330 | René Nussbaumer | If ``--ignore-ipolicy`` is given any instance policy violations occuring |
1586 | 3ed23330 | René Nussbaumer | during this operation are ignored. |
1587 | 3ed23330 | René Nussbaumer | |
1588 | 8c0b16f6 | Guido Trotter | The ``--no-runtime-changes`` option forbids migrate to alter an |
1589 | 8c0b16f6 | Guido Trotter | instance's runtime before migrating it (eg. ballooning an instance |
1590 | 8c0b16f6 | Guido Trotter | down because the target node doesn't have enough available memory). |
1591 | 8c0b16f6 | Guido Trotter | |
1592 | b5f0b5cc | Bernardo Dal Seno | If an instance has the backend parameter ``always\_failover`` set to |
1593 | b5f0b5cc | Bernardo Dal Seno | true, then the migration is automatically converted into a failover. |
1594 | b5f0b5cc | Bernardo Dal Seno | |
1595 | f70bb622 | Michael Hanselmann | See **ganeti(7)** for a description of ``--submit`` and other common |
1596 | f70bb622 | Michael Hanselmann | options. |
1597 | f70bb622 | Michael Hanselmann | |
1598 | 1b7f2c85 | Iustin Pop | Example (and expected output):: |
1599 | 1b7f2c85 | Iustin Pop | |
1600 | 1b7f2c85 | Iustin Pop | # gnt-instance migrate instance1 |
1601 | 1cdc9dbb | Bernardo Dal Seno | Instance instance1 will be migrated. Note that migration |
1602 | 1cdc9dbb | Bernardo Dal Seno | might impact the instance if anything goes wrong (e.g. due to bugs in |
1603 | 1cdc9dbb | Bernardo Dal Seno | the hypervisor). Continue? |
1604 | 1b7f2c85 | Iustin Pop | y/[n]/?: y |
1605 | 1cdc9dbb | Bernardo Dal Seno | Migrating instance instance1.example.com |
1606 | 1b7f2c85 | Iustin Pop | * checking disk consistency between source and target |
1607 | 1cdc9dbb | Bernardo Dal Seno | * switching node node2.example.com to secondary mode |
1608 | 1cdc9dbb | Bernardo Dal Seno | * changing into standalone mode |
1609 | 1b7f2c85 | Iustin Pop | * changing disks into dual-master mode |
1610 | 1cdc9dbb | Bernardo Dal Seno | * wait until resync is done |
1611 | 1cdc9dbb | Bernardo Dal Seno | * preparing node2.example.com to accept the instance |
1612 | 1b7f2c85 | Iustin Pop | * migrating instance to node2.example.com |
1613 | 1cdc9dbb | Bernardo Dal Seno | * switching node node1.example.com to secondary mode |
1614 | 1cdc9dbb | Bernardo Dal Seno | * wait until resync is done |
1615 | 1cdc9dbb | Bernardo Dal Seno | * changing into standalone mode |
1616 | 1cdc9dbb | Bernardo Dal Seno | * changing disks into single-master mode |
1617 | 1cdc9dbb | Bernardo Dal Seno | * wait until resync is done |
1618 | 1cdc9dbb | Bernardo Dal Seno | * done |
1619 | 1b7f2c85 | Iustin Pop | # |
1620 | 1b7f2c85 | Iustin Pop | |
1621 | 1b7f2c85 | Iustin Pop | |
1622 | 1b7f2c85 | Iustin Pop | MOVE |
1623 | 1b7f2c85 | Iustin Pop | ^^^^ |
1624 | 1b7f2c85 | Iustin Pop | |
1625 | 13ddcb50 | Michael Hanselmann | | **move** [-f] [\--ignore-consistency] |
1626 | 13ddcb50 | Michael Hanselmann | | [-n *node*] [\--shutdown-timeout=*N*] [\--submit] [\--ignore-ipolicy] |
1627 | 13ddcb50 | Michael Hanselmann | | {*instance*} |
1628 | 1b7f2c85 | Iustin Pop | |
1629 | 9d0671ba | Iustin Pop | Move will move the instance to an arbitrary node in the cluster. This |
1630 | 9d0671ba | Iustin Pop | works only for instances having a plain or file disk template. |
1631 | 1b7f2c85 | Iustin Pop | |
1632 | 9d0671ba | Iustin Pop | Note that since this operation is done via data copy, it will take a |
1633 | 9d0671ba | Iustin Pop | long time for big disks (similar to replace-disks for a drbd |
1634 | 1b7f2c85 | Iustin Pop | instance). |
1635 | 1b7f2c85 | Iustin Pop | |
1636 | 1b7f2c85 | Iustin Pop | The ``--shutdown-timeout`` is used to specify how much time to wait |
1637 | 1b7f2c85 | Iustin Pop | before forcing the shutdown (e.g. ``xm destroy`` in XEN, killing the |
1638 | 1b7f2c85 | Iustin Pop | kvm process for KVM, etc.). By default two minutes are given to each |
1639 | 1b7f2c85 | Iustin Pop | instance to stop. |
1640 | 1b7f2c85 | Iustin Pop | |
1641 | bb851c63 | Iustin Pop | The ``--ignore-consistency`` option will make Ganeti ignore any errors |
1642 | bb851c63 | Iustin Pop | in trying to shutdown the instance on its node; useful if the |
1643 | bb851c63 | Iustin Pop | hypervisor is broken and you want to recuperate the data. |
1644 | bb851c63 | Iustin Pop | |
1645 | 92cf62e3 | René Nussbaumer | If ``--ignore-ipolicy`` is given any instance policy violations occuring |
1646 | 92cf62e3 | René Nussbaumer | during this operation are ignored. |
1647 | 92cf62e3 | René Nussbaumer | |
1648 | 13ddcb50 | Michael Hanselmann | See **ganeti(7)** for a description of ``--submit`` and other common |
1649 | 13ddcb50 | Michael Hanselmann | options. |
1650 | 13ddcb50 | Michael Hanselmann | |
1651 | 1b7f2c85 | Iustin Pop | Example:: |
1652 | 1b7f2c85 | Iustin Pop | |
1653 | 1b7f2c85 | Iustin Pop | # gnt-instance move -n node3.example.com instance1.example.com |
1654 | 1b7f2c85 | Iustin Pop | |
1655 | 1b7f2c85 | Iustin Pop | |
1656 | bd2a5569 | Michael Hanselmann | CHANGE-GROUP |
1657 | bd2a5569 | Michael Hanselmann | ~~~~~~~~~~~~ |
1658 | bd2a5569 | Michael Hanselmann | |
1659 | f70bb622 | Michael Hanselmann | | **change-group** [\--submit] |
1660 | f70bb622 | Michael Hanselmann | | [\--iallocator *NAME*] [\--to *GROUP*...] {*instance*} |
1661 | bd2a5569 | Michael Hanselmann | |
1662 | bd2a5569 | Michael Hanselmann | This command moves an instance to another node group. The move is |
1663 | bd2a5569 | Michael Hanselmann | calculated by an iallocator, either given on the command line or as a |
1664 | bd2a5569 | Michael Hanselmann | cluster default. |
1665 | bd2a5569 | Michael Hanselmann | |
1666 | bd2a5569 | Michael Hanselmann | If no specific destination groups are specified using ``--to``, all |
1667 | bd2a5569 | Michael Hanselmann | groups except the one containing the instance are considered. |
1668 | bd2a5569 | Michael Hanselmann | |
1669 | f70bb622 | Michael Hanselmann | See **ganeti(7)** for a description of ``--submit`` and other common |
1670 | f70bb622 | Michael Hanselmann | options. |
1671 | f70bb622 | Michael Hanselmann | |
1672 | bd2a5569 | Michael Hanselmann | Example:: |
1673 | bd2a5569 | Michael Hanselmann | |
1674 | bd2a5569 | Michael Hanselmann | # gnt-instance change-group -I hail --to rack2 inst1.example.com |
1675 | bd2a5569 | Michael Hanselmann | |
1676 | bd2a5569 | Michael Hanselmann | |
1677 | 1b7f2c85 | Iustin Pop | TAGS |
1678 | 1b7f2c85 | Iustin Pop | ~~~~ |
1679 | 1b7f2c85 | Iustin Pop | |
1680 | 1b7f2c85 | Iustin Pop | ADD-TAGS |
1681 | 1b7f2c85 | Iustin Pop | ^^^^^^^^ |
1682 | 1b7f2c85 | Iustin Pop | |
1683 | e8f936b0 | Iustin Pop | **add-tags** [\--from *file*] {*instancename*} {*tag*...} |
1684 | 1b7f2c85 | Iustin Pop | |
1685 | 1b7f2c85 | Iustin Pop | Add tags to the given instance. If any of the tags contains invalid |
1686 | 1b7f2c85 | Iustin Pop | characters, the entire operation will abort. |
1687 | 1b7f2c85 | Iustin Pop | |
1688 | 9d0671ba | Iustin Pop | If the ``--from`` option is given, the list of tags will be extended |
1689 | 9d0671ba | Iustin Pop | with the contents of that file (each line becomes a tag). In this |
1690 | 9d0671ba | Iustin Pop | case, there is not need to pass tags on the command line (if you do, |
1691 | 9d0671ba | Iustin Pop | both sources will be used). A file name of ``-`` will be interpreted |
1692 | 9d0671ba | Iustin Pop | as stdin. |
1693 | 1b7f2c85 | Iustin Pop | |
1694 | 1b7f2c85 | Iustin Pop | LIST-TAGS |
1695 | 1b7f2c85 | Iustin Pop | ^^^^^^^^^ |
1696 | 1b7f2c85 | Iustin Pop | |
1697 | 1b7f2c85 | Iustin Pop | **list-tags** {*instancename*} |
1698 | 1b7f2c85 | Iustin Pop | |
1699 | 1b7f2c85 | Iustin Pop | List the tags of the given instance. |
1700 | 1b7f2c85 | Iustin Pop | |
1701 | 1b7f2c85 | Iustin Pop | REMOVE-TAGS |
1702 | 1b7f2c85 | Iustin Pop | ^^^^^^^^^^^ |
1703 | 1b7f2c85 | Iustin Pop | |
1704 | e8f936b0 | Iustin Pop | **remove-tags** [\--from *file*] {*instancename*} {*tag*...} |
1705 | 1b7f2c85 | Iustin Pop | |
1706 | 1b7f2c85 | Iustin Pop | Remove tags from the given instance. If any of the tags are not |
1707 | 1b7f2c85 | Iustin Pop | existing on the node, the entire operation will abort. |
1708 | 1b7f2c85 | Iustin Pop | |
1709 | 1b7f2c85 | Iustin Pop | If the ``--from`` option is given, the list of tags to be removed will |
1710 | 1b7f2c85 | Iustin Pop | be extended with the contents of that file (each line becomes a tag). |
1711 | 1b7f2c85 | Iustin Pop | In this case, there is not need to pass tags on the command line (if |
1712 | b5a418aa | Michael Hanselmann | you do, tags from both sources will be removed). A file name of ``-`` |
1713 | b5a418aa | Michael Hanselmann | will be interpreted as stdin. |
1714 | a84d1115 | René Nussbaumer | |
1715 | a84d1115 | René Nussbaumer | .. vim: set textwidth=72 : |
1716 | 9ff4f2c0 | Michael Hanselmann | .. Local Variables: |
1717 | 9ff4f2c0 | Michael Hanselmann | .. mode: rst |
1718 | 9ff4f2c0 | Michael Hanselmann | .. fill-column: 72 |
1719 | 9ff4f2c0 | Michael Hanselmann | .. End: |