root / man / gnt-instance.sgml @ 7ba594c0
History | View | Annotate | Download (91.2 kB)
1 | a8083063 | Iustin Pop | <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ |
---|---|---|---|
2 | a8083063 | Iustin Pop | |
3 | a8083063 | Iustin Pop | <!-- Fill in your name for FIRSTNAME and SURNAME. --> |
4 | a8083063 | Iustin Pop | <!-- Please adjust the date whenever revising the manpage. --> |
5 | c7c568b4 | René Nussbaumer | <!ENTITY dhdate "<date>January 22, 2010</date>"> |
6 | a8083063 | Iustin Pop | <!-- SECTION should be 1-8, maybe w/ subsection other parameters are |
7 | a8083063 | Iustin Pop | allowed: see man(7), man(1). --> |
8 | a8083063 | Iustin Pop | <!ENTITY dhsection "<manvolnum>8</manvolnum>"> |
9 | a8083063 | Iustin Pop | <!ENTITY dhucpackage "<refentrytitle>gnt-instance</refentrytitle>"> |
10 | a8083063 | Iustin Pop | <!ENTITY dhpackage "gnt-instance"> |
11 | a8083063 | Iustin Pop | |
12 | a8083063 | Iustin Pop | <!ENTITY debian "<productname>Debian</productname>"> |
13 | a8083063 | Iustin Pop | <!ENTITY gnu "<acronym>GNU</acronym>"> |
14 | a8083063 | Iustin Pop | <!ENTITY gpl "&gnu; <acronym>GPL</acronym>"> |
15 | a8083063 | Iustin Pop | <!ENTITY footer SYSTEM "footer.sgml"> |
16 | a8083063 | Iustin Pop | ]> |
17 | a8083063 | Iustin Pop | |
18 | a8083063 | Iustin Pop | <refentry> |
19 | a8083063 | Iustin Pop | <refentryinfo> |
20 | a8083063 | Iustin Pop | <copyright> |
21 | a8083063 | Iustin Pop | <year>2006</year> |
22 | a8083063 | Iustin Pop | <year>2007</year> |
23 | a53a1b18 | Michael Hanselmann | <year>2008</year> |
24 | d3b4cf9f | Iustin Pop | <year>2009</year> |
25 | c7c568b4 | René Nussbaumer | <year>2010</year> |
26 | a8083063 | Iustin Pop | <holder>Google Inc.</holder> |
27 | a8083063 | Iustin Pop | </copyright> |
28 | a8083063 | Iustin Pop | &dhdate; |
29 | a8083063 | Iustin Pop | </refentryinfo> |
30 | a8083063 | Iustin Pop | <refmeta> |
31 | a8083063 | Iustin Pop | &dhucpackage; |
32 | a8083063 | Iustin Pop | |
33 | a8083063 | Iustin Pop | &dhsection; |
34 | d3b4cf9f | Iustin Pop | <refmiscinfo>ganeti 2.0</refmiscinfo> |
35 | a8083063 | Iustin Pop | </refmeta> |
36 | a8083063 | Iustin Pop | <refnamediv> |
37 | a8083063 | Iustin Pop | <refname>&dhpackage;</refname> |
38 | a8083063 | Iustin Pop | |
39 | a8083063 | Iustin Pop | <refpurpose>ganeti instance administration</refpurpose> |
40 | a8083063 | Iustin Pop | </refnamediv> |
41 | a8083063 | Iustin Pop | <refsynopsisdiv> |
42 | a8083063 | Iustin Pop | <cmdsynopsis> |
43 | a8083063 | Iustin Pop | <command>&dhpackage; </command> |
44 | a8083063 | Iustin Pop | |
45 | a8083063 | Iustin Pop | <arg choice="req">command</arg> |
46 | a8083063 | Iustin Pop | <arg>arguments...</arg> |
47 | a8083063 | Iustin Pop | </cmdsynopsis> |
48 | a8083063 | Iustin Pop | </refsynopsisdiv> |
49 | a8083063 | Iustin Pop | <refsect1> |
50 | a8083063 | Iustin Pop | <title>DESCRIPTION</title> |
51 | a8083063 | Iustin Pop | |
52 | a8083063 | Iustin Pop | <para> |
53 | a8083063 | Iustin Pop | The <command>&dhpackage;</command> is used for instance |
54 | a8083063 | Iustin Pop | administration in the ganeti system. |
55 | a8083063 | Iustin Pop | </para> |
56 | a8083063 | Iustin Pop | |
57 | a8083063 | Iustin Pop | </refsect1> |
58 | a8083063 | Iustin Pop | <refsect1> |
59 | a8083063 | Iustin Pop | <title>COMMANDS</title> |
60 | a8083063 | Iustin Pop | |
61 | a8083063 | Iustin Pop | <refsect2> |
62 | a8083063 | Iustin Pop | <title>Creation/removal/querying</title> |
63 | a8083063 | Iustin Pop | |
64 | a8083063 | Iustin Pop | <refsect3> |
65 | a8083063 | Iustin Pop | <title>ADD</title> |
66 | a8083063 | Iustin Pop | <cmdsynopsis> |
67 | a8083063 | Iustin Pop | <command>add</command> |
68 | b9ac33e9 | Iustin Pop | <sbr> |
69 | c0e4a2c3 | Iustin Pop | <arg choice="req">-t<group choice="req"> |
70 | c0e4a2c3 | Iustin Pop | <arg>diskless</arg> |
71 | c0e4a2c3 | Iustin Pop | <arg>file</arg> |
72 | c0e4a2c3 | Iustin Pop | <arg>plain</arg> |
73 | c0e4a2c3 | Iustin Pop | <arg>drbd</arg> |
74 | c0e4a2c3 | Iustin Pop | </group></arg> |
75 | c0e4a2c3 | Iustin Pop | <sbr> |
76 | c0e4a2c3 | Iustin Pop | |
77 | c0e4a2c3 | Iustin Pop | <group choice="req"> |
78 | 17227cd1 | Iustin Pop | <arg rep="repeat">--disk=<replaceable>N</replaceable>:<group choice="req"> |
79 | 17227cd1 | Iustin Pop | <arg>size=<replaceable>VAL</replaceable></arg> |
80 | 17227cd1 | Iustin Pop | <arg>adopt=<replaceable>LV</replaceable></arg> |
81 | 17227cd1 | Iustin Pop | </group>,mode=<replaceable>ro|rw</replaceable></arg> |
82 | c0e4a2c3 | Iustin Pop | <arg>-s <replaceable>SIZE</replaceable></arg> |
83 | c0e4a2c3 | Iustin Pop | </group> |
84 | 783583e9 | Michael Hanselmann | <sbr> |
85 | 1d65264b | Iustin Pop | <arg>--no-ip-check</arg> |
86 | 1d65264b | Iustin Pop | <arg>--no-name-check</arg> |
87 | 1d65264b | Iustin Pop | <arg>--no-start</arg> |
88 | 25a8792c | Iustin Pop | <arg>--no-install</arg> |
89 | 1d65264b | Iustin Pop | <sbr> |
90 | d3b4cf9f | Iustin Pop | <group> |
91 | d3b4cf9f | Iustin Pop | <arg rep="repeat">--net=<replaceable>N</replaceable><arg rep="repeat">:options</arg></arg> |
92 | d3b4cf9f | Iustin Pop | <arg>--no-nics</arg> |
93 | d3b4cf9f | Iustin Pop | </group> |
94 | a8083063 | Iustin Pop | <sbr> |
95 | d3b4cf9f | Iustin Pop | <arg>-B <replaceable>BEPARAMS</replaceable></arg> |
96 | 00f98619 | Iustin Pop | <sbr> |
97 | bdb7d4e8 | Michael Hanselmann | |
98 | d3b4cf9f | Iustin Pop | <arg>-H <replaceable>HYPERVISOR</replaceable><arg>:<arg choice="plain" rep="repeat">option=<replaceable>value</replaceable></arg></arg></arg> |
99 | 00f98619 | Iustin Pop | <sbr> |
100 | bdb7d4e8 | Michael Hanselmann | |
101 | 495beb42 | Manuel Franceschini | <arg>--file-storage-dir <replaceable>dir_path</replaceable></arg> |
102 | bdb7d4e8 | Michael Hanselmann | <arg>--file-driver<group choice="req"> |
103 | 495beb42 | Manuel Franceschini | <arg>loop</arg> |
104 | 495beb42 | Manuel Franceschini | <arg>blktap</arg> |
105 | 495beb42 | Manuel Franceschini | </group></arg> |
106 | 495beb42 | Manuel Franceschini | <sbr> |
107 | bdb7d4e8 | Michael Hanselmann | |
108 | a53a1b18 | Michael Hanselmann | <group choice="req"> |
109 | a53a1b18 | Michael Hanselmann | <arg>-n <replaceable>node<optional>:secondary-node</optional></replaceable></arg> |
110 | a53a1b18 | Michael Hanselmann | <arg>--iallocator <replaceable>name</replaceable></arg> |
111 | a53a1b18 | Michael Hanselmann | </group> |
112 | a53a1b18 | Michael Hanselmann | <sbr> |
113 | a53a1b18 | Michael Hanselmann | |
114 | bdb7d4e8 | Michael Hanselmann | <arg choice="req">-o <replaceable>os-type</replaceable></arg> |
115 | bdb7d4e8 | Michael Hanselmann | <sbr> |
116 | d3b4cf9f | Iustin Pop | <arg>--submit</arg> |
117 | d3b4cf9f | Iustin Pop | <sbr> |
118 | bdb7d4e8 | Michael Hanselmann | |
119 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
120 | a8083063 | Iustin Pop | </cmdsynopsis> |
121 | 00f98619 | Iustin Pop | |
122 | a8083063 | Iustin Pop | <para> |
123 | d3b4cf9f | Iustin Pop | Creates a new instance on the specified host. The |
124 | d3b4cf9f | Iustin Pop | <replaceable>instance</replaceable> argument must be in DNS, |
125 | 7d713344 | Guido Trotter | but depending on the bridge/routing setup, need not be in |
126 | 7d713344 | Guido Trotter | the same network as the nodes in the cluster. |
127 | a8083063 | Iustin Pop | </para> |
128 | a8083063 | Iustin Pop | |
129 | a8083063 | Iustin Pop | <para> |
130 | d3b4cf9f | Iustin Pop | The <option>disk</option> option specifies the parameters |
131 | d3b4cf9f | Iustin Pop | for the disks of the instance. The numbering of disks starts |
132 | d3b4cf9f | Iustin Pop | at zero, and at least one disk needs to be passed. For each |
133 | 17227cd1 | Iustin Pop | disk, either the size or the adoption source needs to be |
134 | 17227cd1 | Iustin Pop | given, and optionally the access mode (read-only or the |
135 | 17227cd1 | Iustin Pop | default of read-write) can also be specified. The size is |
136 | 17227cd1 | Iustin Pop | interpreted (when no unit is given) in mebibytes. You can |
137 | 17227cd1 | Iustin Pop | also use one of the suffixes |
138 | d3b4cf9f | Iustin Pop | <literal>m</literal>, <literal>g</literal> or |
139 | b9ac33e9 | Iustin Pop | <literal>t</literal> to specificy the exact the units used; |
140 | b9ac33e9 | Iustin Pop | these suffixes map to mebibytes, gibibytes and tebibytes. |
141 | a8083063 | Iustin Pop | </para> |
142 | a8083063 | Iustin Pop | |
143 | a8083063 | Iustin Pop | <para> |
144 | 17227cd1 | Iustin Pop | When using the <option>adopt</option> key in the disk |
145 | 17227cd1 | Iustin Pop | definition, Ganeti will reuse those volumes (instead of |
146 | 17227cd1 | Iustin Pop | creating new ones) as the instance's disks. Ganeti will |
147 | 17227cd1 | Iustin Pop | rename these volumes to the standard format, and (without |
148 | 17227cd1 | Iustin Pop | installing the OS) will use them as-is for the |
149 | 17227cd1 | Iustin Pop | instance. This allows migrating instances from non-managed |
150 | 17227cd1 | Iustin Pop | mode (e.q. plain KVM with LVM) to being managed via |
151 | 17227cd1 | Iustin Pop | Ganeti. Note that this works only for the `plain' disk |
152 | 17227cd1 | Iustin Pop | template (see below for template details). |
153 | 17227cd1 | Iustin Pop | </para> |
154 | 17227cd1 | Iustin Pop | |
155 | 17227cd1 | Iustin Pop | <para> |
156 | c0e4a2c3 | Iustin Pop | Alternatively, a single-disk instance can be created via the |
157 | c0e4a2c3 | Iustin Pop | <option>-s</option> option which takes a single argument, |
158 | c0e4a2c3 | Iustin Pop | the size of the disk. This is similar to the Ganeti 1.2 |
159 | c0e4a2c3 | Iustin Pop | version (but will only create one disk). |
160 | c0e4a2c3 | Iustin Pop | </para> |
161 | c0e4a2c3 | Iustin Pop | |
162 | c0e4a2c3 | Iustin Pop | <para> |
163 | d3b4cf9f | Iustin Pop | The minimum disk specification is therefore |
164 | c0e4a2c3 | Iustin Pop | <userinput>--disk 0:size=20G</userinput> (or <userinput>-s |
165 | c0e4a2c3 | Iustin Pop | 20G</userinput> when using the <option>-s</option> option), |
166 | c0e4a2c3 | Iustin Pop | and a three-disk instance can be specified as |
167 | c0e4a2c3 | Iustin Pop | <userinput>--disk 0:size=20G --disk 1:size=4G --disk |
168 | c0e4a2c3 | Iustin Pop | 2:size=100G</userinput>. |
169 | a8083063 | Iustin Pop | </para> |
170 | a8083063 | Iustin Pop | |
171 | a8083063 | Iustin Pop | <para> |
172 | 1d65264b | Iustin Pop | The <option>--no-ip-check</option> skips the checks that are |
173 | 1d65264b | Iustin Pop | done to see if the instance's IP is not already alive |
174 | 1d65264b | Iustin Pop | (i.e. reachable from the master node). |
175 | 1d65264b | Iustin Pop | </para> |
176 | 1d65264b | Iustin Pop | |
177 | 1d65264b | Iustin Pop | <para> |
178 | 1d65264b | Iustin Pop | The <option>--no-name-check</option> skips the check for the |
179 | 1d65264b | Iustin Pop | instance name via the resolver (e.g. in DNS or /etc/hosts, |
180 | 1d65264b | Iustin Pop | depending on your setup). Since the name check is used to |
181 | 1d65264b | Iustin Pop | compute the IP address, if you pass this option you must |
182 | 1d65264b | Iustin Pop | also pass the <option>--no-ip-check</option> option. |
183 | 1d65264b | Iustin Pop | </para> |
184 | 1d65264b | Iustin Pop | |
185 | 1d65264b | Iustin Pop | <para> |
186 | 1d65264b | Iustin Pop | If you don't wat the instance to automatically start after |
187 | 1d65264b | Iustin Pop | creation, this is possible via the |
188 | 1d65264b | Iustin Pop | <option>--no-start</option> option. This will leave the |
189 | 1d65264b | Iustin Pop | instance down until a subsequent <command>gnt-instance |
190 | 1d65264b | Iustin Pop | start</command> command. |
191 | 1d65264b | Iustin Pop | </para> |
192 | 1d65264b | Iustin Pop | |
193 | 1d65264b | Iustin Pop | <para> |
194 | d3b4cf9f | Iustin Pop | The NICs of the instances can be specified via the |
195 | 091c2c64 | Guido Trotter | <option>--net</option> option. By default, one NIC is |
196 | 7d713344 | Guido Trotter | created for the instance, with a random MAC, and set |
197 | 7d713344 | Guido Trotter | up according the the cluster level nic parameters. |
198 | 7d713344 | Guido Trotter | Each NIC can take these parameters (all optional): |
199 | d3b4cf9f | Iustin Pop | <variablelist> |
200 | d3b4cf9f | Iustin Pop | <varlistentry> |
201 | d3b4cf9f | Iustin Pop | <term>mac</term> |
202 | d3b4cf9f | Iustin Pop | <listitem> |
203 | d3b4cf9f | Iustin Pop | <simpara>either a value or <constant>GENERATE</constant> |
204 | d3b4cf9f | Iustin Pop | to generate a new unique MAC</simpara> |
205 | d3b4cf9f | Iustin Pop | </listitem> |
206 | d3b4cf9f | Iustin Pop | </varlistentry> |
207 | d3b4cf9f | Iustin Pop | <varlistentry> |
208 | d3b4cf9f | Iustin Pop | <term>ip</term> |
209 | d3b4cf9f | Iustin Pop | <listitem> |
210 | d3b4cf9f | Iustin Pop | <simpara>specifies the IP address assigned to the |
211 | d3b4cf9f | Iustin Pop | instance from the Ganeti side (this is not necessarily |
212 | d3b4cf9f | Iustin Pop | what the instance will use, but what the node expects |
213 | d3b4cf9f | Iustin Pop | the instance to use)</simpara> |
214 | d3b4cf9f | Iustin Pop | </listitem> |
215 | d3b4cf9f | Iustin Pop | </varlistentry> |
216 | d3b4cf9f | Iustin Pop | <varlistentry> |
217 | 7d713344 | Guido Trotter | <term>mode</term> |
218 | d3b4cf9f | Iustin Pop | <listitem> |
219 | 7d713344 | Guido Trotter | <simpara>specifies the connection mode for this nic: |
220 | 7d713344 | Guido Trotter | routed or bridged.</simpara> |
221 | 7d713344 | Guido Trotter | </listitem> |
222 | 7d713344 | Guido Trotter | </varlistentry> |
223 | 7d713344 | Guido Trotter | <varlistentry> |
224 | 7d713344 | Guido Trotter | <term>link</term> |
225 | 7d713344 | Guido Trotter | <listitem> |
226 | 7d713344 | Guido Trotter | <simpara>in bridged mode specifies the bridge to attach |
227 | 7d713344 | Guido Trotter | this NIC to, in routed mode it's intended to |
228 | 7d713344 | Guido Trotter | differentiate between different routing tables/instance |
229 | 7d713344 | Guido Trotter | groups (but the meaning is dependent on the network |
230 | 8063787e | Guido Trotter | script, see gnt-cluster(8) for more details)</simpara> |
231 | d3b4cf9f | Iustin Pop | </listitem> |
232 | d3b4cf9f | Iustin Pop | </varlistentry> |
233 | d3b4cf9f | Iustin Pop | </variablelist> |
234 | 7d713344 | Guido Trotter | Of these "mode" and "link" are nic parameters, and inherit their |
235 | 7d713344 | Guido Trotter | default at cluster level. |
236 | b9ac33e9 | Iustin Pop | </para> |
237 | b9ac33e9 | Iustin Pop | |
238 | b9ac33e9 | Iustin Pop | <para> |
239 | d3b4cf9f | Iustin Pop | Alternatively, if no network is desired for the instance, you |
240 | d3b4cf9f | Iustin Pop | can prevent the default of one NIC with the |
241 | d3b4cf9f | Iustin Pop | <option>--no-nics</option> option. |
242 | a8083063 | Iustin Pop | </para> |
243 | a8083063 | Iustin Pop | |
244 | a8083063 | Iustin Pop | <para> |
245 | d3b4cf9f | Iustin Pop | The <option>-o</option> options specifies the operating |
246 | d3b4cf9f | Iustin Pop | system to be installed. The available operating systems can |
247 | 25a8792c | Iustin Pop | be listed with <command>gnt-os |
248 | 25a8792c | Iustin Pop | list</command>. Passing <option>--no-install</option> will |
249 | 25a8792c | Iustin Pop | however skip the OS installation, allowing a manual import |
250 | 25a8792c | Iustin Pop | if so desired. Note that the no-installation mode will |
251 | 25a8792c | Iustin Pop | automatically disable the start-up of the instance (without |
252 | 25a8792c | Iustin Pop | an OS, it most likely won't be able to start-up |
253 | 25a8792c | Iustin Pop | successfully). |
254 | a8083063 | Iustin Pop | </para> |
255 | a8083063 | Iustin Pop | |
256 | a8083063 | Iustin Pop | <para> |
257 | d3b4cf9f | Iustin Pop | The <option>-B</option> option specifies the backend |
258 | d3b4cf9f | Iustin Pop | parameters for the instance. If no such parameters are |
259 | d3b4cf9f | Iustin Pop | specified, the values are inherited from the cluster. Possible |
260 | d3b4cf9f | Iustin Pop | parameters are: |
261 | d3b4cf9f | Iustin Pop | <variablelist> |
262 | d3b4cf9f | Iustin Pop | <varlistentry> |
263 | d3b4cf9f | Iustin Pop | <term>memory</term> |
264 | d3b4cf9f | Iustin Pop | <listitem> |
265 | d3b4cf9f | Iustin Pop | <simpara>the memory size of the instance; as usual, |
266 | d3b4cf9f | Iustin Pop | suffixes can be used to denote the unit, otherwise the |
267 | d3b4cf9f | Iustin Pop | value is taken in mebibites</simpara> |
268 | d3b4cf9f | Iustin Pop | </listitem> |
269 | d3b4cf9f | Iustin Pop | </varlistentry> |
270 | d3b4cf9f | Iustin Pop | <varlistentry> |
271 | d3b4cf9f | Iustin Pop | <term>vcpus</term> |
272 | d3b4cf9f | Iustin Pop | <listitem> |
273 | d3b4cf9f | Iustin Pop | <simpara>the number of VCPUs to assign to the instance |
274 | d3b4cf9f | Iustin Pop | (if this value makes sense for the hypervisor)</simpara> |
275 | d3b4cf9f | Iustin Pop | </listitem> |
276 | d3b4cf9f | Iustin Pop | </varlistentry> |
277 | d3b4cf9f | Iustin Pop | <varlistentry> |
278 | d3b4cf9f | Iustin Pop | <term>auto_balance</term> |
279 | d3b4cf9f | Iustin Pop | <listitem> |
280 | d3b4cf9f | Iustin Pop | <simpara>whether the instance is considered in the N+1 |
281 | d3b4cf9f | Iustin Pop | cluster checks (enough redundancy in the cluster to |
282 | d3b4cf9f | Iustin Pop | survive a node failure)</simpara> |
283 | d3b4cf9f | Iustin Pop | </listitem> |
284 | d3b4cf9f | Iustin Pop | </varlistentry> |
285 | d3b4cf9f | Iustin Pop | </variablelist> |
286 | f3a55c90 | Alexander Schreiber | </para> |
287 | f3a55c90 | Alexander Schreiber | |
288 | f3a55c90 | Alexander Schreiber | <para> |
289 | d3b4cf9f | Iustin Pop | The <option>-H</option> option specified the hypervisor to |
290 | d3b4cf9f | Iustin Pop | use for the instance (must be one of the enabled hypervisors |
291 | d3b4cf9f | Iustin Pop | on the cluster) and optionally custom parameters for this |
292 | d3b4cf9f | Iustin Pop | instance. If not other options are used (i.e. the invocation |
293 | d3b4cf9f | Iustin Pop | is just <userinput>-H |
294 | d3b4cf9f | Iustin Pop | <replaceable>NAME</replaceable></userinput>) the instance |
295 | d3b4cf9f | Iustin Pop | will inherit the cluster options. The defaults below show |
296 | d3b4cf9f | Iustin Pop | the cluster defaults at cluster creation time. |
297 | 25c5878d | Alexander Schreiber | </para> |
298 | 25c5878d | Alexander Schreiber | |
299 | 25c5878d | Alexander Schreiber | <para> |
300 | d3b4cf9f | Iustin Pop | The possible hypervisor options are as follows: |
301 | 25c5878d | Alexander Schreiber | <variablelist> |
302 | 25c5878d | Alexander Schreiber | <varlistentry> |
303 | d3b4cf9f | Iustin Pop | <term>boot_order</term> |
304 | 25c5878d | Alexander Schreiber | <listitem> |
305 | d3b4cf9f | Iustin Pop | <simpara>Valid for the Xen HVM and KVM |
306 | d3b4cf9f | Iustin Pop | hypervisors.</simpara> |
307 | d3b4cf9f | Iustin Pop | |
308 | d3b4cf9f | Iustin Pop | <simpara>A string value denoting the boot order. This |
309 | d3b4cf9f | Iustin Pop | has different meaning for the Xen HVM hypervisor and |
310 | d3b4cf9f | Iustin Pop | for the KVM one.</simpara> |
311 | d3b4cf9f | Iustin Pop | |
312 | d3b4cf9f | Iustin Pop | <simpara> |
313 | d3b4cf9f | Iustin Pop | For Xen HVM, The boot order is a string of letters |
314 | d3b4cf9f | Iustin Pop | listing the boot devices, with valid device letters |
315 | d3b4cf9f | Iustin Pop | being: |
316 | d3b4cf9f | Iustin Pop | </simpara> |
317 | d3b4cf9f | Iustin Pop | <variablelist> |
318 | d3b4cf9f | Iustin Pop | <varlistentry> |
319 | d3b4cf9f | Iustin Pop | <term>a</term> |
320 | d3b4cf9f | Iustin Pop | <listitem> |
321 | d3b4cf9f | Iustin Pop | <para> |
322 | d3b4cf9f | Iustin Pop | floppy drive |
323 | d3b4cf9f | Iustin Pop | </para> |
324 | d3b4cf9f | Iustin Pop | </listitem> |
325 | d3b4cf9f | Iustin Pop | </varlistentry> |
326 | d3b4cf9f | Iustin Pop | <varlistentry> |
327 | d3b4cf9f | Iustin Pop | <term>c</term> |
328 | d3b4cf9f | Iustin Pop | <listitem> |
329 | d3b4cf9f | Iustin Pop | <para> |
330 | d3b4cf9f | Iustin Pop | hard disk |
331 | d3b4cf9f | Iustin Pop | </para> |
332 | d3b4cf9f | Iustin Pop | </listitem> |
333 | d3b4cf9f | Iustin Pop | </varlistentry> |
334 | d3b4cf9f | Iustin Pop | <varlistentry> |
335 | d3b4cf9f | Iustin Pop | <term>d</term> |
336 | d3b4cf9f | Iustin Pop | <listitem> |
337 | d3b4cf9f | Iustin Pop | <para> |
338 | d3b4cf9f | Iustin Pop | CDROM drive |
339 | d3b4cf9f | Iustin Pop | </para> |
340 | d3b4cf9f | Iustin Pop | </listitem> |
341 | d3b4cf9f | Iustin Pop | </varlistentry> |
342 | d3b4cf9f | Iustin Pop | <varlistentry> |
343 | d3b4cf9f | Iustin Pop | <term>n</term> |
344 | d3b4cf9f | Iustin Pop | <listitem> |
345 | d3b4cf9f | Iustin Pop | <para> |
346 | d3b4cf9f | Iustin Pop | network boot (PXE) |
347 | d3b4cf9f | Iustin Pop | </para> |
348 | d3b4cf9f | Iustin Pop | </listitem> |
349 | d3b4cf9f | Iustin Pop | </varlistentry> |
350 | d3b4cf9f | Iustin Pop | </variablelist> |
351 | d3b4cf9f | Iustin Pop | <simpara> |
352 | d3b4cf9f | Iustin Pop | The default is not to set an HVM boot order which is |
353 | d3b4cf9f | Iustin Pop | interpreted as 'dc'. |
354 | d3b4cf9f | Iustin Pop | </simpara> |
355 | d3b4cf9f | Iustin Pop | |
356 | ac620f3a | Guido Trotter | <simpara> |
357 | 73a19fcd | Guido Trotter | For KVM the boot order is either |
358 | 73a19fcd | Guido Trotter | <quote>cdrom</quote>, <quote>disk</quote> or |
359 | 73a19fcd | Guido Trotter | <quote>network</quote>. Please note that older |
360 | 73a19fcd | Guido Trotter | versions of KVM couldn't netboot from virtio |
361 | 73a19fcd | Guido Trotter | interfaces. This has been fixed in more recent |
362 | 73a19fcd | Guido Trotter | versions and is confirmed to work at least with |
363 | 73a19fcd | Guido Trotter | qemu-kvm 0.11.1. |
364 | ac620f3a | Guido Trotter | </simpara> |
365 | ac620f3a | Guido Trotter | |
366 | d3b4cf9f | Iustin Pop | </listitem> |
367 | d3b4cf9f | Iustin Pop | </varlistentry> |
368 | d3b4cf9f | Iustin Pop | <varlistentry> |
369 | d3b4cf9f | Iustin Pop | <term>cdrom_image_path</term> |
370 | d3b4cf9f | Iustin Pop | <listitem> |
371 | d3b4cf9f | Iustin Pop | <simpara>Valid for the Xen HVM and KVM hypervisors.</simpara> |
372 | d3b4cf9f | Iustin Pop | |
373 | d3b4cf9f | Iustin Pop | <simpara>The path to a CDROM image to attach to the |
374 | d3b4cf9f | Iustin Pop | instance.</simpara> |
375 | d3b4cf9f | Iustin Pop | |
376 | d3b4cf9f | Iustin Pop | </listitem> |
377 | d3b4cf9f | Iustin Pop | </varlistentry> |
378 | d3b4cf9f | Iustin Pop | <varlistentry> |
379 | d3b4cf9f | Iustin Pop | <term>nic_type</term> |
380 | d3b4cf9f | Iustin Pop | <listitem> |
381 | d3b4cf9f | Iustin Pop | <simpara>Valid for the Xen HVM and KVM hypervisors.</simpara> |
382 | d3b4cf9f | Iustin Pop | |
383 | 25c5878d | Alexander Schreiber | <para> |
384 | d3b4cf9f | Iustin Pop | This parameter determines the way the network cards |
385 | d3b4cf9f | Iustin Pop | are presented to the instance. The possible options are: |
386 | d3b4cf9f | Iustin Pop | <simplelist> |
387 | d3b4cf9f | Iustin Pop | <member>rtl8139 (default for Xen HVM) (HVM & KVM)</member> |
388 | d3b4cf9f | Iustin Pop | <member>ne2k_isa (HVM & KVM)</member> |
389 | d3b4cf9f | Iustin Pop | <member>ne2k_pci (HVM & KVM)</member> |
390 | d3b4cf9f | Iustin Pop | <member>i82551 (KVM)</member> |
391 | d3b4cf9f | Iustin Pop | <member>i82557b (KVM)</member> |
392 | d3b4cf9f | Iustin Pop | <member>i82559er (KVM)</member> |
393 | d3b4cf9f | Iustin Pop | <member>pcnet (KVM)</member> |
394 | d3b4cf9f | Iustin Pop | <member>e1000 (KVM)</member> |
395 | d3b4cf9f | Iustin Pop | <member>paravirtual (default for KVM) (HVM & KVM)</member> |
396 | d3b4cf9f | Iustin Pop | </simplelist> |
397 | 25c5878d | Alexander Schreiber | </para> |
398 | 25c5878d | Alexander Schreiber | </listitem> |
399 | 25c5878d | Alexander Schreiber | </varlistentry> |
400 | 25c5878d | Alexander Schreiber | <varlistentry> |
401 | d3b4cf9f | Iustin Pop | <term>disk_type</term> |
402 | 25c5878d | Alexander Schreiber | <listitem> |
403 | d3b4cf9f | Iustin Pop | <simpara>Valid for the Xen HVM and KVM hypervisors.</simpara> |
404 | d3b4cf9f | Iustin Pop | |
405 | 25c5878d | Alexander Schreiber | <para> |
406 | d3b4cf9f | Iustin Pop | This parameter determines the way the disks are |
407 | d3b4cf9f | Iustin Pop | presented to the instance. The possible options are: |
408 | d3b4cf9f | Iustin Pop | <simplelist> |
409 | d3b4cf9f | Iustin Pop | <member>ioemu (default for HVM & KVM) (HVM & KVM)</member> |
410 | d3b4cf9f | Iustin Pop | <member>ide (HVM & KVM)</member> |
411 | d3b4cf9f | Iustin Pop | <member>scsi (KVM)</member> |
412 | d3b4cf9f | Iustin Pop | <member>sd (KVM)</member> |
413 | d3b4cf9f | Iustin Pop | <member>mtd (KVM)</member> |
414 | d3b4cf9f | Iustin Pop | <member>pflash (KVM)</member> |
415 | d3b4cf9f | Iustin Pop | </simplelist> |
416 | 25c5878d | Alexander Schreiber | </para> |
417 | 25c5878d | Alexander Schreiber | </listitem> |
418 | 25c5878d | Alexander Schreiber | </varlistentry> |
419 | 25c5878d | Alexander Schreiber | <varlistentry> |
420 | d3b4cf9f | Iustin Pop | <term>vnc_bind_address</term> |
421 | 25c5878d | Alexander Schreiber | <listitem> |
422 | d3b4cf9f | Iustin Pop | <simpara>Valid for the Xen HVM and KVM hypervisors.</simpara> |
423 | d3b4cf9f | Iustin Pop | |
424 | d3b4cf9f | Iustin Pop | <para>Specifies the address that the VNC listener for |
425 | d3b4cf9f | Iustin Pop | this instance should bind to. Valid values are IPv4 |
426 | d3b4cf9f | Iustin Pop | addresses. Use the address 0.0.0.0 to bind to all |
427 | d3b4cf9f | Iustin Pop | available interfaces (this is the default) or specify |
428 | d3b4cf9f | Iustin Pop | the address of one of the interfaces on the node to |
429 | d3b4cf9f | Iustin Pop | restrict listening to that interface.</para> |
430 | d3b4cf9f | Iustin Pop | </listitem> |
431 | d3b4cf9f | Iustin Pop | </varlistentry> |
432 | d3b4cf9f | Iustin Pop | |
433 | d3b4cf9f | Iustin Pop | <varlistentry> |
434 | d3b4cf9f | Iustin Pop | <term>vnc_tls</term> |
435 | d3b4cf9f | Iustin Pop | <listitem> |
436 | d3b4cf9f | Iustin Pop | <simpara>Valid for the KVM hypervisor.</simpara> |
437 | d3b4cf9f | Iustin Pop | |
438 | d3b4cf9f | Iustin Pop | <simpara>A boolean option that controls whether the |
439 | d3b4cf9f | Iustin Pop | VNC connection is secured with TLS.</simpara> |
440 | d3b4cf9f | Iustin Pop | </listitem> |
441 | d3b4cf9f | Iustin Pop | </varlistentry> |
442 | d3b4cf9f | Iustin Pop | |
443 | d3b4cf9f | Iustin Pop | <varlistentry> |
444 | d3b4cf9f | Iustin Pop | <term>vnc_x509_path</term> |
445 | d3b4cf9f | Iustin Pop | <listitem> |
446 | d3b4cf9f | Iustin Pop | <simpara>Valid for the KVM hypervisor.</simpara> |
447 | d3b4cf9f | Iustin Pop | |
448 | d3b4cf9f | Iustin Pop | <para>If <option>vnc_tls</option> is enabled, this |
449 | d3b4cf9f | Iustin Pop | options specifies the path to the x509 certificate to |
450 | d3b4cf9f | Iustin Pop | use.</para> |
451 | d3b4cf9f | Iustin Pop | </listitem> |
452 | d3b4cf9f | Iustin Pop | </varlistentry> |
453 | d3b4cf9f | Iustin Pop | |
454 | d3b4cf9f | Iustin Pop | <varlistentry> |
455 | d3b4cf9f | Iustin Pop | <term>vnc_x509_verify</term> |
456 | d3b4cf9f | Iustin Pop | <listitem> |
457 | d3b4cf9f | Iustin Pop | <simpara>Valid for the KVM hypervisor.</simpara> |
458 | d3b4cf9f | Iustin Pop | </listitem> |
459 | d3b4cf9f | Iustin Pop | </varlistentry> |
460 | d3b4cf9f | Iustin Pop | |
461 | d3b4cf9f | Iustin Pop | <varlistentry> |
462 | d3b4cf9f | Iustin Pop | <term>acpi</term> |
463 | d3b4cf9f | Iustin Pop | <listitem> |
464 | d3b4cf9f | Iustin Pop | <simpara>Valid for the Xen HVM and KVM hypervisors.</simpara> |
465 | d3b4cf9f | Iustin Pop | |
466 | 25c5878d | Alexander Schreiber | <para> |
467 | d3b4cf9f | Iustin Pop | A boolean option that specifies if the hypervisor |
468 | d3b4cf9f | Iustin Pop | should enable ACPI support for this instance. By |
469 | d3b4cf9f | Iustin Pop | default, ACPI is disabled. |
470 | 25c5878d | Alexander Schreiber | </para> |
471 | 25c5878d | Alexander Schreiber | </listitem> |
472 | 25c5878d | Alexander Schreiber | </varlistentry> |
473 | d3b4cf9f | Iustin Pop | |
474 | 25c5878d | Alexander Schreiber | <varlistentry> |
475 | d3b4cf9f | Iustin Pop | <term>pae</term> |
476 | 25c5878d | Alexander Schreiber | <listitem> |
477 | d3b4cf9f | Iustin Pop | <simpara>Valid for the Xen HVM and KVM hypervisors.</simpara> |
478 | d3b4cf9f | Iustin Pop | |
479 | 25c5878d | Alexander Schreiber | <para> |
480 | d3b4cf9f | Iustin Pop | A boolean option that specifies if the hypervisor |
481 | d3b4cf9f | Iustin Pop | should enabled PAE support for this instance. The |
482 | d3b4cf9f | Iustin Pop | default is false, disabling PAE support. |
483 | 25c5878d | Alexander Schreiber | </para> |
484 | 25c5878d | Alexander Schreiber | </listitem> |
485 | 25c5878d | Alexander Schreiber | </varlistentry> |
486 | 25c5878d | Alexander Schreiber | |
487 | d3b4cf9f | Iustin Pop | <varlistentry> |
488 | bfe61b0b | Iustin Pop | <term>use_localtime</term> |
489 | bfe61b0b | Iustin Pop | <listitem> |
490 | bfe61b0b | Iustin Pop | <simpara>Valid for the Xen HVM and KVM hypervisors.</simpara> |
491 | bfe61b0b | Iustin Pop | |
492 | bfe61b0b | Iustin Pop | <para> |
493 | bfe61b0b | Iustin Pop | A boolean option that specifies if the instance |
494 | bfe61b0b | Iustin Pop | should be started with its clock set to the |
495 | bfe61b0b | Iustin Pop | localtime of the machine (when true) or to the UTC |
496 | bfe61b0b | Iustin Pop | (When false). The default is false, which is useful |
497 | bfe61b0b | Iustin Pop | for Linux/Unix machines; for Windows OSes, it is |
498 | bfe61b0b | Iustin Pop | recommended to enable this parameter. |
499 | bfe61b0b | Iustin Pop | </para> |
500 | bfe61b0b | Iustin Pop | </listitem> |
501 | bfe61b0b | Iustin Pop | </varlistentry> |
502 | bfe61b0b | Iustin Pop | |
503 | bfe61b0b | Iustin Pop | <varlistentry> |
504 | d3b4cf9f | Iustin Pop | <term>kernel_path</term> |
505 | d3b4cf9f | Iustin Pop | <listitem> |
506 | d3b4cf9f | Iustin Pop | <simpara>Valid for the Xen PVM and KVM hypervisors.</simpara> |
507 | 25c5878d | Alexander Schreiber | |
508 | d3b4cf9f | Iustin Pop | <para> |
509 | d3b4cf9f | Iustin Pop | This option specifies the path (on the node) to the |
510 | d3b4cf9f | Iustin Pop | kernel to boot the instance with. Xen PVM instances |
511 | d3b4cf9f | Iustin Pop | always require this, while for KVM if this option is |
512 | d3b4cf9f | Iustin Pop | empty, it will cause the machine to load the kernel |
513 | d3b4cf9f | Iustin Pop | from its disks. |
514 | d3b4cf9f | Iustin Pop | </para> |
515 | d3b4cf9f | Iustin Pop | </listitem> |
516 | d3b4cf9f | Iustin Pop | </varlistentry> |
517 | ca9c49d5 | Iustin Pop | |
518 | d3b4cf9f | Iustin Pop | <varlistentry> |
519 | 07813a9e | Iustin Pop | <term>kernel_args</term> |
520 | 07813a9e | Iustin Pop | <listitem> |
521 | 07813a9e | Iustin Pop | <simpara>Valid for the Xen PVM and KVM hypervisors.</simpara> |
522 | 07813a9e | Iustin Pop | |
523 | 07813a9e | Iustin Pop | <para> |
524 | 07813a9e | Iustin Pop | This options specifies extra arguments to the kernel |
525 | 07813a9e | Iustin Pop | that will be loaded. device. This is always used |
526 | 07813a9e | Iustin Pop | for Xen PVM, while for KVM it is only used if the |
527 | 07813a9e | Iustin Pop | <option>kernel_path</option> option is also |
528 | 07813a9e | Iustin Pop | specified. |
529 | 07813a9e | Iustin Pop | </para> |
530 | 07813a9e | Iustin Pop | |
531 | 07813a9e | Iustin Pop | <para> |
532 | 07813a9e | Iustin Pop | The default setting for this value is simply |
533 | 07813a9e | Iustin Pop | <constant>"ro"</constant>, which mounts the root |
534 | 07813a9e | Iustin Pop | disk (initially) in read-only one. For example, |
535 | 07813a9e | Iustin Pop | setting this to <userinput>single</userinput> will |
536 | 07813a9e | Iustin Pop | cause the instance to start in single-user mode. |
537 | 07813a9e | Iustin Pop | </para> |
538 | 07813a9e | Iustin Pop | </listitem> |
539 | 07813a9e | Iustin Pop | </varlistentry> |
540 | 07813a9e | Iustin Pop | |
541 | 07813a9e | Iustin Pop | <varlistentry> |
542 | d3b4cf9f | Iustin Pop | <term>initrd_path</term> |
543 | d3b4cf9f | Iustin Pop | <listitem> |
544 | d3b4cf9f | Iustin Pop | <simpara>Valid for the Xen PVM and KVM hypervisors.</simpara> |
545 | ca9c49d5 | Iustin Pop | |
546 | d3b4cf9f | Iustin Pop | <para> |
547 | d3b4cf9f | Iustin Pop | This option specifies the path (on the node) to the |
548 | d3b4cf9f | Iustin Pop | initrd to boot the instance with. Xen PVM instances |
549 | d3b4cf9f | Iustin Pop | can use this always, while for KVM if this option is |
550 | d3b4cf9f | Iustin Pop | only used if the <option>kernel_path</option> option |
551 | 5645d16b | Iustin Pop | is also specified. You can pass here either an |
552 | 5645d16b | Iustin Pop | absolute filename (the path to the initrd) if you |
553 | 5645d16b | Iustin Pop | want to use an initrd, or use the format |
554 | 5645d16b | Iustin Pop | <userinput>no_initrd_path</userinput> for no initrd. |
555 | d3b4cf9f | Iustin Pop | </para> |
556 | d3b4cf9f | Iustin Pop | </listitem> |
557 | d3b4cf9f | Iustin Pop | </varlistentry> |
558 | ca9c49d5 | Iustin Pop | |
559 | d3b4cf9f | Iustin Pop | <varlistentry> |
560 | d3b4cf9f | Iustin Pop | <term>root_path</term> |
561 | d3b4cf9f | Iustin Pop | <listitem> |
562 | d3b4cf9f | Iustin Pop | <simpara>Valid for the Xen PVM and KVM hypervisors.</simpara> |
563 | 02d2adf4 | Alexander Schreiber | |
564 | d3b4cf9f | Iustin Pop | <para> |
565 | d3b4cf9f | Iustin Pop | This options specifies the name of the root |
566 | d3b4cf9f | Iustin Pop | device. This is always needed for Xen PVM, while for |
567 | d3b4cf9f | Iustin Pop | KVM it is only used if the |
568 | d3b4cf9f | Iustin Pop | <option>kernel_path</option> option is also |
569 | d3b4cf9f | Iustin Pop | specified. |
570 | d3b4cf9f | Iustin Pop | </para> |
571 | d3b4cf9f | Iustin Pop | </listitem> |
572 | d3b4cf9f | Iustin Pop | </varlistentry> |
573 | d3b4cf9f | Iustin Pop | |
574 | d3b4cf9f | Iustin Pop | <varlistentry> |
575 | d3b4cf9f | Iustin Pop | <term>serial_console</term> |
576 | d3b4cf9f | Iustin Pop | <listitem> |
577 | d3b4cf9f | Iustin Pop | <simpara>Valid for the KVM hypervisor.</simpara> |
578 | d3b4cf9f | Iustin Pop | |
579 | d3b4cf9f | Iustin Pop | <simpara>This boolean option specifies whether to |
580 | d3b4cf9f | Iustin Pop | emulate a serial console for the instance.</simpara> |
581 | d3b4cf9f | Iustin Pop | </listitem> |
582 | d3b4cf9f | Iustin Pop | </varlistentry> |
583 | 78411c60 | Iustin Pop | |
584 | 19572932 | Iustin Pop | <varlistentry> |
585 | 19572932 | Iustin Pop | <term>disk_cache</term> |
586 | 19572932 | Iustin Pop | <listitem> |
587 | 19572932 | Iustin Pop | <simpara>Valid for the KVM hypervisor.</simpara> |
588 | 19572932 | Iustin Pop | |
589 | 19572932 | Iustin Pop | <simpara>The disk cache mode. It can be either |
590 | 19572932 | Iustin Pop | <userinput>default</userinput> to not pass any cache |
591 | 19572932 | Iustin Pop | option to KVM, or one of the KVM cache modes: none |
592 | 19572932 | Iustin Pop | (for direct I/O), writethrough (to use the host cache |
593 | 19572932 | Iustin Pop | but report completion to the guest only when the host |
594 | 19572932 | Iustin Pop | has commited the changes to disk) or writeback (to use |
595 | 19572932 | Iustin Pop | the host cache and report completion as soon as the |
596 | 19572932 | Iustin Pop | data is in the host cache). Note that there are |
597 | 19572932 | Iustin Pop | special considerations for the cache mode depending on |
598 | 19572932 | Iustin Pop | version of KVM used and disk type (always raw file |
599 | 19572932 | Iustin Pop | under Ganeti), please refer to the KVM documentation |
600 | 19572932 | Iustin Pop | for more details. |
601 | 19572932 | Iustin Pop | </simpara> |
602 | 19572932 | Iustin Pop | </listitem> |
603 | 19572932 | Iustin Pop | </varlistentry> |
604 | 19572932 | Iustin Pop | |
605 | caf39b8a | Guido Trotter | <varlistentry> |
606 | caf39b8a | Guido Trotter | <term>security_model</term> |
607 | caf39b8a | Guido Trotter | <listitem> |
608 | caf39b8a | Guido Trotter | <simpara>Valid for the KVM hypervisor.</simpara> |
609 | caf39b8a | Guido Trotter | |
610 | caf39b8a | Guido Trotter | <simpara>The security model for kvm. Currently one of |
611 | caf39b8a | Guido Trotter | <quote>none</quote>, <quote>user</quote> or |
612 | caf39b8a | Guido Trotter | <quote>pool</quote>. Under <quote>none</quote>, the |
613 | caf39b8a | Guido Trotter | default, nothing is done and instances are run as |
614 | caf39b8a | Guido Trotter | the ganeti daemon user (normally root). |
615 | caf39b8a | Guido Trotter | </simpara> |
616 | caf39b8a | Guido Trotter | |
617 | caf39b8a | Guido Trotter | <simpara>Under <quote>user</quote> kvm will drop |
618 | caf39b8a | Guido Trotter | privileges and become the user specified by the |
619 | caf39b8a | Guido Trotter | security_domain parameter. |
620 | caf39b8a | Guido Trotter | </simpara> |
621 | caf39b8a | Guido Trotter | |
622 | caf39b8a | Guido Trotter | <simpara>Under <quote>pool</quote> a global cluster |
623 | caf39b8a | Guido Trotter | pool of users will be used, making sure no two |
624 | caf39b8a | Guido Trotter | instances share the same user on the same node. |
625 | caf39b8a | Guido Trotter | (this mode is not implemented yet) |
626 | caf39b8a | Guido Trotter | </simpara> |
627 | caf39b8a | Guido Trotter | |
628 | caf39b8a | Guido Trotter | </listitem> |
629 | caf39b8a | Guido Trotter | </varlistentry> |
630 | caf39b8a | Guido Trotter | |
631 | caf39b8a | Guido Trotter | <varlistentry> |
632 | caf39b8a | Guido Trotter | <term>security_domain</term> |
633 | caf39b8a | Guido Trotter | <listitem> |
634 | caf39b8a | Guido Trotter | <simpara>Valid for the KVM hypervisor.</simpara> |
635 | caf39b8a | Guido Trotter | |
636 | caf39b8a | Guido Trotter | <simpara>Under security model <quote>user</quote> the username to |
637 | caf39b8a | Guido Trotter | run the instance under. It must be a valid username |
638 | caf39b8a | Guido Trotter | existing on the host. |
639 | caf39b8a | Guido Trotter | </simpara> |
640 | caf39b8a | Guido Trotter | <simpara>Cannot be set under security model <quote>none</quote> |
641 | caf39b8a | Guido Trotter | or <quote>pool</quote>. |
642 | caf39b8a | Guido Trotter | </simpara> |
643 | caf39b8a | Guido Trotter | |
644 | caf39b8a | Guido Trotter | </listitem> |
645 | caf39b8a | Guido Trotter | </varlistentry> |
646 | caf39b8a | Guido Trotter | |
647 | 7ba594c0 | Guido Trotter | <varlistentry> |
648 | 7ba594c0 | Guido Trotter | <term>kvm_flag</term> |
649 | 7ba594c0 | Guido Trotter | <listitem> |
650 | 7ba594c0 | Guido Trotter | <simpara>Valid for the KVM hypervisor.</simpara> |
651 | 7ba594c0 | Guido Trotter | |
652 | 7ba594c0 | Guido Trotter | <simpara>If <quote>enabled</quote> the -enable-kvm flag is |
653 | 7ba594c0 | Guido Trotter | passed to kvm. If <quote>disabled</quote> -disable-kvm is |
654 | 7ba594c0 | Guido Trotter | passed. If unset no flag is passed, and the default running |
655 | 7ba594c0 | Guido Trotter | mode for your kvm binary will be used. |
656 | 7ba594c0 | Guido Trotter | </simpara> |
657 | 7ba594c0 | Guido Trotter | |
658 | 7ba594c0 | Guido Trotter | </listitem> |
659 | 7ba594c0 | Guido Trotter | </varlistentry> |
660 | 7ba594c0 | Guido Trotter | |
661 | d3b4cf9f | Iustin Pop | </variablelist> |
662 | 78411c60 | Iustin Pop | |
663 | 02d2adf4 | Alexander Schreiber | </para> |
664 | 02d2adf4 | Alexander Schreiber | |
665 | 02d2adf4 | Alexander Schreiber | <para> |
666 | a53a1b18 | Michael Hanselmann | The <option>--iallocator</option> option specifies the instance |
667 | a53a1b18 | Michael Hanselmann | allocator plugin to use. If you pass in this option the allocator |
668 | a53a1b18 | Michael Hanselmann | will select nodes for this instance automatically, so you don't need |
669 | a53a1b18 | Michael Hanselmann | to pass them with the <option>-n</option> option. For more |
670 | a53a1b18 | Michael Hanselmann | information please refer to the instance allocator documentation. |
671 | a53a1b18 | Michael Hanselmann | </para> |
672 | a53a1b18 | Michael Hanselmann | |
673 | a53a1b18 | Michael Hanselmann | <para> |
674 | a8083063 | Iustin Pop | The <option>-t</option> options specifies the disk layout type for |
675 | a8083063 | Iustin Pop | the instance. The available choices are: |
676 | a8083063 | Iustin Pop | <variablelist> |
677 | a8083063 | Iustin Pop | <varlistentry> |
678 | a8083063 | Iustin Pop | <term>diskless</term> |
679 | a8083063 | Iustin Pop | <listitem> |
680 | a8083063 | Iustin Pop | <para> |
681 | a8083063 | Iustin Pop | This creates an instance with no disks. Its useful for |
682 | a8083063 | Iustin Pop | testing only (or other special cases). |
683 | a8083063 | Iustin Pop | </para> |
684 | a8083063 | Iustin Pop | </listitem> |
685 | a8083063 | Iustin Pop | </varlistentry> |
686 | a8083063 | Iustin Pop | <varlistentry> |
687 | 495beb42 | Manuel Franceschini | <term>file</term> |
688 | 495beb42 | Manuel Franceschini | <listitem> |
689 | 495beb42 | Manuel Franceschini | <para>Disk devices will be regular files.</para> |
690 | 495beb42 | Manuel Franceschini | </listitem> |
691 | 495beb42 | Manuel Franceschini | </varlistentry> |
692 | 495beb42 | Manuel Franceschini | <varlistentry> |
693 | a8083063 | Iustin Pop | <term>plain</term> |
694 | a8083063 | Iustin Pop | <listitem> |
695 | a8083063 | Iustin Pop | <para>Disk devices will be logical volumes.</para> |
696 | a8083063 | Iustin Pop | </listitem> |
697 | a8083063 | Iustin Pop | </varlistentry> |
698 | a8083063 | Iustin Pop | <varlistentry> |
699 | f69dab6d | Iustin Pop | <term>drbd</term> |
700 | f69dab6d | Iustin Pop | <listitem> |
701 | f69dab6d | Iustin Pop | <para> |
702 | f69dab6d | Iustin Pop | Disk devices will be drbd (version 8.x) on top of |
703 | f9193417 | Iustin Pop | lvm volumes. |
704 | a8083063 | Iustin Pop | </para> |
705 | a8083063 | Iustin Pop | </listitem> |
706 | a8083063 | Iustin Pop | </varlistentry> |
707 | a8083063 | Iustin Pop | </variablelist> |
708 | a8083063 | Iustin Pop | </para> |
709 | a8083063 | Iustin Pop | |
710 | a8083063 | Iustin Pop | <para> |
711 | 4677a909 | Michael Hanselmann | The optional second value of the <option>--node</option> is used for |
712 | bd028152 | Iustin Pop | the drbd template type and specifies the remote node. |
713 | a8083063 | Iustin Pop | </para> |
714 | a8083063 | Iustin Pop | |
715 | a8083063 | Iustin Pop | <para> |
716 | a8083063 | Iustin Pop | If you do not want gnt-instance to wait for the disk mirror |
717 | a8083063 | Iustin Pop | to be synced, use the <option>--no-wait-for-sync</option> |
718 | a8083063 | Iustin Pop | option. |
719 | a8083063 | Iustin Pop | </para> |
720 | a8083063 | Iustin Pop | |
721 | a8083063 | Iustin Pop | <para> |
722 | 495beb42 | Manuel Franceschini | The <option>--file-storage-dir</option> specifies the relative path |
723 | 495beb42 | Manuel Franceschini | under the cluster-wide file storage directory to store file-based |
724 | 495beb42 | Manuel Franceschini | disks. It is useful for having different subdirectories for |
725 | 495beb42 | Manuel Franceschini | different instances. The full path of the directory where the disk |
726 | 495beb42 | Manuel Franceschini | files are stored will consist of cluster-wide file storage directory |
727 | 495beb42 | Manuel Franceschini | + optional subdirectory + instance name. Example: |
728 | 495beb42 | Manuel Franceschini | /srv/ganeti/file-storage/mysubdir/instance1.example.com. This option |
729 | 495beb42 | Manuel Franceschini | is only relevant for instances using the file storage backend. |
730 | 495beb42 | Manuel Franceschini | </para> |
731 | 495beb42 | Manuel Franceschini | |
732 | 495beb42 | Manuel Franceschini | <para> |
733 | 495beb42 | Manuel Franceschini | The <option>--file-driver</option> specifies the driver to use for |
734 | 495beb42 | Manuel Franceschini | file-based disks. Note that currently these drivers work with the |
735 | 495beb42 | Manuel Franceschini | xen hypervisor only. This option is only relevant for instances using |
736 | 495beb42 | Manuel Franceschini | the file storage backend. The available choices are: |
737 | 495beb42 | Manuel Franceschini | <variablelist> |
738 | 495beb42 | Manuel Franceschini | <varlistentry> |
739 | 495beb42 | Manuel Franceschini | <term>loop</term> |
740 | 495beb42 | Manuel Franceschini | <listitem> |
741 | d3b4cf9f | Iustin Pop | <para> |
742 | d3b4cf9f | Iustin Pop | Kernel loopback driver. This driver uses loopback |
743 | d3b4cf9f | Iustin Pop | devices to access the filesystem within the |
744 | d3b4cf9f | Iustin Pop | file. However, running I/O intensive applications in |
745 | d3b4cf9f | Iustin Pop | your instance using the loop driver might result in |
746 | d3b4cf9f | Iustin Pop | slowdowns. Furthermore, if you use the loopback |
747 | d3b4cf9f | Iustin Pop | driver consider increasing the maximum amount of |
748 | d3b4cf9f | Iustin Pop | loopback devices (on most systems it's 8) using the |
749 | d3b4cf9f | Iustin Pop | max_loop param. |
750 | d3b4cf9f | Iustin Pop | </para> |
751 | 495beb42 | Manuel Franceschini | </listitem> |
752 | 495beb42 | Manuel Franceschini | </varlistentry> |
753 | 495beb42 | Manuel Franceschini | <varlistentry> |
754 | 495beb42 | Manuel Franceschini | <term>blktap</term> |
755 | 495beb42 | Manuel Franceschini | <listitem> |
756 | d3b4cf9f | Iustin Pop | <para>The blktap driver (for Xen hypervisors). In |
757 | d3b4cf9f | Iustin Pop | order to be able to use the blktap driver you should |
758 | d3b4cf9f | Iustin Pop | check if the 'blktapctrl' user space disk agent is |
759 | d3b4cf9f | Iustin Pop | running (usually automatically started via xend). This |
760 | d3b4cf9f | Iustin Pop | user-level disk I/O interface has the advantage of |
761 | d3b4cf9f | Iustin Pop | better performance. Especially if you use a network |
762 | d3b4cf9f | Iustin Pop | file system (e.g. NFS) to store your instances this is |
763 | d3b4cf9f | Iustin Pop | the recommended choice. |
764 | d3b4cf9f | Iustin Pop | </para> |
765 | 495beb42 | Manuel Franceschini | </listitem> |
766 | 495beb42 | Manuel Franceschini | </varlistentry> |
767 | 67470f58 | Iustin Pop | </variablelist> |
768 | 495beb42 | Manuel Franceschini | </para> |
769 | 495beb42 | Manuel Franceschini | |
770 | 495beb42 | Manuel Franceschini | <para> |
771 | d3b4cf9f | Iustin Pop | The <option>--submit</option> option is used to send the job to |
772 | d3b4cf9f | Iustin Pop | the master daemon but not wait for its completion. The job |
773 | d3b4cf9f | Iustin Pop | ID will be shown so that it can be examined via |
774 | d3b4cf9f | Iustin Pop | <command>gnt-job info</command>. |
775 | bd028152 | Iustin Pop | </para> |
776 | 495beb42 | Manuel Franceschini | |
777 | 495beb42 | Manuel Franceschini | <para> |
778 | a8083063 | Iustin Pop | Example: |
779 | a8083063 | Iustin Pop | <screen> |
780 | d3b4cf9f | Iustin Pop | # gnt-instance add -t file --disk 0:size=30g -B memory=512 -o debian-etch \ |
781 | 495beb42 | Manuel Franceschini | -n node1.example.com --file-storage-dir=mysubdir instance1.example.com |
782 | d3b4cf9f | Iustin Pop | # gnt-instance add -t plain --disk 0:size=30g -B memory=512 -o debian-etch \ |
783 | b9ac33e9 | Iustin Pop | -n node1.example.com instance1.example.com |
784 | d3b4cf9f | Iustin Pop | # gnt-instance add -t drbd --disk 0:size=30g -B memory=512 -o debian-etch \ |
785 | 4677a909 | Michael Hanselmann | -n node1.example.com:node2.example.com instance2.example.com |
786 | a8083063 | Iustin Pop | </screen> |
787 | a8083063 | Iustin Pop | </para> |
788 | a8083063 | Iustin Pop | </refsect3> |
789 | a8083063 | Iustin Pop | |
790 | a8083063 | Iustin Pop | <refsect3> |
791 | d3b4cf9f | Iustin Pop | <title>BATCH-CREATE</title> |
792 | d3b4cf9f | Iustin Pop | <cmdsynopsis> |
793 | d3b4cf9f | Iustin Pop | <command>batch-create</command> |
794 | d3b4cf9f | Iustin Pop | <arg choice="req">instances_file.json</arg> |
795 | d3b4cf9f | Iustin Pop | </cmdsynopsis> |
796 | d3b4cf9f | Iustin Pop | |
797 | d3b4cf9f | Iustin Pop | <para> |
798 | d3b4cf9f | Iustin Pop | This command (similar to the Ganeti 1.2 |
799 | d3b4cf9f | Iustin Pop | <command>batcher</command> tool) submits multiple instance |
800 | d3b4cf9f | Iustin Pop | creation jobs based on a definition file. The instance |
801 | d3b4cf9f | Iustin Pop | configurations do not encompass all the possible options for |
802 | d3b4cf9f | Iustin Pop | the <command>add</command> command, but only a subset. |
803 | d3b4cf9f | Iustin Pop | </para> |
804 | d3b4cf9f | Iustin Pop | |
805 | d3b4cf9f | Iustin Pop | <para> |
806 | d3b4cf9f | Iustin Pop | The instance file should be a valid-formed JSON file, |
807 | d3b4cf9f | Iustin Pop | containing a dictionary with instance name and instance |
808 | d3b4cf9f | Iustin Pop | parameters. The accepted parameters are: |
809 | d3b4cf9f | Iustin Pop | |
810 | d3b4cf9f | Iustin Pop | <variablelist> |
811 | d3b4cf9f | Iustin Pop | <varlistentry> |
812 | d3b4cf9f | Iustin Pop | <term>disk_size</term> |
813 | d3b4cf9f | Iustin Pop | <listitem> |
814 | d3b4cf9f | Iustin Pop | <simpara>The size of the disks of the instance.</simpara> |
815 | d3b4cf9f | Iustin Pop | </listitem> |
816 | d3b4cf9f | Iustin Pop | </varlistentry> |
817 | d3b4cf9f | Iustin Pop | <varlistentry> |
818 | d3b4cf9f | Iustin Pop | <term>disk_templace</term> |
819 | d3b4cf9f | Iustin Pop | <listitem> |
820 | d3b4cf9f | Iustin Pop | <simpara>The disk template to use for the instance, |
821 | d3b4cf9f | Iustin Pop | the same as in the <command>add</command> |
822 | d3b4cf9f | Iustin Pop | command.</simpara> |
823 | d3b4cf9f | Iustin Pop | </listitem> |
824 | d3b4cf9f | Iustin Pop | </varlistentry> |
825 | d3b4cf9f | Iustin Pop | <varlistentry> |
826 | d3b4cf9f | Iustin Pop | <term>backend</term> |
827 | d3b4cf9f | Iustin Pop | <listitem> |
828 | d3b4cf9f | Iustin Pop | <simpara>A dictionary of backend parameters.</simpara> |
829 | d3b4cf9f | Iustin Pop | </listitem> |
830 | d3b4cf9f | Iustin Pop | </varlistentry> |
831 | d3b4cf9f | Iustin Pop | <varlistentry> |
832 | d3b4cf9f | Iustin Pop | <term>hypervisor</term> |
833 | d3b4cf9f | Iustin Pop | <listitem> |
834 | d3b4cf9f | Iustin Pop | <simpara>A dictionary with a single key (the |
835 | d3b4cf9f | Iustin Pop | hypervisor name), and as value the hypervisor |
836 | d3b4cf9f | Iustin Pop | options. If not passed, the default hypervisor and |
837 | d3b4cf9f | Iustin Pop | hypervisor options will be inherited.</simpara> |
838 | d3b4cf9f | Iustin Pop | </listitem> |
839 | d3b4cf9f | Iustin Pop | </varlistentry> |
840 | d3b4cf9f | Iustin Pop | <varlistentry> |
841 | 7d713344 | Guido Trotter | <term>mac, ip, mode, link</term> |
842 | d3b4cf9f | Iustin Pop | <listitem> |
843 | d3b4cf9f | Iustin Pop | <simpara>Specifications for the one NIC that will be |
844 | 0b063b42 | Guido Trotter | created for the instance. 'bridge' is also accepted |
845 | 0b063b42 | Guido Trotter | as a backwards compatibile key.</simpara> |
846 | 0b063b42 | Guido Trotter | </listitem> |
847 | 0b063b42 | Guido Trotter | </varlistentry> |
848 | 0b063b42 | Guido Trotter | <varlistentry> |
849 | 0b063b42 | Guido Trotter | <term>nics</term> |
850 | 0b063b42 | Guido Trotter | <listitem> |
851 | 0b063b42 | Guido Trotter | <simpara>List of nics that will be created for the |
852 | 0b063b42 | Guido Trotter | instance. Each entry should be a dict, with mac, ip, mode |
853 | 0b063b42 | Guido Trotter | and link as possible keys. Please don't provide the "mac, |
854 | 0b063b42 | Guido Trotter | ip, mode, link" parent keys if you use this method for |
855 | 0b063b42 | Guido Trotter | specifying nics.</simpara> |
856 | d3b4cf9f | Iustin Pop | </listitem> |
857 | d3b4cf9f | Iustin Pop | </varlistentry> |
858 | d3b4cf9f | Iustin Pop | <varlistentry> |
859 | d3b4cf9f | Iustin Pop | <term>primary_node, secondary_node</term> |
860 | d3b4cf9f | Iustin Pop | <listitem> |
861 | d3b4cf9f | Iustin Pop | <simpara>The primary and optionally the secondary node |
862 | d3b4cf9f | Iustin Pop | to use for the instance (in case an iallocator script |
863 | d3b4cf9f | Iustin Pop | is not used).</simpara> |
864 | d3b4cf9f | Iustin Pop | </listitem> |
865 | d3b4cf9f | Iustin Pop | </varlistentry> |
866 | d3b4cf9f | Iustin Pop | <varlistentry> |
867 | d3b4cf9f | Iustin Pop | <term>iallocator</term> |
868 | d3b4cf9f | Iustin Pop | <listitem> |
869 | d3b4cf9f | Iustin Pop | <simpara>Instead of specifying the nodes, an |
870 | d3b4cf9f | Iustin Pop | iallocator script can be used to automatically compute |
871 | d3b4cf9f | Iustin Pop | them.</simpara> |
872 | d3b4cf9f | Iustin Pop | </listitem> |
873 | d3b4cf9f | Iustin Pop | </varlistentry> |
874 | d3b4cf9f | Iustin Pop | <varlistentry> |
875 | d3b4cf9f | Iustin Pop | <term>start</term> |
876 | d3b4cf9f | Iustin Pop | <listitem> |
877 | d3b4cf9f | Iustin Pop | <simpara>whether to start the instance</simpara> |
878 | d3b4cf9f | Iustin Pop | </listitem> |
879 | d3b4cf9f | Iustin Pop | </varlistentry> |
880 | d3b4cf9f | Iustin Pop | <varlistentry> |
881 | d3b4cf9f | Iustin Pop | <term>ip_check</term> |
882 | d3b4cf9f | Iustin Pop | <listitem> |
883 | d3b4cf9f | Iustin Pop | <simpara>Skip the check for already-in-use instance; |
884 | d3b4cf9f | Iustin Pop | see the description in the <command>add</command> |
885 | d3b4cf9f | Iustin Pop | command for details.</simpara> |
886 | d3b4cf9f | Iustin Pop | </listitem> |
887 | d3b4cf9f | Iustin Pop | </varlistentry> |
888 | d3b4cf9f | Iustin Pop | <varlistentry> |
889 | 1d65264b | Iustin Pop | <term>name_check</term> |
890 | 1d65264b | Iustin Pop | <listitem> |
891 | 1d65264b | Iustin Pop | <simpara>Skip the name check for instances; |
892 | 1d65264b | Iustin Pop | see the description in the <command>add</command> |
893 | 1d65264b | Iustin Pop | command for details.</simpara> |
894 | 1d65264b | Iustin Pop | </listitem> |
895 | 1d65264b | Iustin Pop | </varlistentry> |
896 | 1d65264b | Iustin Pop | <varlistentry> |
897 | d3b4cf9f | Iustin Pop | <term>file_storage_dir, file_driver</term> |
898 | d3b4cf9f | Iustin Pop | <listitem> |
899 | d3b4cf9f | Iustin Pop | <simpara>Configuration for the <literal>file</literal> |
900 | d3b4cf9f | Iustin Pop | disk type, see the <command>add</command> command for |
901 | d3b4cf9f | Iustin Pop | details.</simpara> |
902 | d3b4cf9f | Iustin Pop | </listitem> |
903 | d3b4cf9f | Iustin Pop | </varlistentry> |
904 | d3b4cf9f | Iustin Pop | </variablelist> |
905 | d3b4cf9f | Iustin Pop | </para> |
906 | d3b4cf9f | Iustin Pop | |
907 | d3b4cf9f | Iustin Pop | <para> |
908 | d3b4cf9f | Iustin Pop | A simple definition for one instance can be (with most of |
909 | d3b4cf9f | Iustin Pop | the parameters taken from the cluster defaults): |
910 | d3b4cf9f | Iustin Pop | <screen> |
911 | d3b4cf9f | Iustin Pop | { |
912 | d3b4cf9f | Iustin Pop | "instance3": { |
913 | d3b4cf9f | Iustin Pop | "template": "drbd", |
914 | d3b4cf9f | Iustin Pop | "os": "debootstrap", |
915 | d3b4cf9f | Iustin Pop | "disk_size": ["25G"], |
916 | d3b4cf9f | Iustin Pop | "iallocator": "dumb" |
917 | d3b4cf9f | Iustin Pop | }, |
918 | d3b4cf9f | Iustin Pop | "instance5": { |
919 | d3b4cf9f | Iustin Pop | "template": "drbd", |
920 | d3b4cf9f | Iustin Pop | "os": "debootstrap", |
921 | d3b4cf9f | Iustin Pop | "disk_size": ["25G"], |
922 | d3b4cf9f | Iustin Pop | "iallocator": "dumb", |
923 | d3b4cf9f | Iustin Pop | "hypervisor": "xen-hvm", |
924 | d3b4cf9f | Iustin Pop | "hvparams": {"acpi": true}, |
925 | d3b4cf9f | Iustin Pop | "backend": {"memory": 512} |
926 | d3b4cf9f | Iustin Pop | } |
927 | d3b4cf9f | Iustin Pop | } |
928 | d3b4cf9f | Iustin Pop | </screen> |
929 | d3b4cf9f | Iustin Pop | </para> |
930 | d3b4cf9f | Iustin Pop | |
931 | d3b4cf9f | Iustin Pop | <para> |
932 | d3b4cf9f | Iustin Pop | The command will display the job id for each submitted instance, as follows: |
933 | d3b4cf9f | Iustin Pop | <screen> |
934 | d3b4cf9f | Iustin Pop | # gnt-instance batch-create instances.json |
935 | d3b4cf9f | Iustin Pop | instance3: 11224 |
936 | d3b4cf9f | Iustin Pop | instance5: 11225 |
937 | d3b4cf9f | Iustin Pop | </screen> |
938 | d3b4cf9f | Iustin Pop | </para> |
939 | d3b4cf9f | Iustin Pop | |
940 | d3b4cf9f | Iustin Pop | </refsect3> |
941 | d3b4cf9f | Iustin Pop | |
942 | d3b4cf9f | Iustin Pop | <refsect3> |
943 | a8083063 | Iustin Pop | <title>REMOVE</title> |
944 | a8083063 | Iustin Pop | |
945 | a8083063 | Iustin Pop | <cmdsynopsis> |
946 | a8083063 | Iustin Pop | <command>remove</command> |
947 | 1d67656e | Iustin Pop | <arg>--ignore-failures</arg> |
948 | 1e2c9fd3 | Guido Trotter | <arg>--shutdown-timeout=<replaceable>N</replaceable></arg> |
949 | d3b4cf9f | Iustin Pop | <arg>--submit</arg> |
950 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
951 | a8083063 | Iustin Pop | </cmdsynopsis> |
952 | a8083063 | Iustin Pop | |
953 | a8083063 | Iustin Pop | <para> |
954 | a8083063 | Iustin Pop | Remove an instance. This will remove all data from the |
955 | a8083063 | Iustin Pop | instance and there is <emphasis>no way back</emphasis>. If |
956 | a8083063 | Iustin Pop | you are not sure if you use an instance again, use |
957 | a8083063 | Iustin Pop | <command>shutdown</command> first and leave it in the |
958 | a8083063 | Iustin Pop | shutdown state for a while. |
959 | 1d67656e | Iustin Pop | |
960 | 1d67656e | Iustin Pop | </para> |
961 | 1d67656e | Iustin Pop | |
962 | 1d67656e | Iustin Pop | <para> |
963 | 1d67656e | Iustin Pop | The <option>--ignore-failures</option> option will cause the |
964 | 1d67656e | Iustin Pop | removal to proceed even in the presence of errors during the |
965 | 1d67656e | Iustin Pop | removal of the instance (e.g. during the shutdown or the |
966 | 1d67656e | Iustin Pop | disk removal). If this option is not given, the command will |
967 | 1d67656e | Iustin Pop | stop at the first error. |
968 | a8083063 | Iustin Pop | </para> |
969 | a8083063 | Iustin Pop | |
970 | a8083063 | Iustin Pop | <para> |
971 | 1e2c9fd3 | Guido Trotter | The <option>--shutdown-timeout</option> is used to specify how |
972 | 1e2c9fd3 | Guido Trotter | much time to wait before forcing the shutdown (xm destroy in xen, |
973 | 1e2c9fd3 | Guido Trotter | killing the kvm process, for kvm). By default two minutes are |
974 | 1e2c9fd3 | Guido Trotter | given to each instance to stop. |
975 | 1e2c9fd3 | Guido Trotter | </para> |
976 | 1e2c9fd3 | Guido Trotter | |
977 | 1e2c9fd3 | Guido Trotter | <para> |
978 | d3b4cf9f | Iustin Pop | The <option>--submit</option> option is used to send the job to |
979 | d3b4cf9f | Iustin Pop | the master daemon but not wait for its completion. The job |
980 | d3b4cf9f | Iustin Pop | ID will be shown so that it can be examined via |
981 | d3b4cf9f | Iustin Pop | <command>gnt-job info</command>. |
982 | d3b4cf9f | Iustin Pop | </para> |
983 | d3b4cf9f | Iustin Pop | |
984 | d3b4cf9f | Iustin Pop | <para> |
985 | a8083063 | Iustin Pop | Example: |
986 | a8083063 | Iustin Pop | <screen> |
987 | a8083063 | Iustin Pop | # gnt-instance remove instance1.example.com |
988 | a8083063 | Iustin Pop | </screen> |
989 | a8083063 | Iustin Pop | </para> |
990 | a8083063 | Iustin Pop | </refsect3> |
991 | a8083063 | Iustin Pop | |
992 | a8083063 | Iustin Pop | <refsect3> |
993 | a8083063 | Iustin Pop | <title>LIST</title> |
994 | a8083063 | Iustin Pop | |
995 | a8083063 | Iustin Pop | <cmdsynopsis> |
996 | a8083063 | Iustin Pop | <command>list</command> |
997 | a8083063 | Iustin Pop | <arg>--no-headers</arg> |
998 | a8083063 | Iustin Pop | <arg>--separator=<replaceable>SEPARATOR</replaceable></arg> |
999 | 48c4dfa8 | Iustin Pop | <arg>-o <replaceable>[+]FIELD,...</replaceable></arg> |
1000 | d3b4cf9f | Iustin Pop | <arg rep="repeat">instance</arg> |
1001 | a8083063 | Iustin Pop | </cmdsynopsis> |
1002 | a8083063 | Iustin Pop | |
1003 | a8083063 | Iustin Pop | <para> |
1004 | a8083063 | Iustin Pop | Shows the currently configured instances with memory usage, |
1005 | d3b4cf9f | Iustin Pop | disk usage, the node they are running on, and their run |
1006 | d3b4cf9f | Iustin Pop | status. |
1007 | a8083063 | Iustin Pop | </para> |
1008 | a8083063 | Iustin Pop | |
1009 | a8083063 | Iustin Pop | <para> |
1010 | a8083063 | Iustin Pop | The <option>--no-headers</option> option will skip the |
1011 | a8083063 | Iustin Pop | initial header line. The <option>--separator</option> option |
1012 | a8083063 | Iustin Pop | takes an argument which denotes what will be used between |
1013 | a8083063 | Iustin Pop | the output fields. Both these options are to help scripting. |
1014 | a8083063 | Iustin Pop | </para> |
1015 | a8083063 | Iustin Pop | |
1016 | a8083063 | Iustin Pop | <para> |
1017 | a8083063 | Iustin Pop | The <option>-o</option> option takes a comma-separated list |
1018 | a8083063 | Iustin Pop | of output fields. The available fields and their meaning |
1019 | a8083063 | Iustin Pop | are: |
1020 | a8083063 | Iustin Pop | <variablelist> |
1021 | a8083063 | Iustin Pop | <varlistentry> |
1022 | a8083063 | Iustin Pop | <term>name</term> |
1023 | a8083063 | Iustin Pop | <listitem> |
1024 | a8083063 | Iustin Pop | <simpara>the instance name</simpara> |
1025 | a8083063 | Iustin Pop | </listitem> |
1026 | a8083063 | Iustin Pop | </varlistentry> |
1027 | a8083063 | Iustin Pop | <varlistentry> |
1028 | a8083063 | Iustin Pop | <term>os</term> |
1029 | a8083063 | Iustin Pop | <listitem> |
1030 | a8083063 | Iustin Pop | <simpara>the OS of the instance</simpara> |
1031 | a8083063 | Iustin Pop | </listitem> |
1032 | a8083063 | Iustin Pop | </varlistentry> |
1033 | a8083063 | Iustin Pop | <varlistentry> |
1034 | a8083063 | Iustin Pop | <term>pnode</term> |
1035 | a8083063 | Iustin Pop | <listitem> |
1036 | a8083063 | Iustin Pop | <simpara>the primary node of the instance</simpara> |
1037 | a8083063 | Iustin Pop | </listitem> |
1038 | a8083063 | Iustin Pop | </varlistentry> |
1039 | a8083063 | Iustin Pop | <varlistentry> |
1040 | a8083063 | Iustin Pop | <term>snodes</term> |
1041 | a8083063 | Iustin Pop | <listitem> |
1042 | 4677a909 | Michael Hanselmann | <simpara>comma-separated list of secondary nodes for the |
1043 | a8083063 | Iustin Pop | instance; usually this will be just one node</simpara> |
1044 | a8083063 | Iustin Pop | </listitem> |
1045 | a8083063 | Iustin Pop | </varlistentry> |
1046 | a8083063 | Iustin Pop | <varlistentry> |
1047 | a8083063 | Iustin Pop | <term>admin_state</term> |
1048 | a8083063 | Iustin Pop | <listitem> |
1049 | a8083063 | Iustin Pop | <simpara>the desired state of the instance (either "yes" |
1050 | a8083063 | Iustin Pop | or "no" denoting the instance should run or |
1051 | a8083063 | Iustin Pop | not)</simpara> |
1052 | a8083063 | Iustin Pop | </listitem> |
1053 | a8083063 | Iustin Pop | </varlistentry> |
1054 | a8083063 | Iustin Pop | <varlistentry> |
1055 | a8083063 | Iustin Pop | <term>disk_template</term> |
1056 | a8083063 | Iustin Pop | <listitem> |
1057 | a8083063 | Iustin Pop | <simpara>the disk template of the instance</simpara> |
1058 | a8083063 | Iustin Pop | </listitem> |
1059 | a8083063 | Iustin Pop | </varlistentry> |
1060 | a8083063 | Iustin Pop | <varlistentry> |
1061 | a8083063 | Iustin Pop | <term>oper_state</term> |
1062 | a8083063 | Iustin Pop | <listitem> |
1063 | d8052456 | Iustin Pop | <simpara>the actual state of the instance; can be |
1064 | d8052456 | Iustin Pop | one of the values "running", "stopped", "(node |
1065 | d8052456 | Iustin Pop | down)"</simpara> |
1066 | d8052456 | Iustin Pop | </listitem> |
1067 | d8052456 | Iustin Pop | </varlistentry> |
1068 | d8052456 | Iustin Pop | <varlistentry> |
1069 | d8052456 | Iustin Pop | <term>status</term> |
1070 | d8052456 | Iustin Pop | <listitem> |
1071 | d8052456 | Iustin Pop | <simpara>combined form of admin_state and oper_stat; |
1072 | d8052456 | Iustin Pop | this can be one of: |
1073 | d8052456 | Iustin Pop | <computeroutput>ERROR_nodedown</computeroutput> if the |
1074 | d8052456 | Iustin Pop | node of the instance is down, |
1075 | d8052456 | Iustin Pop | <computeroutput>ERROR_down</computeroutput> if the |
1076 | d8052456 | Iustin Pop | instance should run but is down, |
1077 | d8052456 | Iustin Pop | <computeroutput>ERROR_up</computeroutput> if the |
1078 | d8052456 | Iustin Pop | instance should be stopped but is actually running, |
1079 | d8052456 | Iustin Pop | <computeroutput>ADMIN_down</computeroutput> if the |
1080 | d8052456 | Iustin Pop | instance has been stopped (and is stopped) and |
1081 | d8052456 | Iustin Pop | <computeroutput>running</computeroutput> if the |
1082 | d8052456 | Iustin Pop | instance is set to be running (and is |
1083 | d8052456 | Iustin Pop | running)</simpara> |
1084 | a8083063 | Iustin Pop | </listitem> |
1085 | a8083063 | Iustin Pop | </varlistentry> |
1086 | a8083063 | Iustin Pop | <varlistentry> |
1087 | a8083063 | Iustin Pop | <term>oper_ram</term> |
1088 | a8083063 | Iustin Pop | <listitem> |
1089 | a8083063 | Iustin Pop | <simpara>the actual memory usage of the instance as seen |
1090 | a8083063 | Iustin Pop | by the hypervisor</simpara> |
1091 | a8083063 | Iustin Pop | </listitem> |
1092 | a8083063 | Iustin Pop | </varlistentry> |
1093 | a8083063 | Iustin Pop | <varlistentry> |
1094 | a8083063 | Iustin Pop | <term>ip</term> |
1095 | a8083063 | Iustin Pop | <listitem> |
1096 | a8083063 | Iustin Pop | <simpara>the ip address ganeti recognizes as associated with |
1097 | d3b4cf9f | Iustin Pop | the first instance interface</simpara> |
1098 | a8083063 | Iustin Pop | </listitem> |
1099 | a8083063 | Iustin Pop | </varlistentry> |
1100 | a8083063 | Iustin Pop | <varlistentry> |
1101 | a8083063 | Iustin Pop | <term>mac</term> |
1102 | a8083063 | Iustin Pop | <listitem> |
1103 | d3b4cf9f | Iustin Pop | <simpara>the first instance interface MAC address</simpara> |
1104 | a8083063 | Iustin Pop | </listitem> |
1105 | a8083063 | Iustin Pop | </varlistentry> |
1106 | 7d713344 | Guido Trotter | |
1107 | 7d713344 | Guido Trotter | <varlistentry> |
1108 | 8619a3bd | Guido Trotter | <term>nic_mode</term> |
1109 | 7d713344 | Guido Trotter | <listitem> |
1110 | 7d713344 | Guido Trotter | <simpara>the mode of the first instance NIC |
1111 | 7d713344 | Guido Trotter | (routed or bridged)</simpara> |
1112 | 7d713344 | Guido Trotter | </listitem> |
1113 | 7d713344 | Guido Trotter | </varlistentry> |
1114 | a8083063 | Iustin Pop | <varlistentry> |
1115 | 8619a3bd | Guido Trotter | <term>nic_link</term> |
1116 | a8083063 | Iustin Pop | <listitem> |
1117 | 7d713344 | Guido Trotter | <simpara>the link of the first instance NIC |
1118 | a8083063 | Iustin Pop | </simpara> |
1119 | a8083063 | Iustin Pop | </listitem> |
1120 | a8083063 | Iustin Pop | </varlistentry> |
1121 | d8a4b51d | Iustin Pop | <varlistentry> |
1122 | d8a4b51d | Iustin Pop | <term>sda_size</term> |
1123 | d8a4b51d | Iustin Pop | <listitem> |
1124 | d8a4b51d | Iustin Pop | <simpara>the size of the instance's first disk</simpara> |
1125 | d8a4b51d | Iustin Pop | </listitem> |
1126 | d8a4b51d | Iustin Pop | </varlistentry> |
1127 | d8a4b51d | Iustin Pop | <varlistentry> |
1128 | d8a4b51d | Iustin Pop | <term>sdb_size</term> |
1129 | d8a4b51d | Iustin Pop | <listitem> |
1130 | d3b4cf9f | Iustin Pop | <simpara>the size of the instance's second disk, if |
1131 | d3b4cf9f | Iustin Pop | any</simpara> |
1132 | d8a4b51d | Iustin Pop | </listitem> |
1133 | d8a4b51d | Iustin Pop | </varlistentry> |
1134 | d8a4b51d | Iustin Pop | <varlistentry> |
1135 | d8a4b51d | Iustin Pop | <term>vcpus</term> |
1136 | d8a4b51d | Iustin Pop | <listitem> |
1137 | d8a4b51d | Iustin Pop | <simpara>the number of VCPUs allocated to the |
1138 | d8a4b51d | Iustin Pop | instance</simpara> |
1139 | d8a4b51d | Iustin Pop | </listitem> |
1140 | d8a4b51d | Iustin Pop | </varlistentry> |
1141 | 130a6a6f | Iustin Pop | <varlistentry> |
1142 | 130a6a6f | Iustin Pop | <term>tags</term> |
1143 | 130a6a6f | Iustin Pop | <listitem> |
1144 | 130a6a6f | Iustin Pop | <simpara>comma-separated list of the instances's |
1145 | 130a6a6f | Iustin Pop | tags</simpara> |
1146 | 130a6a6f | Iustin Pop | </listitem> |
1147 | 130a6a6f | Iustin Pop | </varlistentry> |
1148 | 38d7239a | Iustin Pop | <varlistentry> |
1149 | 38d7239a | Iustin Pop | <term>serial_no</term> |
1150 | 38d7239a | Iustin Pop | <listitem> |
1151 | 38d7239a | Iustin Pop | <simpara>the so called 'serial number' of the |
1152 | 38d7239a | Iustin Pop | instance; this is a numeric field that is incremented |
1153 | 38d7239a | Iustin Pop | each time the instance is modified, and it can be used |
1154 | d3b4cf9f | Iustin Pop | to track modifications</simpara> |
1155 | d3b4cf9f | Iustin Pop | </listitem> |
1156 | d3b4cf9f | Iustin Pop | </varlistentry> |
1157 | edc8fc5f | Iustin Pop | <varlistentry> |
1158 | edc8fc5f | Iustin Pop | <term>ctime</term> |
1159 | edc8fc5f | Iustin Pop | <listitem> |
1160 | edc8fc5f | Iustin Pop | <para> |
1161 | edc8fc5f | Iustin Pop | the creation time of the instance; note that this |
1162 | edc8fc5f | Iustin Pop | field contains spaces and as such it's harder to |
1163 | edc8fc5f | Iustin Pop | parse |
1164 | edc8fc5f | Iustin Pop | </para> |
1165 | edc8fc5f | Iustin Pop | <para> |
1166 | edc8fc5f | Iustin Pop | if this attribute is not present (e.g. when |
1167 | edc8fc5f | Iustin Pop | upgrading from older versions), then "N/A" will be |
1168 | edc8fc5f | Iustin Pop | shown instead |
1169 | edc8fc5f | Iustin Pop | </para> |
1170 | edc8fc5f | Iustin Pop | </listitem> |
1171 | edc8fc5f | Iustin Pop | </varlistentry> |
1172 | edc8fc5f | Iustin Pop | <varlistentry> |
1173 | edc8fc5f | Iustin Pop | <term>mtime</term> |
1174 | edc8fc5f | Iustin Pop | <listitem> |
1175 | edc8fc5f | Iustin Pop | <para> |
1176 | edc8fc5f | Iustin Pop | the last modification time of the instance; note |
1177 | edc8fc5f | Iustin Pop | that this field contains spaces and as such it's |
1178 | edc8fc5f | Iustin Pop | harder to parse |
1179 | edc8fc5f | Iustin Pop | </para> |
1180 | edc8fc5f | Iustin Pop | <para> |
1181 | edc8fc5f | Iustin Pop | if this attribute is not present (e.g. when |
1182 | edc8fc5f | Iustin Pop | upgrading from older versions), then "N/A" will be |
1183 | edc8fc5f | Iustin Pop | shown instead |
1184 | edc8fc5f | Iustin Pop | </para> |
1185 | edc8fc5f | Iustin Pop | </listitem> |
1186 | edc8fc5f | Iustin Pop | </varlistentry> |
1187 | edc8fc5f | Iustin Pop | |
1188 | edc8fc5f | Iustin Pop | <varlistentry> |
1189 | edc8fc5f | Iustin Pop | <term>uuid</term> |
1190 | edc8fc5f | Iustin Pop | <listitem> |
1191 | edc8fc5f | Iustin Pop | <simpara>Show the UUID of the instance (generated |
1192 | edc8fc5f | Iustin Pop | automatically by Ganeti)</simpara> |
1193 | edc8fc5f | Iustin Pop | </listitem> |
1194 | edc8fc5f | Iustin Pop | </varlistentry> |
1195 | 90f72445 | Iustin Pop | |
1196 | d3b4cf9f | Iustin Pop | <varlistentry> |
1197 | d3b4cf9f | Iustin Pop | <term>network_port</term> |
1198 | d3b4cf9f | Iustin Pop | <listitem> |
1199 | d3b4cf9f | Iustin Pop | <simpara>If the instance has a network port assigned |
1200 | d3b4cf9f | Iustin Pop | to it (e.g. for VNC connections), this will be shown, |
1201 | d3b4cf9f | Iustin Pop | otherwise <literal>-</literal> will be |
1202 | d3b4cf9f | Iustin Pop | displayed.</simpara> |
1203 | d3b4cf9f | Iustin Pop | </listitem> |
1204 | d3b4cf9f | Iustin Pop | </varlistentry> |
1205 | d3b4cf9f | Iustin Pop | <varlistentry> |
1206 | d3b4cf9f | Iustin Pop | <term>beparams</term> |
1207 | d3b4cf9f | Iustin Pop | <listitem> |
1208 | d3b4cf9f | Iustin Pop | <simpara>A text format of the entire beparams for the |
1209 | d3b4cf9f | Iustin Pop | instance. It's more useful to select individual fields |
1210 | d3b4cf9f | Iustin Pop | from this dictionary, see below.</simpara> |
1211 | d3b4cf9f | Iustin Pop | </listitem> |
1212 | d3b4cf9f | Iustin Pop | </varlistentry> |
1213 | d3b4cf9f | Iustin Pop | <varlistentry> |
1214 | d3b4cf9f | Iustin Pop | <term>disk.count</term> |
1215 | d3b4cf9f | Iustin Pop | <listitem> |
1216 | d3b4cf9f | Iustin Pop | <simpara>The number of instance disks.</simpara> |
1217 | d3b4cf9f | Iustin Pop | </listitem> |
1218 | d3b4cf9f | Iustin Pop | </varlistentry> |
1219 | d3b4cf9f | Iustin Pop | <varlistentry> |
1220 | d3b4cf9f | Iustin Pop | <term>disk.size/N</term> |
1221 | d3b4cf9f | Iustin Pop | <listitem> |
1222 | d3b4cf9f | Iustin Pop | <simpara>The size of the instance's Nth disk. This is |
1223 | d3b4cf9f | Iustin Pop | a more generic form of the <literal>sda_size</literal> |
1224 | d3b4cf9f | Iustin Pop | and <literal>sdb_size</literal> fields.</simpara> |
1225 | d3b4cf9f | Iustin Pop | </listitem> |
1226 | d3b4cf9f | Iustin Pop | </varlistentry> |
1227 | d3b4cf9f | Iustin Pop | <varlistentry> |
1228 | d3b4cf9f | Iustin Pop | <term>disk.sizes</term> |
1229 | d3b4cf9f | Iustin Pop | <listitem> |
1230 | d3b4cf9f | Iustin Pop | <simpara>A comma-separated list of the disk sizes for |
1231 | d3b4cf9f | Iustin Pop | this instance.</simpara> |
1232 | d3b4cf9f | Iustin Pop | </listitem> |
1233 | d3b4cf9f | Iustin Pop | </varlistentry> |
1234 | d3b4cf9f | Iustin Pop | <varlistentry> |
1235 | d3b4cf9f | Iustin Pop | <term>disk_usage</term> |
1236 | d3b4cf9f | Iustin Pop | <listitem> |
1237 | d3b4cf9f | Iustin Pop | <simpara>The total disk space used by this instance on |
1238 | d3b4cf9f | Iustin Pop | each of its nodes. This is not the instance-visible |
1239 | d3b4cf9f | Iustin Pop | disk size, but the actual disk "cost" of the |
1240 | d3b4cf9f | Iustin Pop | instance.</simpara> |
1241 | d3b4cf9f | Iustin Pop | </listitem> |
1242 | d3b4cf9f | Iustin Pop | </varlistentry> |
1243 | d3b4cf9f | Iustin Pop | <varlistentry> |
1244 | d3b4cf9f | Iustin Pop | <term>nic.mac/N</term> |
1245 | d3b4cf9f | Iustin Pop | <listitem> |
1246 | d3b4cf9f | Iustin Pop | <simpara>The MAC of the Nth instance NIC.</simpara> |
1247 | d3b4cf9f | Iustin Pop | </listitem> |
1248 | d3b4cf9f | Iustin Pop | </varlistentry> |
1249 | d3b4cf9f | Iustin Pop | <varlistentry> |
1250 | d3b4cf9f | Iustin Pop | <term>nic.ip/N</term> |
1251 | d3b4cf9f | Iustin Pop | <listitem> |
1252 | d3b4cf9f | Iustin Pop | <simpara>The IP address of the Nth instance NIC.</simpara> |
1253 | d3b4cf9f | Iustin Pop | </listitem> |
1254 | d3b4cf9f | Iustin Pop | </varlistentry> |
1255 | d3b4cf9f | Iustin Pop | <varlistentry> |
1256 | 7d713344 | Guido Trotter | <term>nic.mode/N</term> |
1257 | d3b4cf9f | Iustin Pop | <listitem> |
1258 | 7d713344 | Guido Trotter | <simpara>The mode of the Nth instance NIC</simpara> |
1259 | 7d713344 | Guido Trotter | </listitem> |
1260 | 7d713344 | Guido Trotter | </varlistentry> |
1261 | 7d713344 | Guido Trotter | <varlistentry> |
1262 | 7d713344 | Guido Trotter | <term>nic.link/N</term> |
1263 | 7d713344 | Guido Trotter | <listitem> |
1264 | 7d713344 | Guido Trotter | <simpara>The link of the Nth instance NIC</simpara> |
1265 | d3b4cf9f | Iustin Pop | </listitem> |
1266 | d3b4cf9f | Iustin Pop | </varlistentry> |
1267 | d3b4cf9f | Iustin Pop | <varlistentry> |
1268 | d3b4cf9f | Iustin Pop | <term>nic.macs</term> |
1269 | d3b4cf9f | Iustin Pop | <listitem> |
1270 | d3b4cf9f | Iustin Pop | <simpara>A comma-separated list of all the MACs of the |
1271 | d3b4cf9f | Iustin Pop | instance's NICs.</simpara> |
1272 | d3b4cf9f | Iustin Pop | </listitem> |
1273 | d3b4cf9f | Iustin Pop | </varlistentry> |
1274 | d3b4cf9f | Iustin Pop | <varlistentry> |
1275 | d3b4cf9f | Iustin Pop | <term>nic.ips</term> |
1276 | d3b4cf9f | Iustin Pop | <listitem> |
1277 | d3b4cf9f | Iustin Pop | <simpara>A comma-separated list of all the IP |
1278 | d3b4cf9f | Iustin Pop | addresses of the instance's NICs.</simpara> |
1279 | d3b4cf9f | Iustin Pop | </listitem> |
1280 | d3b4cf9f | Iustin Pop | </varlistentry> |
1281 | d3b4cf9f | Iustin Pop | <varlistentry> |
1282 | 7d713344 | Guido Trotter | <term>nic.modes</term> |
1283 | d3b4cf9f | Iustin Pop | <listitem> |
1284 | 7d713344 | Guido Trotter | <simpara>A comma-separated list of all the modes of the |
1285 | d3b4cf9f | Iustin Pop | instance's NICs.</simpara> |
1286 | d3b4cf9f | Iustin Pop | </listitem> |
1287 | d3b4cf9f | Iustin Pop | </varlistentry> |
1288 | d3b4cf9f | Iustin Pop | <varlistentry> |
1289 | 7d713344 | Guido Trotter | <term>nic.links</term> |
1290 | 7d713344 | Guido Trotter | <listitem> |
1291 | 7d713344 | Guido Trotter | <simpara>A comma-separated list of all the link parameters |
1292 | 7d713344 | Guido Trotter | of the instance's NICs.</simpara> |
1293 | 7d713344 | Guido Trotter | </listitem> |
1294 | 7d713344 | Guido Trotter | </varlistentry> |
1295 | 7d713344 | Guido Trotter | <varlistentry> |
1296 | d3b4cf9f | Iustin Pop | <term>nic.count</term> |
1297 | d3b4cf9f | Iustin Pop | <listitem> |
1298 | d3b4cf9f | Iustin Pop | <simpara>The number of instance nics.</simpara> |
1299 | d3b4cf9f | Iustin Pop | </listitem> |
1300 | d3b4cf9f | Iustin Pop | </varlistentry> |
1301 | d3b4cf9f | Iustin Pop | <varlistentry> |
1302 | d3b4cf9f | Iustin Pop | <term>hv/<replaceable>NAME</replaceable></term> |
1303 | d3b4cf9f | Iustin Pop | <listitem> |
1304 | d3b4cf9f | Iustin Pop | <simpara>The value of the hypervisor parameter called |
1305 | d3b4cf9f | Iustin Pop | <replaceable>NAME</replaceable>. For details of what |
1306 | d3b4cf9f | Iustin Pop | hypervisor parameters exist and their meaning, see the |
1307 | d3b4cf9f | Iustin Pop | <command>add</command> command.</simpara> |
1308 | d3b4cf9f | Iustin Pop | </listitem> |
1309 | d3b4cf9f | Iustin Pop | </varlistentry> |
1310 | d3b4cf9f | Iustin Pop | <varlistentry> |
1311 | d3b4cf9f | Iustin Pop | <term>be/memory</term> |
1312 | d3b4cf9f | Iustin Pop | <listitem> |
1313 | d3b4cf9f | Iustin Pop | <simpara>The configured memory for the instance.</simpara> |
1314 | d3b4cf9f | Iustin Pop | </listitem> |
1315 | d3b4cf9f | Iustin Pop | </varlistentry> |
1316 | d3b4cf9f | Iustin Pop | <varlistentry> |
1317 | d3b4cf9f | Iustin Pop | <term>be/vcpus</term> |
1318 | d3b4cf9f | Iustin Pop | <listitem> |
1319 | d3b4cf9f | Iustin Pop | <simpara>The configured number of VCPUs for the |
1320 | d3b4cf9f | Iustin Pop | instance.</simpara> |
1321 | d3b4cf9f | Iustin Pop | </listitem> |
1322 | d3b4cf9f | Iustin Pop | </varlistentry> |
1323 | d3b4cf9f | Iustin Pop | <varlistentry> |
1324 | d3b4cf9f | Iustin Pop | <term>be/auto_balance</term> |
1325 | d3b4cf9f | Iustin Pop | <listitem> |
1326 | d3b4cf9f | Iustin Pop | <simpara>Whether the instance is considered in N+1 |
1327 | d3b4cf9f | Iustin Pop | checks.</simpara> |
1328 | 38d7239a | Iustin Pop | </listitem> |
1329 | 38d7239a | Iustin Pop | </varlistentry> |
1330 | a8083063 | Iustin Pop | </variablelist> |
1331 | a8083063 | Iustin Pop | </para> |
1332 | a8083063 | Iustin Pop | |
1333 | a8083063 | Iustin Pop | <para> |
1334 | 48c4dfa8 | Iustin Pop | If the value of the option starts with the character |
1335 | d3b4cf9f | Iustin Pop | <constant>+</constant>, the new field(s) will be added to the |
1336 | 48c4dfa8 | Iustin Pop | default list. This allows to quickly see the default list |
1337 | 48c4dfa8 | Iustin Pop | plus a few other fields, instead of retyping the entire list |
1338 | 48c4dfa8 | Iustin Pop | of fields. |
1339 | 48c4dfa8 | Iustin Pop | </para> |
1340 | 48c4dfa8 | Iustin Pop | |
1341 | 48c4dfa8 | Iustin Pop | <para> |
1342 | a8083063 | Iustin Pop | There is a subtle grouping about the available output |
1343 | 872c949f | Iustin Pop | fields: all fields except for <option>oper_state</option>, |
1344 | 872c949f | Iustin Pop | <option>oper_ram</option> and <option>status</option> are |
1345 | 872c949f | Iustin Pop | configuration value and not run-time values. So if you don't |
1346 | 872c949f | Iustin Pop | select any of the these fields, the query will be satisfied |
1347 | a8083063 | Iustin Pop | instantly from the cluster configuration, without having to |
1348 | a8083063 | Iustin Pop | ask the remote nodes for the data. This can be helpful for |
1349 | a8083063 | Iustin Pop | big clusters when you only want some data and it makes sense |
1350 | a8083063 | Iustin Pop | to specify a reduced set of output fields. |
1351 | a8083063 | Iustin Pop | </para> |
1352 | a8083063 | Iustin Pop | |
1353 | a8083063 | Iustin Pop | <para>The default output field list is: |
1354 | a8083063 | Iustin Pop | <simplelist type="inline"> |
1355 | a8083063 | Iustin Pop | <member>name</member> |
1356 | a8083063 | Iustin Pop | <member>os</member> |
1357 | a8083063 | Iustin Pop | <member>pnode</member> |
1358 | a8083063 | Iustin Pop | <member>admin_state</member> |
1359 | a8083063 | Iustin Pop | <member>oper_state</member> |
1360 | a8083063 | Iustin Pop | <member>oper_ram</member> |
1361 | a8083063 | Iustin Pop | </simplelist>. |
1362 | a8083063 | Iustin Pop | </para> |
1363 | a8083063 | Iustin Pop | </refsect3> |
1364 | a8083063 | Iustin Pop | |
1365 | a8083063 | Iustin Pop | <refsect3> |
1366 | a8083063 | Iustin Pop | <title>INFO</title> |
1367 | a8083063 | Iustin Pop | |
1368 | a8083063 | Iustin Pop | <cmdsynopsis> |
1369 | a8083063 | Iustin Pop | <command>info</command> |
1370 | 57821cac | Iustin Pop | <group> |
1371 | 57821cac | Iustin Pop | <arg>-s</arg> |
1372 | 57821cac | Iustin Pop | <arg>--static</arg> |
1373 | 57821cac | Iustin Pop | </group> |
1374 | d09ebf6f | Guido Trotter | <group choice="req"> |
1375 | d09ebf6f | Guido Trotter | <arg>--all</arg> |
1376 | d09ebf6f | Guido Trotter | <arg rep="repeat"><replaceable>instance</replaceable></arg> |
1377 | d09ebf6f | Guido Trotter | </group> |
1378 | a8083063 | Iustin Pop | </cmdsynopsis> |
1379 | a8083063 | Iustin Pop | |
1380 | a8083063 | Iustin Pop | <para> |
1381 | d09ebf6f | Guido Trotter | Show detailed information about the given instance(s). This is |
1382 | d09ebf6f | Guido Trotter | different from <command>list</command> as it shows detailed data |
1383 | d04aaa2f | Iustin Pop | about the instance's disks (especially useful for the drbd disk |
1384 | d09ebf6f | Guido Trotter | template). |
1385 | a8083063 | Iustin Pop | </para> |
1386 | 57821cac | Iustin Pop | |
1387 | 57821cac | Iustin Pop | <para> |
1388 | 57821cac | Iustin Pop | If the option <option>-s</option> is used, only information |
1389 | 57821cac | Iustin Pop | available in the configuration file is returned, without |
1390 | 57821cac | Iustin Pop | querying nodes, making the operation faster. |
1391 | 57821cac | Iustin Pop | </para> |
1392 | d09ebf6f | Guido Trotter | |
1393 | d09ebf6f | Guido Trotter | <para> |
1394 | d09ebf6f | Guido Trotter | Use the <option>--all</option> to get info about all instances, |
1395 | ba0b05fe | Iustin Pop | rather than explicitly passing the ones you're interested in. |
1396 | d09ebf6f | Guido Trotter | </para> |
1397 | a8083063 | Iustin Pop | </refsect3> |
1398 | a8083063 | Iustin Pop | |
1399 | a8083063 | Iustin Pop | <refsect3> |
1400 | a8083063 | Iustin Pop | <title>MODIFY</title> |
1401 | a8083063 | Iustin Pop | |
1402 | a8083063 | Iustin Pop | <cmdsynopsis> |
1403 | a8083063 | Iustin Pop | <command>modify</command> |
1404 | 00f98619 | Iustin Pop | <sbr> |
1405 | d3b4cf9f | Iustin Pop | <arg choice="opt">-H <replaceable>HYPERVISOR_PARAMETERS</replaceable></arg> |
1406 | d3b4cf9f | Iustin Pop | <sbr> |
1407 | d3b4cf9f | Iustin Pop | <arg choice="opt">-B <replaceable>BACKEND_PARAMETERS</replaceable></arg> |
1408 | d3b4cf9f | Iustin Pop | <sbr> |
1409 | d3b4cf9f | Iustin Pop | <group> |
1410 | d3b4cf9f | Iustin Pop | <arg>--net add<replaceable><optional>:options</optional></replaceable></arg> |
1411 | d3b4cf9f | Iustin Pop | <arg>--net remove</arg> |
1412 | d3b4cf9f | Iustin Pop | <arg>--net <replaceable>N:options</replaceable></arg> |
1413 | d3b4cf9f | Iustin Pop | </group> |
1414 | d3b4cf9f | Iustin Pop | <sbr> |
1415 | d3b4cf9f | Iustin Pop | <group> |
1416 | d3b4cf9f | Iustin Pop | <arg>--disk add:size=<replaceable>SIZE</replaceable></arg> |
1417 | d3b4cf9f | Iustin Pop | <arg>--disk remove</arg> |
1418 | d3b4cf9f | Iustin Pop | <arg>--disk <replaceable>N</replaceable>:mode=<replaceable>MODE</replaceable></arg> |
1419 | d3b4cf9f | Iustin Pop | </group> |
1420 | d3b4cf9f | Iustin Pop | |
1421 | 00f98619 | Iustin Pop | <sbr> |
1422 | bbf74a76 | Iustin Pop | <arg>-t<group choice="req"> |
1423 | bbf74a76 | Iustin Pop | <arg>plain</arg> |
1424 | bbf74a76 | Iustin Pop | <arg>drbd</arg> |
1425 | bbf74a76 | Iustin Pop | </group></arg> |
1426 | bbf74a76 | Iustin Pop | |
1427 | 96b39bcc | Iustin Pop | <sbr> |
1428 | 96b39bcc | Iustin Pop | <arg>--os-name=<replaceable>OS</replaceable> <arg>--force-variant</arg></arg> |
1429 | bbf74a76 | Iustin Pop | |
1430 | bbf74a76 | Iustin Pop | <sbr> |
1431 | d3b4cf9f | Iustin Pop | <arg>--submit</arg> |
1432 | 00f98619 | Iustin Pop | <sbr> |
1433 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
1434 | a8083063 | Iustin Pop | </cmdsynopsis> |
1435 | a8083063 | Iustin Pop | |
1436 | a8083063 | Iustin Pop | <para> |
1437 | d3b4cf9f | Iustin Pop | Modifies the memory size, number of vcpus, ip address, MAC |
1438 | 7d713344 | Guido Trotter | address and/or nic parameters for an instance. It can also |
1439 | 7d713344 | Guido Trotter | add and remove disks and NICs to/from the instance. Note |
1440 | 7d713344 | Guido Trotter | that you need to give at least one of the arguments, otherwise |
1441 | 7d713344 | Guido Trotter | the command complains. |
1442 | a8083063 | Iustin Pop | </para> |
1443 | a8083063 | Iustin Pop | |
1444 | a8083063 | Iustin Pop | <para> |
1445 | d3b4cf9f | Iustin Pop | The <option>-H</option> option specifies hypervisor options |
1446 | d3b4cf9f | Iustin Pop | in the form of <userinput>name=value[,...]</userinput>. For details which options can be specified, see the <command>add</command> command. |
1447 | a8083063 | Iustin Pop | </para> |
1448 | a8083063 | Iustin Pop | |
1449 | a8083063 | Iustin Pop | <para> |
1450 | bbf74a76 | Iustin Pop | The <option>-t</option> option will change the disk template |
1451 | bbf74a76 | Iustin Pop | of the instance. Currently only conversions between the |
1452 | bbf74a76 | Iustin Pop | plain and drbd disk templates are supported, and the |
1453 | bbf74a76 | Iustin Pop | instance must be stopped before attempting the conversion. |
1454 | bbf74a76 | Iustin Pop | </para> |
1455 | bbf74a76 | Iustin Pop | |
1456 | bbf74a76 | Iustin Pop | <para> |
1457 | d3b4cf9f | Iustin Pop | The <option>--disk |
1458 | d3b4cf9f | Iustin Pop | add:size=<replaceable>SIZE</replaceable></option> option |
1459 | d3b4cf9f | Iustin Pop | adds a disk to the instance. The <option>--disk |
1460 | d3b4cf9f | Iustin Pop | remove</option> will remove the last disk of the |
1461 | d3b4cf9f | Iustin Pop | instance. The <option>--disk |
1462 | d3b4cf9f | Iustin Pop | <replaceable>N</replaceable>:mode=<replaceable>MODE</replaceable></option> |
1463 | d3b4cf9f | Iustin Pop | option will change the mode of the Nth disk of the instance |
1464 | d3b4cf9f | Iustin Pop | between read-only (<literal>ro</literal>) and read-write |
1465 | d3b4cf9f | Iustin Pop | (<literal>rw</literal>). |
1466 | 00f98619 | Iustin Pop | </para> |
1467 | 00f98619 | Iustin Pop | |
1468 | 00f98619 | Iustin Pop | <para> |
1469 | 091c2c64 | Guido Trotter | The <option>--net |
1470 | d3b4cf9f | Iustin Pop | add:<replaceable>options</replaceable></option> option will |
1471 | d3b4cf9f | Iustin Pop | add a new NIC to the instance. The available options are the |
1472 | 7d713344 | Guido Trotter | same as in the <command>add</command> command (mac, ip, link, |
1473 | 7d713344 | Guido Trotter | mode). The <option>--net remove</option> will remove the |
1474 | 091c2c64 | Guido Trotter | last NIC of the instance, while the <option>--net |
1475 | d3b4cf9f | Iustin Pop | <replaceable>N</replaceable>:<replaceable>options</replaceable></option> |
1476 | d3b4cf9f | Iustin Pop | option will change the parameters of the Nth instance NIC. |
1477 | 25c5878d | Alexander Schreiber | </para> |
1478 | 25c5878d | Alexander Schreiber | |
1479 | 25c5878d | Alexander Schreiber | <para> |
1480 | 96b39bcc | Iustin Pop | The option <option>--os-name</option> will change the OS |
1481 | 96b39bcc | Iustin Pop | name for the instance (without reinstallation). In case an |
1482 | 96b39bcc | Iustin Pop | OS variant is specified that is not found, then by default |
1483 | 96b39bcc | Iustin Pop | the modification is refused, |
1484 | 96b39bcc | Iustin Pop | unless <option>--force-variant</option> is passed. An |
1485 | 96b39bcc | Iustin Pop | invalid OS will also be refused, unless |
1486 | 96b39bcc | Iustin Pop | the <option>--force</option> option is given. |
1487 | 96b39bcc | Iustin Pop | </para> |
1488 | 96b39bcc | Iustin Pop | |
1489 | 96b39bcc | Iustin Pop | <para> |
1490 | d3b4cf9f | Iustin Pop | The <option>--submit</option> option is used to send the job to |
1491 | d3b4cf9f | Iustin Pop | the master daemon but not wait for its completion. The job |
1492 | d3b4cf9f | Iustin Pop | ID will be shown so that it can be examined via |
1493 | d3b4cf9f | Iustin Pop | <command>gnt-job info</command>. |
1494 | ca9c49d5 | Iustin Pop | </para> |
1495 | ca9c49d5 | Iustin Pop | |
1496 | ca9c49d5 | Iustin Pop | <para> |
1497 | a8083063 | Iustin Pop | All the changes take effect at the next restart. If the |
1498 | a8083063 | Iustin Pop | instance is running, there is no effect on the instance. |
1499 | a8083063 | Iustin Pop | </para> |
1500 | a8083063 | Iustin Pop | </refsect3> |
1501 | a8083063 | Iustin Pop | |
1502 | d0834de3 | Michael Hanselmann | <refsect3> |
1503 | d0834de3 | Michael Hanselmann | <title>REINSTALL</title> |
1504 | d0834de3 | Michael Hanselmann | |
1505 | d0834de3 | Michael Hanselmann | <cmdsynopsis> |
1506 | d0834de3 | Michael Hanselmann | <command>reinstall</command> |
1507 | d0834de3 | Michael Hanselmann | <arg choice="opt">-o <replaceable>os-type</replaceable></arg> |
1508 | 20e23543 | Alexander Schreiber | <arg>--select-os</arg> |
1509 | 55efe6da | Iustin Pop | <arg choice="opt">-f <replaceable>force</replaceable></arg> |
1510 | 55efe6da | Iustin Pop | <arg>--force-multiple</arg> |
1511 | 55efe6da | Iustin Pop | <sbr> |
1512 | 55efe6da | Iustin Pop | <group choice="opt"> |
1513 | 55efe6da | Iustin Pop | <arg>--instance</arg> |
1514 | 55efe6da | Iustin Pop | <arg>--node</arg> |
1515 | 55efe6da | Iustin Pop | <arg>--primary</arg> |
1516 | 55efe6da | Iustin Pop | <arg>--secondary</arg> |
1517 | 55efe6da | Iustin Pop | <arg>--all</arg> |
1518 | 55efe6da | Iustin Pop | </group> |
1519 | d3b4cf9f | Iustin Pop | <arg>--submit</arg> |
1520 | 55efe6da | Iustin Pop | <arg choice="opt" rep="repeat"><replaceable>instance</replaceable></arg> |
1521 | d0834de3 | Michael Hanselmann | </cmdsynopsis> |
1522 | d0834de3 | Michael Hanselmann | |
1523 | d0834de3 | Michael Hanselmann | <para> |
1524 | 55efe6da | Iustin Pop | Reinstalls the operating system on the given instance(s). The |
1525 | 55efe6da | Iustin Pop | instance(s) must be stopped when running this command. If the |
1526 | 949bdabe | Iustin Pop | <option>--os-type</option> is specified, the operating |
1527 | 949bdabe | Iustin Pop | system is changed. |
1528 | 949bdabe | Iustin Pop | </para> |
1529 | 949bdabe | Iustin Pop | |
1530 | 949bdabe | Iustin Pop | <para> |
1531 | 20e23543 | Alexander Schreiber | The <option>--select-os</option> option switches to an |
1532 | 20e23543 | Alexander Schreiber | interactive OS reinstall. The user is prompted to select the OS |
1533 | 20e23543 | Alexander Schreiber | template from the list of available OS templates. |
1534 | 20e23543 | Alexander Schreiber | </para> |
1535 | d3b4cf9f | Iustin Pop | |
1536 | d3b4cf9f | Iustin Pop | <para> |
1537 | 55efe6da | Iustin Pop | Since this is a potentially dangerous command, the user will |
1538 | 55efe6da | Iustin Pop | be required to confirm this action, unless the |
1539 | 55efe6da | Iustin Pop | <option>-f</option> flag is passed. When multiple instances |
1540 | 55efe6da | Iustin Pop | are selected (either by passing multiple arguments or by |
1541 | 55efe6da | Iustin Pop | using the <option>--node</option>, |
1542 | 55efe6da | Iustin Pop | <option>--primary</option>, <option>--secondary</option> or |
1543 | 55efe6da | Iustin Pop | <option>--all</option> options), the user must pass both the |
1544 | 55efe6da | Iustin Pop | <option>--force</option> and |
1545 | 55efe6da | Iustin Pop | <option>--force-multiple</option> options to skip the |
1546 | 55efe6da | Iustin Pop | interactive confirmation. |
1547 | 55efe6da | Iustin Pop | </para> |
1548 | 55efe6da | Iustin Pop | |
1549 | 55efe6da | Iustin Pop | <para> |
1550 | d3b4cf9f | Iustin Pop | The <option>--submit</option> option is used to send the job to |
1551 | d3b4cf9f | Iustin Pop | the master daemon but not wait for its completion. The job |
1552 | d3b4cf9f | Iustin Pop | ID will be shown so that it can be examined via |
1553 | d3b4cf9f | Iustin Pop | <command>gnt-job info</command>. |
1554 | d3b4cf9f | Iustin Pop | </para> |
1555 | d3b4cf9f | Iustin Pop | |
1556 | d3b4cf9f | Iustin Pop | |
1557 | d0834de3 | Michael Hanselmann | </refsect3> |
1558 | d0834de3 | Michael Hanselmann | |
1559 | decd5f45 | Iustin Pop | <refsect3> |
1560 | decd5f45 | Iustin Pop | <title>RENAME</title> |
1561 | decd5f45 | Iustin Pop | |
1562 | decd5f45 | Iustin Pop | <cmdsynopsis> |
1563 | decd5f45 | Iustin Pop | <command>rename</command> |
1564 | decd5f45 | Iustin Pop | <arg>--no-ip-check</arg> |
1565 | d3b4cf9f | Iustin Pop | <arg>--submit</arg> |
1566 | decd5f45 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
1567 | decd5f45 | Iustin Pop | <arg choice="req"><replaceable>new_name</replaceable></arg> |
1568 | decd5f45 | Iustin Pop | </cmdsynopsis> |
1569 | decd5f45 | Iustin Pop | |
1570 | decd5f45 | Iustin Pop | <para> |
1571 | decd5f45 | Iustin Pop | Renames the given instance. The instance must be stopped |
1572 | decd5f45 | Iustin Pop | when running this command. The requirements for the new name |
1573 | decd5f45 | Iustin Pop | are the same as for adding an instance: the new name must be |
1574 | decd5f45 | Iustin Pop | resolvable and the IP it resolves to must not be reachable |
1575 | decd5f45 | Iustin Pop | (in order to prevent duplicate IPs the next time the |
1576 | decd5f45 | Iustin Pop | instance is started). The IP test can be skipped if the |
1577 | decd5f45 | Iustin Pop | <option>--no-ip-check</option> option is passed. |
1578 | decd5f45 | Iustin Pop | </para> |
1579 | d3b4cf9f | Iustin Pop | |
1580 | d3b4cf9f | Iustin Pop | <para> |
1581 | d3b4cf9f | Iustin Pop | The <option>--submit</option> option is used to send the job to |
1582 | d3b4cf9f | Iustin Pop | the master daemon but not wait for its completion. The job |
1583 | d3b4cf9f | Iustin Pop | ID will be shown so that it can be examined via |
1584 | d3b4cf9f | Iustin Pop | <command>gnt-job info</command>. |
1585 | d3b4cf9f | Iustin Pop | </para> |
1586 | d3b4cf9f | Iustin Pop | |
1587 | decd5f45 | Iustin Pop | </refsect3> |
1588 | decd5f45 | Iustin Pop | |
1589 | a8083063 | Iustin Pop | </refsect2> |
1590 | a8083063 | Iustin Pop | |
1591 | a8083063 | Iustin Pop | <refsect2> |
1592 | a8083063 | Iustin Pop | <title>Starting/stopping/connecting to console</title> |
1593 | a8083063 | Iustin Pop | |
1594 | a8083063 | Iustin Pop | <refsect3> |
1595 | a8083063 | Iustin Pop | <title>STARTUP</title> |
1596 | a8083063 | Iustin Pop | |
1597 | a8083063 | Iustin Pop | <cmdsynopsis> |
1598 | a8083063 | Iustin Pop | <command>startup</command> |
1599 | d3b4cf9f | Iustin Pop | <sbr> |
1600 | 3bd5f059 | Michael Hanselmann | <arg>--force</arg> |
1601 | 312ac745 | Iustin Pop | <sbr> |
1602 | d3b4cf9f | Iustin Pop | <arg>--force-multiple</arg> |
1603 | d3b4cf9f | Iustin Pop | <sbr> |
1604 | 312ac745 | Iustin Pop | <group choice="opt"> |
1605 | 312ac745 | Iustin Pop | <arg>--instance</arg> |
1606 | 312ac745 | Iustin Pop | <arg>--node</arg> |
1607 | 312ac745 | Iustin Pop | <arg>--primary</arg> |
1608 | 312ac745 | Iustin Pop | <arg>--secondary</arg> |
1609 | 312ac745 | Iustin Pop | <arg>--all</arg> |
1610 | c7c568b4 | René Nussbaumer | <arg>--tags</arg> |
1611 | c7c568b4 | René Nussbaumer | <arg>--node-tags</arg> |
1612 | c7c568b4 | René Nussbaumer | <arg>--pri-node-tags</arg> |
1613 | c7c568b4 | René Nussbaumer | <arg>--sec-node-tags</arg> |
1614 | 312ac745 | Iustin Pop | </group> |
1615 | 312ac745 | Iustin Pop | <sbr> |
1616 | d04aaa2f | Iustin Pop | <arg>-H <option>key=value...</option></arg> |
1617 | d04aaa2f | Iustin Pop | <arg>-B <option>key=value...</option></arg> |
1618 | d04aaa2f | Iustin Pop | <sbr> |
1619 | d3b4cf9f | Iustin Pop | <arg>--submit</arg> |
1620 | d3b4cf9f | Iustin Pop | <sbr> |
1621 | 312ac745 | Iustin Pop | <arg choice="opt" |
1622 | 312ac745 | Iustin Pop | rep="repeat"><replaceable>name</replaceable></arg> |
1623 | a8083063 | Iustin Pop | </cmdsynopsis> |
1624 | a8083063 | Iustin Pop | |
1625 | a8083063 | Iustin Pop | <para> |
1626 | bcee9cb4 | Iustin Pop | Starts one or more instances, depending on the following |
1627 | bcee9cb4 | Iustin Pop | options. The four available modes are: |
1628 | 312ac745 | Iustin Pop | <variablelist> |
1629 | 312ac745 | Iustin Pop | <varlistentry> |
1630 | 312ac745 | Iustin Pop | <term><option>--instance</option></term> |
1631 | 312ac745 | Iustin Pop | <listitem> |
1632 | 312ac745 | Iustin Pop | <simpara>will start the instances given as arguments |
1633 | 312ac745 | Iustin Pop | (at least one argument required); this is the default |
1634 | 312ac745 | Iustin Pop | selection</simpara> |
1635 | 312ac745 | Iustin Pop | </listitem> |
1636 | 312ac745 | Iustin Pop | </varlistentry> |
1637 | 312ac745 | Iustin Pop | <varlistentry> |
1638 | 312ac745 | Iustin Pop | <term>--node</term> |
1639 | 312ac745 | Iustin Pop | <listitem> |
1640 | 312ac745 | Iustin Pop | <simpara>will start the instances who have the given |
1641 | 312ac745 | Iustin Pop | node as either primary or secondary</simpara> |
1642 | 312ac745 | Iustin Pop | </listitem> |
1643 | 312ac745 | Iustin Pop | </varlistentry> |
1644 | 312ac745 | Iustin Pop | <varlistentry> |
1645 | 312ac745 | Iustin Pop | <term><option>--primary</option></term> |
1646 | 312ac745 | Iustin Pop | <listitem> |
1647 | 312ac745 | Iustin Pop | <simpara>will start all instances whose primary node |
1648 | 312ac745 | Iustin Pop | is in the list of nodes passed as arguments (at least |
1649 | 312ac745 | Iustin Pop | one node required)</simpara> |
1650 | 312ac745 | Iustin Pop | </listitem> |
1651 | 312ac745 | Iustin Pop | </varlistentry> |
1652 | 312ac745 | Iustin Pop | <varlistentry> |
1653 | 312ac745 | Iustin Pop | <term><option>--secondary</option></term> |
1654 | 312ac745 | Iustin Pop | <listitem> |
1655 | 312ac745 | Iustin Pop | <simpara>will start all instances whose secondary node |
1656 | 312ac745 | Iustin Pop | is in the list of nodes passed as arguments (at least |
1657 | 312ac745 | Iustin Pop | one node required)</simpara> |
1658 | 312ac745 | Iustin Pop | </listitem> |
1659 | 312ac745 | Iustin Pop | </varlistentry> |
1660 | 312ac745 | Iustin Pop | <varlistentry> |
1661 | 312ac745 | Iustin Pop | <term>--all</term> |
1662 | 312ac745 | Iustin Pop | <listitem> |
1663 | 312ac745 | Iustin Pop | <simpara>will start all instances in the cluster (no |
1664 | 312ac745 | Iustin Pop | arguments accepted)</simpara> |
1665 | 312ac745 | Iustin Pop | </listitem> |
1666 | 312ac745 | Iustin Pop | </varlistentry> |
1667 | c7c568b4 | René Nussbaumer | <varlistentry> |
1668 | c7c568b4 | René Nussbaumer | <term>--tags</term> |
1669 | c7c568b4 | René Nussbaumer | <listitem> |
1670 | c7c568b4 | René Nussbaumer | <simpara>will start all instances in the cluster with |
1671 | c7c568b4 | René Nussbaumer | the tags given as arguments</simpara> |
1672 | c7c568b4 | René Nussbaumer | </listitem> |
1673 | c7c568b4 | René Nussbaumer | </varlistentry> |
1674 | c7c568b4 | René Nussbaumer | <varlistentry> |
1675 | c7c568b4 | René Nussbaumer | <term>--node-tags</term> |
1676 | c7c568b4 | René Nussbaumer | <listitem> |
1677 | c7c568b4 | René Nussbaumer | <simpara>will start all instances in the cluster on |
1678 | c7c568b4 | René Nussbaumer | nodes with the tags given as arguments</simpara> |
1679 | c7c568b4 | René Nussbaumer | </listitem> |
1680 | c7c568b4 | René Nussbaumer | </varlistentry> |
1681 | c7c568b4 | René Nussbaumer | <varlistentry> |
1682 | c7c568b4 | René Nussbaumer | <term>--pri-node-tags</term> |
1683 | c7c568b4 | René Nussbaumer | <listitem> |
1684 | c7c568b4 | René Nussbaumer | <simpara>will start all instances in the cluster on |
1685 | c7c568b4 | René Nussbaumer | primary nodes with the tags given as |
1686 | c7c568b4 | René Nussbaumer | arguments</simpara> |
1687 | c7c568b4 | René Nussbaumer | </listitem> |
1688 | c7c568b4 | René Nussbaumer | </varlistentry> |
1689 | c7c568b4 | René Nussbaumer | <varlistentry> |
1690 | c7c568b4 | René Nussbaumer | <term>--sec-node-tags</term> |
1691 | c7c568b4 | René Nussbaumer | <listitem> |
1692 | c7c568b4 | René Nussbaumer | <simpara>will start all instances in the cluster on |
1693 | c7c568b4 | René Nussbaumer | secondary nodes with the tags given as |
1694 | c7c568b4 | René Nussbaumer | arguments</simpara> |
1695 | c7c568b4 | René Nussbaumer | </listitem> |
1696 | c7c568b4 | René Nussbaumer | </varlistentry> |
1697 | 312ac745 | Iustin Pop | </variablelist> |
1698 | 312ac745 | Iustin Pop | </para> |
1699 | 312ac745 | Iustin Pop | |
1700 | 312ac745 | Iustin Pop | <para> |
1701 | bcee9cb4 | Iustin Pop | Note that although you can pass more than one selection |
1702 | bcee9cb4 | Iustin Pop | option, the last one wins, so in order to guarantee the |
1703 | bcee9cb4 | Iustin Pop | desired result, don't pass more than one such option. |
1704 | a8083063 | Iustin Pop | </para> |
1705 | a8083063 | Iustin Pop | |
1706 | a8083063 | Iustin Pop | <para> |
1707 | 3bd5f059 | Michael Hanselmann | Use <option>--force</option> to start even if secondary disks are |
1708 | 3bd5f059 | Michael Hanselmann | failing. |
1709 | 3bd5f059 | Michael Hanselmann | </para> |
1710 | a8083063 | Iustin Pop | |
1711 | a8083063 | Iustin Pop | <para> |
1712 | d3b4cf9f | Iustin Pop | The <option>--force-multiple</option> will skip the |
1713 | d3b4cf9f | Iustin Pop | interactive confirmation in the case the more than one |
1714 | d3b4cf9f | Iustin Pop | instance will be affected. |
1715 | d3b4cf9f | Iustin Pop | </para> |
1716 | d3b4cf9f | Iustin Pop | |
1717 | d3b4cf9f | Iustin Pop | <para> |
1718 | d04aaa2f | Iustin Pop | The <option>-H</option> and <option>-B</option> options |
1719 | 20b1bd80 | Iustin Pop | specify temporary hypervisor and backend parameters that can |
1720 | 20b1bd80 | Iustin Pop | be used to start an instance with modified parameters. They |
1721 | 20b1bd80 | Iustin Pop | can be useful for quick testing without having to modify an |
1722 | 20b1bd80 | Iustin Pop | instance back and forth, e.g.: |
1723 | d04aaa2f | Iustin Pop | <screen> |
1724 | d04aaa2f | Iustin Pop | # gnt-instance start -H root_args="single" instance1 |
1725 | d04aaa2f | Iustin Pop | # gnt-instance start -B memory=2048 instance2 |
1726 | d04aaa2f | Iustin Pop | </screen> |
1727 | d04aaa2f | Iustin Pop | The first form will start the instance |
1728 | d04aaa2f | Iustin Pop | <userinput>instance1</userinput> in single-user mode, and |
1729 | d04aaa2f | Iustin Pop | the instance <userinput>instance2</userinput> with 2GB of |
1730 | d04aaa2f | Iustin Pop | RAM (this time only, unless that is the actual instance |
1731 | 20b1bd80 | Iustin Pop | memory size already). Note that the values override the |
1732 | 20b1bd80 | Iustin Pop | instance parameters (and not extend them): an instance with |
1733 | 20b1bd80 | Iustin Pop | "root_args=ro" when started with <userinput>-H |
1734 | 20b1bd80 | Iustin Pop | root_args=single</userinput> will result in "single", not |
1735 | 20b1bd80 | Iustin Pop | "ro single". |
1736 | d04aaa2f | Iustin Pop | </para> |
1737 | d04aaa2f | Iustin Pop | |
1738 | d04aaa2f | Iustin Pop | <para> |
1739 | d3b4cf9f | Iustin Pop | The <option>--submit</option> option is used to send the job to |
1740 | d3b4cf9f | Iustin Pop | the master daemon but not wait for its completion. The job |
1741 | d3b4cf9f | Iustin Pop | ID will be shown so that it can be examined via |
1742 | d3b4cf9f | Iustin Pop | <command>gnt-job info</command>. |
1743 | d3b4cf9f | Iustin Pop | </para> |
1744 | d3b4cf9f | Iustin Pop | |
1745 | d3b4cf9f | Iustin Pop | <para> |
1746 | a8083063 | Iustin Pop | Example: |
1747 | a8083063 | Iustin Pop | <screen> |
1748 | a8083063 | Iustin Pop | # gnt-instance start instance1.example.com |
1749 | bcee9cb4 | Iustin Pop | # gnt-instance start --node node1.example.com node2.example.com |
1750 | bcee9cb4 | Iustin Pop | # gnt-instance start --all |
1751 | a8083063 | Iustin Pop | </screen> |
1752 | a8083063 | Iustin Pop | </para> |
1753 | a8083063 | Iustin Pop | </refsect3> |
1754 | a8083063 | Iustin Pop | |
1755 | a8083063 | Iustin Pop | <refsect3> |
1756 | a8083063 | Iustin Pop | <title>SHUTDOWN</title> |
1757 | a8083063 | Iustin Pop | |
1758 | a8083063 | Iustin Pop | <cmdsynopsis> |
1759 | a8083063 | Iustin Pop | <command>shutdown</command> |
1760 | 312ac745 | Iustin Pop | <sbr> |
1761 | 95a5d0fb | Guido Trotter | <arg>--timeout=<replaceable>N</replaceable></arg> |
1762 | 95a5d0fb | Guido Trotter | <sbr> |
1763 | d3b4cf9f | Iustin Pop | <arg>--force-multiple</arg> |
1764 | d3b4cf9f | Iustin Pop | <sbr> |
1765 | 312ac745 | Iustin Pop | <group choice="opt"> |
1766 | 312ac745 | Iustin Pop | <arg>--instance</arg> |
1767 | 312ac745 | Iustin Pop | <arg>--node</arg> |
1768 | 312ac745 | Iustin Pop | <arg>--primary</arg> |
1769 | 312ac745 | Iustin Pop | <arg>--secondary</arg> |
1770 | 312ac745 | Iustin Pop | <arg>--all</arg> |
1771 | c7c568b4 | René Nussbaumer | <arg>--tags</arg> |
1772 | c7c568b4 | René Nussbaumer | <arg>--node-tags</arg> |
1773 | c7c568b4 | René Nussbaumer | <arg>--pri-node-tags</arg> |
1774 | c7c568b4 | René Nussbaumer | <arg>--sec-node-tags</arg> |
1775 | 312ac745 | Iustin Pop | </group> |
1776 | 312ac745 | Iustin Pop | <sbr> |
1777 | d3b4cf9f | Iustin Pop | <arg>--submit</arg> |
1778 | d3b4cf9f | Iustin Pop | <sbr> |
1779 | 312ac745 | Iustin Pop | <arg choice="opt" |
1780 | 312ac745 | Iustin Pop | rep="repeat"><replaceable>name</replaceable></arg> |
1781 | a8083063 | Iustin Pop | </cmdsynopsis> |
1782 | a8083063 | Iustin Pop | |
1783 | a8083063 | Iustin Pop | <para> |
1784 | 312ac745 | Iustin Pop | Stops one or more instances. If the instance cannot be |
1785 | 312ac745 | Iustin Pop | cleanly stopped during a hardcoded interval (currently 2 |
1786 | 312ac745 | Iustin Pop | minutes), it will forcibly stop the instance (equivalent to |
1787 | 312ac745 | Iustin Pop | switching off the power on a physical machine). |
1788 | 312ac745 | Iustin Pop | </para> |
1789 | 312ac745 | Iustin Pop | |
1790 | 312ac745 | Iustin Pop | <para> |
1791 | 95a5d0fb | Guido Trotter | The <option>--timeout</option> is used to specify how much time to |
1792 | 95a5d0fb | Guido Trotter | wait before forcing the shutdown (xm destroy in xen, killing the kvm |
1793 | 95a5d0fb | Guido Trotter | process, for kvm). By default two minutes are given to each instance |
1794 | 95a5d0fb | Guido Trotter | to stop. |
1795 | 95a5d0fb | Guido Trotter | </para> |
1796 | 95a5d0fb | Guido Trotter | |
1797 | 95a5d0fb | Guido Trotter | <para> |
1798 | 312ac745 | Iustin Pop | The <option>--instance</option>, <option>--node</option>, |
1799 | c7c568b4 | René Nussbaumer | <option>--primary</option>, <option>--secondary</option>, |
1800 | c7c568b4 | René Nussbaumer | <option>--all</option>, <option>--tags</option>, |
1801 | c7c568b4 | René Nussbaumer | <option>--node-tags</option>, <option>--pri-node-tags</option> and |
1802 | c7c568b4 | René Nussbaumer | <option>--sec-node-tags</option> options are similar as for the |
1803 | 312ac745 | Iustin Pop | <command>startup</command> command and they influence the |
1804 | 86b8c6ae | Alexander Schreiber | actual instances being shutdown. |
1805 | a8083063 | Iustin Pop | </para> |
1806 | a8083063 | Iustin Pop | |
1807 | a8083063 | Iustin Pop | <para> |
1808 | d3b4cf9f | Iustin Pop | The <option>--submit</option> option is used to send the job to |
1809 | d3b4cf9f | Iustin Pop | the master daemon but not wait for its completion. The job |
1810 | d3b4cf9f | Iustin Pop | ID will be shown so that it can be examined via |
1811 | d3b4cf9f | Iustin Pop | <command>gnt-job info</command>. |
1812 | d3b4cf9f | Iustin Pop | </para> |
1813 | d3b4cf9f | Iustin Pop | |
1814 | d3b4cf9f | Iustin Pop | |
1815 | d3b4cf9f | Iustin Pop | <para> |
1816 | a8083063 | Iustin Pop | Example: |
1817 | a8083063 | Iustin Pop | <screen> |
1818 | a8083063 | Iustin Pop | # gnt-instance shutdown instance1.example.com |
1819 | bcee9cb4 | Iustin Pop | # gnt-instance shutdown --all |
1820 | a8083063 | Iustin Pop | </screen> |
1821 | a8083063 | Iustin Pop | </para> |
1822 | a8083063 | Iustin Pop | </refsect3> |
1823 | a8083063 | Iustin Pop | |
1824 | a8083063 | Iustin Pop | <refsect3> |
1825 | 579d4337 | Alexander Schreiber | <title>REBOOT</title> |
1826 | 579d4337 | Alexander Schreiber | |
1827 | 579d4337 | Alexander Schreiber | <cmdsynopsis> |
1828 | 579d4337 | Alexander Schreiber | <command>reboot</command> |
1829 | 579d4337 | Alexander Schreiber | <sbr> |
1830 | 579d4337 | Alexander Schreiber | <arg>--type=<replaceable>REBOOT-TYPE</replaceable></arg> |
1831 | 579d4337 | Alexander Schreiber | <sbr> |
1832 | 579d4337 | Alexander Schreiber | <arg>--ignore-secondaries</arg> |
1833 | 579d4337 | Alexander Schreiber | <sbr> |
1834 | 1e2c9fd3 | Guido Trotter | <arg>--shutdown-timeout=<replaceable>N</replaceable></arg> |
1835 | 1e2c9fd3 | Guido Trotter | <sbr> |
1836 | 579d4337 | Alexander Schreiber | <arg>--force-multiple</arg> |
1837 | 579d4337 | Alexander Schreiber | <sbr> |
1838 | 579d4337 | Alexander Schreiber | <group choice="opt"> |
1839 | 579d4337 | Alexander Schreiber | <arg>--instance</arg> |
1840 | 579d4337 | Alexander Schreiber | <arg>--node</arg> |
1841 | 579d4337 | Alexander Schreiber | <arg>--primary</arg> |
1842 | 579d4337 | Alexander Schreiber | <arg>--secondary</arg> |
1843 | 579d4337 | Alexander Schreiber | <arg>--all</arg> |
1844 | c7c568b4 | René Nussbaumer | <arg>--tags</arg> |
1845 | c7c568b4 | René Nussbaumer | <arg>--node-tags</arg> |
1846 | c7c568b4 | René Nussbaumer | <arg>--pri-node-tags</arg> |
1847 | c7c568b4 | René Nussbaumer | <arg>--sec-node-tags</arg> |
1848 | 579d4337 | Alexander Schreiber | </group> |
1849 | 579d4337 | Alexander Schreiber | <sbr> |
1850 | d3b4cf9f | Iustin Pop | <arg>--submit</arg> |
1851 | d3b4cf9f | Iustin Pop | <sbr> |
1852 | 579d4337 | Alexander Schreiber | <arg choice="opt" |
1853 | 579d4337 | Alexander Schreiber | rep="repeat"><replaceable>name</replaceable></arg> |
1854 | 579d4337 | Alexander Schreiber | </cmdsynopsis> |
1855 | 579d4337 | Alexander Schreiber | |
1856 | 579d4337 | Alexander Schreiber | <para> |
1857 | 579d4337 | Alexander Schreiber | Reboots one or more instances. The type of reboot depends on |
1858 | 579d4337 | Alexander Schreiber | the value of <option>--type</option>. A soft reboot does a |
1859 | 579d4337 | Alexander Schreiber | hypervisor reboot, a hard reboot does a instance stop, |
1860 | 579d4337 | Alexander Schreiber | recreates the hypervisor config for the instance and |
1861 | 579d4337 | Alexander Schreiber | starts the instance. A full reboot does the equivalent |
1862 | 579d4337 | Alexander Schreiber | of <command>gnt-instance shutdown && gnt-instance |
1863 | bf2fd71e | Alexander Schreiber | startup</command>. The default is hard reboot. |
1864 | 579d4337 | Alexander Schreiber | </para> |
1865 | 579d4337 | Alexander Schreiber | |
1866 | 579d4337 | Alexander Schreiber | <para> |
1867 | 579d4337 | Alexander Schreiber | For the hard reboot the option |
1868 | 579d4337 | Alexander Schreiber | <option>--ignore-secondaries</option> ignores errors for the |
1869 | 579d4337 | Alexander Schreiber | secondary node while re-assembling the instance disks. |
1870 | 579d4337 | Alexander Schreiber | </para> |
1871 | 579d4337 | Alexander Schreiber | |
1872 | 579d4337 | Alexander Schreiber | <para> |
1873 | 579d4337 | Alexander Schreiber | The <option>--instance</option>, <option>--node</option>, |
1874 | c7c568b4 | René Nussbaumer | <option>--primary</option>, <option>--secondary</option>, |
1875 | c7c568b4 | René Nussbaumer | <option>--all</option>, <option>--tags</option>, |
1876 | c7c568b4 | René Nussbaumer | <option>--node-tags</option>, <option>--pri-node-tags</option> and |
1877 | c7c568b4 | René Nussbaumer | <option>--sec-node-tags</option> options are similar as for the |
1878 | 579d4337 | Alexander Schreiber | <command>startup</command> command and they influence the |
1879 | 579d4337 | Alexander Schreiber | actual instances being rebooted. |
1880 | 579d4337 | Alexander Schreiber | </para> |
1881 | 36c87212 | Iustin Pop | |
1882 | 579d4337 | Alexander Schreiber | <para> |
1883 | 1e2c9fd3 | Guido Trotter | The <option>--shutdown-timeout</option> is used to specify how |
1884 | 1e2c9fd3 | Guido Trotter | much time to wait before forcing the shutdown (xm destroy in xen, |
1885 | 1e2c9fd3 | Guido Trotter | killing the kvm process, for kvm). By default two minutes are |
1886 | 1e2c9fd3 | Guido Trotter | given to each instance to stop. |
1887 | 1e2c9fd3 | Guido Trotter | </para> |
1888 | 1e2c9fd3 | Guido Trotter | |
1889 | 1e2c9fd3 | Guido Trotter | <para> |
1890 | d3b4cf9f | Iustin Pop | The <option>--force-multiple</option> will skip the |
1891 | d3b4cf9f | Iustin Pop | interactive confirmation in the case the more than one |
1892 | d3b4cf9f | Iustin Pop | instance will be affected. |
1893 | 579d4337 | Alexander Schreiber | </para> |
1894 | 579d4337 | Alexander Schreiber | |
1895 | 579d4337 | Alexander Schreiber | <para> |
1896 | 579d4337 | Alexander Schreiber | Example: |
1897 | 579d4337 | Alexander Schreiber | <screen> |
1898 | 579d4337 | Alexander Schreiber | # gnt-instance reboot instance1.example.com |
1899 | 579d4337 | Alexander Schreiber | # gnt-instance reboot --type=full instance1.example.com |
1900 | 579d4337 | Alexander Schreiber | </screen> |
1901 | 579d4337 | Alexander Schreiber | </para> |
1902 | 579d4337 | Alexander Schreiber | </refsect3> |
1903 | 579d4337 | Alexander Schreiber | |
1904 | 579d4337 | Alexander Schreiber | <refsect3> |
1905 | a8083063 | Iustin Pop | <title>CONSOLE</title> |
1906 | a8083063 | Iustin Pop | <cmdsynopsis> |
1907 | a8083063 | Iustin Pop | <command>console</command> |
1908 | 51c6e7b5 | Michael Hanselmann | <arg choice="opt">--show-cmd</arg> |
1909 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
1910 | a8083063 | Iustin Pop | </cmdsynopsis> |
1911 | a8083063 | Iustin Pop | |
1912 | a8083063 | Iustin Pop | <para> |
1913 | d3b4cf9f | Iustin Pop | Connects to the console of the given instance. If the |
1914 | d3b4cf9f | Iustin Pop | instance is not up, an error is returned. Use the |
1915 | d3b4cf9f | Iustin Pop | <option>--show-cmd</option> option to display the command |
1916 | d3b4cf9f | Iustin Pop | instead of executing it. |
1917 | a8083063 | Iustin Pop | </para> |
1918 | a8083063 | Iustin Pop | |
1919 | a8083063 | Iustin Pop | <para> |
1920 | d3b4cf9f | Iustin Pop | For HVM instances, this will attempt to connect to the |
1921 | d3b4cf9f | Iustin Pop | serial console of the instance. To connect to the |
1922 | d3b4cf9f | Iustin Pop | virtualized "physical" console of a HVM instance, use a VNC |
1923 | d3b4cf9f | Iustin Pop | client with the connection info from the |
1924 | d3b4cf9f | Iustin Pop | <command>info</command> command. |
1925 | 16034f1f | Alexander Schreiber | </para> |
1926 | 16034f1f | Alexander Schreiber | |
1927 | 16034f1f | Alexander Schreiber | <para> |
1928 | a8083063 | Iustin Pop | Example: |
1929 | a8083063 | Iustin Pop | <screen> |
1930 | a8083063 | Iustin Pop | # gnt-instance console instance1.example.com |
1931 | a8083063 | Iustin Pop | </screen> |
1932 | a8083063 | Iustin Pop | </para> |
1933 | a8083063 | Iustin Pop | </refsect3> |
1934 | a8083063 | Iustin Pop | |
1935 | a8083063 | Iustin Pop | </refsect2> |
1936 | a8083063 | Iustin Pop | |
1937 | a8083063 | Iustin Pop | <refsect2> |
1938 | a8083063 | Iustin Pop | <title>Disk management</title> |
1939 | a8083063 | Iustin Pop | |
1940 | a8083063 | Iustin Pop | <refsect3> |
1941 | a8083063 | Iustin Pop | <title>REPLACE-DISKS</title> |
1942 | a8083063 | Iustin Pop | |
1943 | a8083063 | Iustin Pop | <cmdsynopsis> |
1944 | a8083063 | Iustin Pop | <command>replace-disks</command> |
1945 | d3b4cf9f | Iustin Pop | <arg>--submit</arg> |
1946 | 7ea7bcf6 | Iustin Pop | <arg>--early-release</arg> |
1947 | 7e9366f7 | Iustin Pop | <arg choice="req">-p</arg> |
1948 | 949bdabe | Iustin Pop | <arg>--disks <replaceable>idx</replaceable></arg> |
1949 | 7e9366f7 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
1950 | 7e9366f7 | Iustin Pop | </cmdsynopsis> |
1951 | a53a1b18 | Michael Hanselmann | |
1952 | 7e9366f7 | Iustin Pop | <cmdsynopsis> |
1953 | 7e9366f7 | Iustin Pop | <command>replace-disks</command> |
1954 | d3b4cf9f | Iustin Pop | <arg>--submit</arg> |
1955 | 7ea7bcf6 | Iustin Pop | <arg>--early-release</arg> |
1956 | 7e9366f7 | Iustin Pop | <arg choice="req">-s</arg> |
1957 | 949bdabe | Iustin Pop | <arg>--disks <replaceable>idx</replaceable></arg> |
1958 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
1959 | a8083063 | Iustin Pop | </cmdsynopsis> |
1960 | a8083063 | Iustin Pop | |
1961 | 0b0dea6a | Iustin Pop | <cmdsynopsis> |
1962 | 0b0dea6a | Iustin Pop | <command>replace-disks</command> |
1963 | d3b4cf9f | Iustin Pop | <arg>--submit</arg> |
1964 | 7ea7bcf6 | Iustin Pop | <arg>--early-release</arg> |
1965 | 7e9366f7 | Iustin Pop | <group choice="req"> |
1966 | 7e9366f7 | Iustin Pop | <arg>--iallocator <replaceable>name</replaceable></arg> |
1967 | 7e9366f7 | Iustin Pop | <arg>--new-secondary <replaceable>NODE</replaceable></arg> |
1968 | 0b0dea6a | Iustin Pop | </group> |
1969 | 7e9366f7 | Iustin Pop | |
1970 | 0b0dea6a | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
1971 | 0b0dea6a | Iustin Pop | </cmdsynopsis> |
1972 | 0b0dea6a | Iustin Pop | |
1973 | 05d47e33 | Michael Hanselmann | <cmdsynopsis> |
1974 | 05d47e33 | Michael Hanselmann | <command>replace-disks</command> |
1975 | 05d47e33 | Michael Hanselmann | <arg>--submit</arg> |
1976 | 7ea7bcf6 | Iustin Pop | <arg>--early-release</arg> |
1977 | 05d47e33 | Michael Hanselmann | <arg choice="req">--auto</arg> |
1978 | 05d47e33 | Michael Hanselmann | <arg choice="req"><replaceable>instance</replaceable></arg> |
1979 | 05d47e33 | Michael Hanselmann | </cmdsynopsis> |
1980 | 05d47e33 | Michael Hanselmann | |
1981 | a8083063 | Iustin Pop | <para> |
1982 | 949bdabe | Iustin Pop | This command is a generalized form for replacing disks. It |
1983 | 949bdabe | Iustin Pop | is currently only valid for the mirrored (DRBD) disk |
1984 | 949bdabe | Iustin Pop | template. |
1985 | a8083063 | Iustin Pop | </para> |
1986 | 0b0dea6a | Iustin Pop | |
1987 | 0b0dea6a | Iustin Pop | <para> |
1988 | 7e9366f7 | Iustin Pop | The first form (when passing the <option>-p</option> option) |
1989 | 7e9366f7 | Iustin Pop | will replace the disks on the primary, while the second form |
1990 | 7e9366f7 | Iustin Pop | (when passing the <option>-s</option> option will replace |
1991 | 949bdabe | Iustin Pop | the disks on the secondary node. For these two cases (as the |
1992 | 949bdabe | Iustin Pop | node doesn't change), it is possible to only run the replace |
1993 | 949bdabe | Iustin Pop | for a subset of the disks, using the option |
1994 | 949bdabe | Iustin Pop | <option>--disks</option> which takes a list of |
1995 | 949bdabe | Iustin Pop | comma-delimited disk indices (zero-based), |
1996 | 949bdabe | Iustin Pop | e.g. <userinput>0,2</userinput> to replace only the first |
1997 | 949bdabe | Iustin Pop | and third disks. |
1998 | 0b0dea6a | Iustin Pop | </para> |
1999 | 0b0dea6a | Iustin Pop | |
2000 | a53a1b18 | Michael Hanselmann | <para> |
2001 | 7e9366f7 | Iustin Pop | The third form (when passing either the |
2002 | 7e9366f7 | Iustin Pop | <option>--iallocator</option> or the |
2003 | 7e9366f7 | Iustin Pop | <option>--new-secondary</option> option) is designed to |
2004 | 7e9366f7 | Iustin Pop | change secondary node of the instance. Specifying |
2005 | 7e9366f7 | Iustin Pop | <option>--iallocator</option> makes the new secondary be |
2006 | 7e9366f7 | Iustin Pop | selected automatically by the specified allocator plugin, |
2007 | 7e9366f7 | Iustin Pop | otherwise the new secondary node will be the one chosen |
2008 | 7e9366f7 | Iustin Pop | manually via the <option>--new-secondary</option> option. |
2009 | a53a1b18 | Michael Hanselmann | </para> |
2010 | d3b4cf9f | Iustin Pop | |
2011 | d3b4cf9f | Iustin Pop | <para> |
2012 | 05d47e33 | Michael Hanselmann | The fourth form (when using <option>--auto</option>) will |
2013 | 05d47e33 | Michael Hanselmann | automatically determine which disks of an instance are faulty and |
2014 | 05d47e33 | Michael Hanselmann | replace them within the same node. The <option>--auto</option> |
2015 | 05d47e33 | Michael Hanselmann | option works only when an instance has only faulty disks on |
2016 | 05d47e33 | Michael Hanselmann | either the primary or secondary node; it doesn't work when |
2017 | 05d47e33 | Michael Hanselmann | both sides have faulty disks. |
2018 | 05d47e33 | Michael Hanselmann | </para> |
2019 | 05d47e33 | Michael Hanselmann | |
2020 | 05d47e33 | Michael Hanselmann | <para> |
2021 | d3b4cf9f | Iustin Pop | The <option>--submit</option> option is used to send the job to |
2022 | d3b4cf9f | Iustin Pop | the master daemon but not wait for its completion. The job |
2023 | d3b4cf9f | Iustin Pop | ID will be shown so that it can be examined via |
2024 | d3b4cf9f | Iustin Pop | <command>gnt-job info</command>. |
2025 | d3b4cf9f | Iustin Pop | </para> |
2026 | d3b4cf9f | Iustin Pop | |
2027 | d3b4cf9f | Iustin Pop | <para> |
2028 | 7ea7bcf6 | Iustin Pop | The <option>--early-release</option> changes the code so |
2029 | 7ea7bcf6 | Iustin Pop | that the old storage on secondary node(s) is removed early |
2030 | 7ea7bcf6 | Iustin Pop | (before the resync is completed) and the internal Ganeti |
2031 | 7ea7bcf6 | Iustin Pop | locks for the current (and new, if any) secondary node are |
2032 | 7ea7bcf6 | Iustin Pop | also released, thus allowing more parallelism in the cluster |
2033 | 7ea7bcf6 | Iustin Pop | operation. This should be used only when recovering from a |
2034 | 7ea7bcf6 | Iustin Pop | disk failure on the current secondary (thus the old storage |
2035 | 7ea7bcf6 | Iustin Pop | is already broken) or when the storage on the primary node |
2036 | 7ea7bcf6 | Iustin Pop | is known to be fine (thus we won't need the old storage for |
2037 | 7ea7bcf6 | Iustin Pop | potential recovery). |
2038 | 7ea7bcf6 | Iustin Pop | </para> |
2039 | 7ea7bcf6 | Iustin Pop | |
2040 | 7ea7bcf6 | Iustin Pop | <para> |
2041 | d3b4cf9f | Iustin Pop | Note that it is not possible to select an offline or drained |
2042 | d3b4cf9f | Iustin Pop | node as a new secondary. |
2043 | d3b4cf9f | Iustin Pop | </para> |
2044 | d3b4cf9f | Iustin Pop | |
2045 | a8083063 | Iustin Pop | </refsect3> |
2046 | a8083063 | Iustin Pop | |
2047 | a8083063 | Iustin Pop | <refsect3> |
2048 | a8083063 | Iustin Pop | <title>ACTIVATE-DISKS</title> |
2049 | a8083063 | Iustin Pop | |
2050 | a8083063 | Iustin Pop | <cmdsynopsis> |
2051 | a8083063 | Iustin Pop | <command>activate-disks</command> |
2052 | d3b4cf9f | Iustin Pop | <arg>--submit</arg> |
2053 | b4ec07f8 | Iustin Pop | <arg>--ignore-size</arg> |
2054 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
2055 | a8083063 | Iustin Pop | </cmdsynopsis> |
2056 | a8083063 | Iustin Pop | <para> |
2057 | a8083063 | Iustin Pop | Activates the block devices of the given instance. If |
2058 | a8083063 | Iustin Pop | successful, the command will show the location and name of |
2059 | a8083063 | Iustin Pop | the block devices: |
2060 | a8083063 | Iustin Pop | <screen> |
2061 | d3b4cf9f | Iustin Pop | node1.example.com:disk/0:/dev/drbd0 |
2062 | d3b4cf9f | Iustin Pop | node1.example.com:disk/1:/dev/drbd1 |
2063 | a8083063 | Iustin Pop | </screen> |
2064 | a8083063 | Iustin Pop | |
2065 | a8083063 | Iustin Pop | In this example, <emphasis>node1.example.com</emphasis> is |
2066 | a8083063 | Iustin Pop | the name of the node on which the devices have been |
2067 | d3b4cf9f | Iustin Pop | activated. The <emphasis>disk/0</emphasis> and |
2068 | d3b4cf9f | Iustin Pop | <emphasis>disk/1</emphasis> are the Ganeti-names of the |
2069 | d3b4cf9f | Iustin Pop | instance disks; how they are visible inside the instance is |
2070 | d3b4cf9f | Iustin Pop | hypervisor-specific. <emphasis>/dev/drbd0</emphasis> and |
2071 | d3b4cf9f | Iustin Pop | <emphasis>/dev/drbd1</emphasis> are the actual block devices |
2072 | d3b4cf9f | Iustin Pop | as visible on the node. |
2073 | d3b4cf9f | Iustin Pop | </para> |
2074 | d3b4cf9f | Iustin Pop | |
2075 | d3b4cf9f | Iustin Pop | <para> |
2076 | d3b4cf9f | Iustin Pop | The <option>--submit</option> option is used to send the job to |
2077 | d3b4cf9f | Iustin Pop | the master daemon but not wait for its completion. The job |
2078 | d3b4cf9f | Iustin Pop | ID will be shown so that it can be examined via |
2079 | d3b4cf9f | Iustin Pop | <command>gnt-job info</command>. |
2080 | a8083063 | Iustin Pop | </para> |
2081 | a8083063 | Iustin Pop | |
2082 | a8083063 | Iustin Pop | <para> |
2083 | b4ec07f8 | Iustin Pop | The <option>--ignore-size</option> option can be used to |
2084 | b4ec07f8 | Iustin Pop | activate disks ignoring the currently configured size in |
2085 | b4ec07f8 | Iustin Pop | Ganeti. This can be used in cases where the configuration |
2086 | b4ec07f8 | Iustin Pop | has gotten out of sync with the real-world (e.g. after a |
2087 | b4ec07f8 | Iustin Pop | partially-failed grow-disk operation or due to rounding in |
2088 | b4ec07f8 | Iustin Pop | LVM devices). This should not be used in normal cases, but |
2089 | b4ec07f8 | Iustin Pop | only when activate-disks fails without it. |
2090 | b4ec07f8 | Iustin Pop | </para> |
2091 | b4ec07f8 | Iustin Pop | |
2092 | b4ec07f8 | Iustin Pop | <para> |
2093 | a8083063 | Iustin Pop | Note that it is safe to run this command while the instance |
2094 | a8083063 | Iustin Pop | is already running. |
2095 | a8083063 | Iustin Pop | </para> |
2096 | a8083063 | Iustin Pop | </refsect3> |
2097 | a8083063 | Iustin Pop | |
2098 | a8083063 | Iustin Pop | <refsect3> |
2099 | a8083063 | Iustin Pop | <title>DEACTIVATE-DISKS</title> |
2100 | a8083063 | Iustin Pop | |
2101 | a8083063 | Iustin Pop | <cmdsynopsis> |
2102 | a8083063 | Iustin Pop | <command>deactivate-disks</command> |
2103 | d3b4cf9f | Iustin Pop | <arg>--submit</arg> |
2104 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
2105 | a8083063 | Iustin Pop | </cmdsynopsis> |
2106 | a8083063 | Iustin Pop | <para> |
2107 | a8083063 | Iustin Pop | De-activates the block devices of the given instance. Note |
2108 | bd028152 | Iustin Pop | that if you run this command for an instance with a drbd |
2109 | bd028152 | Iustin Pop | disk template, while it is running, it will not be able to |
2110 | bd028152 | Iustin Pop | shutdown the block devices on the primary node, but it will |
2111 | bd028152 | Iustin Pop | shutdown the block devices on the secondary nodes, thus |
2112 | bd028152 | Iustin Pop | breaking the replication. |
2113 | a8083063 | Iustin Pop | </para> |
2114 | a8083063 | Iustin Pop | |
2115 | d3b4cf9f | Iustin Pop | <para> |
2116 | d3b4cf9f | Iustin Pop | The <option>--submit</option> option is used to send the job to |
2117 | d3b4cf9f | Iustin Pop | the master daemon but not wait for its completion. The job |
2118 | d3b4cf9f | Iustin Pop | ID will be shown so that it can be examined via |
2119 | d3b4cf9f | Iustin Pop | <command>gnt-job info</command>. |
2120 | d3b4cf9f | Iustin Pop | </para> |
2121 | d3b4cf9f | Iustin Pop | |
2122 | a8083063 | Iustin Pop | </refsect3> |
2123 | a8083063 | Iustin Pop | |
2124 | eb65d354 | Iustin Pop | <refsect3> |
2125 | eb65d354 | Iustin Pop | <title>GROW-DISK</title> |
2126 | eb65d354 | Iustin Pop | <cmdsynopsis> |
2127 | eb65d354 | Iustin Pop | <command>grow-disk</command> |
2128 | 6605411d | Iustin Pop | <arg>--no-wait-for-sync</arg> |
2129 | d3b4cf9f | Iustin Pop | <arg>--submit</arg> |
2130 | eb65d354 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
2131 | eb65d354 | Iustin Pop | <arg choice="req"><replaceable>disk</replaceable></arg> |
2132 | eb65d354 | Iustin Pop | <arg choice="req"><replaceable>amount</replaceable></arg> |
2133 | eb65d354 | Iustin Pop | </cmdsynopsis> |
2134 | eb65d354 | Iustin Pop | |
2135 | eb65d354 | Iustin Pop | <para> |
2136 | eb65d354 | Iustin Pop | Grows an instance's disk. This is only possible for |
2137 | eb65d354 | Iustin Pop | instances having a <literal>plain</literal> or |
2138 | eb65d354 | Iustin Pop | <literal>drbd</literal> disk template. |
2139 | eb65d354 | Iustin Pop | </para> |
2140 | eb65d354 | Iustin Pop | |
2141 | eb65d354 | Iustin Pop | <para> |
2142 | eb65d354 | Iustin Pop | Note that this command only change the block device size; it |
2143 | eb65d354 | Iustin Pop | will not grow the actual filesystems, partitions, etc. that |
2144 | eb65d354 | Iustin Pop | live on that disk. Usually, you will need to: |
2145 | eb65d354 | Iustin Pop | <orderedlist> |
2146 | eb65d354 | Iustin Pop | <listitem> |
2147 | eb65d354 | Iustin Pop | <simpara>use <command>gnt-instance grow-disk</command></simpara> |
2148 | eb65d354 | Iustin Pop | </listitem> |
2149 | eb65d354 | Iustin Pop | <listitem> |
2150 | eb65d354 | Iustin Pop | <simpara>reboot the instance (later, at a convenient |
2151 | eb65d354 | Iustin Pop | time)</simpara> |
2152 | eb65d354 | Iustin Pop | </listitem> |
2153 | eb65d354 | Iustin Pop | <listitem> |
2154 | eb65d354 | Iustin Pop | <simpara>use a filesystem resizer, such as |
2155 | eb65d354 | Iustin Pop | <citerefentry> <refentrytitle>ext2online</refentrytitle> |
2156 | eb65d354 | Iustin Pop | <manvolnum>8</manvolnum> </citerefentry> or |
2157 | eb65d354 | Iustin Pop | <citerefentry> <refentrytitle>xfs_growfs</refentrytitle> |
2158 | eb65d354 | Iustin Pop | <manvolnum>8</manvolnum> </citerefentry> to resize the |
2159 | eb65d354 | Iustin Pop | filesystem, or use <citerefentry> |
2160 | eb65d354 | Iustin Pop | <refentrytitle>fdisk</refentrytitle> |
2161 | eb65d354 | Iustin Pop | <manvolnum>8</manvolnum> </citerefentry> to change the |
2162 | eb65d354 | Iustin Pop | partition table on the disk |
2163 | eb65d354 | Iustin Pop | </simpara> |
2164 | eb65d354 | Iustin Pop | </listitem> |
2165 | eb65d354 | Iustin Pop | </orderedlist> |
2166 | eb65d354 | Iustin Pop | </para> |
2167 | eb65d354 | Iustin Pop | |
2168 | eb65d354 | Iustin Pop | |
2169 | eb65d354 | Iustin Pop | <para> |
2170 | d3b4cf9f | Iustin Pop | The <replaceable>disk</replaceable> argument is the index of |
2171 | d3b4cf9f | Iustin Pop | the instance disk to grow. The |
2172 | eb65d354 | Iustin Pop | <replaceable>amount</replaceable> argument is given either |
2173 | eb65d354 | Iustin Pop | as a number (and it represents the amount to increase the |
2174 | eb65d354 | Iustin Pop | disk with in mebibytes) or can be given similar to the |
2175 | eb65d354 | Iustin Pop | arguments in the create instance operation, with a suffix |
2176 | eb65d354 | Iustin Pop | denoting the unit. |
2177 | eb65d354 | Iustin Pop | </para> |
2178 | eb65d354 | Iustin Pop | |
2179 | eb65d354 | Iustin Pop | <para> |
2180 | eb65d354 | Iustin Pop | Note that the disk grow operation might complete on one node |
2181 | eb65d354 | Iustin Pop | but fail on the other; this will leave the instance with |
2182 | eb65d354 | Iustin Pop | different-sized LVs on the two nodes, but this will not |
2183 | eb65d354 | Iustin Pop | create problems (except for unused space). |
2184 | eb65d354 | Iustin Pop | </para> |
2185 | eb65d354 | Iustin Pop | |
2186 | 6605411d | Iustin Pop | <para> |
2187 | 6605411d | Iustin Pop | If you do not want gnt-instance to wait for the new disk |
2188 | 6605411d | Iustin Pop | region to be synced, use the |
2189 | 6605411d | Iustin Pop | <option>--no-wait-for-sync</option> option. |
2190 | 6605411d | Iustin Pop | </para> |
2191 | 6605411d | Iustin Pop | |
2192 | d3b4cf9f | Iustin Pop | <para> |
2193 | d3b4cf9f | Iustin Pop | The <option>--submit</option> option is used to send the job to |
2194 | d3b4cf9f | Iustin Pop | the master daemon but not wait for its completion. The job |
2195 | d3b4cf9f | Iustin Pop | ID will be shown so that it can be examined via |
2196 | d3b4cf9f | Iustin Pop | <command>gnt-job info</command>. |
2197 | d3b4cf9f | Iustin Pop | </para> |
2198 | d3b4cf9f | Iustin Pop | |
2199 | 6605411d | Iustin Pop | |
2200 | d3b4cf9f | Iustin Pop | <para>Example (increase the first disk for instance1 by 16GiB): |
2201 | eb65d354 | Iustin Pop | <screen> |
2202 | d3b4cf9f | Iustin Pop | # gnt-instance grow-disk instance1.example.com 0 16g |
2203 | eb65d354 | Iustin Pop | </screen> |
2204 | eb65d354 | Iustin Pop | </para> |
2205 | eb65d354 | Iustin Pop | |
2206 | eb65d354 | Iustin Pop | <para> |
2207 | d3b4cf9f | Iustin Pop | Also note that disk shrinking is not supported; use |
2208 | eb65d354 | Iustin Pop | <command>gnt-backup export</command> and then |
2209 | eb65d354 | Iustin Pop | <command>gnt-backup import</command> to reduce the disk size |
2210 | eb65d354 | Iustin Pop | of an instance. |
2211 | eb65d354 | Iustin Pop | </para> |
2212 | eb65d354 | Iustin Pop | </refsect3> |
2213 | eb65d354 | Iustin Pop | |
2214 | bd315bfa | Iustin Pop | <refsect3> |
2215 | bd315bfa | Iustin Pop | <title>RECREATE-DISKS</title> |
2216 | bd315bfa | Iustin Pop | |
2217 | bd315bfa | Iustin Pop | <cmdsynopsis> |
2218 | bd315bfa | Iustin Pop | <command>recreate-disks</command> |
2219 | bd315bfa | Iustin Pop | <arg>--submit</arg> |
2220 | bd315bfa | Iustin Pop | <arg>--disks=<option>indices</option></arg> |
2221 | bd315bfa | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
2222 | bd315bfa | Iustin Pop | </cmdsynopsis> |
2223 | bd315bfa | Iustin Pop | <para> |
2224 | bd315bfa | Iustin Pop | Recreates the disks of the given instance, or only a subset |
2225 | bd315bfa | Iustin Pop | of the disks (if the option <option>disks</option> is |
2226 | bd315bfa | Iustin Pop | passed, which must be a comma-separated list of disk |
2227 | bd315bfa | Iustin Pop | indices, starting from zero). |
2228 | bd315bfa | Iustin Pop | </para> |
2229 | bd315bfa | Iustin Pop | |
2230 | bd315bfa | Iustin Pop | <para> |
2231 | cc291012 | Iustin Pop | Note that this functionality should only be used for missing |
2232 | cc291012 | Iustin Pop | disks; if any of the given disks already exists, the |
2233 | cc291012 | Iustin Pop | operation will fail. While this is suboptimal, |
2234 | cc291012 | Iustin Pop | recreate-disks should hopefully not be needed in normal |
2235 | cc291012 | Iustin Pop | operation and as such the impact of this is low. |
2236 | cc291012 | Iustin Pop | </para> |
2237 | cc291012 | Iustin Pop | |
2238 | cc291012 | Iustin Pop | <para> |
2239 | bd315bfa | Iustin Pop | The <option>--submit</option> option is used to send the job to |
2240 | bd315bfa | Iustin Pop | the master daemon but not wait for its completion. The job |
2241 | bd315bfa | Iustin Pop | ID will be shown so that it can be examined via |
2242 | bd315bfa | Iustin Pop | <command>gnt-job info</command>. |
2243 | bd315bfa | Iustin Pop | </para> |
2244 | bd315bfa | Iustin Pop | |
2245 | bd315bfa | Iustin Pop | </refsect3> |
2246 | bd315bfa | Iustin Pop | |
2247 | a8083063 | Iustin Pop | </refsect2> |
2248 | a8083063 | Iustin Pop | |
2249 | a8083063 | Iustin Pop | <refsect2> |
2250 | a8083063 | Iustin Pop | <title>Recovery</title> |
2251 | a8083063 | Iustin Pop | |
2252 | a8083063 | Iustin Pop | <refsect3> |
2253 | a8083063 | Iustin Pop | <title>FAILOVER</title> |
2254 | a8083063 | Iustin Pop | |
2255 | a8083063 | Iustin Pop | <cmdsynopsis> |
2256 | a8083063 | Iustin Pop | <command>failover</command> |
2257 | a8083063 | Iustin Pop | <arg>-f</arg> |
2258 | a8083063 | Iustin Pop | <arg>--ignore-consistency</arg> |
2259 | 1e2c9fd3 | Guido Trotter | <arg>--shutdown-timeout=<replaceable>N</replaceable></arg> |
2260 | d3b4cf9f | Iustin Pop | <arg>--submit</arg> |
2261 | 80de0e3f | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
2262 | a8083063 | Iustin Pop | </cmdsynopsis> |
2263 | a8083063 | Iustin Pop | |
2264 | a8083063 | Iustin Pop | <para> |
2265 | 80de0e3f | Iustin Pop | Failover will fail the instance over its secondary |
2266 | bd028152 | Iustin Pop | node. This works only for instances having a drbd disk |
2267 | bd028152 | Iustin Pop | template. |
2268 | a8083063 | Iustin Pop | </para> |
2269 | a8083063 | Iustin Pop | |
2270 | a8083063 | Iustin Pop | <para> |
2271 | a8083063 | Iustin Pop | Normally the failover will check the consistency of the |
2272 | 80de0e3f | Iustin Pop | disks before failing over the instance. If you are trying to |
2273 | a8083063 | Iustin Pop | migrate instances off a dead node, this will fail. Use the |
2274 | a8083063 | Iustin Pop | <option>--ignore-consistency</option> option for this |
2275 | 24a40d57 | Iustin Pop | purpose. Note that this option can be dangerous as errors in |
2276 | 24a40d57 | Iustin Pop | shutting down the instance will be ignored, resulting in |
2277 | 24a40d57 | Iustin Pop | possibly having the instance running on two machines in |
2278 | 24a40d57 | Iustin Pop | parallel (on disconnected DRBD drives). |
2279 | a8083063 | Iustin Pop | </para> |
2280 | a8083063 | Iustin Pop | |
2281 | a8083063 | Iustin Pop | <para> |
2282 | 1e2c9fd3 | Guido Trotter | The <option>--shutdown-timeout</option> is used to specify how |
2283 | 1e2c9fd3 | Guido Trotter | much time to wait before forcing the shutdown (xm destroy in xen, |
2284 | 1e2c9fd3 | Guido Trotter | killing the kvm process, for kvm). By default two minutes are |
2285 | 1e2c9fd3 | Guido Trotter | given to each instance to stop. |
2286 | 1e2c9fd3 | Guido Trotter | </para> |
2287 | 1e2c9fd3 | Guido Trotter | |
2288 | 1e2c9fd3 | Guido Trotter | <para> |
2289 | d3b4cf9f | Iustin Pop | The <option>--submit</option> option is used to send the job to |
2290 | d3b4cf9f | Iustin Pop | the master daemon but not wait for its completion. The job |
2291 | d3b4cf9f | Iustin Pop | ID will be shown so that it can be examined via |
2292 | d3b4cf9f | Iustin Pop | <command>gnt-job info</command>. |
2293 | d3b4cf9f | Iustin Pop | </para> |
2294 | d3b4cf9f | Iustin Pop | |
2295 | d3b4cf9f | Iustin Pop | <para> |
2296 | a8083063 | Iustin Pop | Example: |
2297 | a8083063 | Iustin Pop | <screen> |
2298 | a8083063 | Iustin Pop | # gnt-instance failover instance1.example.com |
2299 | a8083063 | Iustin Pop | </screen> |
2300 | a8083063 | Iustin Pop | </para> |
2301 | a8083063 | Iustin Pop | </refsect3> |
2302 | a8083063 | Iustin Pop | |
2303 | d3b4cf9f | Iustin Pop | <refsect3> |
2304 | d3b4cf9f | Iustin Pop | <title>MIGRATE</title> |
2305 | d3b4cf9f | Iustin Pop | |
2306 | d3b4cf9f | Iustin Pop | <cmdsynopsis> |
2307 | d3b4cf9f | Iustin Pop | <command>migrate</command> |
2308 | d3b4cf9f | Iustin Pop | <arg>-f</arg> |
2309 | d3b4cf9f | Iustin Pop | <arg choice="req">--cleanup</arg> |
2310 | d3b4cf9f | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
2311 | d3b4cf9f | Iustin Pop | </cmdsynopsis> |
2312 | d3b4cf9f | Iustin Pop | |
2313 | d3b4cf9f | Iustin Pop | <cmdsynopsis> |
2314 | d3b4cf9f | Iustin Pop | <command>migrate</command> |
2315 | d3b4cf9f | Iustin Pop | <arg>-f</arg> |
2316 | d3b4cf9f | Iustin Pop | <arg>--non-live</arg> |
2317 | d3b4cf9f | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
2318 | d3b4cf9f | Iustin Pop | </cmdsynopsis> |
2319 | d3b4cf9f | Iustin Pop | |
2320 | d3b4cf9f | Iustin Pop | <para> |
2321 | d3b4cf9f | Iustin Pop | Migrate will move the instance to its secondary node without |
2322 | d3b4cf9f | Iustin Pop | shutdown. It only works for instances having the drbd8 disk |
2323 | d3b4cf9f | Iustin Pop | template type. |
2324 | d3b4cf9f | Iustin Pop | </para> |
2325 | d3b4cf9f | Iustin Pop | |
2326 | d3b4cf9f | Iustin Pop | <para> |
2327 | d3b4cf9f | Iustin Pop | The migration command needs a perfectly healthy instance, as |
2328 | d3b4cf9f | Iustin Pop | we rely on the dual-master capability of drbd8 and the disks |
2329 | d3b4cf9f | Iustin Pop | of the instance are not allowed to be degraded. |
2330 | d3b4cf9f | Iustin Pop | </para> |
2331 | d3b4cf9f | Iustin Pop | |
2332 | d3b4cf9f | Iustin Pop | <para> |
2333 | d3b4cf9f | Iustin Pop | The <option>--non-live</option> option will switch (for the |
2334 | d3b4cf9f | Iustin Pop | hypervisors that support it) between a "fully live" |
2335 | d3b4cf9f | Iustin Pop | (i.e. the interruption is as minimal as possible) migration |
2336 | d3b4cf9f | Iustin Pop | and one in which the instance is frozen, its state saved and |
2337 | d3b4cf9f | Iustin Pop | transported to the remote node, and then resumed there. This |
2338 | d3b4cf9f | Iustin Pop | all depends on the hypervisor support for two different |
2339 | d3b4cf9f | Iustin Pop | methods. In any case, it is not an error to pass this |
2340 | d3b4cf9f | Iustin Pop | parameter (it will just be ignored if the hypervisor doesn't |
2341 | d3b4cf9f | Iustin Pop | support it). |
2342 | d3b4cf9f | Iustin Pop | </para> |
2343 | d3b4cf9f | Iustin Pop | |
2344 | d3b4cf9f | Iustin Pop | <para> |
2345 | d3b4cf9f | Iustin Pop | If the <option>--cleanup</option> option is passed, the |
2346 | d3b4cf9f | Iustin Pop | operation changes from migration to attempting recovery from |
2347 | d3b4cf9f | Iustin Pop | a failed previous migration. In this mode, ganeti checks if |
2348 | d3b4cf9f | Iustin Pop | the instance runs on the correct node (and updates its |
2349 | d3b4cf9f | Iustin Pop | configuration if not) and ensures the instances's disks are |
2350 | d3b4cf9f | Iustin Pop | configured correctly. In this mode, the |
2351 | d3b4cf9f | Iustin Pop | <option>--non-live</option> option is ignored. |
2352 | d3b4cf9f | Iustin Pop | </para> |
2353 | d3b4cf9f | Iustin Pop | |
2354 | d3b4cf9f | Iustin Pop | <para> |
2355 | d3b4cf9f | Iustin Pop | The option <option>-f</option> will skip the prompting for |
2356 | d3b4cf9f | Iustin Pop | confirmation. |
2357 | d3b4cf9f | Iustin Pop | </para> |
2358 | d3b4cf9f | Iustin Pop | <para> |
2359 | d3b4cf9f | Iustin Pop | Example (and expected output): |
2360 | d3b4cf9f | Iustin Pop | <screen> |
2361 | d3b4cf9f | Iustin Pop | # gnt-instance migrate instance1 |
2362 | d3b4cf9f | Iustin Pop | Migrate will happen to the instance instance1. Note that migration is |
2363 | d3b4cf9f | Iustin Pop | **experimental** in this version. This might impact the instance if |
2364 | d3b4cf9f | Iustin Pop | anything goes wrong. Continue? |
2365 | d3b4cf9f | Iustin Pop | y/[n]/?: y |
2366 | d3b4cf9f | Iustin Pop | * checking disk consistency between source and target |
2367 | d3b4cf9f | Iustin Pop | * ensuring the target is in secondary mode |
2368 | d3b4cf9f | Iustin Pop | * changing disks into dual-master mode |
2369 | d3b4cf9f | Iustin Pop | - INFO: Waiting for instance instance1 to sync disks. |
2370 | d3b4cf9f | Iustin Pop | - INFO: Instance instance1's disks are in sync. |
2371 | d3b4cf9f | Iustin Pop | * migrating instance to node2.example.com |
2372 | d3b4cf9f | Iustin Pop | * changing the instance's disks on source node to secondary |
2373 | d3b4cf9f | Iustin Pop | - INFO: Waiting for instance instance1 to sync disks. |
2374 | d3b4cf9f | Iustin Pop | - INFO: Instance instance1's disks are in sync. |
2375 | d3b4cf9f | Iustin Pop | * changing the instance's disks to single-master |
2376 | d3b4cf9f | Iustin Pop | # |
2377 | d3b4cf9f | Iustin Pop | </screen> |
2378 | d3b4cf9f | Iustin Pop | </para> |
2379 | d3b4cf9f | Iustin Pop | </refsect3> |
2380 | d3b4cf9f | Iustin Pop | |
2381 | fbf5a861 | Iustin Pop | <refsect3> |
2382 | fbf5a861 | Iustin Pop | <title>MOVE</title> |
2383 | fbf5a861 | Iustin Pop | |
2384 | fbf5a861 | Iustin Pop | <cmdsynopsis> |
2385 | fbf5a861 | Iustin Pop | <command>move</command> |
2386 | fbf5a861 | Iustin Pop | <arg>-f</arg> |
2387 | fbf5a861 | Iustin Pop | <arg>-n <replaceable>node</replaceable></arg> |
2388 | 1e2c9fd3 | Guido Trotter | <arg>--shutdown-timeout=<replaceable>N</replaceable></arg> |
2389 | fbf5a861 | Iustin Pop | <arg>--submit</arg> |
2390 | fbf5a861 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
2391 | fbf5a861 | Iustin Pop | </cmdsynopsis> |
2392 | fbf5a861 | Iustin Pop | |
2393 | fbf5a861 | Iustin Pop | <para> |
2394 | fbf5a861 | Iustin Pop | Move will move the instance to an arbitrary node in the |
2395 | fbf5a861 | Iustin Pop | cluster. This works only for instances having a plain or |
2396 | fbf5a861 | Iustin Pop | file disk template. |
2397 | fbf5a861 | Iustin Pop | </para> |
2398 | fbf5a861 | Iustin Pop | |
2399 | fbf5a861 | Iustin Pop | <para> |
2400 | fbf5a861 | Iustin Pop | Note that since this operation is done via data copy, it |
2401 | fbf5a861 | Iustin Pop | will take a long time for big disks (similar to |
2402 | fbf5a861 | Iustin Pop | replace-disks for a drbd instance). |
2403 | fbf5a861 | Iustin Pop | </para> |
2404 | fbf5a861 | Iustin Pop | |
2405 | fbf5a861 | Iustin Pop | <para> |
2406 | 1e2c9fd3 | Guido Trotter | The <option>--shutdown-timeout</option> is used to specify how |
2407 | 1e2c9fd3 | Guido Trotter | much time to wait before forcing the shutdown (xm destroy in xen, |
2408 | 1e2c9fd3 | Guido Trotter | killing the kvm process, for kvm). By default two minutes are |
2409 | 1e2c9fd3 | Guido Trotter | given to each instance to stop. |
2410 | 1e2c9fd3 | Guido Trotter | </para> |
2411 | 1e2c9fd3 | Guido Trotter | |
2412 | 1e2c9fd3 | Guido Trotter | <para> |
2413 | fbf5a861 | Iustin Pop | The <option>--submit</option> option is used to send the job to |
2414 | fbf5a861 | Iustin Pop | the master daemon but not wait for its completion. The job |
2415 | fbf5a861 | Iustin Pop | ID will be shown so that it can be examined via |
2416 | fbf5a861 | Iustin Pop | <command>gnt-job info</command>. |
2417 | fbf5a861 | Iustin Pop | </para> |
2418 | fbf5a861 | Iustin Pop | |
2419 | fbf5a861 | Iustin Pop | <para> |
2420 | fbf5a861 | Iustin Pop | Example: |
2421 | fbf5a861 | Iustin Pop | <screen> |
2422 | fbf5a861 | Iustin Pop | # gnt-instance move -n node3.example.com instance1.example.com |
2423 | fbf5a861 | Iustin Pop | </screen> |
2424 | fbf5a861 | Iustin Pop | </para> |
2425 | fbf5a861 | Iustin Pop | </refsect3> |
2426 | fbf5a861 | Iustin Pop | |
2427 | a8083063 | Iustin Pop | </refsect2> |
2428 | a8083063 | Iustin Pop | |
2429 | cc425644 | Iustin Pop | <refsect2> |
2430 | cc425644 | Iustin Pop | <title>TAGS</title> |
2431 | cc425644 | Iustin Pop | |
2432 | cc425644 | Iustin Pop | <refsect3> |
2433 | cc425644 | Iustin Pop | <title>ADD-TAGS</title> |
2434 | cc425644 | Iustin Pop | |
2435 | cc425644 | Iustin Pop | <cmdsynopsis> |
2436 | cc425644 | Iustin Pop | <command>add-tags</command> |
2437 | 810c50b7 | Iustin Pop | <arg choice="opt">--from <replaceable>file</replaceable></arg> |
2438 | cc425644 | Iustin Pop | <arg choice="req"><replaceable>instancename</replaceable></arg> |
2439 | cc425644 | Iustin Pop | <arg choice="req" |
2440 | cc425644 | Iustin Pop | rep="repeat"><replaceable>tag</replaceable></arg> |
2441 | cc425644 | Iustin Pop | </cmdsynopsis> |
2442 | cc425644 | Iustin Pop | |
2443 | cc425644 | Iustin Pop | <para> |
2444 | cc425644 | Iustin Pop | Add tags to the given instance. If any of the tags contains |
2445 | cc425644 | Iustin Pop | invalid characters, the entire operation will abort. |
2446 | cc425644 | Iustin Pop | </para> |
2447 | 810c50b7 | Iustin Pop | <para> |
2448 | 810c50b7 | Iustin Pop | If the <option>--from</option> option is given, the list of |
2449 | 810c50b7 | Iustin Pop | tags will be extended with the contents of that file (each |
2450 | 810c50b7 | Iustin Pop | line becomes a tag). In this case, there is not need to pass |
2451 | 810c50b7 | Iustin Pop | tags on the command line (if you do, both sources will be |
2452 | 810c50b7 | Iustin Pop | used). A file name of - will be interpreted as stdin. |
2453 | 810c50b7 | Iustin Pop | </para> |
2454 | cc425644 | Iustin Pop | </refsect3> |
2455 | cc425644 | Iustin Pop | |
2456 | cc425644 | Iustin Pop | <refsect3> |
2457 | cc425644 | Iustin Pop | <title>LIST-TAGS</title> |
2458 | cc425644 | Iustin Pop | |
2459 | cc425644 | Iustin Pop | <cmdsynopsis> |
2460 | cc425644 | Iustin Pop | <command>list-tags</command> |
2461 | cc425644 | Iustin Pop | <arg choice="req"><replaceable>instancename</replaceable></arg> |
2462 | cc425644 | Iustin Pop | </cmdsynopsis> |
2463 | cc425644 | Iustin Pop | |
2464 | cc425644 | Iustin Pop | <para>List the tags of the given instance.</para> |
2465 | cc425644 | Iustin Pop | </refsect3> |
2466 | cc425644 | Iustin Pop | |
2467 | cc425644 | Iustin Pop | <refsect3> |
2468 | cc425644 | Iustin Pop | <title>REMOVE-TAGS</title> |
2469 | cc425644 | Iustin Pop | <cmdsynopsis> |
2470 | cc425644 | Iustin Pop | <command>remove-tags</command> |
2471 | 810c50b7 | Iustin Pop | <arg choice="opt">--from <replaceable>file</replaceable></arg> |
2472 | cc425644 | Iustin Pop | <arg choice="req"><replaceable>instancename</replaceable></arg> |
2473 | cc425644 | Iustin Pop | <arg choice="req" |
2474 | cc425644 | Iustin Pop | rep="repeat"><replaceable>tag</replaceable></arg> |
2475 | cc425644 | Iustin Pop | </cmdsynopsis> |
2476 | cc425644 | Iustin Pop | |
2477 | cc425644 | Iustin Pop | <para> |
2478 | cc425644 | Iustin Pop | Remove tags from the given instance. If any of the tags are |
2479 | cc425644 | Iustin Pop | not existing on the node, the entire operation will abort. |
2480 | cc425644 | Iustin Pop | </para> |
2481 | 810c50b7 | Iustin Pop | |
2482 | 810c50b7 | Iustin Pop | <para> |
2483 | 810c50b7 | Iustin Pop | If the <option>--from</option> option is given, the list of |
2484 | 810c50b7 | Iustin Pop | tags will be extended with the contents of that file (each |
2485 | 810c50b7 | Iustin Pop | line becomes a tag). In this case, there is not need to pass |
2486 | 810c50b7 | Iustin Pop | tags on the command line (if you do, both sources will be |
2487 | 810c50b7 | Iustin Pop | used). A file name of - will be interpreted as stdin. |
2488 | 810c50b7 | Iustin Pop | </para> |
2489 | cc425644 | Iustin Pop | </refsect3> |
2490 | cc425644 | Iustin Pop | |
2491 | cc425644 | Iustin Pop | </refsect2> |
2492 | cc425644 | Iustin Pop | |
2493 | a8083063 | Iustin Pop | </refsect1> |
2494 | a8083063 | Iustin Pop | |
2495 | a8083063 | Iustin Pop | &footer; |
2496 | a8083063 | Iustin Pop | |
2497 | a8083063 | Iustin Pop | </refentry> |
2498 | a8083063 | Iustin Pop | |
2499 | a8083063 | Iustin Pop | <!-- Keep this comment at the end of the file |
2500 | a8083063 | Iustin Pop | Local variables: |
2501 | a8083063 | Iustin Pop | mode: sgml |
2502 | a8083063 | Iustin Pop | sgml-omittag:t |
2503 | a8083063 | Iustin Pop | sgml-shorttag:t |
2504 | a8083063 | Iustin Pop | sgml-minimize-attributes:nil |
2505 | a8083063 | Iustin Pop | sgml-always-quote-attributes:t |
2506 | a8083063 | Iustin Pop | sgml-indent-step:2 |
2507 | a8083063 | Iustin Pop | sgml-indent-data:t |
2508 | a8083063 | Iustin Pop | sgml-parent-document:nil |
2509 | a8083063 | Iustin Pop | sgml-default-dtd-file:nil |
2510 | a8083063 | Iustin Pop | sgml-exposed-tags:nil |
2511 | a8083063 | Iustin Pop | sgml-local-catalogs:nil |
2512 | a8083063 | Iustin Pop | sgml-local-ecat-files:nil |
2513 | a8083063 | Iustin Pop | End: |
2514 | a8083063 | Iustin Pop | --> |