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