root / man / gnt-cluster.sgml @ d0834de3
History | View | Annotate | Download (6.3 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>June 20, 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-cluster</refentrytitle>"> |
10 | a8083063 | Iustin Pop | <!ENTITY dhpackage "gnt-cluster"> |
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 administration, cluster-wide</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 cluster-wide |
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 | <cmdsynopsis> |
59 | a8083063 | Iustin Pop | <command>command</command> |
60 | a8083063 | Iustin Pop | <arg>-n <replaceable>node</replaceable></arg> |
61 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>command</replaceable></arg> |
62 | a8083063 | Iustin Pop | </cmdsynopsis> |
63 | a8083063 | Iustin Pop | |
64 | a8083063 | Iustin Pop | <para> |
65 | a8083063 | Iustin Pop | Executes a command on all nodes. If the option |
66 | a8083063 | Iustin Pop | <option>-n</option> is not given, the command will be executed |
67 | a8083063 | Iustin Pop | on all nodes, otherwise it will be executed only on the node(s) |
68 | a8083063 | Iustin Pop | specified. Use the option multiple times for running it on |
69 | a8083063 | Iustin Pop | multiple nodes, like: |
70 | a8083063 | Iustin Pop | |
71 | a8083063 | Iustin Pop | <screen> |
72 | a8083063 | Iustin Pop | # gnt-cluster command -n node1.example.com -n node2.example.com date |
73 | a8083063 | Iustin Pop | </screen> |
74 | a8083063 | Iustin Pop | |
75 | a8083063 | Iustin Pop | </para> |
76 | a8083063 | Iustin Pop | |
77 | a8083063 | Iustin Pop | <para>The command is constructed by concatenating all other |
78 | a8083063 | Iustin Pop | command line arguments. For example, to list the contents of the |
79 | a8083063 | Iustin Pop | <filename class="directory">/etc</filename> directory on all |
80 | a8083063 | Iustin Pop | nodes, run: |
81 | a8083063 | Iustin Pop | |
82 | a8083063 | Iustin Pop | <screen> |
83 | a8083063 | Iustin Pop | # gnt-cluster command ls -l /etc |
84 | a8083063 | Iustin Pop | </screen> |
85 | a8083063 | Iustin Pop | |
86 | a8083063 | Iustin Pop | and the command which will be executed will be |
87 | a8083063 | Iustin Pop | <computeroutput>"ls -l /etc"</computeroutput> |
88 | a8083063 | Iustin Pop | </para> |
89 | a8083063 | Iustin Pop | |
90 | a8083063 | Iustin Pop | |
91 | a8083063 | Iustin Pop | <cmdsynopsis> |
92 | a8083063 | Iustin Pop | <command>copyfile</command> |
93 | a8083063 | Iustin Pop | <arg>-n <replaceable>node</replaceable></arg> |
94 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>file</replaceable></arg> |
95 | a8083063 | Iustin Pop | </cmdsynopsis> |
96 | a8083063 | Iustin Pop | |
97 | a8083063 | Iustin Pop | <para> |
98 | a8083063 | Iustin Pop | Copies a file to all or to some nodes. The argument specifies |
99 | a8083063 | Iustin Pop | the source file (on the current system), the <option>-n</option> |
100 | a8083063 | Iustin Pop | argument specifies the target node, or nodes if the option is |
101 | a8083063 | Iustin Pop | given multiple times. If <option>-n</option> is not given at |
102 | a8083063 | Iustin Pop | all, the file will be copied to all nodes. |
103 | a8083063 | Iustin Pop | |
104 | a8083063 | Iustin Pop | Example: |
105 | a8083063 | Iustin Pop | <screen> |
106 | a8083063 | Iustin Pop | # gnt-cluster -n node1.example.com -n node2.example.com copyfile /tmp/test |
107 | a8083063 | Iustin Pop | </screen> |
108 | a8083063 | Iustin Pop | |
109 | a8083063 | Iustin Pop | This will copy the file <filename>/tmp/test</filename> from the |
110 | a8083063 | Iustin Pop | current node to the two named nodes. |
111 | a8083063 | Iustin Pop | </para> |
112 | a8083063 | Iustin Pop | |
113 | a8083063 | Iustin Pop | <cmdsynopsis> |
114 | a8083063 | Iustin Pop | <command>getmaster</command> |
115 | a8083063 | Iustin Pop | </cmdsynopsis> |
116 | a8083063 | Iustin Pop | |
117 | a8083063 | Iustin Pop | <para> |
118 | a8083063 | Iustin Pop | Displays the current master node. |
119 | a8083063 | Iustin Pop | </para> |
120 | a8083063 | Iustin Pop | |
121 | a8083063 | Iustin Pop | <cmdsynopsis> |
122 | a8083063 | Iustin Pop | <command>info</command> |
123 | a8083063 | Iustin Pop | </cmdsynopsis> |
124 | a8083063 | Iustin Pop | |
125 | a8083063 | Iustin Pop | <para> |
126 | a8083063 | Iustin Pop | Shows runtime cluster information: cluster name, architecture |
127 | a8083063 | Iustin Pop | (32 or 64 bit), master node, node list and instance list. |
128 | a8083063 | Iustin Pop | </para> |
129 | a8083063 | Iustin Pop | |
130 | a8083063 | Iustin Pop | <cmdsynopsis> |
131 | a8083063 | Iustin Pop | <command>init</command> |
132 | a8083063 | Iustin Pop | <arg>-s <replaceable>secondary_ip</replaceable></arg> |
133 | 7e84d392 | Michael Hanselmann | <arg>-b <replaceable>bridge</replaceable></arg> |
134 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>clustername</replaceable></arg> |
135 | a8083063 | Iustin Pop | </cmdsynopsis> |
136 | a8083063 | Iustin Pop | <para> |
137 | a8083063 | Iustin Pop | This commands is only run once initially on the first node of |
138 | a8083063 | Iustin Pop | the cluster. It will initialize the cluster configuration and |
139 | a8083063 | Iustin Pop | setup ssh-keys and more. |
140 | a8083063 | Iustin Pop | </para> |
141 | a8083063 | Iustin Pop | |
142 | a8083063 | Iustin Pop | <para> |
143 | a8083063 | Iustin Pop | Note that the <replaceable>clustername</replaceable> is not any |
144 | a8083063 | Iustin Pop | random name. It has to be resolvable to an IP address using DNS, |
145 | a8083063 | Iustin Pop | and it is best if you give the fully-qualified domain name. |
146 | a8083063 | Iustin Pop | </para> |
147 | a8083063 | Iustin Pop | |
148 | a8083063 | Iustin Pop | <para> |
149 | a8083063 | Iustin Pop | The cluster can run in two modes: single-home or dual-homed. In |
150 | a8083063 | Iustin Pop | the first case, all traffic (both public traffic, inter-node |
151 | a8083063 | Iustin Pop | traffic and data replication traffic) goes over the same |
152 | a8083063 | Iustin Pop | interface. In the dual-homed case, the data replication traffic |
153 | a8083063 | Iustin Pop | goes over the second network. The <option>-s</option> option |
154 | a8083063 | Iustin Pop | here marks the cluster as dual-homed and its parameter |
155 | a8083063 | Iustin Pop | represents this node's address on the second network. If you |
156 | a8083063 | Iustin Pop | initialise the cluster with <option>-s</option>, all nodes added |
157 | a8083063 | Iustin Pop | must have a secondary IP as well. |
158 | a8083063 | Iustin Pop | </para> |
159 | a8083063 | Iustin Pop | |
160 | a8083063 | Iustin Pop | <para> |
161 | a8083063 | Iustin Pop | Note that for Ganeti it doesn't matter if the secondary network |
162 | a8083063 | Iustin Pop | is actually a separate physical network, or is done using |
163 | a8083063 | Iustin Pop | tunneling, etc. For performance reasons, it's recommended to use |
164 | a8083063 | Iustin Pop | a separate network, of course. |
165 | a8083063 | Iustin Pop | </para> |
166 | a8083063 | Iustin Pop | |
167 | 7e84d392 | Michael Hanselmann | <para> |
168 | 7e84d392 | Michael Hanselmann | The <option>-b</option> option specifies the default bridge for |
169 | 7e84d392 | Michael Hanselmann | instances. |
170 | 7e84d392 | Michael Hanselmann | </para> |
171 | 7e84d392 | Michael Hanselmann | |
172 | a8083063 | Iustin Pop | <cmdsynopsis> |
173 | a8083063 | Iustin Pop | <command>masterfailover</command> |
174 | a8083063 | Iustin Pop | </cmdsynopsis> |
175 | a8083063 | Iustin Pop | |
176 | a8083063 | Iustin Pop | <para> |
177 | a8083063 | Iustin Pop | Failover the master role to the current node. |
178 | a8083063 | Iustin Pop | </para> |
179 | a8083063 | Iustin Pop | |
180 | a8083063 | Iustin Pop | <cmdsynopsis> |
181 | a8083063 | Iustin Pop | <command>destroy</command> |
182 | a8083063 | Iustin Pop | </cmdsynopsis> |
183 | a8083063 | Iustin Pop | |
184 | a8083063 | Iustin Pop | <para> |
185 | a8083063 | Iustin Pop | Remove all configuration files related to the cluster, so that a |
186 | a8083063 | Iustin Pop | <command>gnt-cluster init</command> can be done again afterwards. |
187 | a8083063 | Iustin Pop | </para> |
188 | a8083063 | Iustin Pop | |
189 | a8083063 | Iustin Pop | <cmdsynopsis> |
190 | a8083063 | Iustin Pop | <command>verify</command> |
191 | a8083063 | Iustin Pop | </cmdsynopsis> |
192 | a8083063 | Iustin Pop | |
193 | a8083063 | Iustin Pop | <para> |
194 | a8083063 | Iustin Pop | Verify correctness of cluster configuration. This is safe with |
195 | a8083063 | Iustin Pop | respect to running instances, and incurs no downtime of the |
196 | a8083063 | Iustin Pop | instances. |
197 | a8083063 | Iustin Pop | </para> |
198 | a8083063 | Iustin Pop | |
199 | a8083063 | Iustin Pop | <cmdsynopsis> |
200 | a8083063 | Iustin Pop | <command>version</command> |
201 | a8083063 | Iustin Pop | </cmdsynopsis> |
202 | a8083063 | Iustin Pop | |
203 | a8083063 | Iustin Pop | <para> |
204 | a8083063 | Iustin Pop | Show the cluster version. |
205 | a8083063 | Iustin Pop | </para> |
206 | a8083063 | Iustin Pop | |
207 | a8083063 | Iustin Pop | </refsect1> |
208 | a8083063 | Iustin Pop | |
209 | a8083063 | Iustin Pop | &footer; |
210 | a8083063 | Iustin Pop | |
211 | a8083063 | Iustin Pop | </refentry> |
212 | a8083063 | Iustin Pop | |
213 | a8083063 | Iustin Pop | <!-- Keep this comment at the end of the file |
214 | a8083063 | Iustin Pop | Local variables: |
215 | a8083063 | Iustin Pop | mode: sgml |
216 | a8083063 | Iustin Pop | sgml-omittag:t |
217 | a8083063 | Iustin Pop | sgml-shorttag:t |
218 | a8083063 | Iustin Pop | sgml-minimize-attributes:nil |
219 | a8083063 | Iustin Pop | sgml-always-quote-attributes:t |
220 | a8083063 | Iustin Pop | sgml-indent-step:2 |
221 | a8083063 | Iustin Pop | sgml-indent-data:t |
222 | a8083063 | Iustin Pop | sgml-parent-document:nil |
223 | a8083063 | Iustin Pop | sgml-default-dtd-file:nil |
224 | a8083063 | Iustin Pop | sgml-exposed-tags:nil |
225 | a8083063 | Iustin Pop | sgml-local-catalogs:nil |
226 | a8083063 | Iustin Pop | sgml-local-ecat-files:nil |
227 | a8083063 | Iustin Pop | End: |
228 | a8083063 | Iustin Pop | --> |