root / man / gnt-cluster.sgml @ cc425644
History | View | Annotate | Download (8.8 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 | 75f49d9b | Iustin Pop | <refsect2> |
59 | cc425644 | Iustin Pop | <title>ADD-TAGS</title> |
60 | cc425644 | Iustin Pop | |
61 | cc425644 | Iustin Pop | <cmdsynopsis> |
62 | cc425644 | Iustin Pop | <command>add-tags</command> |
63 | cc425644 | Iustin Pop | <arg choice="req" |
64 | cc425644 | Iustin Pop | rep="repeat"><replaceable>tag</replaceable></arg> |
65 | cc425644 | Iustin Pop | </cmdsynopsis> |
66 | cc425644 | Iustin Pop | |
67 | cc425644 | Iustin Pop | <para> |
68 | cc425644 | Iustin Pop | Add tags to the cluster. If any of the tags contains invalid |
69 | cc425644 | Iustin Pop | characters, the entire operation will abort. |
70 | cc425644 | Iustin Pop | </para> |
71 | cc425644 | Iustin Pop | </refsect2> |
72 | cc425644 | Iustin Pop | |
73 | cc425644 | Iustin Pop | <refsect2> |
74 | 75f49d9b | Iustin Pop | <title>COMMAND</title> |
75 | 75f49d9b | Iustin Pop | |
76 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
77 | 75f49d9b | Iustin Pop | <command>command</command> |
78 | 75f49d9b | Iustin Pop | <arg>-n <replaceable>node</replaceable></arg> |
79 | 75f49d9b | Iustin Pop | <arg choice="req"><replaceable>command</replaceable></arg> |
80 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
81 | 75f49d9b | Iustin Pop | |
82 | 75f49d9b | Iustin Pop | <para> |
83 | 75f49d9b | Iustin Pop | Executes a command on all nodes. If the option |
84 | 75f49d9b | Iustin Pop | <option>-n</option> is not given, the command will be executed |
85 | 75f49d9b | Iustin Pop | on all nodes, otherwise it will be executed only on the |
86 | 75f49d9b | Iustin Pop | node(s) specified. Use the option multiple times for running |
87 | 75f49d9b | Iustin Pop | it on multiple nodes, like: |
88 | 75f49d9b | Iustin Pop | |
89 | 75f49d9b | Iustin Pop | <screen> |
90 | 75f49d9b | Iustin Pop | # gnt-cluster command -n node1.example.com -n node2.example.com date |
91 | 75f49d9b | Iustin Pop | </screen> |
92 | 75f49d9b | Iustin Pop | |
93 | 75f49d9b | Iustin Pop | </para> |
94 | 75f49d9b | Iustin Pop | |
95 | 75f49d9b | Iustin Pop | <para> |
96 | 75f49d9b | Iustin Pop | The command is constructed by concatenating all other command |
97 | 75f49d9b | Iustin Pop | line arguments. For example, to list the contents of the |
98 | 75f49d9b | Iustin Pop | <filename class="directory">/etc</filename> directory on all |
99 | 75f49d9b | Iustin Pop | nodes, run: |
100 | 75f49d9b | Iustin Pop | |
101 | 75f49d9b | Iustin Pop | <screen> |
102 | 75f49d9b | Iustin Pop | # gnt-cluster command ls -l /etc |
103 | 75f49d9b | Iustin Pop | </screen> |
104 | 75f49d9b | Iustin Pop | |
105 | 75f49d9b | Iustin Pop | and the command which will be executed will be |
106 | 75f49d9b | Iustin Pop | <computeroutput>"ls -l /etc"</computeroutput> |
107 | 75f49d9b | Iustin Pop | </para> |
108 | 75f49d9b | Iustin Pop | </refsect2> |
109 | 75f49d9b | Iustin Pop | |
110 | 75f49d9b | Iustin Pop | <refsect2> |
111 | 75f49d9b | Iustin Pop | <title>COPYFILE</title> |
112 | 75f49d9b | Iustin Pop | |
113 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
114 | 75f49d9b | Iustin Pop | <command>copyfile</command> |
115 | 75f49d9b | Iustin Pop | <arg>-n <replaceable>node</replaceable></arg> |
116 | 75f49d9b | Iustin Pop | <arg choice="req"><replaceable>file</replaceable></arg> |
117 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
118 | 75f49d9b | Iustin Pop | |
119 | 75f49d9b | Iustin Pop | <para> |
120 | 75f49d9b | Iustin Pop | Copies a file to all or to some nodes. The argument specifies |
121 | 75f49d9b | Iustin Pop | the source file (on the current system), the |
122 | 75f49d9b | Iustin Pop | <option>-n</option> argument specifies the target node, or |
123 | 75f49d9b | Iustin Pop | nodes if the option is given multiple times. If |
124 | 75f49d9b | Iustin Pop | <option>-n</option> is not given at all, the file will be |
125 | 75f49d9b | Iustin Pop | copied to all nodes. |
126 | 75f49d9b | Iustin Pop | |
127 | 75f49d9b | Iustin Pop | Example: |
128 | 75f49d9b | Iustin Pop | <screen> |
129 | 75f49d9b | Iustin Pop | # gnt-cluster -n node1.example.com -n node2.example.com copyfile /tmp/test |
130 | 75f49d9b | Iustin Pop | </screen> |
131 | 75f49d9b | Iustin Pop | |
132 | 75f49d9b | Iustin Pop | This will copy the file <filename>/tmp/test</filename> from |
133 | 75f49d9b | Iustin Pop | the current node to the two named nodes. |
134 | 75f49d9b | Iustin Pop | </para> |
135 | 75f49d9b | Iustin Pop | </refsect2> |
136 | 75f49d9b | Iustin Pop | |
137 | 75f49d9b | Iustin Pop | <refsect2> |
138 | 75f49d9b | Iustin Pop | <title>DESTROY</title> |
139 | 75f49d9b | Iustin Pop | |
140 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
141 | 75f49d9b | Iustin Pop | <command>destroy</command> |
142 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
143 | 75f49d9b | Iustin Pop | |
144 | 75f49d9b | Iustin Pop | <para> |
145 | 75f49d9b | Iustin Pop | Remove all configuration files related to the cluster, so that |
146 | 75f49d9b | Iustin Pop | a <command>gnt-cluster init</command> can be done again |
147 | 75f49d9b | Iustin Pop | afterwards. |
148 | 75f49d9b | Iustin Pop | </para> |
149 | 75f49d9b | Iustin Pop | </refsect2> |
150 | 75f49d9b | Iustin Pop | |
151 | 75f49d9b | Iustin Pop | <refsect2> |
152 | 75f49d9b | Iustin Pop | <title>GETMASTER</title> |
153 | 75f49d9b | Iustin Pop | |
154 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
155 | 75f49d9b | Iustin Pop | <command>getmaster</command> |
156 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
157 | 75f49d9b | Iustin Pop | |
158 | 75f49d9b | Iustin Pop | <para> |
159 | 75f49d9b | Iustin Pop | Displays the current master node. |
160 | 75f49d9b | Iustin Pop | </para> |
161 | 75f49d9b | Iustin Pop | </refsect2> |
162 | 75f49d9b | Iustin Pop | |
163 | 75f49d9b | Iustin Pop | <refsect2> |
164 | 75f49d9b | Iustin Pop | <title>INFO</title> |
165 | 75f49d9b | Iustin Pop | |
166 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
167 | 75f49d9b | Iustin Pop | <command>info</command> |
168 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
169 | 75f49d9b | Iustin Pop | |
170 | 75f49d9b | Iustin Pop | <para> |
171 | 75f49d9b | Iustin Pop | Shows runtime cluster information: cluster name, architecture |
172 | 75f49d9b | Iustin Pop | (32 or 64 bit), master node, node list and instance list. |
173 | 75f49d9b | Iustin Pop | </para> |
174 | 75f49d9b | Iustin Pop | </refsect2> |
175 | 75f49d9b | Iustin Pop | |
176 | 75f49d9b | Iustin Pop | <refsect2> |
177 | 75f49d9b | Iustin Pop | <title>INIT</title> |
178 | 75f49d9b | Iustin Pop | |
179 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
180 | 75f49d9b | Iustin Pop | <command>init</command> |
181 | 75f49d9b | Iustin Pop | <arg>-s <replaceable>secondary_ip</replaceable></arg> |
182 | 75f49d9b | Iustin Pop | <arg>-b <replaceable>bridge</replaceable></arg> |
183 | 75f49d9b | Iustin Pop | <arg choice="req"><replaceable>clustername</replaceable></arg> |
184 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
185 | 75f49d9b | Iustin Pop | |
186 | 75f49d9b | Iustin Pop | <para> |
187 | 75f49d9b | Iustin Pop | This commands is only run once initially on the first node of |
188 | 75f49d9b | Iustin Pop | the cluster. It will initialize the cluster configuration and |
189 | 75f49d9b | Iustin Pop | setup ssh-keys and more. |
190 | 75f49d9b | Iustin Pop | </para> |
191 | 75f49d9b | Iustin Pop | |
192 | 75f49d9b | Iustin Pop | <para> |
193 | 75f49d9b | Iustin Pop | Note that the <replaceable>clustername</replaceable> is not |
194 | 75f49d9b | Iustin Pop | any random name. It has to be resolvable to an IP address |
195 | 75f49d9b | Iustin Pop | using DNS, and it is best if you give the fully-qualified |
196 | 75f49d9b | Iustin Pop | domain name. |
197 | 75f49d9b | Iustin Pop | </para> |
198 | 75f49d9b | Iustin Pop | |
199 | 75f49d9b | Iustin Pop | <para> |
200 | 75f49d9b | Iustin Pop | The cluster can run in two modes: single-home or |
201 | 75f49d9b | Iustin Pop | dual-homed. In the first case, all traffic (both public |
202 | 75f49d9b | Iustin Pop | traffic, inter-node traffic and data replication traffic) goes |
203 | 75f49d9b | Iustin Pop | over the same interface. In the dual-homed case, the data |
204 | 75f49d9b | Iustin Pop | replication traffic goes over the second network. The |
205 | 75f49d9b | Iustin Pop | <option>-s</option> option here marks the cluster as |
206 | 75f49d9b | Iustin Pop | dual-homed and its parameter represents this node's address on |
207 | 75f49d9b | Iustin Pop | the second network. If you initialise the cluster with |
208 | 75f49d9b | Iustin Pop | <option>-s</option>, all nodes added must have a secondary IP |
209 | 75f49d9b | Iustin Pop | as well. |
210 | 75f49d9b | Iustin Pop | </para> |
211 | 75f49d9b | Iustin Pop | |
212 | 75f49d9b | Iustin Pop | <para> |
213 | 75f49d9b | Iustin Pop | Note that for Ganeti it doesn't matter if the secondary |
214 | 75f49d9b | Iustin Pop | |
215 | 75f49d9b | Iustin Pop | network is actually a separate physical network, or is done |
216 | 75f49d9b | Iustin Pop | using tunneling, etc. For performance reasons, it's |
217 | 75f49d9b | Iustin Pop | recommended to use a separate network, of course. |
218 | 75f49d9b | Iustin Pop | </para> |
219 | 75f49d9b | Iustin Pop | |
220 | 75f49d9b | Iustin Pop | <para> |
221 | 75f49d9b | Iustin Pop | The <option>-b</option> option specifies the default bridge |
222 | 75f49d9b | Iustin Pop | for instances. |
223 | 75f49d9b | Iustin Pop | </para> |
224 | 75f49d9b | Iustin Pop | </refsect2> |
225 | 75f49d9b | Iustin Pop | |
226 | 75f49d9b | Iustin Pop | <refsect2> |
227 | cc425644 | Iustin Pop | <title>LIST-TAGS</title> |
228 | cc425644 | Iustin Pop | |
229 | cc425644 | Iustin Pop | <cmdsynopsis> |
230 | cc425644 | Iustin Pop | <command>list-tags</command> |
231 | cc425644 | Iustin Pop | </cmdsynopsis> |
232 | cc425644 | Iustin Pop | |
233 | cc425644 | Iustin Pop | <para>List the tags of the cluster.</para> |
234 | cc425644 | Iustin Pop | </refsect2> |
235 | cc425644 | Iustin Pop | |
236 | cc425644 | Iustin Pop | <refsect2> |
237 | 75f49d9b | Iustin Pop | <title>MASTERFAILOVER</title> |
238 | 75f49d9b | Iustin Pop | |
239 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
240 | 75f49d9b | Iustin Pop | <command>masterfailover</command> |
241 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
242 | 75f49d9b | Iustin Pop | |
243 | 75f49d9b | Iustin Pop | <para> |
244 | 75f49d9b | Iustin Pop | Failover the master role to the current node. |
245 | 75f49d9b | Iustin Pop | </para> |
246 | 75f49d9b | Iustin Pop | </refsect2> |
247 | 75f49d9b | Iustin Pop | |
248 | 75f49d9b | Iustin Pop | <refsect2> |
249 | cc425644 | Iustin Pop | <title>REMOVE-TAGS</title> |
250 | cc425644 | Iustin Pop | |
251 | cc425644 | Iustin Pop | <cmdsynopsis> |
252 | cc425644 | Iustin Pop | <command>remove-tags</command> |
253 | cc425644 | Iustin Pop | <arg choice="req" |
254 | cc425644 | Iustin Pop | rep="repeat"><replaceable>tag</replaceable></arg> |
255 | cc425644 | Iustin Pop | </cmdsynopsis> |
256 | cc425644 | Iustin Pop | |
257 | cc425644 | Iustin Pop | <para> |
258 | cc425644 | Iustin Pop | Remove tags from the cluster. If any of the tags are not |
259 | cc425644 | Iustin Pop | existing on the cluster, the entire operation will abort. |
260 | cc425644 | Iustin Pop | </para> |
261 | cc425644 | Iustin Pop | </refsect2> |
262 | cc425644 | Iustin Pop | |
263 | cc425644 | Iustin Pop | <refsect2> |
264 | 75f49d9b | Iustin Pop | <title>RENAME</title> |
265 | 75f49d9b | Iustin Pop | |
266 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
267 | 75f49d9b | Iustin Pop | <command>rename</command> |
268 | 75f49d9b | Iustin Pop | <arg>-f</arg> |
269 | 75f49d9b | Iustin Pop | <arg choice="req"><replaceable>name</replaceable></arg> |
270 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
271 | 75f49d9b | Iustin Pop | |
272 | 75f49d9b | Iustin Pop | <para> |
273 | 75f49d9b | Iustin Pop | Renames the cluster and in the process updates the master IP |
274 | 75f49d9b | Iustin Pop | address to the one the new name resolves to. At least one of |
275 | 75f49d9b | Iustin Pop | either the name or the IP address must be different, otherwise |
276 | 75f49d9b | Iustin Pop | the operation will be aborted. |
277 | 75f49d9b | Iustin Pop | </para> |
278 | 75f49d9b | Iustin Pop | |
279 | 75f49d9b | Iustin Pop | <para> |
280 | 75f49d9b | Iustin Pop | Note that since this command can be dangerous (especially when |
281 | 75f49d9b | Iustin Pop | run over SSH), the command will require confirmation unless |
282 | 75f49d9b | Iustin Pop | run with the <option>-f</option> option. |
283 | 75f49d9b | Iustin Pop | </para> |
284 | 75f49d9b | Iustin Pop | </refsect2> |
285 | 75f49d9b | Iustin Pop | |
286 | 75f49d9b | Iustin Pop | <refsect2> |
287 | 75f49d9b | Iustin Pop | <title>VERIFY</title> |
288 | 75f49d9b | Iustin Pop | |
289 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
290 | 75f49d9b | Iustin Pop | <command>verify</command> |
291 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
292 | 75f49d9b | Iustin Pop | |
293 | 75f49d9b | Iustin Pop | <para> |
294 | 75f49d9b | Iustin Pop | Verify correctness of cluster configuration. This is safe with |
295 | 75f49d9b | Iustin Pop | respect to running instances, and incurs no downtime of the |
296 | 75f49d9b | Iustin Pop | instances. |
297 | 75f49d9b | Iustin Pop | </para> |
298 | 75f49d9b | Iustin Pop | </refsect2> |
299 | 75f49d9b | Iustin Pop | |
300 | 75f49d9b | Iustin Pop | <refsect2> |
301 | 75f49d9b | Iustin Pop | <title>VERSION</title> |
302 | 75f49d9b | Iustin Pop | |
303 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
304 | 75f49d9b | Iustin Pop | <command>version</command> |
305 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
306 | 75f49d9b | Iustin Pop | |
307 | 75f49d9b | Iustin Pop | <para> |
308 | 75f49d9b | Iustin Pop | Show the cluster version. |
309 | 75f49d9b | Iustin Pop | </para> |
310 | 75f49d9b | Iustin Pop | </refsect2> |
311 | a8083063 | Iustin Pop | |
312 | a8083063 | Iustin Pop | </refsect1> |
313 | a8083063 | Iustin Pop | |
314 | a8083063 | Iustin Pop | &footer; |
315 | a8083063 | Iustin Pop | |
316 | a8083063 | Iustin Pop | </refentry> |
317 | a8083063 | Iustin Pop | |
318 | a8083063 | Iustin Pop | <!-- Keep this comment at the end of the file |
319 | a8083063 | Iustin Pop | Local variables: |
320 | a8083063 | Iustin Pop | mode: sgml |
321 | a8083063 | Iustin Pop | sgml-omittag:t |
322 | a8083063 | Iustin Pop | sgml-shorttag:t |
323 | a8083063 | Iustin Pop | sgml-minimize-attributes:nil |
324 | a8083063 | Iustin Pop | sgml-always-quote-attributes:t |
325 | a8083063 | Iustin Pop | sgml-indent-step:2 |
326 | a8083063 | Iustin Pop | sgml-indent-data:t |
327 | a8083063 | Iustin Pop | sgml-parent-document:nil |
328 | a8083063 | Iustin Pop | sgml-default-dtd-file:nil |
329 | a8083063 | Iustin Pop | sgml-exposed-tags:nil |
330 | a8083063 | Iustin Pop | sgml-local-catalogs:nil |
331 | a8083063 | Iustin Pop | sgml-local-ecat-files:nil |
332 | a8083063 | Iustin Pop | End: |
333 | a8083063 | Iustin Pop | --> |