root / man / gnt-instance.sgml @ 36c87212
History | View | Annotate | Download (31.4 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 | a8083063 | Iustin Pop | <!ENTITY dhdate "<date>May 16, 2007</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 | a8083063 | Iustin Pop | <holder>Google Inc.</holder> |
24 | a8083063 | Iustin Pop | </copyright> |
25 | a8083063 | Iustin Pop | &dhdate; |
26 | a8083063 | Iustin Pop | </refentryinfo> |
27 | a8083063 | Iustin Pop | <refmeta> |
28 | a8083063 | Iustin Pop | &dhucpackage; |
29 | a8083063 | Iustin Pop | |
30 | a8083063 | Iustin Pop | &dhsection; |
31 | a8083063 | Iustin Pop | <refmiscinfo>ganeti 1.2</refmiscinfo> |
32 | a8083063 | Iustin Pop | </refmeta> |
33 | a8083063 | Iustin Pop | <refnamediv> |
34 | a8083063 | Iustin Pop | <refname>&dhpackage;</refname> |
35 | a8083063 | Iustin Pop | |
36 | a8083063 | Iustin Pop | <refpurpose>ganeti instance administration</refpurpose> |
37 | a8083063 | Iustin Pop | </refnamediv> |
38 | a8083063 | Iustin Pop | <refsynopsisdiv> |
39 | a8083063 | Iustin Pop | <cmdsynopsis> |
40 | a8083063 | Iustin Pop | <command>&dhpackage; </command> |
41 | a8083063 | Iustin Pop | |
42 | a8083063 | Iustin Pop | <arg choice="req">command</arg> |
43 | a8083063 | Iustin Pop | <arg>arguments...</arg> |
44 | a8083063 | Iustin Pop | </cmdsynopsis> |
45 | a8083063 | Iustin Pop | </refsynopsisdiv> |
46 | a8083063 | Iustin Pop | <refsect1> |
47 | a8083063 | Iustin Pop | <title>DESCRIPTION</title> |
48 | a8083063 | Iustin Pop | |
49 | a8083063 | Iustin Pop | <para> |
50 | a8083063 | Iustin Pop | The <command>&dhpackage;</command> is used for instance |
51 | a8083063 | Iustin Pop | administration in the ganeti system. |
52 | a8083063 | Iustin Pop | </para> |
53 | a8083063 | Iustin Pop | |
54 | a8083063 | Iustin Pop | </refsect1> |
55 | a8083063 | Iustin Pop | <refsect1> |
56 | a8083063 | Iustin Pop | <title>COMMANDS</title> |
57 | a8083063 | Iustin Pop | |
58 | a8083063 | Iustin Pop | <refsect2> |
59 | a8083063 | Iustin Pop | <title>Creation/removal/querying</title> |
60 | a8083063 | Iustin Pop | |
61 | a8083063 | Iustin Pop | <refsect3> |
62 | a8083063 | Iustin Pop | <title>ADD</title> |
63 | a8083063 | Iustin Pop | <cmdsynopsis> |
64 | a8083063 | Iustin Pop | <command>add</command> |
65 | a8083063 | Iustin Pop | <arg>-s <replaceable>disksize</replaceable></arg> |
66 | b9ac33e9 | Iustin Pop | <arg>--swap-size <replaceable>disksize</replaceable></arg> |
67 | a8083063 | Iustin Pop | <arg>-m <replaceable>memsize</replaceable></arg> |
68 | b9ac33e9 | Iustin Pop | <sbr> |
69 | b9ac33e9 | Iustin Pop | <arg>-o <replaceable>os-type</replaceable></arg> |
70 | a8083063 | Iustin Pop | <arg>-b <replaceable>bridge</replaceable></arg> |
71 | a8083063 | Iustin Pop | <sbr> |
72 | a8083063 | Iustin Pop | <arg choice="req">-t<group> |
73 | a8083063 | Iustin Pop | <arg>diskless</arg> |
74 | a8083063 | Iustin Pop | <arg>plain</arg> |
75 | a8083063 | Iustin Pop | <arg>local_raid1</arg> |
76 | a8083063 | Iustin Pop | <arg>remote_raid1</arg> |
77 | a8083063 | Iustin Pop | </group> |
78 | a8083063 | Iustin Pop | </arg> |
79 | b9ac33e9 | Iustin Pop | <sbr> |
80 | b9ac33e9 | Iustin Pop | <arg choice="req">-n <replaceable>node</replaceable></arg> |
81 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
82 | a8083063 | Iustin Pop | </cmdsynopsis> |
83 | a8083063 | Iustin Pop | <para> |
84 | a8083063 | Iustin Pop | Creates a new instance on the specified |
85 | a8083063 | Iustin Pop | host. <replaceable>instance</replaceable> must be in DNS and |
86 | a8083063 | Iustin Pop | resolve to a IP in the same network as the nodes in the |
87 | a8083063 | Iustin Pop | cluster. |
88 | a8083063 | Iustin Pop | </para> |
89 | a8083063 | Iustin Pop | |
90 | a8083063 | Iustin Pop | <para> |
91 | a8083063 | Iustin Pop | The <option>-s</option> option specifies the disk size for |
92 | b9ac33e9 | Iustin Pop | the instance, in mebibytes (defaults to |
93 | b9ac33e9 | Iustin Pop | <constant>20480MiB</constant> = |
94 | b9ac33e9 | Iustin Pop | <constant>20GiB</constant>). You can also use one of the |
95 | b9ac33e9 | Iustin Pop | suffixes <literal>m</literal>, <literal>g</literal> or |
96 | b9ac33e9 | Iustin Pop | <literal>t</literal> to specificy the exact the units used; |
97 | b9ac33e9 | Iustin Pop | these suffixes map to mebibytes, gibibytes and tebibytes. |
98 | a8083063 | Iustin Pop | </para> |
99 | a8083063 | Iustin Pop | |
100 | a8083063 | Iustin Pop | <para> |
101 | b9ac33e9 | Iustin Pop | The <option>--swap-size</option> option specifies the swap |
102 | b9ac33e9 | Iustin Pop | disk size (in mebibytes) for the instance (the one presented |
103 | b9ac33e9 | Iustin Pop | as <filename class="devicefile">/dev/sdb</filename>). The |
104 | b9ac33e9 | Iustin Pop | default is <constant>4096MiB</constant>. As for the disk |
105 | b9ac33e9 | Iustin Pop | size, you can specify other suffixes. |
106 | a8083063 | Iustin Pop | </para> |
107 | a8083063 | Iustin Pop | |
108 | a8083063 | Iustin Pop | <para> |
109 | a8083063 | Iustin Pop | The <option>-m</option> option specifies the memory size for |
110 | b9ac33e9 | Iustin Pop | the instance, in mebibytes (defaults to 128 MiB). Again, you |
111 | b9ac33e9 | Iustin Pop | can use other suffixes (e.g. <userinput>2g</userinput>). |
112 | b9ac33e9 | Iustin Pop | </para> |
113 | b9ac33e9 | Iustin Pop | |
114 | b9ac33e9 | Iustin Pop | <para> |
115 | b9ac33e9 | Iustin Pop | The <option>-o</option> options specifies the operating |
116 | b9ac33e9 | Iustin Pop | system to be installed. The available operating systems can |
117 | b9ac33e9 | Iustin Pop | be listed with <command>gnt-os list</command>. |
118 | a8083063 | Iustin Pop | </para> |
119 | a8083063 | Iustin Pop | |
120 | a8083063 | Iustin Pop | <para> |
121 | a8083063 | Iustin Pop | The <option>-b</option> option specifies the bridge to which the |
122 | a8083063 | Iustin Pop | instance will be connected. (defaults to the cluster-wide default |
123 | 7e84d392 | Michael Hanselmann | bridge specified at cluster initialization time). |
124 | a8083063 | Iustin Pop | </para> |
125 | a8083063 | Iustin Pop | |
126 | a8083063 | Iustin Pop | <para> |
127 | a8083063 | Iustin Pop | The <option>-t</option> options specifies the disk layout type for |
128 | a8083063 | Iustin Pop | the instance. The available choices are: |
129 | a8083063 | Iustin Pop | <variablelist> |
130 | a8083063 | Iustin Pop | <varlistentry> |
131 | a8083063 | Iustin Pop | <term>diskless</term> |
132 | a8083063 | Iustin Pop | <listitem> |
133 | a8083063 | Iustin Pop | <para> |
134 | a8083063 | Iustin Pop | This creates an instance with no disks. Its useful for |
135 | a8083063 | Iustin Pop | testing only (or other special cases). |
136 | a8083063 | Iustin Pop | </para> |
137 | a8083063 | Iustin Pop | </listitem> |
138 | a8083063 | Iustin Pop | </varlistentry> |
139 | a8083063 | Iustin Pop | <varlistentry> |
140 | a8083063 | Iustin Pop | <term>plain</term> |
141 | a8083063 | Iustin Pop | <listitem> |
142 | a8083063 | Iustin Pop | <para>Disk devices will be logical volumes.</para> |
143 | a8083063 | Iustin Pop | </listitem> |
144 | a8083063 | Iustin Pop | </varlistentry> |
145 | a8083063 | Iustin Pop | <varlistentry> |
146 | a8083063 | Iustin Pop | <term>local_raid1</term> |
147 | a8083063 | Iustin Pop | <listitem> |
148 | a8083063 | Iustin Pop | <para> |
149 | a8083063 | Iustin Pop | Disk devices will be md raid1 arrays over two local |
150 | a8083063 | Iustin Pop | logical volumes. |
151 | a8083063 | Iustin Pop | </para> |
152 | a8083063 | Iustin Pop | </listitem> |
153 | a8083063 | Iustin Pop | </varlistentry> |
154 | a8083063 | Iustin Pop | <varlistentry> |
155 | a8083063 | Iustin Pop | <term>remote_raid1</term> |
156 | a8083063 | Iustin Pop | <listitem> |
157 | a8083063 | Iustin Pop | <para> |
158 | a8083063 | Iustin Pop | Disk devices will be md raid1 arrays with one |
159 | a8083063 | Iustin Pop | component (so it's not actually raid1): a drbd device |
160 | a8083063 | Iustin Pop | between the instance's primary node and the node given |
161 | a8083063 | Iustin Pop | by the option <option>--secondary-node</option>. |
162 | a8083063 | Iustin Pop | </para> |
163 | a8083063 | Iustin Pop | </listitem> |
164 | a8083063 | Iustin Pop | </varlistentry> |
165 | a8083063 | Iustin Pop | </variablelist> |
166 | a8083063 | Iustin Pop | </para> |
167 | a8083063 | Iustin Pop | |
168 | a8083063 | Iustin Pop | <para> |
169 | a8083063 | Iustin Pop | The <option>--secondary-node</option> option is used with |
170 | a8083063 | Iustin Pop | the remote raid disk template type and specifies the remote |
171 | a8083063 | Iustin Pop | node. |
172 | a8083063 | Iustin Pop | </para> |
173 | a8083063 | Iustin Pop | |
174 | a8083063 | Iustin Pop | <para> |
175 | a8083063 | Iustin Pop | If you do not want gnt-instance to wait for the disk mirror |
176 | a8083063 | Iustin Pop | to be synced, use the <option>--no-wait-for-sync</option> |
177 | a8083063 | Iustin Pop | option. |
178 | a8083063 | Iustin Pop | </para> |
179 | a8083063 | Iustin Pop | |
180 | a8083063 | Iustin Pop | |
181 | a8083063 | Iustin Pop | <para> |
182 | a8083063 | Iustin Pop | Example: |
183 | a8083063 | Iustin Pop | <screen> |
184 | b9ac33e9 | Iustin Pop | # gnt-instance add -t plain -s 30g -m 512 -o debian-etch \ |
185 | b9ac33e9 | Iustin Pop | -n node1.example.com instance1.example.com |
186 | a8083063 | Iustin Pop | # gnt-instance add -t remote_raid1 --secondary-node node3.example.com \ |
187 | b9ac33e9 | Iustin Pop | -s 30g -m 512 -o debian-etch \ |
188 | b9ac33e9 | Iustin Pop | -n node1.example.com instance2.example.com |
189 | a8083063 | Iustin Pop | </screen> |
190 | a8083063 | Iustin Pop | </para> |
191 | a8083063 | Iustin Pop | |
192 | a8083063 | Iustin Pop | </refsect3> |
193 | a8083063 | Iustin Pop | |
194 | a8083063 | Iustin Pop | <refsect3> |
195 | a8083063 | Iustin Pop | <title>REMOVE</title> |
196 | a8083063 | Iustin Pop | |
197 | a8083063 | Iustin Pop | <cmdsynopsis> |
198 | a8083063 | Iustin Pop | <command>remove</command> |
199 | 1d67656e | Iustin Pop | <arg>--ignore-failures</arg> |
200 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
201 | a8083063 | Iustin Pop | </cmdsynopsis> |
202 | a8083063 | Iustin Pop | |
203 | a8083063 | Iustin Pop | <para> |
204 | a8083063 | Iustin Pop | Remove an instance. This will remove all data from the |
205 | a8083063 | Iustin Pop | instance and there is <emphasis>no way back</emphasis>. If |
206 | a8083063 | Iustin Pop | you are not sure if you use an instance again, use |
207 | a8083063 | Iustin Pop | <command>shutdown</command> first and leave it in the |
208 | a8083063 | Iustin Pop | shutdown state for a while. |
209 | 1d67656e | Iustin Pop | |
210 | 1d67656e | Iustin Pop | </para> |
211 | 1d67656e | Iustin Pop | |
212 | 1d67656e | Iustin Pop | <para> |
213 | 1d67656e | Iustin Pop | The <option>--ignore-failures</option> option will cause the |
214 | 1d67656e | Iustin Pop | removal to proceed even in the presence of errors during the |
215 | 1d67656e | Iustin Pop | removal of the instance (e.g. during the shutdown or the |
216 | 1d67656e | Iustin Pop | disk removal). If this option is not given, the command will |
217 | 1d67656e | Iustin Pop | stop at the first error. |
218 | a8083063 | Iustin Pop | </para> |
219 | a8083063 | Iustin Pop | |
220 | a8083063 | Iustin Pop | <para> |
221 | a8083063 | Iustin Pop | Example: |
222 | a8083063 | Iustin Pop | <screen> |
223 | a8083063 | Iustin Pop | # gnt-instance remove instance1.example.com |
224 | a8083063 | Iustin Pop | </screen> |
225 | a8083063 | Iustin Pop | </para> |
226 | a8083063 | Iustin Pop | </refsect3> |
227 | a8083063 | Iustin Pop | |
228 | a8083063 | Iustin Pop | <refsect3> |
229 | a8083063 | Iustin Pop | <title>LIST</title> |
230 | a8083063 | Iustin Pop | |
231 | a8083063 | Iustin Pop | <cmdsynopsis> |
232 | a8083063 | Iustin Pop | <command>list</command> |
233 | a8083063 | Iustin Pop | <arg>--no-headers</arg> |
234 | a8083063 | Iustin Pop | <arg>--separator=<replaceable>SEPARATOR</replaceable></arg> |
235 | a8083063 | Iustin Pop | <arg>-o <replaceable>FIELD,...</replaceable></arg> |
236 | a8083063 | Iustin Pop | </cmdsynopsis> |
237 | a8083063 | Iustin Pop | |
238 | a8083063 | Iustin Pop | <para> |
239 | a8083063 | Iustin Pop | Shows the currently configured instances with memory usage, |
240 | a8083063 | Iustin Pop | disk usage, the node they are running on, and the CPU time, |
241 | a8083063 | Iustin Pop | counted in seconds, used by each instance since its latest |
242 | a8083063 | Iustin Pop | restart. |
243 | a8083063 | Iustin Pop | </para> |
244 | a8083063 | Iustin Pop | |
245 | a8083063 | Iustin Pop | <para> |
246 | a8083063 | Iustin Pop | The <option>--no-headers</option> option will skip the |
247 | a8083063 | Iustin Pop | initial header line. The <option>--separator</option> option |
248 | a8083063 | Iustin Pop | takes an argument which denotes what will be used between |
249 | a8083063 | Iustin Pop | the output fields. Both these options are to help scripting. |
250 | a8083063 | Iustin Pop | </para> |
251 | a8083063 | Iustin Pop | |
252 | a8083063 | Iustin Pop | <para> |
253 | a8083063 | Iustin Pop | The <option>-o</option> option takes a comma-separated list |
254 | a8083063 | Iustin Pop | of output fields. The available fields and their meaning |
255 | a8083063 | Iustin Pop | are: |
256 | a8083063 | Iustin Pop | <variablelist> |
257 | a8083063 | Iustin Pop | <varlistentry> |
258 | a8083063 | Iustin Pop | <term>name</term> |
259 | a8083063 | Iustin Pop | <listitem> |
260 | a8083063 | Iustin Pop | <simpara>the instance name</simpara> |
261 | a8083063 | Iustin Pop | </listitem> |
262 | a8083063 | Iustin Pop | </varlistentry> |
263 | a8083063 | Iustin Pop | <varlistentry> |
264 | a8083063 | Iustin Pop | <term>os</term> |
265 | a8083063 | Iustin Pop | <listitem> |
266 | a8083063 | Iustin Pop | <simpara>the OS of the instance</simpara> |
267 | a8083063 | Iustin Pop | </listitem> |
268 | a8083063 | Iustin Pop | </varlistentry> |
269 | a8083063 | Iustin Pop | <varlistentry> |
270 | a8083063 | Iustin Pop | <term>pnode</term> |
271 | a8083063 | Iustin Pop | <listitem> |
272 | a8083063 | Iustin Pop | <simpara>the primary node of the instance</simpara> |
273 | a8083063 | Iustin Pop | </listitem> |
274 | a8083063 | Iustin Pop | </varlistentry> |
275 | a8083063 | Iustin Pop | <varlistentry> |
276 | a8083063 | Iustin Pop | <term>snodes</term> |
277 | a8083063 | Iustin Pop | <listitem> |
278 | a8083063 | Iustin Pop | <simpara>comma-separated list of secondary-nodes for the |
279 | a8083063 | Iustin Pop | instance; usually this will be just one node</simpara> |
280 | a8083063 | Iustin Pop | </listitem> |
281 | a8083063 | Iustin Pop | </varlistentry> |
282 | a8083063 | Iustin Pop | <varlistentry> |
283 | a8083063 | Iustin Pop | <term>admin_state</term> |
284 | a8083063 | Iustin Pop | <listitem> |
285 | a8083063 | Iustin Pop | <simpara>the desired state of the instance (either "yes" |
286 | a8083063 | Iustin Pop | or "no" denoting the instance should run or |
287 | a8083063 | Iustin Pop | not)</simpara> |
288 | a8083063 | Iustin Pop | </listitem> |
289 | a8083063 | Iustin Pop | </varlistentry> |
290 | a8083063 | Iustin Pop | <varlistentry> |
291 | a8083063 | Iustin Pop | <term>admin_ram</term> |
292 | a8083063 | Iustin Pop | <listitem> |
293 | a8083063 | Iustin Pop | <simpara>the desired memory for the instance</simpara> |
294 | a8083063 | Iustin Pop | </listitem> |
295 | a8083063 | Iustin Pop | </varlistentry> |
296 | a8083063 | Iustin Pop | <varlistentry> |
297 | a8083063 | Iustin Pop | <term>disk_template</term> |
298 | a8083063 | Iustin Pop | <listitem> |
299 | a8083063 | Iustin Pop | <simpara>the disk template of the instance</simpara> |
300 | a8083063 | Iustin Pop | </listitem> |
301 | a8083063 | Iustin Pop | </varlistentry> |
302 | a8083063 | Iustin Pop | <varlistentry> |
303 | a8083063 | Iustin Pop | <term>oper_state</term> |
304 | a8083063 | Iustin Pop | <listitem> |
305 | a8083063 | Iustin Pop | <simpara>the actual state of the instance; can take of |
306 | a8083063 | Iustin Pop | the values "running", "stopped", "(node down)"</simpara> |
307 | a8083063 | Iustin Pop | </listitem> |
308 | a8083063 | Iustin Pop | </varlistentry> |
309 | a8083063 | Iustin Pop | <varlistentry> |
310 | a8083063 | Iustin Pop | <term>oper_ram</term> |
311 | a8083063 | Iustin Pop | <listitem> |
312 | a8083063 | Iustin Pop | <simpara>the actual memory usage of the instance as seen |
313 | a8083063 | Iustin Pop | by the hypervisor</simpara> |
314 | a8083063 | Iustin Pop | </listitem> |
315 | a8083063 | Iustin Pop | </varlistentry> |
316 | a8083063 | Iustin Pop | <varlistentry> |
317 | a8083063 | Iustin Pop | <term>ip</term> |
318 | a8083063 | Iustin Pop | <listitem> |
319 | a8083063 | Iustin Pop | <simpara>the ip address ganeti recognizes as associated with |
320 | a8083063 | Iustin Pop | the instance interface</simpara> |
321 | a8083063 | Iustin Pop | </listitem> |
322 | a8083063 | Iustin Pop | </varlistentry> |
323 | a8083063 | Iustin Pop | <varlistentry> |
324 | a8083063 | Iustin Pop | <term>mac</term> |
325 | a8083063 | Iustin Pop | <listitem> |
326 | a8083063 | Iustin Pop | <simpara>the instance interface MAC address</simpara> |
327 | a8083063 | Iustin Pop | </listitem> |
328 | a8083063 | Iustin Pop | </varlistentry> |
329 | a8083063 | Iustin Pop | <varlistentry> |
330 | a8083063 | Iustin Pop | <term>bridge</term> |
331 | a8083063 | Iustin Pop | <listitem> |
332 | a8083063 | Iustin Pop | <simpara>bridge the instance is connected to |
333 | a8083063 | Iustin Pop | </simpara> |
334 | a8083063 | Iustin Pop | </listitem> |
335 | a8083063 | Iustin Pop | </varlistentry> |
336 | a8083063 | Iustin Pop | </variablelist> |
337 | a8083063 | Iustin Pop | </para> |
338 | a8083063 | Iustin Pop | |
339 | a8083063 | Iustin Pop | <para> |
340 | a8083063 | Iustin Pop | There is a subtle grouping about the available output |
341 | a8083063 | Iustin Pop | fields: all fields except for <option>oper_state</option> |
342 | a8083063 | Iustin Pop | and <option>oper_ram</option> are configuration value and |
343 | a8083063 | Iustin Pop | not run-time values. So if you don't select any of the |
344 | a8083063 | Iustin Pop | <option>oper_*</option> fields, the query will be satisfied |
345 | a8083063 | Iustin Pop | instantly from the cluster configuration, without having to |
346 | a8083063 | Iustin Pop | ask the remote nodes for the data. This can be helpful for |
347 | a8083063 | Iustin Pop | big clusters when you only want some data and it makes sense |
348 | a8083063 | Iustin Pop | to specify a reduced set of output fields. |
349 | a8083063 | Iustin Pop | </para> |
350 | a8083063 | Iustin Pop | |
351 | a8083063 | Iustin Pop | <para>The default output field list is: |
352 | a8083063 | Iustin Pop | <simplelist type="inline"> |
353 | a8083063 | Iustin Pop | <member>name</member> |
354 | a8083063 | Iustin Pop | <member>os</member> |
355 | a8083063 | Iustin Pop | <member>pnode</member> |
356 | a8083063 | Iustin Pop | <member>admin_state</member> |
357 | a8083063 | Iustin Pop | <member>oper_state</member> |
358 | a8083063 | Iustin Pop | <member>oper_ram</member> |
359 | a8083063 | Iustin Pop | </simplelist>. |
360 | a8083063 | Iustin Pop | </para> |
361 | a8083063 | Iustin Pop | </refsect3> |
362 | a8083063 | Iustin Pop | |
363 | a8083063 | Iustin Pop | <refsect3> |
364 | a8083063 | Iustin Pop | <title>INFO</title> |
365 | a8083063 | Iustin Pop | |
366 | a8083063 | Iustin Pop | <cmdsynopsis> |
367 | a8083063 | Iustin Pop | <command>info</command> |
368 | a8083063 | Iustin Pop | <arg rep="repeat"><replaceable>instance</replaceable></arg> |
369 | a8083063 | Iustin Pop | </cmdsynopsis> |
370 | a8083063 | Iustin Pop | |
371 | a8083063 | Iustin Pop | <para> |
372 | a8083063 | Iustin Pop | Show detailed information about the (given) instances. This |
373 | a8083063 | Iustin Pop | is different from <command>list</command> as it shows |
374 | a8083063 | Iustin Pop | detailed data about the instance's disks (especially useful |
375 | a8083063 | Iustin Pop | for remote raid templates). |
376 | a8083063 | Iustin Pop | </para> |
377 | a8083063 | Iustin Pop | </refsect3> |
378 | a8083063 | Iustin Pop | |
379 | a8083063 | Iustin Pop | <refsect3> |
380 | a8083063 | Iustin Pop | <title>MODIFY</title> |
381 | a8083063 | Iustin Pop | |
382 | a8083063 | Iustin Pop | <cmdsynopsis> |
383 | a8083063 | Iustin Pop | <command>modify</command> |
384 | a8083063 | Iustin Pop | <arg choice="opt">-m <replaceable>memsize</replaceable></arg> |
385 | a8083063 | Iustin Pop | <arg choice="opt">-p <replaceable>vcpus</replaceable></arg> |
386 | a8083063 | Iustin Pop | <arg choice="opt">-i <replaceable>ip</replaceable></arg> |
387 | a8083063 | Iustin Pop | <arg choice="opt">-b <replaceable>bridge</replaceable></arg> |
388 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
389 | a8083063 | Iustin Pop | </cmdsynopsis> |
390 | a8083063 | Iustin Pop | |
391 | a8083063 | Iustin Pop | <para> |
392 | a8083063 | Iustin Pop | Modify the memory size, number of vcpus, ip address and/or bridge |
393 | a8083063 | Iustin Pop | for an instance. |
394 | a8083063 | Iustin Pop | </para> |
395 | a8083063 | Iustin Pop | |
396 | a8083063 | Iustin Pop | <para> |
397 | a8083063 | Iustin Pop | The memory size is given in MiB. Note that you need to give |
398 | a8083063 | Iustin Pop | at least one of the arguments, otherwise the command |
399 | a8083063 | Iustin Pop | complains. |
400 | a8083063 | Iustin Pop | </para> |
401 | a8083063 | Iustin Pop | |
402 | a8083063 | Iustin Pop | <para> |
403 | a8083063 | Iustin Pop | All the changes take effect at the next restart. If the |
404 | a8083063 | Iustin Pop | instance is running, there is no effect on the instance. |
405 | a8083063 | Iustin Pop | </para> |
406 | a8083063 | Iustin Pop | </refsect3> |
407 | a8083063 | Iustin Pop | |
408 | d0834de3 | Michael Hanselmann | <refsect3> |
409 | d0834de3 | Michael Hanselmann | <title>REINSTALL</title> |
410 | d0834de3 | Michael Hanselmann | |
411 | d0834de3 | Michael Hanselmann | <cmdsynopsis> |
412 | d0834de3 | Michael Hanselmann | <command>reinstall</command> |
413 | d0834de3 | Michael Hanselmann | <arg choice="opt">-o <replaceable>os-type</replaceable></arg> |
414 | d0834de3 | Michael Hanselmann | <arg choice="opt">-f <replaceable>force</replaceable></arg> |
415 | d0834de3 | Michael Hanselmann | <arg choice="req"><replaceable>instance</replaceable></arg> |
416 | d0834de3 | Michael Hanselmann | </cmdsynopsis> |
417 | d0834de3 | Michael Hanselmann | |
418 | d0834de3 | Michael Hanselmann | <para> |
419 | d0834de3 | Michael Hanselmann | Reinstalls the operating system on the given instance. The instance |
420 | d0834de3 | Michael Hanselmann | must be stopped when running this command. If the |
421 | d0834de3 | Michael Hanselmann | <option>--os-type</option> is specified, the operating system is |
422 | d0834de3 | Michael Hanselmann | changed. |
423 | d0834de3 | Michael Hanselmann | </para> |
424 | d0834de3 | Michael Hanselmann | </refsect3> |
425 | d0834de3 | Michael Hanselmann | |
426 | decd5f45 | Iustin Pop | <refsect3> |
427 | decd5f45 | Iustin Pop | <title>RENAME</title> |
428 | decd5f45 | Iustin Pop | |
429 | decd5f45 | Iustin Pop | <cmdsynopsis> |
430 | decd5f45 | Iustin Pop | <command>rename</command> |
431 | decd5f45 | Iustin Pop | <arg>--no-ip-check</arg> |
432 | decd5f45 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
433 | decd5f45 | Iustin Pop | <arg choice="req"><replaceable>new_name</replaceable></arg> |
434 | decd5f45 | Iustin Pop | </cmdsynopsis> |
435 | decd5f45 | Iustin Pop | |
436 | decd5f45 | Iustin Pop | <para> |
437 | decd5f45 | Iustin Pop | Renames the given instance. The instance must be stopped |
438 | decd5f45 | Iustin Pop | when running this command. The requirements for the new name |
439 | decd5f45 | Iustin Pop | are the same as for adding an instance: the new name must be |
440 | decd5f45 | Iustin Pop | resolvable and the IP it resolves to must not be reachable |
441 | decd5f45 | Iustin Pop | (in order to prevent duplicate IPs the next time the |
442 | decd5f45 | Iustin Pop | instance is started). The IP test can be skipped if the |
443 | decd5f45 | Iustin Pop | <option>--no-ip-check</option> option is passed. |
444 | decd5f45 | Iustin Pop | </para> |
445 | decd5f45 | Iustin Pop | </refsect3> |
446 | decd5f45 | Iustin Pop | |
447 | a8083063 | Iustin Pop | </refsect2> |
448 | a8083063 | Iustin Pop | |
449 | a8083063 | Iustin Pop | <refsect2> |
450 | a8083063 | Iustin Pop | <title>Starting/stopping/connecting to console</title> |
451 | a8083063 | Iustin Pop | |
452 | a8083063 | Iustin Pop | <refsect3> |
453 | a8083063 | Iustin Pop | <title>STARTUP</title> |
454 | a8083063 | Iustin Pop | |
455 | a8083063 | Iustin Pop | <cmdsynopsis> |
456 | a8083063 | Iustin Pop | <command>startup</command> |
457 | a8083063 | Iustin Pop | <arg>--extra=<replaceable>PARAMS</replaceable></arg> |
458 | 312ac745 | Iustin Pop | <sbr> |
459 | 312ac745 | Iustin Pop | <group choice="opt"> |
460 | 312ac745 | Iustin Pop | <arg>--instance</arg> |
461 | 312ac745 | Iustin Pop | <arg>--node</arg> |
462 | 312ac745 | Iustin Pop | <arg>--primary</arg> |
463 | 312ac745 | Iustin Pop | <arg>--secondary</arg> |
464 | 312ac745 | Iustin Pop | <arg>--all</arg> |
465 | 312ac745 | Iustin Pop | </group> |
466 | 312ac745 | Iustin Pop | <sbr> |
467 | 312ac745 | Iustin Pop | <arg choice="opt" |
468 | 312ac745 | Iustin Pop | rep="repeat"><replaceable>name</replaceable></arg> |
469 | a8083063 | Iustin Pop | </cmdsynopsis> |
470 | a8083063 | Iustin Pop | |
471 | a8083063 | Iustin Pop | <para> |
472 | 312ac745 | Iustin Pop | Starts one or more instances, depending on the |
473 | 312ac745 | Iustin Pop | <option>--by-*</option> mode. The four available modes are: |
474 | 312ac745 | Iustin Pop | <variablelist> |
475 | 312ac745 | Iustin Pop | <varlistentry> |
476 | 312ac745 | Iustin Pop | <term><option>--instance</option></term> |
477 | 312ac745 | Iustin Pop | <listitem> |
478 | 312ac745 | Iustin Pop | <simpara>will start the instances given as arguments |
479 | 312ac745 | Iustin Pop | (at least one argument required); this is the default |
480 | 312ac745 | Iustin Pop | selection</simpara> |
481 | 312ac745 | Iustin Pop | </listitem> |
482 | 312ac745 | Iustin Pop | </varlistentry> |
483 | 312ac745 | Iustin Pop | <varlistentry> |
484 | 312ac745 | Iustin Pop | <term>--node</term> |
485 | 312ac745 | Iustin Pop | <listitem> |
486 | 312ac745 | Iustin Pop | <simpara>will start the instances who have the given |
487 | 312ac745 | Iustin Pop | node as either primary or secondary</simpara> |
488 | 312ac745 | Iustin Pop | </listitem> |
489 | 312ac745 | Iustin Pop | </varlistentry> |
490 | 312ac745 | Iustin Pop | <varlistentry> |
491 | 312ac745 | Iustin Pop | <term><option>--primary</option></term> |
492 | 312ac745 | Iustin Pop | <listitem> |
493 | 312ac745 | Iustin Pop | <simpara>will start all instances whose primary node |
494 | 312ac745 | Iustin Pop | is in the list of nodes passed as arguments (at least |
495 | 312ac745 | Iustin Pop | one node required)</simpara> |
496 | 312ac745 | Iustin Pop | </listitem> |
497 | 312ac745 | Iustin Pop | </varlistentry> |
498 | 312ac745 | Iustin Pop | <varlistentry> |
499 | 312ac745 | Iustin Pop | <term><option>--secondary</option></term> |
500 | 312ac745 | Iustin Pop | <listitem> |
501 | 312ac745 | Iustin Pop | <simpara>will start all instances whose secondary node |
502 | 312ac745 | Iustin Pop | is in the list of nodes passed as arguments (at least |
503 | 312ac745 | Iustin Pop | one node required)</simpara> |
504 | 312ac745 | Iustin Pop | </listitem> |
505 | 312ac745 | Iustin Pop | </varlistentry> |
506 | 312ac745 | Iustin Pop | <varlistentry> |
507 | 312ac745 | Iustin Pop | <term>--all</term> |
508 | 312ac745 | Iustin Pop | <listitem> |
509 | 312ac745 | Iustin Pop | <simpara>will start all instances in the cluster (no |
510 | 312ac745 | Iustin Pop | arguments accepted)</simpara> |
511 | 312ac745 | Iustin Pop | </listitem> |
512 | 312ac745 | Iustin Pop | </varlistentry> |
513 | 312ac745 | Iustin Pop | </variablelist> |
514 | 312ac745 | Iustin Pop | </para> |
515 | 312ac745 | Iustin Pop | |
516 | 312ac745 | Iustin Pop | <para> |
517 | 312ac745 | Iustin Pop | Note that although you can pass more than one |
518 | 312ac745 | Iustin Pop | <option>--by-</option> option, the last one wins, so in |
519 | 312ac745 | Iustin Pop | order to guarantee the desired result, don't pass more than |
520 | 312ac745 | Iustin Pop | one such option. |
521 | a8083063 | Iustin Pop | </para> |
522 | a8083063 | Iustin Pop | |
523 | a8083063 | Iustin Pop | <para> |
524 | a8083063 | Iustin Pop | The <option>--extra</option> option is used to pass |
525 | a8083063 | Iustin Pop | additional argument to the instance's kernel for this start |
526 | a8083063 | Iustin Pop | only. Currently there is no way to specify a persistent set |
527 | a8083063 | Iustin Pop | of arguments (beside the one hardcoded). Note that this may |
528 | a8083063 | Iustin Pop | not apply to all virtualization types. |
529 | a8083063 | Iustin Pop | </para> |
530 | a8083063 | Iustin Pop | |
531 | a8083063 | Iustin Pop | |
532 | a8083063 | Iustin Pop | <para> |
533 | a8083063 | Iustin Pop | Example: |
534 | a8083063 | Iustin Pop | <screen> |
535 | a8083063 | Iustin Pop | # gnt-instance start instance1.example.com |
536 | a8083063 | Iustin Pop | # gnt-instance start --extra single test1.example.com |
537 | 312ac745 | Iustin Pop | # gnt-instance start --by-node node1.example.com node2.example.com |
538 | 312ac745 | Iustin Pop | # gnt-instance start --by-cluster |
539 | a8083063 | Iustin Pop | </screen> |
540 | a8083063 | Iustin Pop | </para> |
541 | a8083063 | Iustin Pop | </refsect3> |
542 | a8083063 | Iustin Pop | |
543 | a8083063 | Iustin Pop | <refsect3> |
544 | a8083063 | Iustin Pop | <title>SHUTDOWN</title> |
545 | a8083063 | Iustin Pop | |
546 | a8083063 | Iustin Pop | <cmdsynopsis> |
547 | a8083063 | Iustin Pop | <command>shutdown</command> |
548 | 312ac745 | Iustin Pop | <sbr> |
549 | 312ac745 | Iustin Pop | <group choice="opt"> |
550 | 312ac745 | Iustin Pop | <arg>--instance</arg> |
551 | 312ac745 | Iustin Pop | <arg>--node</arg> |
552 | 312ac745 | Iustin Pop | <arg>--primary</arg> |
553 | 312ac745 | Iustin Pop | <arg>--secondary</arg> |
554 | 312ac745 | Iustin Pop | <arg>--all</arg> |
555 | 312ac745 | Iustin Pop | </group> |
556 | 312ac745 | Iustin Pop | <sbr> |
557 | 312ac745 | Iustin Pop | |
558 | 312ac745 | Iustin Pop | <arg choice="opt" |
559 | 312ac745 | Iustin Pop | rep="repeat"><replaceable>name</replaceable></arg> |
560 | a8083063 | Iustin Pop | </cmdsynopsis> |
561 | a8083063 | Iustin Pop | |
562 | a8083063 | Iustin Pop | <para> |
563 | 312ac745 | Iustin Pop | Stops one or more instances. If the instance cannot be |
564 | 312ac745 | Iustin Pop | cleanly stopped during a hardcoded interval (currently 2 |
565 | 312ac745 | Iustin Pop | minutes), it will forcibly stop the instance (equivalent to |
566 | 312ac745 | Iustin Pop | switching off the power on a physical machine). |
567 | 312ac745 | Iustin Pop | </para> |
568 | 312ac745 | Iustin Pop | |
569 | 312ac745 | Iustin Pop | <para> |
570 | 312ac745 | Iustin Pop | The <option>--instance</option>, <option>--node</option>, |
571 | 312ac745 | Iustin Pop | <option>--primary</option>, <option>--secondary</option> and |
572 | 312ac745 | Iustin Pop | <option>--all</option> options are similar as for the |
573 | 312ac745 | Iustin Pop | <command>startup</command> command and they influence the |
574 | 86b8c6ae | Alexander Schreiber | actual instances being shutdown. |
575 | a8083063 | Iustin Pop | </para> |
576 | a8083063 | Iustin Pop | |
577 | a8083063 | Iustin Pop | <para> |
578 | a8083063 | Iustin Pop | Example: |
579 | a8083063 | Iustin Pop | <screen> |
580 | a8083063 | Iustin Pop | # gnt-instance shutdown instance1.example.com |
581 | 312ac745 | Iustin Pop | # gnt-instance shutdown --by-cluster |
582 | a8083063 | Iustin Pop | </screen> |
583 | a8083063 | Iustin Pop | </para> |
584 | a8083063 | Iustin Pop | </refsect3> |
585 | a8083063 | Iustin Pop | |
586 | a8083063 | Iustin Pop | <refsect3> |
587 | 579d4337 | Alexander Schreiber | <title>REBOOT</title> |
588 | 579d4337 | Alexander Schreiber | |
589 | 579d4337 | Alexander Schreiber | <cmdsynopsis> |
590 | 579d4337 | Alexander Schreiber | <command>reboot</command> |
591 | 579d4337 | Alexander Schreiber | <sbr> |
592 | 579d4337 | Alexander Schreiber | <arg>--extra=<replaceable>PARAMS</replaceable></arg> |
593 | 579d4337 | Alexander Schreiber | <sbr> |
594 | 579d4337 | Alexander Schreiber | <arg>--type=<replaceable>REBOOT-TYPE</replaceable></arg> |
595 | 579d4337 | Alexander Schreiber | <sbr> |
596 | 579d4337 | Alexander Schreiber | <arg>--ignore-secondaries</arg> |
597 | 579d4337 | Alexander Schreiber | <sbr> |
598 | 579d4337 | Alexander Schreiber | <arg>--force-multiple</arg> |
599 | 579d4337 | Alexander Schreiber | <sbr> |
600 | 579d4337 | Alexander Schreiber | <group choice="opt"> |
601 | 579d4337 | Alexander Schreiber | <arg>--instance</arg> |
602 | 579d4337 | Alexander Schreiber | <arg>--node</arg> |
603 | 579d4337 | Alexander Schreiber | <arg>--primary</arg> |
604 | 579d4337 | Alexander Schreiber | <arg>--secondary</arg> |
605 | 579d4337 | Alexander Schreiber | <arg>--all</arg> |
606 | 579d4337 | Alexander Schreiber | </group> |
607 | 579d4337 | Alexander Schreiber | <sbr> |
608 | 579d4337 | Alexander Schreiber | |
609 | 579d4337 | Alexander Schreiber | <arg choice="opt" |
610 | 579d4337 | Alexander Schreiber | rep="repeat"><replaceable>name</replaceable></arg> |
611 | 579d4337 | Alexander Schreiber | </cmdsynopsis> |
612 | 579d4337 | Alexander Schreiber | |
613 | 579d4337 | Alexander Schreiber | <para> |
614 | 579d4337 | Alexander Schreiber | Reboots one or more instances. The type of reboot depends on |
615 | 579d4337 | Alexander Schreiber | the value of <option>--type</option>. A soft reboot does a |
616 | 579d4337 | Alexander Schreiber | hypervisor reboot, a hard reboot does a instance stop, |
617 | 579d4337 | Alexander Schreiber | recreates the hypervisor config for the instance and |
618 | 579d4337 | Alexander Schreiber | starts the instance. A full reboot does the equivalent |
619 | 579d4337 | Alexander Schreiber | of <command>gnt-instance shutdown && gnt-instance |
620 | 579d4337 | Alexander Schreiber | startup</command>. The default is soft reboot. |
621 | 579d4337 | Alexander Schreiber | </para> |
622 | 579d4337 | Alexander Schreiber | |
623 | 579d4337 | Alexander Schreiber | <para> |
624 | 579d4337 | Alexander Schreiber | For the hard reboot the option |
625 | 579d4337 | Alexander Schreiber | <option>--ignore-secondaries</option> ignores errors for the |
626 | 579d4337 | Alexander Schreiber | secondary node while re-assembling the instance disks. |
627 | 579d4337 | Alexander Schreiber | </para> |
628 | 579d4337 | Alexander Schreiber | |
629 | 579d4337 | Alexander Schreiber | <para> |
630 | 579d4337 | Alexander Schreiber | The <option>--instance</option>, <option>--node</option>, |
631 | 579d4337 | Alexander Schreiber | <option>--primary</option>, <option>--secondary</option> and |
632 | 579d4337 | Alexander Schreiber | <option>--all</option> options are similar as for the |
633 | 579d4337 | Alexander Schreiber | <command>startup</command> command and they influence the |
634 | 579d4337 | Alexander Schreiber | actual instances being rebooted. |
635 | 579d4337 | Alexander Schreiber | </para> |
636 | 36c87212 | Iustin Pop | |
637 | 579d4337 | Alexander Schreiber | <para> |
638 | 579d4337 | Alexander Schreiber | Use the <option>--force-multiple</option> to keep |
639 | 579d4337 | Alexander Schreiber | gnt-instance from asking for confirmation when more than one |
640 | 579d4337 | Alexander Schreiber | instance is affected. |
641 | 579d4337 | Alexander Schreiber | </para> |
642 | 579d4337 | Alexander Schreiber | |
643 | 579d4337 | Alexander Schreiber | <para> |
644 | 579d4337 | Alexander Schreiber | Example: |
645 | 579d4337 | Alexander Schreiber | <screen> |
646 | 579d4337 | Alexander Schreiber | # gnt-instance reboot instance1.example.com |
647 | 579d4337 | Alexander Schreiber | # gnt-instance reboot --type=full instance1.example.com |
648 | 579d4337 | Alexander Schreiber | </screen> |
649 | 579d4337 | Alexander Schreiber | </para> |
650 | 579d4337 | Alexander Schreiber | </refsect3> |
651 | 579d4337 | Alexander Schreiber | |
652 | 579d4337 | Alexander Schreiber | <refsect3> |
653 | a8083063 | Iustin Pop | <title>CONSOLE</title> |
654 | a8083063 | Iustin Pop | <cmdsynopsis> |
655 | a8083063 | Iustin Pop | <command>console</command> |
656 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
657 | a8083063 | Iustin Pop | </cmdsynopsis> |
658 | a8083063 | Iustin Pop | |
659 | a8083063 | Iustin Pop | <para> |
660 | a8083063 | Iustin Pop | Connects to the console of the given instance. If the instance |
661 | a8083063 | Iustin Pop | is not up, an error is returned. |
662 | a8083063 | Iustin Pop | </para> |
663 | a8083063 | Iustin Pop | |
664 | a8083063 | Iustin Pop | <para> |
665 | a8083063 | Iustin Pop | Example: |
666 | a8083063 | Iustin Pop | <screen> |
667 | a8083063 | Iustin Pop | # gnt-instance console instance1.example.com |
668 | a8083063 | Iustin Pop | </screen> |
669 | a8083063 | Iustin Pop | </para> |
670 | a8083063 | Iustin Pop | </refsect3> |
671 | a8083063 | Iustin Pop | |
672 | a8083063 | Iustin Pop | </refsect2> |
673 | a8083063 | Iustin Pop | |
674 | a8083063 | Iustin Pop | <refsect2> |
675 | a8083063 | Iustin Pop | <title>Disk management</title> |
676 | a8083063 | Iustin Pop | |
677 | a8083063 | Iustin Pop | <refsect3> |
678 | a8083063 | Iustin Pop | <title>REPLACE-DISKS</title> |
679 | a8083063 | Iustin Pop | |
680 | a8083063 | Iustin Pop | <cmdsynopsis> |
681 | a8083063 | Iustin Pop | <command>replace-disks</command> |
682 | a8083063 | Iustin Pop | <arg choice="req">--new-secondary <replaceable>NODE</replaceable></arg> |
683 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
684 | a8083063 | Iustin Pop | </cmdsynopsis> |
685 | a8083063 | Iustin Pop | |
686 | a8083063 | Iustin Pop | <para> |
687 | a8083063 | Iustin Pop | This command does a full add and replace for both disks of |
688 | a8083063 | Iustin Pop | an instance. It basically does an |
689 | a8083063 | Iustin Pop | <command>addmirror</command> and |
690 | a8083063 | Iustin Pop | <command>removemirror</command> for both disks of the |
691 | a8083063 | Iustin Pop | instance. |
692 | a8083063 | Iustin Pop | </para> |
693 | a8083063 | Iustin Pop | |
694 | a8083063 | Iustin Pop | <para> |
695 | a8083063 | Iustin Pop | If you also want to replace the secondary node during this |
696 | a8083063 | Iustin Pop | process (for example to fix a broken secondary node), you |
697 | a8083063 | Iustin Pop | can do so using the <option>--new-secondary</option> option. |
698 | a8083063 | Iustin Pop | </para> |
699 | a8083063 | Iustin Pop | </refsect3> |
700 | a8083063 | Iustin Pop | |
701 | a8083063 | Iustin Pop | <refsect3> |
702 | a8083063 | Iustin Pop | <title>ADD-MIRROR</title> |
703 | a8083063 | Iustin Pop | <cmdsynopsis> |
704 | a8083063 | Iustin Pop | <command>add-mirror</command> |
705 | a8083063 | Iustin Pop | <arg choice="req">-b <replaceable>sdX</replaceable></arg> |
706 | a8083063 | Iustin Pop | <arg choice="req">-n <replaceable>node</replaceable></arg> |
707 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
708 | a8083063 | Iustin Pop | </cmdsynopsis> |
709 | a8083063 | Iustin Pop | <para> |
710 | a8083063 | Iustin Pop | Adds a new mirror to the disk layout of the instance, if the |
711 | a8083063 | Iustin Pop | instance has a remote raid disk layout. |
712 | a8083063 | Iustin Pop | |
713 | a8083063 | Iustin Pop | The new mirror member will be between the instance's primary |
714 | a8083063 | Iustin Pop | node and the node given with the <option>-n</option> option. |
715 | a8083063 | Iustin Pop | </para> |
716 | a8083063 | Iustin Pop | </refsect3> |
717 | a8083063 | Iustin Pop | |
718 | a8083063 | Iustin Pop | <refsect3> |
719 | a8083063 | Iustin Pop | <title>REMOVE-MIRROR</title> |
720 | a8083063 | Iustin Pop | |
721 | a8083063 | Iustin Pop | <cmdsynopsis> |
722 | a8083063 | Iustin Pop | <command>removemirror</command> |
723 | a8083063 | Iustin Pop | <arg choice="req">-b <replaceable>sdX</replaceable></arg> |
724 | a8083063 | Iustin Pop | <arg choice="req">-p <replaceable>id</replaceable></arg> |
725 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
726 | a8083063 | Iustin Pop | </cmdsynopsis> |
727 | a8083063 | Iustin Pop | <para> |
728 | a8083063 | Iustin Pop | Removes a mirror componenent from the disk layout of the |
729 | a8083063 | Iustin Pop | instance, if the instance has a remote raid disk layout. |
730 | a8083063 | Iustin Pop | </para> |
731 | a8083063 | Iustin Pop | |
732 | a8083063 | Iustin Pop | <para> |
733 | a8083063 | Iustin Pop | You need to specifiy on which disk to act on using the |
734 | a8083063 | Iustin Pop | <option>-b</option> option (either <filename>sda</filename> |
735 | a8083063 | Iustin Pop | or <filename>sdb</filename>) and the mirror component, which |
736 | a8083063 | Iustin Pop | is identified by the <option>-p</option> option. You can |
737 | a8083063 | Iustin Pop | find the list of valid identifiers with the |
738 | a8083063 | Iustin Pop | <command>info</command> command. |
739 | a8083063 | Iustin Pop | </para> |
740 | a8083063 | Iustin Pop | |
741 | a8083063 | Iustin Pop | <refsect3> |
742 | a8083063 | Iustin Pop | <title>ACTIVATE-DISKS</title> |
743 | a8083063 | Iustin Pop | |
744 | a8083063 | Iustin Pop | <cmdsynopsis> |
745 | a8083063 | Iustin Pop | <command>activate-disks</command> |
746 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
747 | a8083063 | Iustin Pop | </cmdsynopsis> |
748 | a8083063 | Iustin Pop | <para> |
749 | a8083063 | Iustin Pop | Activates the block devices of the given instance. If |
750 | a8083063 | Iustin Pop | successful, the command will show the location and name of |
751 | a8083063 | Iustin Pop | the block devices: |
752 | a8083063 | Iustin Pop | <screen> |
753 | a8083063 | Iustin Pop | node1.example.com:sda:/dev/md0 |
754 | a8083063 | Iustin Pop | node1.example.com:sdb:/dev/md1 |
755 | a8083063 | Iustin Pop | </screen> |
756 | a8083063 | Iustin Pop | |
757 | a8083063 | Iustin Pop | In this example, <emphasis>node1.example.com</emphasis> is |
758 | a8083063 | Iustin Pop | the name of the node on which the devices have been |
759 | a8083063 | Iustin Pop | activated. The <emphasis>sda</emphasis> and |
760 | a8083063 | Iustin Pop | <emphasis>sdb</emphasis> are the names of the block devices |
761 | a8083063 | Iustin Pop | inside the instance. <emphasis>/dev/md0</emphasis> and |
762 | a8083063 | Iustin Pop | <emphasis>/dev/md1</emphasis> are the names of the block |
763 | a8083063 | Iustin Pop | devices as visible on the node. |
764 | a8083063 | Iustin Pop | </para> |
765 | a8083063 | Iustin Pop | |
766 | a8083063 | Iustin Pop | <para> |
767 | a8083063 | Iustin Pop | Note that it is safe to run this command while the instance |
768 | a8083063 | Iustin Pop | is already running. |
769 | a8083063 | Iustin Pop | </para> |
770 | a8083063 | Iustin Pop | </refsect3> |
771 | a8083063 | Iustin Pop | |
772 | a8083063 | Iustin Pop | <refsect3> |
773 | a8083063 | Iustin Pop | <title>DEACTIVATE-DISKS</title> |
774 | a8083063 | Iustin Pop | |
775 | a8083063 | Iustin Pop | <cmdsynopsis> |
776 | a8083063 | Iustin Pop | <command>deactivate-disks</command> |
777 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
778 | a8083063 | Iustin Pop | </cmdsynopsis> |
779 | a8083063 | Iustin Pop | <para> |
780 | a8083063 | Iustin Pop | De-activates the block devices of the given instance. Note |
781 | a8083063 | Iustin Pop | that if you run this command for a remote raid instance |
782 | a8083063 | Iustin Pop | type, while it is running, it will not be able to shutdown |
783 | a8083063 | Iustin Pop | the block devices on the primary node, but it will shutdown |
784 | a8083063 | Iustin Pop | the block devices on the secondary nodes, thus breaking the |
785 | a8083063 | Iustin Pop | replication. |
786 | a8083063 | Iustin Pop | </para> |
787 | a8083063 | Iustin Pop | |
788 | a8083063 | Iustin Pop | </refsect3> |
789 | a8083063 | Iustin Pop | |
790 | a8083063 | Iustin Pop | </refsect2> |
791 | a8083063 | Iustin Pop | |
792 | a8083063 | Iustin Pop | <refsect2> |
793 | a8083063 | Iustin Pop | <title>Recovery</title> |
794 | a8083063 | Iustin Pop | |
795 | a8083063 | Iustin Pop | <refsect3> |
796 | a8083063 | Iustin Pop | <title>FAILOVER</title> |
797 | a8083063 | Iustin Pop | |
798 | a8083063 | Iustin Pop | <cmdsynopsis> |
799 | a8083063 | Iustin Pop | <command>failover</command> |
800 | a8083063 | Iustin Pop | <arg>-f</arg> |
801 | a8083063 | Iustin Pop | <arg>--ignore-consistency</arg> |
802 | 36c87212 | Iustin Pop | <sbr> |
803 | 36c87212 | Iustin Pop | <group choice="opt"> |
804 | 36c87212 | Iustin Pop | <arg>--instance</arg> |
805 | 36c87212 | Iustin Pop | <arg>--primary</arg> |
806 | 36c87212 | Iustin Pop | <arg>--secondary</arg> |
807 | 36c87212 | Iustin Pop | </group> |
808 | 36c87212 | Iustin Pop | <sbr> |
809 | 36c87212 | Iustin Pop | <arg choice="req" rep="repeat"><replaceable>name</replaceable></arg> |
810 | a8083063 | Iustin Pop | </cmdsynopsis> |
811 | a8083063 | Iustin Pop | |
812 | a8083063 | Iustin Pop | <para> |
813 | 36c87212 | Iustin Pop | Failover will fail the selected instances to their secondary |
814 | a8083063 | Iustin Pop | node. This works only for instances having a remote raid |
815 | a8083063 | Iustin Pop | disk layout. |
816 | a8083063 | Iustin Pop | </para> |
817 | a8083063 | Iustin Pop | |
818 | a8083063 | Iustin Pop | <para> |
819 | 36c87212 | Iustin Pop | The selection of which instances to failover is done via the |
820 | 36c87212 | Iustin Pop | following options: |
821 | 36c87212 | Iustin Pop | <variablelist> |
822 | 36c87212 | Iustin Pop | <varlistentry> |
823 | 36c87212 | Iustin Pop | <term><option>--instance</option></term> |
824 | 36c87212 | Iustin Pop | <listitem> |
825 | 36c87212 | Iustin Pop | <simpara>will select the instances given as arguments |
826 | 36c87212 | Iustin Pop | (at least one argument required); this is the default |
827 | 36c87212 | Iustin Pop | selection</simpara> |
828 | 36c87212 | Iustin Pop | </listitem> |
829 | 36c87212 | Iustin Pop | </varlistentry> |
830 | 36c87212 | Iustin Pop | <varlistentry> |
831 | 36c87212 | Iustin Pop | <term><option>--primary</option></term> |
832 | 36c87212 | Iustin Pop | <listitem> |
833 | 36c87212 | Iustin Pop | <simpara>will select all instances whose primary node |
834 | 36c87212 | Iustin Pop | is in the list of nodes passed as arguments (at least |
835 | 36c87212 | Iustin Pop | one node required)</simpara> |
836 | 36c87212 | Iustin Pop | </listitem> |
837 | 36c87212 | Iustin Pop | </varlistentry> |
838 | 36c87212 | Iustin Pop | <varlistentry> |
839 | 36c87212 | Iustin Pop | <term><option>--secondary</option></term> |
840 | 36c87212 | Iustin Pop | <listitem> |
841 | 36c87212 | Iustin Pop | <simpara>will select all instances whose secondary |
842 | 36c87212 | Iustin Pop | node is in the list of nodes passed as arguments (at |
843 | 36c87212 | Iustin Pop | least one node required)</simpara> |
844 | 36c87212 | Iustin Pop | </listitem> |
845 | 36c87212 | Iustin Pop | </varlistentry> |
846 | 36c87212 | Iustin Pop | </variablelist> |
847 | 36c87212 | Iustin Pop | </para> |
848 | 36c87212 | Iustin Pop | |
849 | 36c87212 | Iustin Pop | <para> |
850 | a8083063 | Iustin Pop | Normally the failover will check the consistency of the |
851 | 36c87212 | Iustin Pop | disks before failing over an instance. If you are trying to |
852 | a8083063 | Iustin Pop | migrate instances off a dead node, this will fail. Use the |
853 | a8083063 | Iustin Pop | <option>--ignore-consistency</option> option for this |
854 | 24a40d57 | Iustin Pop | purpose. Note that this option can be dangerous as errors in |
855 | 24a40d57 | Iustin Pop | shutting down the instance will be ignored, resulting in |
856 | 24a40d57 | Iustin Pop | possibly having the instance running on two machines in |
857 | 24a40d57 | Iustin Pop | parallel (on disconnected DRBD drives). |
858 | a8083063 | Iustin Pop | </para> |
859 | a8083063 | Iustin Pop | |
860 | a8083063 | Iustin Pop | <para> |
861 | a8083063 | Iustin Pop | Example: |
862 | a8083063 | Iustin Pop | <screen> |
863 | a8083063 | Iustin Pop | # gnt-instance failover instance1.example.com |
864 | 36c87212 | Iustin Pop | # gnt-instance failover --primary node4.example.com |
865 | a8083063 | Iustin Pop | </screen> |
866 | a8083063 | Iustin Pop | </para> |
867 | a8083063 | Iustin Pop | </refsect3> |
868 | a8083063 | Iustin Pop | |
869 | a8083063 | Iustin Pop | </refsect2> |
870 | a8083063 | Iustin Pop | |
871 | cc425644 | Iustin Pop | <refsect2> |
872 | cc425644 | Iustin Pop | <title>TAGS</title> |
873 | cc425644 | Iustin Pop | |
874 | cc425644 | Iustin Pop | <refsect3> |
875 | cc425644 | Iustin Pop | <title>ADD-TAGS</title> |
876 | cc425644 | Iustin Pop | |
877 | cc425644 | Iustin Pop | <cmdsynopsis> |
878 | cc425644 | Iustin Pop | <command>add-tags</command> |
879 | 810c50b7 | Iustin Pop | <arg choice="opt">--from <replaceable>file</replaceable></arg> |
880 | cc425644 | Iustin Pop | <arg choice="req"><replaceable>instancename</replaceable></arg> |
881 | cc425644 | Iustin Pop | <arg choice="req" |
882 | cc425644 | Iustin Pop | rep="repeat"><replaceable>tag</replaceable></arg> |
883 | cc425644 | Iustin Pop | </cmdsynopsis> |
884 | cc425644 | Iustin Pop | |
885 | cc425644 | Iustin Pop | <para> |
886 | cc425644 | Iustin Pop | Add tags to the given instance. If any of the tags contains |
887 | cc425644 | Iustin Pop | invalid characters, the entire operation will abort. |
888 | cc425644 | Iustin Pop | </para> |
889 | 810c50b7 | Iustin Pop | <para> |
890 | 810c50b7 | Iustin Pop | If the <option>--from</option> option is given, the list of |
891 | 810c50b7 | Iustin Pop | tags will be extended with the contents of that file (each |
892 | 810c50b7 | Iustin Pop | line becomes a tag). In this case, there is not need to pass |
893 | 810c50b7 | Iustin Pop | tags on the command line (if you do, both sources will be |
894 | 810c50b7 | Iustin Pop | used). A file name of - will be interpreted as stdin. |
895 | 810c50b7 | Iustin Pop | </para> |
896 | cc425644 | Iustin Pop | </refsect3> |
897 | cc425644 | Iustin Pop | |
898 | cc425644 | Iustin Pop | <refsect3> |
899 | cc425644 | Iustin Pop | <title>LIST-TAGS</title> |
900 | cc425644 | Iustin Pop | |
901 | cc425644 | Iustin Pop | <cmdsynopsis> |
902 | cc425644 | Iustin Pop | <command>list-tags</command> |
903 | cc425644 | Iustin Pop | <arg choice="req"><replaceable>instancename</replaceable></arg> |
904 | cc425644 | Iustin Pop | </cmdsynopsis> |
905 | cc425644 | Iustin Pop | |
906 | cc425644 | Iustin Pop | <para>List the tags of the given instance.</para> |
907 | cc425644 | Iustin Pop | </refsect3> |
908 | cc425644 | Iustin Pop | |
909 | cc425644 | Iustin Pop | <refsect3> |
910 | cc425644 | Iustin Pop | <title>REMOVE-TAGS</title> |
911 | cc425644 | Iustin Pop | <cmdsynopsis> |
912 | cc425644 | Iustin Pop | <command>remove-tags</command> |
913 | 810c50b7 | Iustin Pop | <arg choice="opt">--from <replaceable>file</replaceable></arg> |
914 | cc425644 | Iustin Pop | <arg choice="req"><replaceable>instancename</replaceable></arg> |
915 | cc425644 | Iustin Pop | <arg choice="req" |
916 | cc425644 | Iustin Pop | rep="repeat"><replaceable>tag</replaceable></arg> |
917 | cc425644 | Iustin Pop | </cmdsynopsis> |
918 | cc425644 | Iustin Pop | |
919 | cc425644 | Iustin Pop | <para> |
920 | cc425644 | Iustin Pop | Remove tags from the given instance. If any of the tags are |
921 | cc425644 | Iustin Pop | not existing on the node, the entire operation will abort. |
922 | cc425644 | Iustin Pop | </para> |
923 | 810c50b7 | Iustin Pop | |
924 | 810c50b7 | Iustin Pop | <para> |
925 | 810c50b7 | Iustin Pop | If the <option>--from</option> option is given, the list of |
926 | 810c50b7 | Iustin Pop | tags will be extended with the contents of that file (each |
927 | 810c50b7 | Iustin Pop | line becomes a tag). In this case, there is not need to pass |
928 | 810c50b7 | Iustin Pop | tags on the command line (if you do, both sources will be |
929 | 810c50b7 | Iustin Pop | used). A file name of - will be interpreted as stdin. |
930 | 810c50b7 | Iustin Pop | </para> |
931 | cc425644 | Iustin Pop | </refsect3> |
932 | cc425644 | Iustin Pop | |
933 | cc425644 | Iustin Pop | </refsect2> |
934 | cc425644 | Iustin Pop | |
935 | a8083063 | Iustin Pop | </refsect1> |
936 | a8083063 | Iustin Pop | |
937 | a8083063 | Iustin Pop | &footer; |
938 | a8083063 | Iustin Pop | |
939 | a8083063 | Iustin Pop | </refentry> |
940 | a8083063 | Iustin Pop | |
941 | a8083063 | Iustin Pop | <!-- Keep this comment at the end of the file |
942 | a8083063 | Iustin Pop | Local variables: |
943 | a8083063 | Iustin Pop | mode: sgml |
944 | a8083063 | Iustin Pop | sgml-omittag:t |
945 | a8083063 | Iustin Pop | sgml-shorttag:t |
946 | a8083063 | Iustin Pop | sgml-minimize-attributes:nil |
947 | a8083063 | Iustin Pop | sgml-always-quote-attributes:t |
948 | a8083063 | Iustin Pop | sgml-indent-step:2 |
949 | a8083063 | Iustin Pop | sgml-indent-data:t |
950 | a8083063 | Iustin Pop | sgml-parent-document:nil |
951 | a8083063 | Iustin Pop | sgml-default-dtd-file:nil |
952 | a8083063 | Iustin Pop | sgml-exposed-tags:nil |
953 | a8083063 | Iustin Pop | sgml-local-catalogs:nil |
954 | a8083063 | Iustin Pop | sgml-local-ecat-files:nil |
955 | a8083063 | Iustin Pop | End: |
956 | a8083063 | Iustin Pop | --> |