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