Revision 4de0fa98

b/man/Makefile.am
1 1
# Build man pages
2 2

  
3 3
man_MANS = ganeti.7 ganeti-os-interface.7 gnt-cluster.8 gnt-node.8 gnt-os.8 \
4
	   gnt-instance.8 ganeti-noded.8 ganeti-watcher.8 gnt-backup.8
4
	   gnt-instance.8 ganeti-noded.8 ganeti-watcher.8 gnt-backup.8 \
5
	   ganeti-master.8
5 6

  
6 7
maninput = $(patsubst %.7,%.in,$(patsubst %.8,%.in,$(man_MANS)))
7 8

  
8 9
EXTRA_DIST = ganeti-os-interface.sgml gnt-cluster.sgml gnt-node.sgml \
9 10
	     ganeti-watcher.sgml ganeti.sgml gnt-instance.sgml gnt-os.sgml \
10
	     gnt-backup.sgml ganeti-noded.sgml \
11
	     gnt-backup.sgml ganeti-noded.sgml ganeti-master.sgml \
11 12
	     footer.sgml $(maninput)
12 13
CLEANFILES = *.[78]
13 14
MAINTAINERCLEANFILES = $(maninput)
b/man/footer.sgml
53 53
      <citerefentry>
54 54
        <refentrytitle>ganeti-noded</refentrytitle>
55 55
        <manvolnum>8</manvolnum>
56
      </citerefentry> (node daemon).
56
      </citerefentry> (node daemon),
57
      <citerefentry>
58
        <refentrytitle>ganeti-master</refentrytitle>
59
        <manvolnum>8</manvolnum>
60
      </citerefentry> (the master startup script).
57 61
    </para>
58 62

  
59 63
  </refsect1>
b/man/ganeti-master.sgml
1
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2

  
3
  <!-- Please adjust the date whenever revising the manpage. -->
4
  <!ENTITY dhdate      "<date>November 22, 2007</date>">
5
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
6
       allowed: see man(7), man(1). -->
7
  <!ENTITY dhsection   "<manvolnum>8</manvolnum>">
8
  <!ENTITY dhucpackage "<refentrytitle>ganeti-master</refentrytitle>">
9
  <!ENTITY dhpackage   "ganeti-master">
10

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

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

  
29
    &dhsection;
30
    <refmiscinfo>ganeti 1.2</refmiscinfo>
31
  </refmeta>
32
  <refnamediv>
33
    <refname>&dhpackage;</refname>
34

  
35
    <refpurpose>ganeti master startup script</refpurpose>
36
  </refnamediv>
37
  <refsynopsisdiv>
38
    <cmdsynopsis>
39
      <command>&dhpackage; </command>
40
      <arg>-d</arg>
41
      <group choice="req">
42
        <arg>start</arg>
43
        <arg>stop</arg>
44
      </group>
45

  
46
    </cmdsynopsis>
47
  </refsynopsisdiv>
48
  <refsect1>
49
    <title>DESCRIPTION</title>
50

  
51
    <para>
52
      The <command>&dhpackage;</command> is the program that activates
53
      the cluster IP on the master node.
54
    </para>
55

  
56
    <para>
57
      The script will first check to see if the IP is not already
58
      alive on the cluster (on another node). If so, it wil abort the
59
      startup.
60
    </para>
61

  
62
    <para>
63
      If the master IP is unreachable, the script will add the IP to
64
      the <literal>master_netdev</literal> interface (as configured at
65
      cluster init time) with the label the name of the interface plus
66
      <quote>:0</quote>, so that the new IP shows up as a
67
      subinterface. After that, it will send three gratuitous ARP
68
      updates so that the switch updates its tables immediatly
69
      (instead of after expiry).
70
    </para>
71

  
72
  </refsect1>
73

  
74
  <refsect1>
75
    <title>Exit codes</title>
76
    <variablelist>
77
      <varlistentry>
78
        <term>0</term>
79
        <listitem>
80
          <simpara>successfull exit, IP activated</simpara>
81
        </listitem>
82
      </varlistentry>
83
      <varlistentry>
84
        <term>1</term>
85
        <listitem>
86
          <simpara>failed to add the IP to the interface</simpara>
87
        </listitem>
88
      </varlistentry>
89
      <varlistentry>
90
        <term>11</term>
91
        <listitem>
92
          <simpara>this node doesn't have the master role, no action
93
            taken</simpara>
94
        </listitem>
95
      </varlistentry>
96
      <varlistentry>
97
        <term>12</term>
98
        <listitem>
99
          <simpara>the configuration of the node is not complete; most
100
          probably, this node is not part of a cluster</simpara>
101
        </listitem>
102
      </varlistentry>
103
      <varlistentry>
104
        <term>13</term>
105
        <listitem>
106
          <simpara>the IP is reachable on the network, activation
107
            aborted</simpara>
108
        </listitem>
109
      </varlistentry>
110
      <varlistentry>
111
        <term>14</term>
112
        <listitem>
113
          <simpara>argument error - the script should be called with
114
          either the <option>start</option> or <option>stop</option>
115
          arguments</simpara>
116
        </listitem>
117
      </varlistentry>
118
    </variablelist>
119
  </refsect1>
120

  
121
  &footer;
122

  
123
</refentry>
124

  
125
<!-- Keep this comment at the end of the file
126
Local variables:
127
mode: sgml
128
sgml-omittag:t
129
sgml-shorttag:t
130
sgml-minimize-attributes:nil
131
sgml-always-quote-attributes:t
132
sgml-indent-step:2
133
sgml-indent-data:t
134
sgml-parent-document:nil
135
sgml-default-dtd-file:nil
136
sgml-exposed-tags:nil
137
sgml-local-catalogs:nil
138
sgml-local-ecat-files:nil
139
End:
140
-->

Also available in: Unified diff