root / man / gnt-cluster.sgml @ 3fc175f0
History | View | Annotate | Download (15.5 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 | ed2d1409 | Iustin Pop | <!ENTITY dhdate "<date>December 12, 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 | 810c50b7 | Iustin Pop | <arg choice="opt">--from <replaceable>file</replaceable></arg> |
64 | cc425644 | Iustin Pop | <arg choice="req" |
65 | cc425644 | Iustin Pop | rep="repeat"><replaceable>tag</replaceable></arg> |
66 | cc425644 | Iustin Pop | </cmdsynopsis> |
67 | cc425644 | Iustin Pop | |
68 | cc425644 | Iustin Pop | <para> |
69 | cc425644 | Iustin Pop | Add tags to the cluster. If any of the tags contains invalid |
70 | cc425644 | Iustin Pop | characters, the entire operation will abort. |
71 | cc425644 | Iustin Pop | </para> |
72 | 810c50b7 | Iustin Pop | |
73 | 810c50b7 | Iustin Pop | <para> |
74 | 810c50b7 | Iustin Pop | If the <option>--from</option> option is given, the list of |
75 | 810c50b7 | Iustin Pop | tags will be extended with the contents of that file (each |
76 | 810c50b7 | Iustin Pop | line becomes a tag). In this case, there is not need to pass |
77 | 810c50b7 | Iustin Pop | tags on the command line (if you do, both sources will be |
78 | 810c50b7 | Iustin Pop | used). A file name of - will be interpreted as stdin. |
79 | 810c50b7 | Iustin Pop | </para> |
80 | cc425644 | Iustin Pop | </refsect2> |
81 | cc425644 | Iustin Pop | |
82 | cc425644 | Iustin Pop | <refsect2> |
83 | 75f49d9b | Iustin Pop | <title>COMMAND</title> |
84 | 75f49d9b | Iustin Pop | |
85 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
86 | 75f49d9b | Iustin Pop | <command>command</command> |
87 | 75f49d9b | Iustin Pop | <arg>-n <replaceable>node</replaceable></arg> |
88 | 75f49d9b | Iustin Pop | <arg choice="req"><replaceable>command</replaceable></arg> |
89 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
90 | 75f49d9b | Iustin Pop | |
91 | 75f49d9b | Iustin Pop | <para> |
92 | 75f49d9b | Iustin Pop | Executes a command on all nodes. If the option |
93 | 75f49d9b | Iustin Pop | <option>-n</option> is not given, the command will be executed |
94 | 75f49d9b | Iustin Pop | on all nodes, otherwise it will be executed only on the |
95 | 75f49d9b | Iustin Pop | node(s) specified. Use the option multiple times for running |
96 | 75f49d9b | Iustin Pop | it on multiple nodes, like: |
97 | 75f49d9b | Iustin Pop | |
98 | 75f49d9b | Iustin Pop | <screen> |
99 | 75f49d9b | Iustin Pop | # gnt-cluster command -n node1.example.com -n node2.example.com date |
100 | 75f49d9b | Iustin Pop | </screen> |
101 | 75f49d9b | Iustin Pop | |
102 | 75f49d9b | Iustin Pop | </para> |
103 | 75f49d9b | Iustin Pop | |
104 | 75f49d9b | Iustin Pop | <para> |
105 | 5f83e263 | Iustin Pop | The command is executed serially on the selected nodes. If the |
106 | 5f83e263 | Iustin Pop | master node is present in the list, the command will be |
107 | 5f83e263 | Iustin Pop | executed last on the master. Regarding the other nodes, the |
108 | 5f83e263 | Iustin Pop | execution order is somewhat alphabetic (it's smarter so that |
109 | 5f83e263 | Iustin Pop | node2.example.com will be earlier than node10.example.com but |
110 | 5f83e263 | Iustin Pop | after node1.example.com). |
111 | 5f83e263 | Iustin Pop | </para> |
112 | 5f83e263 | Iustin Pop | |
113 | 5f83e263 | Iustin Pop | <para> |
114 | 5f83e263 | Iustin Pop | So given the node names node1, node2, node3, node10, node11, |
115 | 5f83e263 | Iustin Pop | with node3 being the master, the order will be: node1, node2, |
116 | 5f83e263 | Iustin Pop | node10, node11, node3. |
117 | 5f83e263 | Iustin Pop | </para> |
118 | 5f83e263 | Iustin Pop | |
119 | 5f83e263 | Iustin Pop | <para> |
120 | 75f49d9b | Iustin Pop | The command is constructed by concatenating all other command |
121 | 75f49d9b | Iustin Pop | line arguments. For example, to list the contents of the |
122 | 75f49d9b | Iustin Pop | <filename class="directory">/etc</filename> directory on all |
123 | 75f49d9b | Iustin Pop | nodes, run: |
124 | 75f49d9b | Iustin Pop | |
125 | 75f49d9b | Iustin Pop | <screen> |
126 | 75f49d9b | Iustin Pop | # gnt-cluster command ls -l /etc |
127 | 75f49d9b | Iustin Pop | </screen> |
128 | 75f49d9b | Iustin Pop | |
129 | 75f49d9b | Iustin Pop | and the command which will be executed will be |
130 | 75f49d9b | Iustin Pop | <computeroutput>"ls -l /etc"</computeroutput> |
131 | 75f49d9b | Iustin Pop | </para> |
132 | 75f49d9b | Iustin Pop | </refsect2> |
133 | 75f49d9b | Iustin Pop | |
134 | 75f49d9b | Iustin Pop | <refsect2> |
135 | 75f49d9b | Iustin Pop | <title>COPYFILE</title> |
136 | 75f49d9b | Iustin Pop | |
137 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
138 | 75f49d9b | Iustin Pop | <command>copyfile</command> |
139 | 75f49d9b | Iustin Pop | <arg>-n <replaceable>node</replaceable></arg> |
140 | 75f49d9b | Iustin Pop | <arg choice="req"><replaceable>file</replaceable></arg> |
141 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
142 | 75f49d9b | Iustin Pop | |
143 | 75f49d9b | Iustin Pop | <para> |
144 | 75f49d9b | Iustin Pop | Copies a file to all or to some nodes. The argument specifies |
145 | 75f49d9b | Iustin Pop | the source file (on the current system), the |
146 | 75f49d9b | Iustin Pop | <option>-n</option> argument specifies the target node, or |
147 | 75f49d9b | Iustin Pop | nodes if the option is given multiple times. If |
148 | 75f49d9b | Iustin Pop | <option>-n</option> is not given at all, the file will be |
149 | 75f49d9b | Iustin Pop | copied to all nodes. |
150 | 75f49d9b | Iustin Pop | |
151 | 75f49d9b | Iustin Pop | Example: |
152 | 75f49d9b | Iustin Pop | <screen> |
153 | 75f49d9b | Iustin Pop | # gnt-cluster -n node1.example.com -n node2.example.com copyfile /tmp/test |
154 | 75f49d9b | Iustin Pop | </screen> |
155 | 75f49d9b | Iustin Pop | |
156 | 75f49d9b | Iustin Pop | This will copy the file <filename>/tmp/test</filename> from |
157 | 75f49d9b | Iustin Pop | the current node to the two named nodes. |
158 | 75f49d9b | Iustin Pop | </para> |
159 | 75f49d9b | Iustin Pop | </refsect2> |
160 | 75f49d9b | Iustin Pop | |
161 | 75f49d9b | Iustin Pop | <refsect2> |
162 | 75f49d9b | Iustin Pop | <title>DESTROY</title> |
163 | 75f49d9b | Iustin Pop | |
164 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
165 | 75f49d9b | Iustin Pop | <command>destroy</command> |
166 | f69dab6d | Iustin Pop | <arg choice="req">--yes-do-it</arg> |
167 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
168 | 75f49d9b | Iustin Pop | |
169 | 75f49d9b | Iustin Pop | <para> |
170 | 75f49d9b | Iustin Pop | Remove all configuration files related to the cluster, so that |
171 | 75f49d9b | Iustin Pop | a <command>gnt-cluster init</command> can be done again |
172 | 75f49d9b | Iustin Pop | afterwards. |
173 | 75f49d9b | Iustin Pop | </para> |
174 | f69dab6d | Iustin Pop | |
175 | f69dab6d | Iustin Pop | <para> |
176 | f69dab6d | Iustin Pop | Since this is a dangerous command, you are required to pass |
177 | f69dab6d | Iustin Pop | the argument <replaceable>--yes-do-it.</replaceable> |
178 | f69dab6d | Iustin Pop | </para> |
179 | 75f49d9b | Iustin Pop | </refsect2> |
180 | 75f49d9b | Iustin Pop | |
181 | 75f49d9b | Iustin Pop | <refsect2> |
182 | 75f49d9b | Iustin Pop | <title>GETMASTER</title> |
183 | 75f49d9b | Iustin Pop | |
184 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
185 | 75f49d9b | Iustin Pop | <command>getmaster</command> |
186 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
187 | 75f49d9b | Iustin Pop | |
188 | 75f49d9b | Iustin Pop | <para> |
189 | 75f49d9b | Iustin Pop | Displays the current master node. |
190 | 75f49d9b | Iustin Pop | </para> |
191 | 75f49d9b | Iustin Pop | </refsect2> |
192 | 75f49d9b | Iustin Pop | |
193 | 75f49d9b | Iustin Pop | <refsect2> |
194 | 75f49d9b | Iustin Pop | <title>INFO</title> |
195 | 75f49d9b | Iustin Pop | |
196 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
197 | 75f49d9b | Iustin Pop | <command>info</command> |
198 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
199 | 75f49d9b | Iustin Pop | |
200 | 75f49d9b | Iustin Pop | <para> |
201 | 75f49d9b | Iustin Pop | Shows runtime cluster information: cluster name, architecture |
202 | 75f49d9b | Iustin Pop | (32 or 64 bit), master node, node list and instance list. |
203 | 75f49d9b | Iustin Pop | </para> |
204 | 75f49d9b | Iustin Pop | </refsect2> |
205 | 75f49d9b | Iustin Pop | |
206 | 75f49d9b | Iustin Pop | <refsect2> |
207 | 75f49d9b | Iustin Pop | <title>INIT</title> |
208 | 75f49d9b | Iustin Pop | |
209 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
210 | 75f49d9b | Iustin Pop | <command>init</command> |
211 | 75f49d9b | Iustin Pop | <arg>-s <replaceable>secondary_ip</replaceable></arg> |
212 | 75f49d9b | Iustin Pop | <arg>-b <replaceable>bridge</replaceable></arg> |
213 | f3b100e1 | Guido Trotter | <arg>-t <replaceable>hypervisor-type</replaceable></arg> |
214 | f3b100e1 | Guido Trotter | <arg>-g <replaceable>vg-name</replaceable></arg> |
215 | f3b100e1 | Guido Trotter | <arg>--master-netdev <replaceable>vg-name</replaceable></arg> |
216 | f3b100e1 | Guido Trotter | <arg>-m <replaceable>mac-prefix</replaceable></arg> |
217 | 11c05c42 | Manuel Franceschini | <arg>--no-lvm-storage</arg> |
218 | 75f49d9b | Iustin Pop | <arg choice="req"><replaceable>clustername</replaceable></arg> |
219 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
220 | 75f49d9b | Iustin Pop | |
221 | 75f49d9b | Iustin Pop | <para> |
222 | 75f49d9b | Iustin Pop | This commands is only run once initially on the first node of |
223 | 75f49d9b | Iustin Pop | the cluster. It will initialize the cluster configuration and |
224 | 75f49d9b | Iustin Pop | setup ssh-keys and more. |
225 | 75f49d9b | Iustin Pop | </para> |
226 | 75f49d9b | Iustin Pop | |
227 | 75f49d9b | Iustin Pop | <para> |
228 | 75f49d9b | Iustin Pop | Note that the <replaceable>clustername</replaceable> is not |
229 | 75f49d9b | Iustin Pop | any random name. It has to be resolvable to an IP address |
230 | 75f49d9b | Iustin Pop | using DNS, and it is best if you give the fully-qualified |
231 | f3b100e1 | Guido Trotter | domain name. Also it is advisable to reserve a per-cluster |
232 | f3b100e1 | Guido Trotter | unique name, and not try to reuse one of the nodes' names. |
233 | 75f49d9b | Iustin Pop | </para> |
234 | 75f49d9b | Iustin Pop | |
235 | 75f49d9b | Iustin Pop | <para> |
236 | 75f49d9b | Iustin Pop | The cluster can run in two modes: single-home or |
237 | 75f49d9b | Iustin Pop | dual-homed. In the first case, all traffic (both public |
238 | 75f49d9b | Iustin Pop | traffic, inter-node traffic and data replication traffic) goes |
239 | 75f49d9b | Iustin Pop | over the same interface. In the dual-homed case, the data |
240 | 75f49d9b | Iustin Pop | replication traffic goes over the second network. The |
241 | 75f49d9b | Iustin Pop | <option>-s</option> option here marks the cluster as |
242 | 75f49d9b | Iustin Pop | dual-homed and its parameter represents this node's address on |
243 | 75f49d9b | Iustin Pop | the second network. If you initialise the cluster with |
244 | 75f49d9b | Iustin Pop | <option>-s</option>, all nodes added must have a secondary IP |
245 | 75f49d9b | Iustin Pop | as well. |
246 | 75f49d9b | Iustin Pop | </para> |
247 | 75f49d9b | Iustin Pop | |
248 | 75f49d9b | Iustin Pop | <para> |
249 | 75f49d9b | Iustin Pop | Note that for Ganeti it doesn't matter if the secondary |
250 | 75f49d9b | Iustin Pop | network is actually a separate physical network, or is done |
251 | 75f49d9b | Iustin Pop | using tunneling, etc. For performance reasons, it's |
252 | 75f49d9b | Iustin Pop | recommended to use a separate network, of course. |
253 | 75f49d9b | Iustin Pop | </para> |
254 | 75f49d9b | Iustin Pop | |
255 | 75f49d9b | Iustin Pop | <para> |
256 | 75f49d9b | Iustin Pop | The <option>-b</option> option specifies the default bridge |
257 | 75f49d9b | Iustin Pop | for instances. |
258 | 75f49d9b | Iustin Pop | </para> |
259 | f3b100e1 | Guido Trotter | |
260 | bf6fe28b | Alexander Schreiber | <para> |
261 | bf6fe28b | Alexander Schreiber | The <option>-t</option> allows to set the hypervisor type of |
262 | bf6fe28b | Alexander Schreiber | the cluster. Available hypervisor types are: xen-3.0, fake and |
263 | bf6fe28b | Alexander Schreiber | xen-hvm3.1. The default is the xen-3.0 hypervisor. |
264 | bf6fe28b | Alexander Schreiber | Note that if you init the cluster with hypervisor-type |
265 | bf6fe28b | Alexander Schreiber | xen-hvm3.1 you also need to provide the cluster VNC password |
266 | bf6fe28b | Alexander Schreiber | file <filename>/etc/ganeti/vnc-cluster-password</filename> and |
267 | bf6fe28b | Alexander Schreiber | the HVM boot ISO image |
268 | bf6fe28b | Alexander Schreiber | <filename>/srv/ganeti/iso/hvm-install.iso</filename> because |
269 | bf6fe28b | Alexander Schreiber | instances created by the experimental HVM support require them. |
270 | bf6fe28b | Alexander Schreiber | </para> |
271 | f3b100e1 | Guido Trotter | |
272 | f3b100e1 | Guido Trotter | <para> |
273 | f3b100e1 | Guido Trotter | The <option>-g</option> option will let you specify a volume group |
274 | 11c05c42 | Manuel Franceschini | different than 'xenvg' for ganeti to use when creating instance disks. |
275 | 11c05c42 | Manuel Franceschini | This volume group must have the same name on all nodes. Once the |
276 | 11c05c42 | Manuel Franceschini | cluster is initialized this can be altered by using the |
277 | 11c05c42 | Manuel Franceschini | <command>modify</command> command. If you don't want to use lvm |
278 | 11c05c42 | Manuel Franceschini | storage at all use the <option>--no-lvm-storage</option> option. |
279 | 11c05c42 | Manuel Franceschini | Once the cluster is initialized you can change this setup with the |
280 | 11c05c42 | Manuel Franceschini | <command>modify</command> command. |
281 | f3b100e1 | Guido Trotter | </para> |
282 | f3b100e1 | Guido Trotter | |
283 | f3b100e1 | Guido Trotter | <para> |
284 | f3b100e1 | Guido Trotter | The <option>--master-netdev</option> option is useful for specifying a |
285 | f3b100e1 | Guido Trotter | different interface on which the master will activate its IP address. |
286 | f3b100e1 | Guido Trotter | It's important that all nodes have this interface because you'll need |
287 | f3b100e1 | Guido Trotter | it for a master failover. |
288 | f3b100e1 | Guido Trotter | </para> |
289 | f3b100e1 | Guido Trotter | |
290 | f3b100e1 | Guido Trotter | <para> |
291 | f3b100e1 | Guido Trotter | The <option>-m</option> option will let you specify a three byte prefix |
292 | f3b100e1 | Guido Trotter | under which the virtual MAC addresses of your instances will be |
293 | f3b100e1 | Guido Trotter | generated. The prefix must be specified in the format XX:XX:XX and the |
294 | f3b100e1 | Guido Trotter | default is aa:00:00. |
295 | f3b100e1 | Guido Trotter | </para> |
296 | f3b100e1 | Guido Trotter | |
297 | 11c05c42 | Manuel Franceschini | <para> |
298 | 11c05c42 | Manuel Franceschini | The <option>--no-lvm-storage</option> allows you to initialize the |
299 | 11c05c42 | Manuel Franceschini | cluster without lvm support. This means that only instances using |
300 | 11c05c42 | Manuel Franceschini | files as storage backend will be possible to create. Once the cluster |
301 | 11c05c42 | Manuel Franceschini | is initialized you can change this setup with the |
302 | 11c05c42 | Manuel Franceschini | <command>modify</command> command. |
303 | 11c05c42 | Manuel Franceschini | </para> |
304 | 75f49d9b | Iustin Pop | </refsect2> |
305 | 75f49d9b | Iustin Pop | |
306 | 75f49d9b | Iustin Pop | <refsect2> |
307 | cc425644 | Iustin Pop | <title>LIST-TAGS</title> |
308 | cc425644 | Iustin Pop | |
309 | cc425644 | Iustin Pop | <cmdsynopsis> |
310 | cc425644 | Iustin Pop | <command>list-tags</command> |
311 | cc425644 | Iustin Pop | </cmdsynopsis> |
312 | cc425644 | Iustin Pop | |
313 | cc425644 | Iustin Pop | <para>List the tags of the cluster.</para> |
314 | cc425644 | Iustin Pop | </refsect2> |
315 | cc425644 | Iustin Pop | |
316 | cc425644 | Iustin Pop | <refsect2> |
317 | 75f49d9b | Iustin Pop | <title>MASTERFAILOVER</title> |
318 | 75f49d9b | Iustin Pop | |
319 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
320 | 75f49d9b | Iustin Pop | <command>masterfailover</command> |
321 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
322 | 75f49d9b | Iustin Pop | |
323 | 75f49d9b | Iustin Pop | <para> |
324 | 75f49d9b | Iustin Pop | Failover the master role to the current node. |
325 | 75f49d9b | Iustin Pop | </para> |
326 | 75f49d9b | Iustin Pop | </refsect2> |
327 | 75f49d9b | Iustin Pop | |
328 | 75f49d9b | Iustin Pop | <refsect2> |
329 | 11c05c42 | Manuel Franceschini | <title>MODIFY</title> |
330 | 11c05c42 | Manuel Franceschini | |
331 | 11c05c42 | Manuel Franceschini | <cmdsynopsis> |
332 | 11c05c42 | Manuel Franceschini | <command>modify</command> |
333 | 11c05c42 | Manuel Franceschini | <arg choice="opt">-g <replaceable>vg-name</replaceable></arg> |
334 | 11c05c42 | Manuel Franceschini | <arg choice="opt">--no-lvm-storage</arg> |
335 | 11c05c42 | Manuel Franceschini | </cmdsynopsis> |
336 | 11c05c42 | Manuel Franceschini | |
337 | 11c05c42 | Manuel Franceschini | <para> |
338 | 11c05c42 | Manuel Franceschini | Modify the options for the cluster. |
339 | 11c05c42 | Manuel Franceschini | </para> |
340 | 11c05c42 | Manuel Franceschini | |
341 | 11c05c42 | Manuel Franceschini | <para> |
342 | 11c05c42 | Manuel Franceschini | The <option>-g</option> and <option>--no-lvm-stoarge</option> are |
343 | 11c05c42 | Manuel Franceschini | described in the <command>init</command> command. |
344 | 11c05c42 | Manuel Franceschini | </para> |
345 | 11c05c42 | Manuel Franceschini | </refsect2> |
346 | 11c05c42 | Manuel Franceschini | |
347 | 11c05c42 | Manuel Franceschini | <refsect2> |
348 | cc425644 | Iustin Pop | <title>REMOVE-TAGS</title> |
349 | cc425644 | Iustin Pop | |
350 | cc425644 | Iustin Pop | <cmdsynopsis> |
351 | cc425644 | Iustin Pop | <command>remove-tags</command> |
352 | 810c50b7 | Iustin Pop | <arg choice="opt">--from <replaceable>file</replaceable></arg> |
353 | cc425644 | Iustin Pop | <arg choice="req" |
354 | cc425644 | Iustin Pop | rep="repeat"><replaceable>tag</replaceable></arg> |
355 | cc425644 | Iustin Pop | </cmdsynopsis> |
356 | cc425644 | Iustin Pop | |
357 | cc425644 | Iustin Pop | <para> |
358 | cc425644 | Iustin Pop | Remove tags from the cluster. If any of the tags are not |
359 | cc425644 | Iustin Pop | existing on the cluster, the entire operation will abort. |
360 | cc425644 | Iustin Pop | </para> |
361 | 810c50b7 | Iustin Pop | |
362 | 810c50b7 | Iustin Pop | <para> |
363 | 810c50b7 | Iustin Pop | If the <option>--from</option> option is given, the list of |
364 | 810c50b7 | Iustin Pop | tags will be extended with the contents of that file (each |
365 | 810c50b7 | Iustin Pop | line becomes a tag). In this case, there is not need to pass |
366 | 810c50b7 | Iustin Pop | tags on the command line (if you do, both sources will be |
367 | 810c50b7 | Iustin Pop | used). A file name of - will be interpreted as stdin. |
368 | 810c50b7 | Iustin Pop | </para> |
369 | cc425644 | Iustin Pop | </refsect2> |
370 | cc425644 | Iustin Pop | |
371 | cc425644 | Iustin Pop | <refsect2> |
372 | 75f49d9b | Iustin Pop | <title>RENAME</title> |
373 | 75f49d9b | Iustin Pop | |
374 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
375 | 75f49d9b | Iustin Pop | <command>rename</command> |
376 | 75f49d9b | Iustin Pop | <arg>-f</arg> |
377 | 75f49d9b | Iustin Pop | <arg choice="req"><replaceable>name</replaceable></arg> |
378 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
379 | 75f49d9b | Iustin Pop | |
380 | 75f49d9b | Iustin Pop | <para> |
381 | 75f49d9b | Iustin Pop | Renames the cluster and in the process updates the master IP |
382 | 75f49d9b | Iustin Pop | address to the one the new name resolves to. At least one of |
383 | 75f49d9b | Iustin Pop | either the name or the IP address must be different, otherwise |
384 | 75f49d9b | Iustin Pop | the operation will be aborted. |
385 | 75f49d9b | Iustin Pop | </para> |
386 | 75f49d9b | Iustin Pop | |
387 | 75f49d9b | Iustin Pop | <para> |
388 | 75f49d9b | Iustin Pop | Note that since this command can be dangerous (especially when |
389 | 75f49d9b | Iustin Pop | run over SSH), the command will require confirmation unless |
390 | 75f49d9b | Iustin Pop | run with the <option>-f</option> option. |
391 | 75f49d9b | Iustin Pop | </para> |
392 | 75f49d9b | Iustin Pop | </refsect2> |
393 | 75f49d9b | Iustin Pop | |
394 | 75f49d9b | Iustin Pop | <refsect2> |
395 | 73415719 | Iustin Pop | <title>SEARCH-TAGS</title> |
396 | 73415719 | Iustin Pop | |
397 | 73415719 | Iustin Pop | <cmdsynopsis> |
398 | 73415719 | Iustin Pop | <command>search-tags</command> |
399 | 73415719 | Iustin Pop | <arg choice="req"><replaceable>pattern</replaceable></arg> |
400 | 73415719 | Iustin Pop | </cmdsynopsis> |
401 | 73415719 | Iustin Pop | |
402 | 73415719 | Iustin Pop | <para> |
403 | 73415719 | Iustin Pop | Searches the tags on all objects in the cluster (the cluster |
404 | 73415719 | Iustin Pop | itself, the nodes and the instances) for a given pattern. The |
405 | 73415719 | Iustin Pop | pattern is interpreted as a regular expression and a search |
406 | 73415719 | Iustin Pop | will be done on it (i.e. the given pattern is not anchored to |
407 | 73415719 | Iustin Pop | the beggining of the string; if you want that, prefix the |
408 | 73415719 | Iustin Pop | pattern with <literal>^</literal>). |
409 | 73415719 | Iustin Pop | </para> |
410 | 73415719 | Iustin Pop | |
411 | 73415719 | Iustin Pop | <para> |
412 | 73415719 | Iustin Pop | If no tags are matching the pattern, the exit code of the |
413 | 73415719 | Iustin Pop | command will be one. If there is at least one match, the exit |
414 | 73415719 | Iustin Pop | code will be zero. Each match is listed on one line, the |
415 | 73415719 | Iustin Pop | object and the tag separated by a space. The cluster will be |
416 | 73415719 | Iustin Pop | listed as <filename>/cluster</filename>, a node will be listed |
417 | 73415719 | Iustin Pop | as |
418 | 73415719 | Iustin Pop | <filename>/nodes/<replaceable>name</replaceable></filename>, |
419 | 73415719 | Iustin Pop | and an instance as |
420 | 73415719 | Iustin Pop | <filename>/instances/<replaceable>name</replaceable></filename>. |
421 | 73415719 | Iustin Pop | Example: |
422 | 73415719 | Iustin Pop | </para> |
423 | 73415719 | Iustin Pop | <screen> |
424 | 73415719 | Iustin Pop | # gnt-cluster search time |
425 | 73415719 | Iustin Pop | /cluster ctime:2007-09-01 |
426 | 73415719 | Iustin Pop | /nodes/node1.example.com mtime:2007-10-04 |
427 | 73415719 | Iustin Pop | </screen> |
428 | 73415719 | Iustin Pop | </refsect2> |
429 | 73415719 | Iustin Pop | |
430 | 73415719 | Iustin Pop | <refsect2> |
431 | 75f49d9b | Iustin Pop | <title>VERIFY</title> |
432 | 75f49d9b | Iustin Pop | |
433 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
434 | 75f49d9b | Iustin Pop | <command>verify</command> |
435 | 3cf7c9fa | Guido Trotter | <arg choice="opt">--no-nplus1-mem</arg> |
436 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
437 | 75f49d9b | Iustin Pop | |
438 | 75f49d9b | Iustin Pop | <para> |
439 | 75f49d9b | Iustin Pop | Verify correctness of cluster configuration. This is safe with |
440 | 75f49d9b | Iustin Pop | respect to running instances, and incurs no downtime of the |
441 | 75f49d9b | Iustin Pop | instances. |
442 | 75f49d9b | Iustin Pop | </para> |
443 | 3cf7c9fa | Guido Trotter | |
444 | 3cf7c9fa | Guido Trotter | <para> |
445 | 3cf7c9fa | Guido Trotter | If the <option>--no-nplus1-mem</option> option is given, ganeti won't |
446 | 3cf7c9fa | Guido Trotter | check whether if it loses a node it can restart all the instances on |
447 | 3cf7c9fa | Guido Trotter | their secondaries (and report an error otherwise). |
448 | 3cf7c9fa | Guido Trotter | </para> |
449 | 75f49d9b | Iustin Pop | </refsect2> |
450 | 75f49d9b | Iustin Pop | |
451 | 75f49d9b | Iustin Pop | <refsect2> |
452 | ed2d1409 | Iustin Pop | <title>VERIFY-DISKS</title> |
453 | ed2d1409 | Iustin Pop | |
454 | ed2d1409 | Iustin Pop | <cmdsynopsis> |
455 | ed2d1409 | Iustin Pop | <command>verify-disks</command> |
456 | ed2d1409 | Iustin Pop | </cmdsynopsis> |
457 | ed2d1409 | Iustin Pop | |
458 | ed2d1409 | Iustin Pop | <para> |
459 | ed2d1409 | Iustin Pop | The command checks which instances have degraded DRBD disks |
460 | ed2d1409 | Iustin Pop | and activates the disks of those instances. |
461 | ed2d1409 | Iustin Pop | </para> |
462 | ed2d1409 | Iustin Pop | |
463 | ed2d1409 | Iustin Pop | <para> |
464 | ed2d1409 | Iustin Pop | This command is run from the <command>ganeti-watcher</command> |
465 | ed2d1409 | Iustin Pop | tool, which also has a different, complementary algorithm for |
466 | ed2d1409 | Iustin Pop | doing this check. Together, these two should ensure that DRBD |
467 | ed2d1409 | Iustin Pop | disks are kept consistent. |
468 | ed2d1409 | Iustin Pop | </para> |
469 | ed2d1409 | Iustin Pop | </refsect2> |
470 | ed2d1409 | Iustin Pop | |
471 | ed2d1409 | Iustin Pop | <refsect2> |
472 | 75f49d9b | Iustin Pop | <title>VERSION</title> |
473 | 75f49d9b | Iustin Pop | |
474 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
475 | 75f49d9b | Iustin Pop | <command>version</command> |
476 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
477 | 75f49d9b | Iustin Pop | |
478 | 75f49d9b | Iustin Pop | <para> |
479 | 75f49d9b | Iustin Pop | Show the cluster version. |
480 | 75f49d9b | Iustin Pop | </para> |
481 | 75f49d9b | Iustin Pop | </refsect2> |
482 | a8083063 | Iustin Pop | |
483 | a8083063 | Iustin Pop | </refsect1> |
484 | a8083063 | Iustin Pop | |
485 | a8083063 | Iustin Pop | &footer; |
486 | a8083063 | Iustin Pop | |
487 | a8083063 | Iustin Pop | </refentry> |
488 | a8083063 | Iustin Pop | |
489 | a8083063 | Iustin Pop | <!-- Keep this comment at the end of the file |
490 | a8083063 | Iustin Pop | Local variables: |
491 | a8083063 | Iustin Pop | mode: sgml |
492 | a8083063 | Iustin Pop | sgml-omittag:t |
493 | a8083063 | Iustin Pop | sgml-shorttag:t |
494 | a8083063 | Iustin Pop | sgml-minimize-attributes:nil |
495 | a8083063 | Iustin Pop | sgml-always-quote-attributes:t |
496 | a8083063 | Iustin Pop | sgml-indent-step:2 |
497 | a8083063 | Iustin Pop | sgml-indent-data:t |
498 | a8083063 | Iustin Pop | sgml-parent-document:nil |
499 | a8083063 | Iustin Pop | sgml-default-dtd-file:nil |
500 | a8083063 | Iustin Pop | sgml-exposed-tags:nil |
501 | a8083063 | Iustin Pop | sgml-local-catalogs:nil |
502 | a8083063 | Iustin Pop | sgml-local-ecat-files:nil |
503 | a8083063 | Iustin Pop | End: |
504 | a8083063 | Iustin Pop | --> |