Revision d3b4cf9f man/gnt-node.sgml

b/man/gnt-node.sgml
2 2

  
3 3
  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
4 4
  <!-- Please adjust the date whenever revising the manpage. -->
5
  <!ENTITY dhdate      "<date>June 20, 2007</date>">
5
  <!ENTITY dhdate      "<date>February 12, 2009</date>">
6 6
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
7 7
       allowed: see man(7), man(1). -->
8 8
  <!ENTITY dhsection   "<manvolnum>8</manvolnum>">
......
21 21
      <year>2006</year>
22 22
      <year>2007</year>
23 23
      <year>2008</year>
24
      <year>2009</year>
24 25
      <holder>Google Inc.</holder>
25 26
    </copyright>
26 27
    &dhdate;
......
29 30
    &dhucpackage;
30 31

  
31 32
    &dhsection;
32
    <refmiscinfo>ganeti 1.2</refmiscinfo>
33
    <refmiscinfo>ganeti 2.0</refmiscinfo>
33 34
  </refmeta>
34 35
  <refnamediv>
35 36
    <refname>&dhpackage;</refname>
......
94 95
      </para>
95 96

  
96 97
      <para>
97
        In case you're readding a node after hardware failure, you
98
        can use the <option>--readd</option> parameter.
98
        In case you're readding a node after hardware failure, you can
99
        use the <option>--readd</option> parameter. In this case, you
100
        don't need to pass the secondary IP again, it will reused from
101
        the cluster. Also, the <literal>drained</literal> and
102
        <literal>offline</literal> flags of the node will be cleared
103
        before re-adding it.
99 104
      </para>
100 105

  
101 106
      <para>
......
138 143
      <cmdsynopsis>
139 144
        <command>evacuate</command>
140 145
        <arg>-f</arg>
141
        <arg choice="req"><replaceable>source_node</replaceable></arg>
142
        <arg choice="req"><replaceable>destination_node</replaceable></arg>
146
        <group>
147
          <arg>--iallocator <replaceable>NAME</replaceable></arg>
148
          <arg>--new-secondary <replaceable>destination_node</replaceable></arg>
149
        </group>
150
        <arg choice="req"><replaceable>node</replaceable></arg>
143 151
      </cmdsynopsis>
144 152

  
145 153
      <para>
146
        This command will change the secondary node from the source
147
        node to the destination node for all instances having the
148
        source node as secondary. It works only for instances having
149
        a drbd disk template.
154
        This command will move all secondary instances away from the
155
        given node. It works only for instances having a drbd disk
156
        template.
157
      </para>
158

  
159
      <para>
160
        The new location for the instances can be specified in two ways:
161
        <itemizedlist>
162
          <listitem>
163
            <simpara>as a single node for all instances, via the
164
            <option>--new-secondary</option> option</simpara>
165
          </listitem>
166
          <listitem>
167
            <simpara>or via the <option>--iallocator</option> option,
168
            giving a script name as parameter, so each instance will
169
            be in turn placed on the (per the script) optimal
170
            node</simpara>
171
          </listitem>
172
        </itemizedlist>
150 173
      </para>
151 174

  
152 175
      <para>
153 176
        Example:
154 177
        <screen>
155
          # gnt-node evacuate node1.example.com node2.example.com
178
          # gnt-node evacuate -I dumb node3.example.com
156 179
        </screen>
157 180
      </para>
158 181
    </refsect2>
......
208 231

  
209 232
      <cmdsynopsis>
210 233
        <command>list</command>
234
        <arg>--sync</arg>
235
        <sbr>
211 236
        <arg>--no-headers</arg>
212 237
        <arg>--separator=<replaceable>SEPARATOR</replaceable></arg>
238
        <sbr>
239
        <arg>--units=<replaceable>UNITS</replaceable></arg>
213 240
        <arg>-o <replaceable>[+]FIELD,...</replaceable></arg>
241
        <sbr>
242
        <arg rep="repeat">node</arg>
214 243
      </cmdsynopsis>
215 244

  
216 245
      <para>
217
        Lists the nodes in the cluster. If you give the
218
        <option>--ip-info</option> option, the output contains just
219
        the node name, primary ip and secondary ip. In case the
220
        secondary ip is the same as the primary one, it will be listed
221
        as <emphasis>"-"</emphasis>.
246
        Lists the nodes in the cluster.
222 247
      </para>
223 248

  
224 249
      <para>
......
229 254
      </para>
230 255

  
231 256
      <para>
257
        The units used to display the numeric values in the output
258
        varies, depending on the options given. By default, the values
259
        will be formatted in the most appropriate unit. If the
260
        <option>--separator</option> option is given, then the values
261
        are shown in mebibytes to allow parsing by scripts. In both
262
        cases, the <option>--units</option> option can be used to
263
        enforce a given output unit.
264
      </para>
265

  
266
      <para>
267
        By default, the query of nodes will be done in parallel with
268
        any running jobs. This might give inconsistent results for the
269
        free disk/memory. The <option>--sync</option> can be used to
270
        grab locks for all the nodes and ensure consistent view of the
271
        cluster (but this might stall the query for a long time).
272
      </para>
273

  
274
      <para>
232 275
        The <option>-o</option> option takes a comma-separated list of
233 276
        output fields. The available fields and their meaning are:
234 277
        <variablelist>
......
342 385
              modifications</simpara>
343 386
            </listitem>
344 387
          </varlistentry>
388
          <varlistentry>
389
            <term>ctotal</term>
390
            <listitem>
391
              <simpara>the toal number of logical processors</simpara>
392
            </listitem>
393
          </varlistentry>
394
          <varlistentry>
395
            <term>cnodes</term>
396
            <listitem>
397
              <simpara>the number of NUMA domains on the node, if the
398
              hypervisor can export this information</simpara>
399
            </listitem>
400
          </varlistentry>
401
          <varlistentry>
402
            <term>csockets</term>
403
            <listitem>
404
              <simpara>the number of physical CPU sockets, if the
405
              hypervisor can export this information</simpara>
406
            </listitem>
407
          </varlistentry>
408
          <varlistentry>
409
            <term>master_candidate</term>
410
            <listitem>
411
              <simpara>whether the node is a master candidate or not</simpara>
412
            </listitem>
413
          </varlistentry>
414
          <varlistentry>
415
            <term>drained</term>
416
            <listitem>
417
              <simpara>whether the node is drained or not</simpara>
418
            </listitem>
419
          </varlistentry>
420
          <varlistentry>
421
            <term>offline</term>
422
            <listitem>
423
              <simpara>whether the node is offline or not</simpara>
424
            </listitem>
425
          </varlistentry>
345 426
        </variablelist>
346 427
      </para>
347 428

  
......
355 436

  
356 437
      <para>
357 438
        Note that some of this fields are known from the configuration
358
        of the cluster (<simplelist type="inline">
439
        of the cluster (e.g. <simplelist type="inline">
359 440
        <member>name</member> <member>pinst</member>
360 441
        <member>sinst</member> <member>pip</member>
361 442
        <member>sip</member> </simplelist> and thus the master does
......
370 451
        details, the mtotal, mnode and mfree may have slighly varying
371 452
        meanings. For example, some solutions share the node memory
372 453
        with the pool of memory used for instances
373
        (<acronym>UML</acronym>), whereas others have separate memory
454
        (<acronym>KVM</acronym>), whereas others have separate memory
374 455
        for the node and for the instances (Xen).
375 456
      </para>
457

  
458
      <para>
459
        If no node names are given, then all nodes are
460
        queried. Otherwise, only the given nodes will be listed.
461
      </para>
376 462
    </refsect2>
377 463

  
378 464
    <refsect2>
......
387 473
    </refsect2>
388 474

  
389 475
    <refsect2>
476
      <title>MIGRATE</title>
477
      <cmdsynopsis>
478
        <command>migrate</command>
479
        <arg>-f</arg>
480
        <arg>--non-live</arg>
481
        <arg choice="req"><replaceable>node</replaceable></arg>
482
      </cmdsynopsis>
483

  
484
      <para>
485
        This command will migrate all instances having the given
486
        node as primary to their secondary nodes. This works only for
487
        instances having a drbd disk template.
488
      </para>
489

  
490
      <para>
491
        As for the <command>gnt-instance migrate</command> command,
492
        the <option>--no-live</option> option can be given to do a
493
        non-live migration.
494
      </para>
495

  
496
      <para>
497
        Example:
498
        <screen>
499
          # gnt-node migrate node1.example.com
500
        </screen>
501
      </para>
502

  
503
    </refsect2>
504

  
505
    <refsect2>
390 506
      <title>REMOVE</title>
391 507

  
392 508
      <cmdsynopsis>
......
457 573
      </para>
458 574

  
459 575
      <para>
576
        The units used to display the numeric values in the output
577
        varies, depending on the options given. By default, the values
578
        will be formatted in the most appropriate unit. If the
579
        <option>--separator</option> option is given, then the values
580
        are shown in mebibytes to allow parsing by scripts. In both
581
        cases, the <option>--units</option> option can be used to
582
        enforce a given output unit.
583
      </para>
584

  
585
      <para>
460 586
        The <option>-o</option> option takes a comma-separated list of
461 587
        output fields. The available fields and their meaning are:
462 588
        <variablelist>

Also available in: Unified diff