root / man / gnt-node.sgml @ 36e23a40
History | View | Annotate | Download (20.9 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 12, 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-node</refentrytitle>"> |
10 | a8083063 | Iustin Pop | <!ENTITY dhpackage "gnt-node"> |
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 | e7c6e02b | 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>node 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 managing the |
53 | a8083063 | Iustin Pop | (physical) nodes 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>ADD</title> |
62 | a8083063 | Iustin Pop | |
63 | a8083063 | Iustin Pop | <cmdsynopsis> |
64 | a8083063 | Iustin Pop | <command>add</command> |
65 | e7c6e02b | Michael Hanselmann | <arg>--readd</arg> |
66 | a8083063 | Iustin Pop | <arg>-s <replaceable>secondary_ip</replaceable></arg> |
67 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>nodename</replaceable></arg> |
68 | a8083063 | Iustin Pop | </cmdsynopsis> |
69 | a8083063 | Iustin Pop | |
70 | a8083063 | Iustin Pop | <para> |
71 | a8083063 | Iustin Pop | Adds the given node to the cluster. |
72 | a8083063 | Iustin Pop | </para> |
73 | a8083063 | Iustin Pop | |
74 | a8083063 | Iustin Pop | <para> |
75 | a8083063 | Iustin Pop | This command is used to join a new node to the cluster. You |
76 | a8083063 | Iustin Pop | will have to provide the password for root of the node to be |
77 | a8083063 | Iustin Pop | able to add the node in the cluster. The command needs to be |
78 | a8083063 | Iustin Pop | run on the ganeti master. |
79 | a8083063 | Iustin Pop | </para> |
80 | a8083063 | Iustin Pop | |
81 | a8083063 | Iustin Pop | <para> |
82 | a8083063 | Iustin Pop | Note that the command is potentially destructive, as it will |
83 | a8083063 | Iustin Pop | forcibly join the specified host the cluster, not paying |
84 | a8083063 | Iustin Pop | attention to its current status (it could be already in a |
85 | a8083063 | Iustin Pop | cluster, etc.) |
86 | a8083063 | Iustin Pop | </para> |
87 | a8083063 | Iustin Pop | |
88 | a8083063 | Iustin Pop | <para> |
89 | a8083063 | Iustin Pop | The <option>-s</option> is used in dual-home clusters and |
90 | a8083063 | Iustin Pop | specifies the new node's IP in the secondary network. See the |
91 | a8083063 | Iustin Pop | discussion in <citerefentry> |
92 | a8083063 | Iustin Pop | <refentrytitle>gnt-cluster</refentrytitle> |
93 | a8083063 | Iustin Pop | <manvolnum>8</manvolnum> </citerefentry> for more |
94 | a8083063 | Iustin Pop | informations. |
95 | a8083063 | Iustin Pop | </para> |
96 | a8083063 | Iustin Pop | |
97 | a8083063 | Iustin Pop | <para> |
98 | d3b4cf9f | Iustin Pop | In case you're readding a node after hardware failure, you can |
99 | d3b4cf9f | Iustin Pop | use the <option>--readd</option> parameter. In this case, you |
100 | d3b4cf9f | Iustin Pop | don't need to pass the secondary IP again, it will reused from |
101 | d3b4cf9f | Iustin Pop | the cluster. Also, the <literal>drained</literal> and |
102 | d3b4cf9f | Iustin Pop | <literal>offline</literal> flags of the node will be cleared |
103 | d3b4cf9f | Iustin Pop | before re-adding it. |
104 | e7c6e02b | Michael Hanselmann | </para> |
105 | e7c6e02b | Michael Hanselmann | |
106 | e7c6e02b | Michael Hanselmann | <para> |
107 | a8083063 | Iustin Pop | Example: |
108 | a8083063 | Iustin Pop | <screen> |
109 | a8083063 | Iustin Pop | # gnt-node add node5.example.com |
110 | a8083063 | Iustin Pop | # gnt-node add -s 192.168.44.5 node5.example.com |
111 | a8083063 | Iustin Pop | </screen> |
112 | a8083063 | Iustin Pop | </para> |
113 | a8083063 | Iustin Pop | </refsect2> |
114 | a8083063 | Iustin Pop | |
115 | a8083063 | Iustin Pop | <refsect2> |
116 | cc425644 | Iustin Pop | <title>ADD-TAGS</title> |
117 | cc425644 | Iustin Pop | |
118 | cc425644 | Iustin Pop | <cmdsynopsis> |
119 | cc425644 | Iustin Pop | <command>add-tags</command> |
120 | 810c50b7 | Iustin Pop | <arg choice="opt">--from <replaceable>file</replaceable></arg> |
121 | cc425644 | Iustin Pop | <arg choice="req"><replaceable>nodename</replaceable></arg> |
122 | cc425644 | Iustin Pop | <arg choice="req" |
123 | cc425644 | Iustin Pop | rep="repeat"><replaceable>tag</replaceable></arg> |
124 | cc425644 | Iustin Pop | </cmdsynopsis> |
125 | cc425644 | Iustin Pop | |
126 | cc425644 | Iustin Pop | <para> |
127 | cc425644 | Iustin Pop | Add tags to the given node. If any of the tags contains |
128 | cc425644 | Iustin Pop | invalid characters, the entire operation will abort. |
129 | cc425644 | Iustin Pop | </para> |
130 | 810c50b7 | Iustin Pop | |
131 | 810c50b7 | Iustin Pop | <para> |
132 | 810c50b7 | Iustin Pop | If the <option>--from</option> option is given, the list of |
133 | 810c50b7 | Iustin Pop | tags will be extended with the contents of that file (each |
134 | 810c50b7 | Iustin Pop | line becomes a tag). In this case, there is not need to pass |
135 | 810c50b7 | Iustin Pop | tags on the command line (if you do, both sources will be |
136 | 810c50b7 | Iustin Pop | used). A file name of - will be interpreted as stdin. |
137 | 810c50b7 | Iustin Pop | </para> |
138 | cc425644 | Iustin Pop | </refsect2> |
139 | cc425644 | Iustin Pop | |
140 | cc425644 | Iustin Pop | <refsect2> |
141 | a5bc662a | Iustin Pop | <title>EVACUATE</title> |
142 | a5bc662a | Iustin Pop | |
143 | a5bc662a | Iustin Pop | <cmdsynopsis> |
144 | a5bc662a | Iustin Pop | <command>evacuate</command> |
145 | a5bc662a | Iustin Pop | <arg>-f</arg> |
146 | d3b4cf9f | Iustin Pop | <group> |
147 | d3b4cf9f | Iustin Pop | <arg>--iallocator <replaceable>NAME</replaceable></arg> |
148 | d3b4cf9f | Iustin Pop | <arg>--new-secondary <replaceable>destination_node</replaceable></arg> |
149 | d3b4cf9f | Iustin Pop | </group> |
150 | d3b4cf9f | Iustin Pop | <arg choice="req"><replaceable>node</replaceable></arg> |
151 | a5bc662a | Iustin Pop | </cmdsynopsis> |
152 | a5bc662a | Iustin Pop | |
153 | a5bc662a | Iustin Pop | <para> |
154 | d3b4cf9f | Iustin Pop | This command will move all secondary instances away from the |
155 | d3b4cf9f | Iustin Pop | given node. It works only for instances having a drbd disk |
156 | d3b4cf9f | Iustin Pop | template. |
157 | d3b4cf9f | Iustin Pop | </para> |
158 | d3b4cf9f | Iustin Pop | |
159 | d3b4cf9f | Iustin Pop | <para> |
160 | d3b4cf9f | Iustin Pop | The new location for the instances can be specified in two ways: |
161 | d3b4cf9f | Iustin Pop | <itemizedlist> |
162 | d3b4cf9f | Iustin Pop | <listitem> |
163 | d3b4cf9f | Iustin Pop | <simpara>as a single node for all instances, via the |
164 | d3b4cf9f | Iustin Pop | <option>--new-secondary</option> option</simpara> |
165 | d3b4cf9f | Iustin Pop | </listitem> |
166 | d3b4cf9f | Iustin Pop | <listitem> |
167 | d3b4cf9f | Iustin Pop | <simpara>or via the <option>--iallocator</option> option, |
168 | d3b4cf9f | Iustin Pop | giving a script name as parameter, so each instance will |
169 | d3b4cf9f | Iustin Pop | be in turn placed on the (per the script) optimal |
170 | d3b4cf9f | Iustin Pop | node</simpara> |
171 | d3b4cf9f | Iustin Pop | </listitem> |
172 | d3b4cf9f | Iustin Pop | </itemizedlist> |
173 | a5bc662a | Iustin Pop | </para> |
174 | a5bc662a | Iustin Pop | |
175 | a5bc662a | Iustin Pop | <para> |
176 | a5bc662a | Iustin Pop | Example: |
177 | a5bc662a | Iustin Pop | <screen> |
178 | d3b4cf9f | Iustin Pop | # gnt-node evacuate -I dumb node3.example.com |
179 | a5bc662a | Iustin Pop | </screen> |
180 | a5bc662a | Iustin Pop | </para> |
181 | a5bc662a | Iustin Pop | </refsect2> |
182 | a5bc662a | Iustin Pop | |
183 | a5bc662a | Iustin Pop | <refsect2> |
184 | c450e9b0 | Iustin Pop | <title>FAILOVER</title> |
185 | c450e9b0 | Iustin Pop | |
186 | c450e9b0 | Iustin Pop | <cmdsynopsis> |
187 | c450e9b0 | Iustin Pop | <command>failover</command> |
188 | c450e9b0 | Iustin Pop | <arg>-f</arg> |
189 | c450e9b0 | Iustin Pop | <arg>--ignore-consistency</arg> |
190 | c450e9b0 | Iustin Pop | <arg choice="req"><replaceable>node</replaceable></arg> |
191 | c450e9b0 | Iustin Pop | </cmdsynopsis> |
192 | c450e9b0 | Iustin Pop | |
193 | c450e9b0 | Iustin Pop | <para> |
194 | c450e9b0 | Iustin Pop | This command will fail over all instances having the given |
195 | c450e9b0 | Iustin Pop | node as primary to their secondary nodes. This works only for |
196 | bd028152 | Iustin Pop | instances having a drbd disk template. |
197 | c450e9b0 | Iustin Pop | </para> |
198 | c450e9b0 | Iustin Pop | |
199 | c450e9b0 | Iustin Pop | <para> |
200 | c450e9b0 | Iustin Pop | Normally the failover will check the consistency of the disks |
201 | c450e9b0 | Iustin Pop | before failing over the instance. If you are trying to migrate |
202 | c450e9b0 | Iustin Pop | instances off a dead node, this will fail. Use the |
203 | c450e9b0 | Iustin Pop | <option>--ignore-consistency</option> option for this purpose. |
204 | c450e9b0 | Iustin Pop | </para> |
205 | c450e9b0 | Iustin Pop | |
206 | c450e9b0 | Iustin Pop | <para> |
207 | c450e9b0 | Iustin Pop | Example: |
208 | c450e9b0 | Iustin Pop | <screen> |
209 | c450e9b0 | Iustin Pop | # gnt-node failover node1.example.com |
210 | c450e9b0 | Iustin Pop | </screen> |
211 | c450e9b0 | Iustin Pop | </para> |
212 | c450e9b0 | Iustin Pop | </refsect2> |
213 | c450e9b0 | Iustin Pop | |
214 | c450e9b0 | Iustin Pop | <refsect2> |
215 | a8083063 | Iustin Pop | <title>INFO</title> |
216 | a8083063 | Iustin Pop | |
217 | a8083063 | Iustin Pop | <cmdsynopsis> |
218 | a8083063 | Iustin Pop | <command>info</command> |
219 | a8083063 | Iustin Pop | <arg rep="repeat"><replaceable>node</replaceable></arg> |
220 | a8083063 | Iustin Pop | </cmdsynopsis> |
221 | a8083063 | Iustin Pop | |
222 | a8083063 | Iustin Pop | <para> |
223 | a8083063 | Iustin Pop | Show detailed information about the nodes in the cluster. If you |
224 | a8083063 | Iustin Pop | don't give any arguments, all nodes will be shows, otherwise the |
225 | a8083063 | Iustin Pop | output will be restricted to the given names. |
226 | a8083063 | Iustin Pop | </para> |
227 | a8083063 | Iustin Pop | </refsect2> |
228 | a8083063 | Iustin Pop | |
229 | a8083063 | Iustin Pop | <refsect2> |
230 | a8083063 | Iustin Pop | <title>LIST</title> |
231 | a8083063 | Iustin Pop | |
232 | a8083063 | Iustin Pop | <cmdsynopsis> |
233 | a8083063 | Iustin Pop | <command>list</command> |
234 | d3b4cf9f | Iustin Pop | <arg>--sync</arg> |
235 | d3b4cf9f | Iustin Pop | <sbr> |
236 | a8083063 | Iustin Pop | <arg>--no-headers</arg> |
237 | a8083063 | Iustin Pop | <arg>--separator=<replaceable>SEPARATOR</replaceable></arg> |
238 | d3b4cf9f | Iustin Pop | <sbr> |
239 | d3b4cf9f | Iustin Pop | <arg>--units=<replaceable>UNITS</replaceable></arg> |
240 | 48c4dfa8 | Iustin Pop | <arg>-o <replaceable>[+]FIELD,...</replaceable></arg> |
241 | d3b4cf9f | Iustin Pop | <sbr> |
242 | d3b4cf9f | Iustin Pop | <arg rep="repeat">node</arg> |
243 | a8083063 | Iustin Pop | </cmdsynopsis> |
244 | a8083063 | Iustin Pop | |
245 | a8083063 | Iustin Pop | <para> |
246 | d3b4cf9f | Iustin Pop | Lists the nodes in the cluster. |
247 | a8083063 | Iustin Pop | </para> |
248 | a8083063 | Iustin Pop | |
249 | a8083063 | Iustin Pop | <para> |
250 | a8083063 | Iustin Pop | The <option>--no-headers</option> option will skip the initial |
251 | a8083063 | Iustin Pop | header line. The <option>--separator</option> option takes an |
252 | a8083063 | Iustin Pop | argument which denotes what will be used between the output |
253 | a8083063 | Iustin Pop | fields. Both these options are to help scripting. |
254 | a8083063 | Iustin Pop | </para> |
255 | a8083063 | Iustin Pop | |
256 | a8083063 | Iustin Pop | <para> |
257 | d3b4cf9f | Iustin Pop | The units used to display the numeric values in the output |
258 | d3b4cf9f | Iustin Pop | varies, depending on the options given. By default, the values |
259 | d3b4cf9f | Iustin Pop | will be formatted in the most appropriate unit. If the |
260 | d3b4cf9f | Iustin Pop | <option>--separator</option> option is given, then the values |
261 | d3b4cf9f | Iustin Pop | are shown in mebibytes to allow parsing by scripts. In both |
262 | d3b4cf9f | Iustin Pop | cases, the <option>--units</option> option can be used to |
263 | d3b4cf9f | Iustin Pop | enforce a given output unit. |
264 | d3b4cf9f | Iustin Pop | </para> |
265 | d3b4cf9f | Iustin Pop | |
266 | d3b4cf9f | Iustin Pop | <para> |
267 | d3b4cf9f | Iustin Pop | By default, the query of nodes will be done in parallel with |
268 | d3b4cf9f | Iustin Pop | any running jobs. This might give inconsistent results for the |
269 | d3b4cf9f | Iustin Pop | free disk/memory. The <option>--sync</option> can be used to |
270 | d3b4cf9f | Iustin Pop | grab locks for all the nodes and ensure consistent view of the |
271 | d3b4cf9f | Iustin Pop | cluster (but this might stall the query for a long time). |
272 | d3b4cf9f | Iustin Pop | </para> |
273 | d3b4cf9f | Iustin Pop | |
274 | d3b4cf9f | Iustin Pop | <para> |
275 | a8083063 | Iustin Pop | The <option>-o</option> option takes a comma-separated list of |
276 | a8083063 | Iustin Pop | output fields. The available fields and their meaning are: |
277 | a8083063 | Iustin Pop | <variablelist> |
278 | a8083063 | Iustin Pop | <varlistentry> |
279 | a8083063 | Iustin Pop | <term>name</term> |
280 | a8083063 | Iustin Pop | <listitem> |
281 | a8083063 | Iustin Pop | <simpara>the node name</simpara> |
282 | a8083063 | Iustin Pop | </listitem> |
283 | a8083063 | Iustin Pop | </varlistentry> |
284 | a8083063 | Iustin Pop | <varlistentry> |
285 | d8a4b51d | Iustin Pop | <term>pinst_cnt</term> |
286 | a8083063 | Iustin Pop | <listitem> |
287 | a8083063 | Iustin Pop | <simpara>the number of instances having this node as |
288 | a8083063 | Iustin Pop | primary</simpara> |
289 | a8083063 | Iustin Pop | </listitem> |
290 | a8083063 | Iustin Pop | </varlistentry> |
291 | a8083063 | Iustin Pop | <varlistentry> |
292 | d8a4b51d | Iustin Pop | <term>pinst_list</term> |
293 | d8a4b51d | Iustin Pop | <listitem> |
294 | d8a4b51d | Iustin Pop | <simpara>the list of instances having this node as |
295 | d8a4b51d | Iustin Pop | primary, comma separated</simpara> |
296 | d8a4b51d | Iustin Pop | </listitem> |
297 | d8a4b51d | Iustin Pop | </varlistentry> |
298 | d8a4b51d | Iustin Pop | <varlistentry> |
299 | d8a4b51d | Iustin Pop | <term>sinst_cnt</term> |
300 | a8083063 | Iustin Pop | <listitem> |
301 | a8083063 | Iustin Pop | <simpara>the number of instances having this node as a |
302 | a8083063 | Iustin Pop | secondary node</simpara> |
303 | a8083063 | Iustin Pop | </listitem> |
304 | a8083063 | Iustin Pop | </varlistentry> |
305 | a8083063 | Iustin Pop | <varlistentry> |
306 | d8a4b51d | Iustin Pop | <term>sinst_list</term> |
307 | d8a4b51d | Iustin Pop | <listitem> |
308 | d8a4b51d | Iustin Pop | <simpara>the list of instances having this node as a |
309 | d8a4b51d | Iustin Pop | secondary node, comma separated</simpara> |
310 | d8a4b51d | Iustin Pop | </listitem> |
311 | d8a4b51d | Iustin Pop | </varlistentry> |
312 | d8a4b51d | Iustin Pop | <varlistentry> |
313 | a8083063 | Iustin Pop | <term>pip</term> |
314 | a8083063 | Iustin Pop | <listitem> |
315 | a8083063 | Iustin Pop | <simpara>the primary ip of this node (used for cluster |
316 | a8083063 | Iustin Pop | communication)</simpara> |
317 | a8083063 | Iustin Pop | </listitem> |
318 | a8083063 | Iustin Pop | </varlistentry> |
319 | a8083063 | Iustin Pop | <varlistentry> |
320 | a8083063 | Iustin Pop | <term>sip</term> |
321 | a8083063 | Iustin Pop | <listitem> |
322 | a8083063 | Iustin Pop | <simpara> |
323 | a8083063 | Iustin Pop | the secondary ip of this node (used for data |
324 | a8083063 | Iustin Pop | replication in dual-ip clusters, see <citerefentry> |
325 | a8083063 | Iustin Pop | <refentrytitle>gnt-cluster</refentrytitle> |
326 | a8083063 | Iustin Pop | <manvolnum>8</manvolnum> |
327 | a8083063 | Iustin Pop | </citerefentry> |
328 | a8083063 | Iustin Pop | </simpara> |
329 | a8083063 | Iustin Pop | </listitem> |
330 | a8083063 | Iustin Pop | </varlistentry> |
331 | a8083063 | Iustin Pop | <varlistentry> |
332 | a8083063 | Iustin Pop | <term>dtotal</term> |
333 | a8083063 | Iustin Pop | <listitem> |
334 | a8083063 | Iustin Pop | <simpara>total disk space in the volume group used for |
335 | a8083063 | Iustin Pop | instance disk allocations</simpara> |
336 | a8083063 | Iustin Pop | </listitem> |
337 | a8083063 | Iustin Pop | </varlistentry> |
338 | a8083063 | Iustin Pop | <varlistentry> |
339 | a8083063 | Iustin Pop | <term>dfree</term> |
340 | a8083063 | Iustin Pop | <listitem> |
341 | a8083063 | Iustin Pop | <simpara>available disk space in the volume group</simpara> |
342 | a8083063 | Iustin Pop | </listitem> |
343 | a8083063 | Iustin Pop | </varlistentry> |
344 | a8083063 | Iustin Pop | <varlistentry> |
345 | a8083063 | Iustin Pop | <term>mtotal</term> |
346 | a8083063 | Iustin Pop | <listitem> |
347 | a8083063 | Iustin Pop | <simpara>total memory on the physical node</simpara> |
348 | a8083063 | Iustin Pop | </listitem> |
349 | a8083063 | Iustin Pop | </varlistentry> |
350 | a8083063 | Iustin Pop | <varlistentry> |
351 | a8083063 | Iustin Pop | <term>mnode</term> |
352 | a8083063 | Iustin Pop | <listitem> |
353 | a8083063 | Iustin Pop | <simpara>the memory used by the node itself</simpara> |
354 | a8083063 | Iustin Pop | </listitem> |
355 | a8083063 | Iustin Pop | </varlistentry> |
356 | a8083063 | Iustin Pop | <varlistentry> |
357 | a8083063 | Iustin Pop | <term>mfree</term> |
358 | a8083063 | Iustin Pop | <listitem> |
359 | a8083063 | Iustin Pop | <simpara>memory available for instance |
360 | a8083063 | Iustin Pop | allocations</simpara> |
361 | a8083063 | Iustin Pop | </listitem> |
362 | a8083063 | Iustin Pop | </varlistentry> |
363 | d8a4b51d | Iustin Pop | <varlistentry> |
364 | d8a4b51d | Iustin Pop | <term>bootid</term> |
365 | d8a4b51d | Iustin Pop | <listitem> |
366 | d8a4b51d | Iustin Pop | <simpara>the node bootid value; this is a linux specific |
367 | d8a4b51d | Iustin Pop | feature that assigns a new UUID to the node at each boot |
368 | d8a4b51d | Iustin Pop | and can be use to detect node reboots (by tracking |
369 | d8a4b51d | Iustin Pop | changes in this value)</simpara> |
370 | d8a4b51d | Iustin Pop | </listitem> |
371 | d8a4b51d | Iustin Pop | </varlistentry> |
372 | 130a6a6f | Iustin Pop | <varlistentry> |
373 | 130a6a6f | Iustin Pop | <term>tags</term> |
374 | 130a6a6f | Iustin Pop | <listitem> |
375 | 130a6a6f | Iustin Pop | <simpara>comma-separated list of the node's |
376 | 130a6a6f | Iustin Pop | tags</simpara> |
377 | 130a6a6f | Iustin Pop | </listitem> |
378 | 130a6a6f | Iustin Pop | </varlistentry> |
379 | 38d7239a | Iustin Pop | <varlistentry> |
380 | 38d7239a | Iustin Pop | <term>serial_no</term> |
381 | 38d7239a | Iustin Pop | <listitem> |
382 | 38d7239a | Iustin Pop | <simpara>the so called 'serial number' of the instance; |
383 | 38d7239a | Iustin Pop | this is a numeric field that is incremented each time |
384 | 38d7239a | Iustin Pop | the instance is modified, and it can be used to detect |
385 | 38d7239a | Iustin Pop | modifications</simpara> |
386 | 38d7239a | Iustin Pop | </listitem> |
387 | 38d7239a | Iustin Pop | </varlistentry> |
388 | d3b4cf9f | Iustin Pop | <varlistentry> |
389 | d3b4cf9f | Iustin Pop | <term>ctotal</term> |
390 | d3b4cf9f | Iustin Pop | <listitem> |
391 | d3b4cf9f | Iustin Pop | <simpara>the toal number of logical processors</simpara> |
392 | d3b4cf9f | Iustin Pop | </listitem> |
393 | d3b4cf9f | Iustin Pop | </varlistentry> |
394 | d3b4cf9f | Iustin Pop | <varlistentry> |
395 | d3b4cf9f | Iustin Pop | <term>cnodes</term> |
396 | d3b4cf9f | Iustin Pop | <listitem> |
397 | d3b4cf9f | Iustin Pop | <simpara>the number of NUMA domains on the node, if the |
398 | d3b4cf9f | Iustin Pop | hypervisor can export this information</simpara> |
399 | d3b4cf9f | Iustin Pop | </listitem> |
400 | d3b4cf9f | Iustin Pop | </varlistentry> |
401 | d3b4cf9f | Iustin Pop | <varlistentry> |
402 | d3b4cf9f | Iustin Pop | <term>csockets</term> |
403 | d3b4cf9f | Iustin Pop | <listitem> |
404 | d3b4cf9f | Iustin Pop | <simpara>the number of physical CPU sockets, if the |
405 | d3b4cf9f | Iustin Pop | hypervisor can export this information</simpara> |
406 | d3b4cf9f | Iustin Pop | </listitem> |
407 | d3b4cf9f | Iustin Pop | </varlistentry> |
408 | d3b4cf9f | Iustin Pop | <varlistentry> |
409 | d3b4cf9f | Iustin Pop | <term>master_candidate</term> |
410 | d3b4cf9f | Iustin Pop | <listitem> |
411 | d3b4cf9f | Iustin Pop | <simpara>whether the node is a master candidate or not</simpara> |
412 | d3b4cf9f | Iustin Pop | </listitem> |
413 | d3b4cf9f | Iustin Pop | </varlistentry> |
414 | d3b4cf9f | Iustin Pop | <varlistentry> |
415 | d3b4cf9f | Iustin Pop | <term>drained</term> |
416 | d3b4cf9f | Iustin Pop | <listitem> |
417 | d3b4cf9f | Iustin Pop | <simpara>whether the node is drained or not</simpara> |
418 | d3b4cf9f | Iustin Pop | </listitem> |
419 | d3b4cf9f | Iustin Pop | </varlistentry> |
420 | d3b4cf9f | Iustin Pop | <varlistentry> |
421 | d3b4cf9f | Iustin Pop | <term>offline</term> |
422 | d3b4cf9f | Iustin Pop | <listitem> |
423 | d3b4cf9f | Iustin Pop | <simpara>whether the node is offline or not</simpara> |
424 | d3b4cf9f | Iustin Pop | </listitem> |
425 | d3b4cf9f | Iustin Pop | </varlistentry> |
426 | a8083063 | Iustin Pop | </variablelist> |
427 | a8083063 | Iustin Pop | </para> |
428 | a8083063 | Iustin Pop | |
429 | a8083063 | Iustin Pop | <para> |
430 | 48c4dfa8 | Iustin Pop | If the value of the option starts with the character |
431 | 48c4dfa8 | Iustin Pop | <constant>+</constant>, the new fields will be added to the |
432 | 48c4dfa8 | Iustin Pop | default list. This allows to quickly see the default list plus |
433 | 48c4dfa8 | Iustin Pop | a few other fields, instead of retyping the entire list of |
434 | 48c4dfa8 | Iustin Pop | fields. |
435 | 48c4dfa8 | Iustin Pop | </para> |
436 | 48c4dfa8 | Iustin Pop | |
437 | 48c4dfa8 | Iustin Pop | <para> |
438 | a8083063 | Iustin Pop | Note that some of this fields are known from the configuration |
439 | d3b4cf9f | Iustin Pop | of the cluster (e.g. <simplelist type="inline"> |
440 | a8083063 | Iustin Pop | <member>name</member> <member>pinst</member> |
441 | a8083063 | Iustin Pop | <member>sinst</member> <member>pip</member> |
442 | a8083063 | Iustin Pop | <member>sip</member> </simplelist> and thus the master does |
443 | a8083063 | Iustin Pop | not need to contact the node for this data (making the listing |
444 | a8083063 | Iustin Pop | fast if only fields from this set are selected), whereas the |
445 | a8083063 | Iustin Pop | other fields are "live" fields and we need to make a query to |
446 | a8083063 | Iustin Pop | the cluster nodes. |
447 | a8083063 | Iustin Pop | </para> |
448 | a8083063 | Iustin Pop | |
449 | a8083063 | Iustin Pop | <para> |
450 | a8083063 | Iustin Pop | Depending on the virtualization type and implementation |
451 | a8083063 | Iustin Pop | details, the mtotal, mnode and mfree may have slighly varying |
452 | a8083063 | Iustin Pop | meanings. For example, some solutions share the node memory |
453 | a8083063 | Iustin Pop | with the pool of memory used for instances |
454 | d3b4cf9f | Iustin Pop | (<acronym>KVM</acronym>), whereas others have separate memory |
455 | a8083063 | Iustin Pop | for the node and for the instances (Xen). |
456 | a8083063 | Iustin Pop | </para> |
457 | d3b4cf9f | Iustin Pop | |
458 | d3b4cf9f | Iustin Pop | <para> |
459 | d3b4cf9f | Iustin Pop | If no node names are given, then all nodes are |
460 | d3b4cf9f | Iustin Pop | queried. Otherwise, only the given nodes will be listed. |
461 | d3b4cf9f | Iustin Pop | </para> |
462 | a8083063 | Iustin Pop | </refsect2> |
463 | a8083063 | Iustin Pop | |
464 | a8083063 | Iustin Pop | <refsect2> |
465 | cc425644 | Iustin Pop | <title>LIST-TAGS</title> |
466 | cc425644 | Iustin Pop | |
467 | cc425644 | Iustin Pop | <cmdsynopsis> |
468 | cc425644 | Iustin Pop | <command>list-tags</command> |
469 | cc425644 | Iustin Pop | <arg choice="req"><replaceable>nodename</replaceable></arg> |
470 | cc425644 | Iustin Pop | </cmdsynopsis> |
471 | cc425644 | Iustin Pop | |
472 | cc425644 | Iustin Pop | <para>List the tags of the given node.</para> |
473 | cc425644 | Iustin Pop | </refsect2> |
474 | cc425644 | Iustin Pop | |
475 | cc425644 | Iustin Pop | <refsect2> |
476 | d3b4cf9f | Iustin Pop | <title>MIGRATE</title> |
477 | d3b4cf9f | Iustin Pop | <cmdsynopsis> |
478 | d3b4cf9f | Iustin Pop | <command>migrate</command> |
479 | d3b4cf9f | Iustin Pop | <arg>-f</arg> |
480 | d3b4cf9f | Iustin Pop | <arg>--non-live</arg> |
481 | d3b4cf9f | Iustin Pop | <arg choice="req"><replaceable>node</replaceable></arg> |
482 | d3b4cf9f | Iustin Pop | </cmdsynopsis> |
483 | d3b4cf9f | Iustin Pop | |
484 | d3b4cf9f | Iustin Pop | <para> |
485 | d3b4cf9f | Iustin Pop | This command will migrate all instances having the given |
486 | d3b4cf9f | Iustin Pop | node as primary to their secondary nodes. This works only for |
487 | d3b4cf9f | Iustin Pop | instances having a drbd disk template. |
488 | d3b4cf9f | Iustin Pop | </para> |
489 | d3b4cf9f | Iustin Pop | |
490 | d3b4cf9f | Iustin Pop | <para> |
491 | d3b4cf9f | Iustin Pop | As for the <command>gnt-instance migrate</command> command, |
492 | d3b4cf9f | Iustin Pop | the <option>--no-live</option> option can be given to do a |
493 | d3b4cf9f | Iustin Pop | non-live migration. |
494 | d3b4cf9f | Iustin Pop | </para> |
495 | d3b4cf9f | Iustin Pop | |
496 | d3b4cf9f | Iustin Pop | <para> |
497 | d3b4cf9f | Iustin Pop | Example: |
498 | d3b4cf9f | Iustin Pop | <screen> |
499 | d3b4cf9f | Iustin Pop | # gnt-node migrate node1.example.com |
500 | d3b4cf9f | Iustin Pop | </screen> |
501 | d3b4cf9f | Iustin Pop | </para> |
502 | d3b4cf9f | Iustin Pop | |
503 | d3b4cf9f | Iustin Pop | </refsect2> |
504 | d3b4cf9f | Iustin Pop | |
505 | d3b4cf9f | Iustin Pop | <refsect2> |
506 | a8083063 | Iustin Pop | <title>REMOVE</title> |
507 | a8083063 | Iustin Pop | |
508 | a8083063 | Iustin Pop | <cmdsynopsis> |
509 | a8083063 | Iustin Pop | <command>remove</command> |
510 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>nodename</replaceable></arg> |
511 | a8083063 | Iustin Pop | </cmdsynopsis> |
512 | a8083063 | Iustin Pop | |
513 | a8083063 | Iustin Pop | <para> |
514 | a8083063 | Iustin Pop | Removes a node from the cluster. Instances must be removed or |
515 | a8083063 | Iustin Pop | migrated to another cluster before. |
516 | a8083063 | Iustin Pop | </para> |
517 | a8083063 | Iustin Pop | |
518 | a8083063 | Iustin Pop | <para> |
519 | a8083063 | Iustin Pop | Example: |
520 | a8083063 | Iustin Pop | <screen> |
521 | a8083063 | Iustin Pop | # gnt-node remove node5.example.com |
522 | a8083063 | Iustin Pop | </screen> |
523 | a8083063 | Iustin Pop | </para> |
524 | a8083063 | Iustin Pop | </refsect2> |
525 | a8083063 | Iustin Pop | |
526 | dcb93971 | Michael Hanselmann | <refsect2> |
527 | cc425644 | Iustin Pop | <title>REMOVE-TAGS</title> |
528 | cc425644 | Iustin Pop | <cmdsynopsis> |
529 | cc425644 | Iustin Pop | <command>remove-tags</command> |
530 | 810c50b7 | Iustin Pop | <arg choice="opt">--from <replaceable>file</replaceable></arg> |
531 | cc425644 | Iustin Pop | <arg choice="req"><replaceable>nodename</replaceable></arg> |
532 | cc425644 | Iustin Pop | <arg choice="req" |
533 | cc425644 | Iustin Pop | rep="repeat"><replaceable>tag</replaceable></arg> |
534 | cc425644 | Iustin Pop | </cmdsynopsis> |
535 | cc425644 | Iustin Pop | |
536 | cc425644 | Iustin Pop | <para> |
537 | cc425644 | Iustin Pop | Remove tags from the given node. If any of the tags are not |
538 | cc425644 | Iustin Pop | existing on the node, the entire operation will abort. |
539 | cc425644 | Iustin Pop | </para> |
540 | 810c50b7 | Iustin Pop | |
541 | 810c50b7 | Iustin Pop | <para> |
542 | 810c50b7 | Iustin Pop | If the <option>--from</option> option is given, the list of |
543 | 810c50b7 | Iustin Pop | tags will be extended with the contents of that file (each |
544 | 810c50b7 | Iustin Pop | line becomes a tag). In this case, there is not need to pass |
545 | 810c50b7 | Iustin Pop | tags on the command line (if you do, both sources will be |
546 | 810c50b7 | Iustin Pop | used). A file name of - will be interpreted as stdin. |
547 | 810c50b7 | Iustin Pop | </para> |
548 | cc425644 | Iustin Pop | </refsect2> |
549 | cc425644 | Iustin Pop | |
550 | cc425644 | Iustin Pop | <refsect2> |
551 | dcb93971 | Michael Hanselmann | <title>VOLUMES</title> |
552 | dcb93971 | Michael Hanselmann | |
553 | dcb93971 | Michael Hanselmann | <cmdsynopsis> |
554 | dcb93971 | Michael Hanselmann | <command>volumes</command> |
555 | f69dab6d | Iustin Pop | <arg>--no-headers</arg> |
556 | f69dab6d | Iustin Pop | <arg>--human-readable</arg> |
557 | f69dab6d | Iustin Pop | <arg>--separator=<replaceable>SEPARATOR</replaceable></arg> |
558 | f69dab6d | Iustin Pop | <arg>--output=<replaceable>FIELDS</replaceable></arg> |
559 | f69dab6d | Iustin Pop | <sbr> |
560 | dcb93971 | Michael Hanselmann | <arg rep="repeat"><replaceable>node</replaceable></arg> |
561 | dcb93971 | Michael Hanselmann | </cmdsynopsis> |
562 | dcb93971 | Michael Hanselmann | |
563 | dcb93971 | Michael Hanselmann | <para> |
564 | dcb93971 | Michael Hanselmann | Lists all logical volumes and their physical disks from the node(s) |
565 | dcb93971 | Michael Hanselmann | provided. |
566 | dcb93971 | Michael Hanselmann | </para> |
567 | dcb93971 | Michael Hanselmann | |
568 | dcb93971 | Michael Hanselmann | <para> |
569 | f69dab6d | Iustin Pop | The <option>--no-headers</option> option will skip the initial |
570 | f69dab6d | Iustin Pop | header line. The <option>--separator</option> option takes an |
571 | f69dab6d | Iustin Pop | argument which denotes what will be used between the output |
572 | f69dab6d | Iustin Pop | fields. Both these options are to help scripting. |
573 | f69dab6d | Iustin Pop | </para> |
574 | f69dab6d | Iustin Pop | |
575 | f69dab6d | Iustin Pop | <para> |
576 | d3b4cf9f | Iustin Pop | The units used to display the numeric values in the output |
577 | d3b4cf9f | Iustin Pop | varies, depending on the options given. By default, the values |
578 | d3b4cf9f | Iustin Pop | will be formatted in the most appropriate unit. If the |
579 | d3b4cf9f | Iustin Pop | <option>--separator</option> option is given, then the values |
580 | d3b4cf9f | Iustin Pop | are shown in mebibytes to allow parsing by scripts. In both |
581 | d3b4cf9f | Iustin Pop | cases, the <option>--units</option> option can be used to |
582 | d3b4cf9f | Iustin Pop | enforce a given output unit. |
583 | d3b4cf9f | Iustin Pop | </para> |
584 | d3b4cf9f | Iustin Pop | |
585 | d3b4cf9f | Iustin Pop | <para> |
586 | f69dab6d | Iustin Pop | The <option>-o</option> option takes a comma-separated list of |
587 | f69dab6d | Iustin Pop | output fields. The available fields and their meaning are: |
588 | f69dab6d | Iustin Pop | <variablelist> |
589 | f69dab6d | Iustin Pop | <varlistentry> |
590 | f69dab6d | Iustin Pop | <term>node</term> |
591 | f69dab6d | Iustin Pop | <listitem> |
592 | f69dab6d | Iustin Pop | <simpara>the node name on which the volume exists</simpara> |
593 | f69dab6d | Iustin Pop | </listitem> |
594 | f69dab6d | Iustin Pop | </varlistentry> |
595 | f69dab6d | Iustin Pop | <varlistentry> |
596 | f69dab6d | Iustin Pop | <term>phys</term> |
597 | f69dab6d | Iustin Pop | <listitem> |
598 | f69dab6d | Iustin Pop | <simpara>the physical drive (on which the LVM physical |
599 | f69dab6d | Iustin Pop | volume lives)</simpara> |
600 | f69dab6d | Iustin Pop | </listitem> |
601 | f69dab6d | Iustin Pop | </varlistentry> |
602 | f69dab6d | Iustin Pop | <varlistentry> |
603 | f69dab6d | Iustin Pop | <term>vg</term> |
604 | f69dab6d | Iustin Pop | <listitem> |
605 | f69dab6d | Iustin Pop | <simpara>the volume group name</simpara> |
606 | f69dab6d | Iustin Pop | </listitem> |
607 | f69dab6d | Iustin Pop | </varlistentry> |
608 | f69dab6d | Iustin Pop | <varlistentry> |
609 | f69dab6d | Iustin Pop | <term>name</term> |
610 | f69dab6d | Iustin Pop | <listitem> |
611 | f69dab6d | Iustin Pop | <simpara>the logical volume name</simpara> |
612 | f69dab6d | Iustin Pop | </listitem> |
613 | f69dab6d | Iustin Pop | </varlistentry> |
614 | f69dab6d | Iustin Pop | <varlistentry> |
615 | f69dab6d | Iustin Pop | <term>size</term> |
616 | f69dab6d | Iustin Pop | <listitem> |
617 | f69dab6d | Iustin Pop | <simpara>the logical volume size</simpara> |
618 | f69dab6d | Iustin Pop | </listitem> |
619 | f69dab6d | Iustin Pop | </varlistentry> |
620 | f69dab6d | Iustin Pop | <varlistentry> |
621 | f69dab6d | Iustin Pop | <term>instance</term> |
622 | f69dab6d | Iustin Pop | <listitem> |
623 | f69dab6d | Iustin Pop | <simpara>The name of the instance to which this volume |
624 | f69dab6d | Iustin Pop | belongs, or (in case it's an orphan volume) the |
625 | f69dab6d | Iustin Pop | character <quote>-</quote></simpara> |
626 | f69dab6d | Iustin Pop | </listitem> |
627 | f69dab6d | Iustin Pop | </varlistentry> |
628 | f69dab6d | Iustin Pop | </variablelist> |
629 | f69dab6d | Iustin Pop | </para> |
630 | f69dab6d | Iustin Pop | |
631 | f69dab6d | Iustin Pop | <para> |
632 | dcb93971 | Michael Hanselmann | Example: |
633 | dcb93971 | Michael Hanselmann | <screen> |
634 | dcb93971 | Michael Hanselmann | # gnt-node volumes node5.example.com |
635 | dcb93971 | Michael Hanselmann | Node PhysDev VG Name Size Instance |
636 | dcb93971 | Michael Hanselmann | node1.example.com /dev/hdc1 xenvg instance1.example.com-sda_11000.meta 128 instance1.example.com |
637 | dcb93971 | Michael Hanselmann | node1.example.com /dev/hdc1 xenvg instance1.example.com-sda_11001.data 256 instance1.example.com |
638 | dcb93971 | Michael Hanselmann | </screen> |
639 | dcb93971 | Michael Hanselmann | </para> |
640 | dcb93971 | Michael Hanselmann | </refsect2> |
641 | dcb93971 | Michael Hanselmann | |
642 | a8083063 | Iustin Pop | </refsect1> |
643 | a8083063 | Iustin Pop | |
644 | a8083063 | Iustin Pop | &footer; |
645 | a8083063 | Iustin Pop | |
646 | a8083063 | Iustin Pop | </refentry> |
647 | a8083063 | Iustin Pop | |
648 | a8083063 | Iustin Pop | <!-- Keep this comment at the end of the file |
649 | a8083063 | Iustin Pop | Local variables: |
650 | a8083063 | Iustin Pop | mode: sgml |
651 | a8083063 | Iustin Pop | sgml-omittag:t |
652 | a8083063 | Iustin Pop | sgml-shorttag:t |
653 | a8083063 | Iustin Pop | sgml-minimize-attributes:nil |
654 | a8083063 | Iustin Pop | sgml-always-quote-attributes:t |
655 | a8083063 | Iustin Pop | sgml-indent-step:2 |
656 | a8083063 | Iustin Pop | sgml-indent-data:t |
657 | a8083063 | Iustin Pop | sgml-parent-document:nil |
658 | a8083063 | Iustin Pop | sgml-default-dtd-file:nil |
659 | a8083063 | Iustin Pop | sgml-exposed-tags:nil |
660 | a8083063 | Iustin Pop | sgml-local-catalogs:nil |
661 | a8083063 | Iustin Pop | sgml-local-ecat-files:nil |
662 | a8083063 | Iustin Pop | End: |
663 | a8083063 | Iustin Pop | --> |