Statistics
| Branch: | Tag: | Revision:

root / man / gnt-cluster.sgml @ 74adc100

History | View | Annotate | Download (29.1 kB)

1
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2

    
3
  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
4
  <!-- Please adjust the date whenever revising the manpage. -->
5
  <!ENTITY dhdate      "<date>February 12, 2009</date>">
6
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
7
       allowed: see man(7), man(1). -->
8
  <!ENTITY dhsection   "<manvolnum>8</manvolnum>">
9
  <!ENTITY dhucpackage "<refentrytitle>gnt-cluster</refentrytitle>">
10
  <!ENTITY dhpackage   "gnt-cluster">
11

    
12
  <!ENTITY debian      "<productname>Debian</productname>">
13
  <!ENTITY gnu         "<acronym>GNU</acronym>">
14
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
15
  <!ENTITY footer SYSTEM "footer.sgml">
16
]>
17

    
18
<refentry>
19
  <refentryinfo>
20
    <copyright>
21
      <year>2006</year>
22
      <year>2007</year>
23
      <year>2008</year>
24
      <year>2009</year>
25
      <holder>Google Inc.</holder>
26
    </copyright>
27
    &dhdate;
28
  </refentryinfo>
29
  <refmeta>
30
    &dhucpackage;
31

    
32
    &dhsection;
33
    <refmiscinfo>ganeti 2.0</refmiscinfo>
34
  </refmeta>
35
  <refnamediv>
36
    <refname>&dhpackage;</refname>
37

    
38
    <refpurpose>ganeti administration, cluster-wide</refpurpose>
39
  </refnamediv>
40
  <refsynopsisdiv>
41
    <cmdsynopsis>
42
      <command>&dhpackage; </command>
43

    
44
      <arg choice="req">command</arg>
45
      <arg>arguments...</arg>
46
    </cmdsynopsis>
47
  </refsynopsisdiv>
48
  <refsect1>
49
    <title>DESCRIPTION</title>
50

    
51
    <para>
52
      The <command>&dhpackage;</command> is used for cluster-wide
53
      administration in the ganeti system.
54
    </para>
55

    
56
  </refsect1>
57
  <refsect1>
58
    <title>COMMANDS</title>
59

    
60
    <refsect2>
61
      <title>ADD-TAGS</title>
62

    
63
      <cmdsynopsis>
64
        <command>add-tags</command>
65
        <arg choice="opt">--from <replaceable>file</replaceable></arg>
66
        <arg choice="req"
67
        rep="repeat"><replaceable>tag</replaceable></arg>
68
      </cmdsynopsis>
69

    
70
      <para>
71
        Add tags to the cluster. If any of the tags contains invalid
72
        characters, the entire operation will abort.
73
      </para>
74

    
75
      <para>
76
        If the <option>--from</option> option is given, the list of
77
        tags will be extended with the contents of that file (each
78
        line becomes a tag). In this case, there is not need to pass
79
        tags on the command line (if you do, both sources will be
80
        used). A file name of - will be interpreted as stdin.
81
      </para>
82
    </refsect2>
83

    
84
    <refsect2>
85
      <title>COMMAND</title>
86

    
87
      <cmdsynopsis>
88
        <command>command</command>
89
        <arg>-n <replaceable>node</replaceable></arg>
90
        <arg choice="req"><replaceable>command</replaceable></arg>
91
      </cmdsynopsis>
92

    
93
      <para>
94
        Executes a command on all nodes. If the option
95
        <option>-n</option> is not given, the command will be executed
96
        on all nodes, otherwise it will be executed only on the
97
        node(s) specified. Use the option multiple times for running
98
        it on multiple nodes, like:
99

    
100
        <screen>
101
          # gnt-cluster command -n node1.example.com -n node2.example.com date
102
        </screen>
103

    
104
      </para>
105

    
106
      <para>
107
        The command is executed serially on the selected nodes. If the
108
        master node is present in the list, the command will be
109
        executed last on the master. Regarding the other nodes, the
110
        execution order is somewhat alphabetic, so that
111
        node2.example.com will be earlier than node10.example.com but
112
        after node1.example.com.
113
      </para>
114

    
115
      <para>
116
        So given the node names node1, node2, node3, node10, node11,
117
        with node3 being the master, the order will be: node1, node2,
118
        node10, node11, node3.
119
      </para>
120

    
121
      <para>
122
        The command is constructed by concatenating all other command
123
        line arguments. For example, to list the contents of the
124
        <filename class="directory">/etc</filename> directory on all
125
        nodes, run:
126

    
127
        <screen>
128
          # gnt-cluster command ls -l /etc
129
        </screen>
130

    
131
        and the command which will be executed will be
132
        <computeroutput>"ls -l /etc"</computeroutput>
133
      </para>
134
    </refsect2>
135

    
136
    <refsect2>
137
      <title>COPYFILE</title>
138

    
139
      <cmdsynopsis>
140
        <command>copyfile</command>
141
        <arg>--use-replication-network</arg>
142
        <arg>-n <replaceable>node</replaceable></arg>
143
        <arg choice="req"><replaceable>file</replaceable></arg>
144
      </cmdsynopsis>
145

    
146
      <para>
147
        Copies a file to all or to some nodes. The argument specifies
148
        the source file (on the current system), the
149
        <option>-n</option> argument specifies the target node, or
150
        nodes if the option is given multiple times. If
151
        <option>-n</option> is not given at all, the file will be
152
        copied to all nodes.
153

    
154
        Passing the <option>--use-replication-network</option> option
155
        will cause the copy to be done over the replication network
156
        (only matters if the primary/secondary IPs are different).
157

    
158
        Example:
159
        <screen>
160
          # gnt-cluster -n node1.example.com -n node2.example.com copyfile /tmp/test
161
        </screen>
162

    
163
        This will copy the file <filename>/tmp/test</filename> from
164
        the current node to the two named nodes.
165
      </para>
166
    </refsect2>
167

    
168
    <refsect2>
169
      <title>DESTROY</title>
170

    
171
      <cmdsynopsis>
172
        <command>destroy</command>
173
        <arg choice="req">--yes-do-it</arg>
174
      </cmdsynopsis>
175

    
176
      <para>
177
        Remove all configuration files related to the cluster, so that
178
        a <command>gnt-cluster init</command> can be done again
179
        afterwards.
180
      </para>
181

    
182
      <para>
183
        Since this is a dangerous command, you are required to pass
184
        the argument <replaceable>--yes-do-it.</replaceable>
185
      </para>
186
    </refsect2>
187

    
188
    <refsect2>
189
      <title>GETMASTER</title>
190

    
191
      <cmdsynopsis>
192
        <command>getmaster</command>
193
      </cmdsynopsis>
194

    
195
      <para>
196
        Displays the current master node.
197
      </para>
198
    </refsect2>
199

    
200
    <refsect2>
201
      <title>INFO</title>
202

    
203
      <cmdsynopsis>
204
        <command>info</command>
205
      </cmdsynopsis>
206

    
207
      <para>
208
        Shows runtime cluster information: cluster name, architecture
209
        (32 or 64 bit), master node, node list and instance list.
210
      </para>
211
    </refsect2>
212

    
213
    <refsect2>
214
      <title>INIT</title>
215

    
216
      <cmdsynopsis>
217
        <command>init</command>
218
        <sbr>
219
        <arg>-s <replaceable>secondary_ip</replaceable></arg>
220
        <sbr>
221
        <arg>-g <replaceable>vg-name</replaceable></arg>
222
        <sbr>
223
        <arg>--master-netdev <replaceable>vg-name</replaceable></arg>
224
        <sbr>
225
        <arg>-m <replaceable>mac-prefix</replaceable></arg>
226
        <sbr>
227
        <arg>--no-lvm-storage</arg>
228
        <sbr>
229
        <arg>--no-etc-hosts</arg>
230
        <sbr>
231
        <arg>--no-ssh-init</arg>
232
        <sbr>
233
        <arg>--file-storage-dir <replaceable>dir</replaceable></arg>
234
        <sbr>
235
        <arg>--enabled-hypervisors <replaceable>hypervisors</replaceable></arg>
236
        <sbr>
237
        <arg>-t <replaceable>hypervisor name</replaceable></arg>
238
        <sbr>
239
        <arg>--hypervisor-parameters <replaceable>hypervisor</replaceable>:<replaceable>hv-param</replaceable>=<replaceable>value</replaceable><arg rep="repeat" choice="opt">,<replaceable>hv-param</replaceable>=<replaceable>value</replaceable></arg></arg>
240
        <sbr>
241
        <arg>--backend-parameters <replaceable>be-param</replaceable>=<replaceable>value</replaceable><arg rep="repeat" choice="opt">,<replaceable>be-param</replaceable>=<replaceable>value</replaceable></arg></arg>
242
        <sbr>
243
        <arg>--nic-parameters <replaceable>nic-param</replaceable>=<replaceable>value</replaceable><arg rep="repeat" choice="opt">,<replaceable>nic-param</replaceable>=<replaceable>value</replaceable></arg></arg>
244
        <sbr>
245
        <arg choice="req"><replaceable>clustername</replaceable></arg>
246
      </cmdsynopsis>
247

    
248
      <para>
249
        This commands is only run once initially on the first node of
250
        the cluster. It will initialize the cluster configuration and
251
        setup ssh-keys and more.
252
      </para>
253

    
254
      <para>
255
        Note that the <replaceable>clustername</replaceable> is not
256
        any random name. It has to be resolvable to an IP address
257
        using DNS, and it is best if you give the fully-qualified
258
        domain name. This hostname must resolve to an IP address
259
        reserved exclusively for this purpose.
260
      </para>
261

    
262
      <para>
263
        The cluster can run in two modes: single-home or
264
        dual-homed. In the first case, all traffic (both public
265
        traffic, inter-node traffic and data replication traffic) goes
266
        over the same interface. In the dual-homed case, the data
267
        replication traffic goes over the second network. The
268
        <option>-s</option> option here marks the cluster as
269
        dual-homed and its parameter represents this node's address on
270
        the second network. If you initialise the cluster with
271
        <option>-s</option>, all nodes added must have a secondary IP
272
        as well.
273
      </para>
274

    
275
      <para>
276
        Note that for Ganeti it doesn't matter if the secondary
277
        network is actually a separate physical network, or is done
278
        using tunneling, etc. For performance reasons, it's
279
        recommended to use a separate network, of course.
280
      </para>
281

    
282
      <para>
283
        The <option>-g</option> option will let you specify a volume group
284
        different than 'xenvg' for ganeti to use when creating instance disks.
285
        This volume group must have the same name on all nodes. Once the
286
        cluster is initialized this can be altered by using the
287
        <command>modify</command> command. If you don't want to use lvm
288
        storage at all use the <option>--no-lvm-storage</option> option.
289
        Once the cluster is initialized you can change this setup with the
290
        <command>modify</command> command.
291
      </para>
292

    
293
      <para>
294
        The <option>--master-netdev</option> option is useful for specifying a
295
        different interface on which the master will activate its IP address.
296
        It's important that all nodes have this interface because you'll need
297
        it for a master failover.
298
      </para>
299

    
300
      <para>
301
        The <option>-m</option> option will let you specify a three byte prefix
302
        under which the virtual MAC addresses of your instances will be
303
        generated. The prefix must be specified in the format XX:XX:XX and the
304
        default is aa:00:00.
305
      </para>
306

    
307
      <para>
308
        The <option>--no-lvm-storage</option> option allows you to initialize
309
        the cluster without lvm support. This means that only instances using
310
        files as storage backend will be possible to create. Once the cluster
311
        is initialized you can change this setup with the
312
        <command>modify</command> command.
313
      </para>
314

    
315
      <para>
316
        The <option>--no-etc-hosts</option> option allows you to initialize the
317
        cluster without modifying the <filename>/etc/hosts</filename> file.
318
      </para>
319

    
320
      <para>
321
        The <option>--no-ssh-init</option> option allows you to initialize the
322
        cluster without creating or distributing SSH key pairs.
323
      </para>
324

    
325
      <para>
326
        The <option>--file-storage-dir</option> option allows you
327
        set the directory to use for storing the instance disk
328
        files when using file storage as backend for instance disks.
329
      </para>
330

    
331
      <para>
332
        The <option>--enabled-hypervisors</option> option allows you
333
        to set the list of hypervisors that will be enabled for
334
        this cluster. Instance hypervisors can only be chosen from
335
        the list of enabled hypervisors, and the first entry of this list
336
        will be used by default. Currently, the following hypervisors are
337
        available:
338
      </para>
339

    
340
      <para>
341
        <variablelist>
342
          <varlistentry>
343
            <term>xen-pvm</term>
344
            <listitem>
345
              <para>
346
                Xen PVM hypervisor
347
              </para>
348
            </listitem>
349
          </varlistentry>
350
          <varlistentry>
351
            <term>xen-hvm</term>
352
            <listitem>
353
              <para>
354
                Xen HVM hypervisor
355
              </para>
356
            </listitem>
357
          </varlistentry>
358
          <varlistentry>
359
            <term>kvm</term>
360
            <listitem>
361
              <para>
362
                Linux KVM hypervisor
363
              </para>
364
            </listitem>
365
          </varlistentry>
366
          <varlistentry>
367
            <term>chroot</term>
368
            <listitem>
369
              <para>
370
                a simple chroot manager that starts chroot based on a
371
                script at the root of the filesystem holding the
372
                chroot
373
          <varlistentry>
374
            <term>fake</term>
375
            <listitem>
376
              <para>
377
                fake hypervisor for development/testing
378
              </para>
379
            </listitem>
380
          </varlistentry>
381
        </variablelist>
382
      </para>
383

    
384
      <para>
385
        Either a single hypervisor name or a comma-separated list of
386
        hypervisor names can be specified. If this option is not
387
        specified, only the xen-pvm hypervisor is enabled by default.
388
      </para>
389

    
390
      <para>
391
        The <option>--hypervisor-parameters</option> option allows you
392
        to set default hypervisor specific parameters for the
393
        cluster. The format of this option is the name of the
394
        hypervisor, followed by a colon and a comma-separated list of
395
        key=value pairs. The keys available for each hypervisors are
396
        detailed in the <citerefentry>
397
        <refentrytitle>gnt-instance</refentrytitle>
398
        <manvolnum>8</manvolnum> </citerefentry> man page, in the
399
        <command>add</command> command plus the following parameters
400
        which are only configurable globally (at cluster level):
401

    
402
        <variablelist>
403
          <varlistentry>
404
            <term>migration_port</term>
405
            <listitem>
406
              <simpara>Valid for the Xen PVM and KVM hypervisors.</simpara>
407

    
408
              <para>
409
                This options specifies the TCP port to use for
410
                live-migration. For Xen, the same port should be
411
                configured on all nodes in
412
                the <filename>/etc/xen/xend-config.sxp</filename>
413
                file, under the
414
                key <quote>xend-relocation-port</quote>.
415
              </para>
416
            </listitem>
417
          </varlistentry>
418
        </variablelist>
419

    
420
      </para>
421

    
422
      <para>
423
        The <option>--backend-parameters</option> option allows you to set
424
        the default backend parameters for the cluster. The parameter
425
        format is a comma-separated list of key=value pairs with the
426
        following supported keys:
427
      </para>
428

    
429
      <para>
430
        <variablelist>
431
          <varlistentry>
432
            <term>vcpus</term>
433
            <listitem>
434
              <para>
435
                Number of VCPUs to set for an instance by default, must
436
                be an integer, will be set to 1 if no specified.
437
              </para>
438
            </listitem>
439
          </varlistentry>
440
          <varlistentry>
441
            <term>memory</term>
442
            <listitem>
443
              <para>
444
                Amount of memory to allocate for an instance by default,
445
                can be either an integer or an integer followed by a
446
                unit (M for mebibytes and G for gibibytes are
447
                supported), will be set to 128M if not specified.
448
              </para>
449
            </listitem>
450
          </varlistentry>
451
          <varlistentry>
452
            <term>auto_balance</term>
453
            <listitem>
454
              <para>
455
                Value of the auto_balance flag for instances to use by
456
                default, will be set to true if not specified.
457
              </para>
458
            </listitem>
459
          </varlistentry>
460
        </variablelist>
461
      </para>
462

    
463
      <para>
464
        The <option>--nic-parameters</option> option allows you to set
465
        the default nic parameters for the cluster. The parameter
466
        format is a comma-separated list of key=value pairs with the
467
        following supported keys:
468
        <variablelist>
469
          <varlistentry>
470
            <term>mode</term>
471
            <listitem>
472
              <para>
473
                The default nic mode, 'routed' or 'bridged'.
474
              </para>
475
            </listitem>
476
          </varlistentry>
477
          <varlistentry>
478
            <term>link</term>
479
            <listitem>
480
              <para>
481
                In bridged mode the default NIC bridge. In routed mode it
482
                represents an hypervisor-vif-script dependent value to allow
483
                different instance groups. For example under the KVM default
484
                network script it is interpreted as a routing table number or
485
                name.
486
              </para>
487
            </listitem>
488
          </varlistentry>
489
        </variablelist>
490
      </para>
491

    
492
    </refsect2>
493

    
494
    <refsect2>
495
      <title>LIST-TAGS</title>
496

    
497
      <cmdsynopsis>
498
        <command>list-tags</command>
499
      </cmdsynopsis>
500

    
501
      <para>List the tags of the cluster.</para>
502
    </refsect2>
503

    
504
    <refsect2>
505
      <title>MASTERFAILOVER</title>
506

    
507
      <cmdsynopsis>
508
        <command>masterfailover</command>
509
        <arg>--no-voting</arg>
510
      </cmdsynopsis>
511

    
512
      <para>
513
        Failover the master role to the current node.
514
      </para>
515

    
516
      <para>
517
        The <option>--no-voting</option> option skips the remote node agreement
518
        checks. This is dangerous, but necessary in some cases (for example
519
        failing over the master role in a 2 node cluster with the original master
520
        down). If the original master then comes up, it won't be able to start
521
        its master daemon because it won't have enough votes, but so won't the
522
        new master, if the master daemon ever needs a restart. You can pass
523
        --no-voting to ganeti-masterd on the new master to solve this problem,
524
        and gnt-cluster redist-conf to make sure the cluster is consistent again.
525
      </para>
526

    
527
    </refsect2>
528

    
529
    <refsect2>
530
      <title>MODIFY</title>
531

    
532
      <cmdsynopsis>
533
        <command>modify</command>
534
        <sbr>
535
        <arg choice="opt">-g <replaceable>vg-name</replaceable></arg>
536
        <sbr>
537
        <arg choice="opt">--no-lvm-storage</arg>
538
        <sbr>
539
        <arg choice="opt">--enabled-hypervisors
540
        <replaceable>hypervisors</replaceable></arg>
541
        <sbr>
542
        <arg choice="opt">--hypervisor-parameters <replaceable>hypervisor</replaceable>:<replaceable>hv-param</replaceable>=<replaceable>value</replaceable><arg rep="repeat" choice="opt">,<replaceable>hv-param</replaceable>=<replaceable>value</replaceable></arg></arg>
543
        <sbr>
544
        <arg choice="opt">--backend-parameters <replaceable>be-param</replaceable>=<replaceable>value</replaceable><arg rep="repeat" choice="opt">,<replaceable>be-param</replaceable>=<replaceable>value</replaceable></arg></arg>
545
        <sbr>
546
        <arg choice="opt">--nic-parameters <replaceable>nic-param</replaceable>=<replaceable>value</replaceable><arg rep="repeat" choice="opt">,<replaceable>nic-param</replaceable>=<replaceable>value</replaceable></arg></arg>
547
        <sbr>
548
        <arg choice="opt">-C <replaceable>candidate_pool_size</replaceable></arg>
549

    
550
      </cmdsynopsis>
551

    
552
        <para>
553
          Modify the options for the cluster.
554
        </para>
555

    
556
        <para>
557
          The <option>-g</option>, <option>--no-lvm-storarge</option>,
558
          <option>--enabled-hypervisors</option>,
559
          <option>--hypervisor-parameters</option>,
560
          <option>--backend-parameters</option> and
561
          <option>--nic-parameters</option> and options are
562
          described in the <command>init</command> command.
563
        </para>
564

    
565
      <para>
566
        The <option>-C</option> option specifies the
567
        <varname>candidate_pool_size</varname> cluster parameter. This
568
        is the number of nodes that the master will try to keep as
569
        <literal>master_candidates</literal>. For more details about
570
        this role and other node roles, see the <citerefentry>
571
        <refentrytitle>ganeti</refentrytitle><manvolnum>7</manvolnum>
572
        </citerefentry>. If you increase the size, the master will
573
        automatically promote as many nodes as required and possible
574
        to reach the intended number.
575
      </para>
576
    </refsect2>
577

    
578
    <refsect2>
579
      <title>QUEUE</title>
580

    
581
      <cmdsynopsis>
582
        <command>queue</command>
583
        <arg choice="opt">drain</arg>
584
        <arg choice="opt">undrain</arg>
585
        <arg choice="opt">info</arg>
586

    
587
      </cmdsynopsis>
588

    
589
      <para>
590
        Change job queue properties.
591
      </para>
592

    
593
      <para>
594
        The <option>drain</option> option sets the drain flag on the
595
        job queue. No new jobs will be accepted, but jobs already in
596
        the queue will be processed.
597
      </para>
598

    
599
      <para>
600
        The <option>undrain</option> will unset the drain flag on the
601
        job queue. New jobs will be accepted.
602
      </para>
603

    
604
      <para>
605
        The <option>info</option> option shows the properties of the
606
        job queue.
607
      </para>
608
    </refsect2>
609

    
610
    <refsect2>
611
      <title>WATCHER</title>
612

    
613
      <cmdsynopsis>
614
        <command>watcher</command>
615
        <group choice="req">
616
          <arg>pause <replaceable>duration</replaceable></arg>
617
          <arg>continue</arg>
618
          <arg>info</arg>
619
        </group>
620
      </cmdsynopsis>
621

    
622
      <para>
623
        Make the watcher pause or let it continue.
624
      </para>
625

    
626
      <para>
627
        The <option>pause</option> option causes the watcher to pause for
628
        <replaceable>duration</replaceable> seconds.
629
      </para>
630

    
631
      <para>
632
        The <option>continue</option> option will let the watcher continue.
633
      </para>
634

    
635
      <para>
636
        The <option>info</option> option shows whether the watcher is currently
637
        paused.
638
      </para>
639
    </refsect2>
640

    
641
    <refsect2>
642
      <title>redist-conf</title>
643
      <cmdsynopsis>
644
        <command>redist-conf</command>
645
          <arg>--submit</arg>
646
      </cmdsynopsis>
647

    
648
      <para>
649
        This command forces a full push of configuration files from
650
        the master node to the other nodes in the cluster. This is
651
        normally not needed, but can be run if the
652
        <command>verify</command> complains about configuration
653
        mismatches.
654
      </para>
655

    
656
      <para>
657
        The <option>--submit</option> option is used to send the job
658
        to the master daemon but not wait for its completion. The job
659
        ID will be shown so that it can be examined via
660
        <command>gnt-job info</command>.
661
      </para>
662

    
663
    </refsect2>
664
    <refsect2>
665
      <title>REMOVE-TAGS</title>
666

    
667
      <cmdsynopsis>
668
        <command>remove-tags</command>
669
        <arg choice="opt">--from <replaceable>file</replaceable></arg>
670
        <arg choice="req"
671
        rep="repeat"><replaceable>tag</replaceable></arg>
672
      </cmdsynopsis>
673

    
674
      <para>
675
        Remove tags from the cluster. If any of the tags are not
676
        existing on the cluster, the entire operation will abort.
677
      </para>
678

    
679
      <para>
680
        If the <option>--from</option> option is given, the list of
681
        tags will be extended with the contents of that file (each
682
        line becomes a tag). In this case, there is not need to pass
683
        tags on the command line (if you do, both sources will be
684
        used). A file name of - will be interpreted as stdin.
685
      </para>
686
    </refsect2>
687

    
688
    <refsect2>
689
      <title>RENAME</title>
690

    
691
      <cmdsynopsis>
692
        <command>rename</command>
693
        <arg>-f</arg>
694
        <arg choice="req"><replaceable>name</replaceable></arg>
695
      </cmdsynopsis>
696

    
697
      <para>
698
        Renames the cluster and in the process updates the master IP
699
        address to the one the new name resolves to. At least one of
700
        either the name or the IP address must be different, otherwise
701
        the operation will be aborted.
702
      </para>
703

    
704
      <para>
705
        Note that since this command can be dangerous (especially when
706
        run over SSH), the command will require confirmation unless
707
        run with the <option>-f</option> option.
708
      </para>
709
    </refsect2>
710

    
711
    <refsect2>
712
      <title>RENEW-CRYPTO</title>
713

    
714
      <cmdsynopsis>
715
        <command>renew-crypto</command>
716
        <arg>-f</arg>
717
        <sbr>
718
        <arg choice="opt">--new-cluster-certificate</arg>
719
        <arg choice="opt">--new-confd-hmac-key</arg>
720
        <sbr>
721
        <arg choice="opt">--new-rapi-certificate</arg>
722
        <arg choice="opt">--rapi-certificate <replaceable>rapi-cert</replaceable></arg>
723
      </cmdsynopsis>
724

    
725
      <para>
726
        This command will stop all
727
        Ganeti daemons in the cluster and start them again once the new
728
        certificates and keys are replicated. The options
729
        <option>--new-cluster-certificate</option> and
730
        <option>--new-confd-hmac-key</option> can be used to regenerate the
731
        cluster-internal SSL certificate respective the HMAC key used by
732
        <citerefentry>
733
        <refentrytitle>ganeti-confd</refentrytitle><manvolnum>8</manvolnum>
734
        </citerefentry>. To generate a new self-signed RAPI certificate (used
735
        by <citerefentry>
736
        <refentrytitle>ganeti-rapi</refentrytitle><manvolnum>8</manvolnum>
737
        </citerefentry>) specify <option>--new-rapi-certificate</option>. If
738
        you want to use your own certificate, e.g. one signed by a certificate
739
        authority (CA), pass its filename to
740
        <option>--rapi-certificate</option>.
741
      </para>
742
    </refsect2>
743

    
744
    <refsect2>
745
      <title>REPAIR-DISK-SIZES</title>
746

    
747
      <cmdsynopsis>
748
        <command>repair-disk-sizes</command>
749
        <arg rep="repeat">instance</arg>
750
      </cmdsynopsis>
751

    
752
      <para>
753
        This command checks that the recorded size of the given
754
        instance's disks matches the actual size and updates any
755
        mismatches found. This is needed if the Ganeti configuration
756
        is no longer consistent with reality, as it will impact some
757
        disk operations. If no arguments are given, all instances will
758
        be checked.
759
      </para>
760

    
761
      <para>
762
        Note that only active disks can be checked by this command; in
763
        case a disk cannot be activated it's advised to use
764
        <command>gnt-instance activate-disks --ignore-size ...</command> to
765
        force activation without regard to the
766
        current size.
767
      </para>
768

    
769
      <para>
770
        When the all disk sizes are consistent, the command will
771
        return no output. Otherwise it will log details about the
772
        inconsistencies in the configuration.
773
      </para>
774
    </refsect2>
775

    
776
    <refsect2>
777
      <title>SEARCH-TAGS</title>
778

    
779
      <cmdsynopsis>
780
        <command>search-tags</command>
781
        <arg choice="req"><replaceable>pattern</replaceable></arg>
782
      </cmdsynopsis>
783

    
784
      <para>
785
        Searches the tags on all objects in the cluster (the cluster
786
        itself, the nodes and the instances) for a given pattern. The
787
        pattern is interpreted as a regular expression and a search
788
        will be done on it (i.e. the given pattern is not anchored to
789
        the beggining of the string; if you want that, prefix the
790
        pattern with <literal>^</literal>).
791
      </para>
792

    
793
      <para>
794
        If no tags are matching the pattern, the exit code of the
795
        command will be one. If there is at least one match, the exit
796
        code will be zero. Each match is listed on one line, the
797
        object and the tag separated by a space. The cluster will be
798
        listed as <filename>/cluster</filename>, a node will be listed
799
        as
800
        <filename>/nodes/<replaceable>name</replaceable></filename>,
801
        and an instance as
802
        <filename>/instances/<replaceable>name</replaceable></filename>.
803
        Example:
804
      </para>
805
<screen>
806
# gnt-cluster search-tags time
807
/cluster ctime:2007-09-01
808
/nodes/node1.example.com mtime:2007-10-04
809
</screen>
810
    </refsect2>
811

    
812
    <refsect2>
813
      <title>VERIFY</title>
814

    
815
      <cmdsynopsis>
816
        <command>verify</command>
817
        <arg choice="opt">--no-nplus1-mem</arg>
818
      </cmdsynopsis>
819

    
820
      <para>
821
        Verify correctness of cluster configuration. This is safe with
822
        respect to running instances, and incurs no downtime of the
823
        instances.
824
      </para>
825

    
826
      <para>
827
        If the <option>--no-nplus1-mem</option> option is given, ganeti won't
828
        check whether if it loses a node it can restart all the instances on
829
        their secondaries (and report an error otherwise).
830
      </para>
831
    </refsect2>
832

    
833
    <refsect2>
834
      <title>VERIFY-DISKS</title>
835

    
836
      <cmdsynopsis>
837
        <command>verify-disks</command>
838
      </cmdsynopsis>
839

    
840
      <para>
841
        The command checks which instances have degraded DRBD disks
842
        and activates the disks of those instances.
843
      </para>
844

    
845
      <para>
846
        This command is run from the <command>ganeti-watcher</command>
847
        tool, which also has a different, complementary algorithm for
848
        doing this check. Together, these two should ensure that DRBD
849
        disks are kept consistent.
850
      </para>
851
    </refsect2>
852

    
853
    <refsect2>
854
      <title>VERSION</title>
855

    
856
      <cmdsynopsis>
857
        <command>version</command>
858
      </cmdsynopsis>
859

    
860
      <para>
861
        Show the cluster version.
862
      </para>
863
    </refsect2>
864

    
865
  </refsect1>
866

    
867
  &footer;
868

    
869
</refentry>
870

    
871
<!-- Keep this comment at the end of the file
872
Local variables:
873
mode: sgml
874
sgml-omittag:t
875
sgml-shorttag:t
876
sgml-minimize-attributes:nil
877
sgml-always-quote-attributes:t
878
sgml-indent-step:2
879
sgml-indent-data:t
880
sgml-parent-document:nil
881
sgml-default-dtd-file:nil
882
sgml-exposed-tags:nil
883
sgml-local-catalogs:nil
884
sgml-local-ecat-files:nil
885
End:
886
-->