root / man / gnt-cluster.sgml @ b18ecea2
History | View | Annotate | Download (35.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 | e0897adf | Michael Hanselmann | <!ENTITY dhdate "<date>June 08, 2010</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 | d3b4cf9f | Iustin Pop | <year>2008</year> |
24 | d3b4cf9f | Iustin Pop | <year>2009</year> |
25 | a8083063 | Iustin Pop | <holder>Google Inc.</holder> |
26 | a8083063 | Iustin Pop | </copyright> |
27 | a8083063 | Iustin Pop | &dhdate; |
28 | a8083063 | Iustin Pop | </refentryinfo> |
29 | a8083063 | Iustin Pop | <refmeta> |
30 | a8083063 | Iustin Pop | &dhucpackage; |
31 | a8083063 | Iustin Pop | |
32 | a8083063 | Iustin Pop | &dhsection; |
33 | e0897adf | Michael Hanselmann | <refmiscinfo>Ganeti 2.2</refmiscinfo> |
34 | a8083063 | Iustin Pop | </refmeta> |
35 | a8083063 | Iustin Pop | <refnamediv> |
36 | a8083063 | Iustin Pop | <refname>&dhpackage;</refname> |
37 | a8083063 | Iustin Pop | |
38 | e0897adf | Michael Hanselmann | <refpurpose>Ganeti administration, cluster-wide</refpurpose> |
39 | a8083063 | Iustin Pop | </refnamediv> |
40 | a8083063 | Iustin Pop | <refsynopsisdiv> |
41 | a8083063 | Iustin Pop | <cmdsynopsis> |
42 | a8083063 | Iustin Pop | <command>&dhpackage; </command> |
43 | a8083063 | Iustin Pop | |
44 | a8083063 | Iustin Pop | <arg choice="req">command</arg> |
45 | a8083063 | Iustin Pop | <arg>arguments...</arg> |
46 | a8083063 | Iustin Pop | </cmdsynopsis> |
47 | a8083063 | Iustin Pop | </refsynopsisdiv> |
48 | a8083063 | Iustin Pop | <refsect1> |
49 | a8083063 | Iustin Pop | <title>DESCRIPTION</title> |
50 | a8083063 | Iustin Pop | |
51 | a8083063 | Iustin Pop | <para> |
52 | a8083063 | Iustin Pop | The <command>&dhpackage;</command> is used for cluster-wide |
53 | e0897adf | Michael Hanselmann | administration in the Ganeti system. |
54 | a8083063 | Iustin Pop | </para> |
55 | a8083063 | Iustin Pop | |
56 | a8083063 | Iustin Pop | </refsect1> |
57 | a8083063 | Iustin Pop | <refsect1> |
58 | a8083063 | Iustin Pop | <title>COMMANDS</title> |
59 | a8083063 | Iustin Pop | |
60 | 75f49d9b | Iustin Pop | <refsect2> |
61 | cc425644 | Iustin Pop | <title>ADD-TAGS</title> |
62 | cc425644 | Iustin Pop | |
63 | cc425644 | Iustin Pop | <cmdsynopsis> |
64 | cc425644 | Iustin Pop | <command>add-tags</command> |
65 | 810c50b7 | Iustin Pop | <arg choice="opt">--from <replaceable>file</replaceable></arg> |
66 | cc425644 | Iustin Pop | <arg choice="req" |
67 | cc425644 | Iustin Pop | rep="repeat"><replaceable>tag</replaceable></arg> |
68 | cc425644 | Iustin Pop | </cmdsynopsis> |
69 | cc425644 | Iustin Pop | |
70 | cc425644 | Iustin Pop | <para> |
71 | cc425644 | Iustin Pop | Add tags to the cluster. If any of the tags contains invalid |
72 | cc425644 | Iustin Pop | characters, the entire operation will abort. |
73 | cc425644 | Iustin Pop | </para> |
74 | 810c50b7 | Iustin Pop | |
75 | 810c50b7 | Iustin Pop | <para> |
76 | 810c50b7 | Iustin Pop | If the <option>--from</option> option is given, the list of |
77 | 810c50b7 | Iustin Pop | tags will be extended with the contents of that file (each |
78 | 810c50b7 | Iustin Pop | line becomes a tag). In this case, there is not need to pass |
79 | 810c50b7 | Iustin Pop | tags on the command line (if you do, both sources will be |
80 | 810c50b7 | Iustin Pop | used). A file name of - will be interpreted as stdin. |
81 | 810c50b7 | Iustin Pop | </para> |
82 | cc425644 | Iustin Pop | </refsect2> |
83 | cc425644 | Iustin Pop | |
84 | cc425644 | Iustin Pop | <refsect2> |
85 | 75f49d9b | Iustin Pop | <title>COMMAND</title> |
86 | 75f49d9b | Iustin Pop | |
87 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
88 | 75f49d9b | Iustin Pop | <command>command</command> |
89 | 75f49d9b | Iustin Pop | <arg>-n <replaceable>node</replaceable></arg> |
90 | 75f49d9b | Iustin Pop | <arg choice="req"><replaceable>command</replaceable></arg> |
91 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
92 | 75f49d9b | Iustin Pop | |
93 | 75f49d9b | Iustin Pop | <para> |
94 | 75f49d9b | Iustin Pop | Executes a command on all nodes. If the option |
95 | 75f49d9b | Iustin Pop | <option>-n</option> is not given, the command will be executed |
96 | 75f49d9b | Iustin Pop | on all nodes, otherwise it will be executed only on the |
97 | 75f49d9b | Iustin Pop | node(s) specified. Use the option multiple times for running |
98 | 75f49d9b | Iustin Pop | it on multiple nodes, like: |
99 | 75f49d9b | Iustin Pop | |
100 | 75f49d9b | Iustin Pop | <screen> |
101 | 75f49d9b | Iustin Pop | # gnt-cluster command -n node1.example.com -n node2.example.com date |
102 | 75f49d9b | Iustin Pop | </screen> |
103 | 75f49d9b | Iustin Pop | |
104 | 75f49d9b | Iustin Pop | </para> |
105 | 75f49d9b | Iustin Pop | |
106 | 75f49d9b | Iustin Pop | <para> |
107 | 5f83e263 | Iustin Pop | The command is executed serially on the selected nodes. If the |
108 | 5f83e263 | Iustin Pop | master node is present in the list, the command will be |
109 | 5f83e263 | Iustin Pop | executed last on the master. Regarding the other nodes, the |
110 | d3b4cf9f | Iustin Pop | execution order is somewhat alphabetic, so that |
111 | 5f83e263 | Iustin Pop | node2.example.com will be earlier than node10.example.com but |
112 | d3b4cf9f | Iustin Pop | after node1.example.com. |
113 | 5f83e263 | Iustin Pop | </para> |
114 | 5f83e263 | Iustin Pop | |
115 | 5f83e263 | Iustin Pop | <para> |
116 | 5f83e263 | Iustin Pop | So given the node names node1, node2, node3, node10, node11, |
117 | 5f83e263 | Iustin Pop | with node3 being the master, the order will be: node1, node2, |
118 | 5f83e263 | Iustin Pop | node10, node11, node3. |
119 | 5f83e263 | Iustin Pop | </para> |
120 | 5f83e263 | Iustin Pop | |
121 | 5f83e263 | Iustin Pop | <para> |
122 | 75f49d9b | Iustin Pop | The command is constructed by concatenating all other command |
123 | 75f49d9b | Iustin Pop | line arguments. For example, to list the contents of the |
124 | 75f49d9b | Iustin Pop | <filename class="directory">/etc</filename> directory on all |
125 | 75f49d9b | Iustin Pop | nodes, run: |
126 | 75f49d9b | Iustin Pop | |
127 | 75f49d9b | Iustin Pop | <screen> |
128 | 75f49d9b | Iustin Pop | # gnt-cluster command ls -l /etc |
129 | 75f49d9b | Iustin Pop | </screen> |
130 | 75f49d9b | Iustin Pop | |
131 | 75f49d9b | Iustin Pop | and the command which will be executed will be |
132 | 75f49d9b | Iustin Pop | <computeroutput>"ls -l /etc"</computeroutput> |
133 | 75f49d9b | Iustin Pop | </para> |
134 | 75f49d9b | Iustin Pop | </refsect2> |
135 | 75f49d9b | Iustin Pop | |
136 | 75f49d9b | Iustin Pop | <refsect2> |
137 | 75f49d9b | Iustin Pop | <title>COPYFILE</title> |
138 | 75f49d9b | Iustin Pop | |
139 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
140 | 75f49d9b | Iustin Pop | <command>copyfile</command> |
141 | 74adc100 | Iustin Pop | <arg>--use-replication-network</arg> |
142 | 75f49d9b | Iustin Pop | <arg>-n <replaceable>node</replaceable></arg> |
143 | 75f49d9b | Iustin Pop | <arg choice="req"><replaceable>file</replaceable></arg> |
144 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
145 | 75f49d9b | Iustin Pop | |
146 | 75f49d9b | Iustin Pop | <para> |
147 | 75f49d9b | Iustin Pop | Copies a file to all or to some nodes. The argument specifies |
148 | 75f49d9b | Iustin Pop | the source file (on the current system), the |
149 | 75f49d9b | Iustin Pop | <option>-n</option> argument specifies the target node, or |
150 | 75f49d9b | Iustin Pop | nodes if the option is given multiple times. If |
151 | 75f49d9b | Iustin Pop | <option>-n</option> is not given at all, the file will be |
152 | 75f49d9b | Iustin Pop | copied to all nodes. |
153 | 75f49d9b | Iustin Pop | |
154 | 74adc100 | Iustin Pop | Passing the <option>--use-replication-network</option> option |
155 | 74adc100 | Iustin Pop | will cause the copy to be done over the replication network |
156 | 74adc100 | Iustin Pop | (only matters if the primary/secondary IPs are different). |
157 | 74adc100 | Iustin Pop | |
158 | 75f49d9b | Iustin Pop | Example: |
159 | 75f49d9b | Iustin Pop | <screen> |
160 | 75f49d9b | Iustin Pop | # gnt-cluster -n node1.example.com -n node2.example.com copyfile /tmp/test |
161 | 75f49d9b | Iustin Pop | </screen> |
162 | 75f49d9b | Iustin Pop | |
163 | 75f49d9b | Iustin Pop | This will copy the file <filename>/tmp/test</filename> from |
164 | 75f49d9b | Iustin Pop | the current node to the two named nodes. |
165 | 75f49d9b | Iustin Pop | </para> |
166 | 75f49d9b | Iustin Pop | </refsect2> |
167 | 75f49d9b | Iustin Pop | |
168 | 75f49d9b | Iustin Pop | <refsect2> |
169 | 75f49d9b | Iustin Pop | <title>DESTROY</title> |
170 | 75f49d9b | Iustin Pop | |
171 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
172 | 75f49d9b | Iustin Pop | <command>destroy</command> |
173 | f69dab6d | Iustin Pop | <arg choice="req">--yes-do-it</arg> |
174 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
175 | 75f49d9b | Iustin Pop | |
176 | 75f49d9b | Iustin Pop | <para> |
177 | 75f49d9b | Iustin Pop | Remove all configuration files related to the cluster, so that |
178 | 75f49d9b | Iustin Pop | a <command>gnt-cluster init</command> can be done again |
179 | 75f49d9b | Iustin Pop | afterwards. |
180 | 75f49d9b | Iustin Pop | </para> |
181 | f69dab6d | Iustin Pop | |
182 | f69dab6d | Iustin Pop | <para> |
183 | f69dab6d | Iustin Pop | Since this is a dangerous command, you are required to pass |
184 | f69dab6d | Iustin Pop | the argument <replaceable>--yes-do-it.</replaceable> |
185 | f69dab6d | Iustin Pop | </para> |
186 | 75f49d9b | Iustin Pop | </refsect2> |
187 | 75f49d9b | Iustin Pop | |
188 | 75f49d9b | Iustin Pop | <refsect2> |
189 | 75f49d9b | Iustin Pop | <title>GETMASTER</title> |
190 | 75f49d9b | Iustin Pop | |
191 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
192 | 75f49d9b | Iustin Pop | <command>getmaster</command> |
193 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
194 | 75f49d9b | Iustin Pop | |
195 | 75f49d9b | Iustin Pop | <para> |
196 | 75f49d9b | Iustin Pop | Displays the current master node. |
197 | 75f49d9b | Iustin Pop | </para> |
198 | 75f49d9b | Iustin Pop | </refsect2> |
199 | 75f49d9b | Iustin Pop | |
200 | 75f49d9b | Iustin Pop | <refsect2> |
201 | 75f49d9b | Iustin Pop | <title>INFO</title> |
202 | 75f49d9b | Iustin Pop | |
203 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
204 | 75f49d9b | Iustin Pop | <command>info</command> |
205 | d729e03a | Guido Trotter | <arg>--roman</arg> |
206 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
207 | 75f49d9b | Iustin Pop | |
208 | 75f49d9b | Iustin Pop | <para> |
209 | 75f49d9b | Iustin Pop | Shows runtime cluster information: cluster name, architecture |
210 | 75f49d9b | Iustin Pop | (32 or 64 bit), master node, node list and instance list. |
211 | 75f49d9b | Iustin Pop | </para> |
212 | d729e03a | Guido Trotter | |
213 | d729e03a | Guido Trotter | <para> |
214 | d729e03a | Guido Trotter | Passing the <option>--roman</option> option gnt-cluster info will try |
215 | d729e03a | Guido Trotter | to print its integer fields in a latin friendly way. This allows |
216 | d729e03a | Guido Trotter | further diffusion of Ganeti among ancient cultures. |
217 | d729e03a | Guido Trotter | </para> |
218 | d729e03a | Guido Trotter | |
219 | 75f49d9b | Iustin Pop | </refsect2> |
220 | 75f49d9b | Iustin Pop | |
221 | 75f49d9b | Iustin Pop | <refsect2> |
222 | 75f49d9b | Iustin Pop | <title>INIT</title> |
223 | 75f49d9b | Iustin Pop | |
224 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
225 | 75f49d9b | Iustin Pop | <command>init</command> |
226 | d3b4cf9f | Iustin Pop | <sbr> |
227 | 75f49d9b | Iustin Pop | <arg>-s <replaceable>secondary_ip</replaceable></arg> |
228 | d3b4cf9f | Iustin Pop | <sbr> |
229 | f3b100e1 | Guido Trotter | <arg>-g <replaceable>vg-name</replaceable></arg> |
230 | d3b4cf9f | Iustin Pop | <sbr> |
231 | e538a046 | Guido Trotter | <arg>--master-netdev <replaceable>interface-name</replaceable></arg> |
232 | d3b4cf9f | Iustin Pop | <sbr> |
233 | f3b100e1 | Guido Trotter | <arg>-m <replaceable>mac-prefix</replaceable></arg> |
234 | d3b4cf9f | Iustin Pop | <sbr> |
235 | 11c05c42 | Manuel Franceschini | <arg>--no-lvm-storage</arg> |
236 | d3b4cf9f | Iustin Pop | <sbr> |
237 | b989b9d9 | Ken Wehr | <arg>--no-etc-hosts</arg> |
238 | b989b9d9 | Ken Wehr | <sbr> |
239 | b989b9d9 | Ken Wehr | <arg>--no-ssh-init</arg> |
240 | b989b9d9 | Ken Wehr | <sbr> |
241 | 19ae0895 | Alexander Schreiber | <arg>--file-storage-dir <replaceable>dir</replaceable></arg> |
242 | d3b4cf9f | Iustin Pop | <sbr> |
243 | 19ae0895 | Alexander Schreiber | <arg>--enabled-hypervisors <replaceable>hypervisors</replaceable></arg> |
244 | d3b4cf9f | Iustin Pop | <sbr> |
245 | 19ae0895 | Alexander Schreiber | <arg>-t <replaceable>hypervisor name</replaceable></arg> |
246 | d3b4cf9f | Iustin Pop | <sbr> |
247 | 555918b3 | Guido Trotter | <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> |
248 | d3b4cf9f | Iustin Pop | <sbr> |
249 | 555918b3 | Guido Trotter | <arg>--backend-parameters <replaceable>be-param</replaceable>=<replaceable>value</replaceable><arg rep="repeat" choice="opt">,<replaceable>be-param</replaceable>=<replaceable>value</replaceable></arg></arg> |
250 | d3b4cf9f | Iustin Pop | <sbr> |
251 | 7d713344 | Guido Trotter | <arg>--nic-parameters <replaceable>nic-param</replaceable>=<replaceable>value</replaceable><arg rep="repeat" choice="opt">,<replaceable>nic-param</replaceable>=<replaceable>value</replaceable></arg></arg> |
252 | 7d713344 | Guido Trotter | <sbr> |
253 | 3953242f | Iustin Pop | <arg>--maintain-node-health <group choice="req"><arg>yes</arg><arg>no</arg></group></arg> |
254 | 3953242f | Iustin Pop | <sbr> |
255 | 89100352 | Balazs Lecz | <arg>--uid-pool <replaceable>user-id pool definition</replaceable></arg> |
256 | 89100352 | Balazs Lecz | <sbr> |
257 | 92be7021 | Apollon Oikonomopoulos | <arg>-I <replaceable>default instance allocator</replaceable></arg> |
258 | 92be7021 | Apollon Oikonomopoulos | <sbr> |
259 | 69affe73 | Manuel Franceschini | <arg>--primary-ip-version <replaceable>version</replaceable></arg> |
260 | 69affe73 | Manuel Franceschini | <sbr> |
261 | b18ecea2 | Renรฉ Nussbaumer | <arg>--prealloc-wipe-disks</arg> |
262 | b18ecea2 | Renรฉ Nussbaumer | <sbr> |
263 | 75f49d9b | Iustin Pop | <arg choice="req"><replaceable>clustername</replaceable></arg> |
264 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
265 | 75f49d9b | Iustin Pop | |
266 | 75f49d9b | Iustin Pop | <para> |
267 | 75f49d9b | Iustin Pop | This commands is only run once initially on the first node of |
268 | 75f49d9b | Iustin Pop | the cluster. It will initialize the cluster configuration and |
269 | 75f49d9b | Iustin Pop | setup ssh-keys and more. |
270 | 75f49d9b | Iustin Pop | </para> |
271 | 75f49d9b | Iustin Pop | |
272 | 75f49d9b | Iustin Pop | <para> |
273 | 75f49d9b | Iustin Pop | Note that the <replaceable>clustername</replaceable> is not |
274 | 75f49d9b | Iustin Pop | any random name. It has to be resolvable to an IP address |
275 | 75f49d9b | Iustin Pop | using DNS, and it is best if you give the fully-qualified |
276 | 56db8a84 | Alexander Schreiber | domain name. This hostname must resolve to an IP address |
277 | 56db8a84 | Alexander Schreiber | reserved exclusively for this purpose. |
278 | 75f49d9b | Iustin Pop | </para> |
279 | 75f49d9b | Iustin Pop | |
280 | 75f49d9b | Iustin Pop | <para> |
281 | 75f49d9b | Iustin Pop | The cluster can run in two modes: single-home or |
282 | 75f49d9b | Iustin Pop | dual-homed. In the first case, all traffic (both public |
283 | 75f49d9b | Iustin Pop | traffic, inter-node traffic and data replication traffic) goes |
284 | 75f49d9b | Iustin Pop | over the same interface. In the dual-homed case, the data |
285 | 75f49d9b | Iustin Pop | replication traffic goes over the second network. The |
286 | 75f49d9b | Iustin Pop | <option>-s</option> option here marks the cluster as |
287 | 75f49d9b | Iustin Pop | dual-homed and its parameter represents this node's address on |
288 | 75f49d9b | Iustin Pop | the second network. If you initialise the cluster with |
289 | 75f49d9b | Iustin Pop | <option>-s</option>, all nodes added must have a secondary IP |
290 | 75f49d9b | Iustin Pop | as well. |
291 | 75f49d9b | Iustin Pop | </para> |
292 | 75f49d9b | Iustin Pop | |
293 | 75f49d9b | Iustin Pop | <para> |
294 | 75f49d9b | Iustin Pop | Note that for Ganeti it doesn't matter if the secondary |
295 | 75f49d9b | Iustin Pop | network is actually a separate physical network, or is done |
296 | 75f49d9b | Iustin Pop | using tunneling, etc. For performance reasons, it's |
297 | 75f49d9b | Iustin Pop | recommended to use a separate network, of course. |
298 | 75f49d9b | Iustin Pop | </para> |
299 | 75f49d9b | Iustin Pop | |
300 | 75f49d9b | Iustin Pop | <para> |
301 | f3b100e1 | Guido Trotter | The <option>-g</option> option will let you specify a volume group |
302 | e0897adf | Michael Hanselmann | different than "xenvg" for Ganeti to use when creating instance disks. |
303 | 11c05c42 | Manuel Franceschini | This volume group must have the same name on all nodes. Once the |
304 | 11c05c42 | Manuel Franceschini | cluster is initialized this can be altered by using the |
305 | 11c05c42 | Manuel Franceschini | <command>modify</command> command. If you don't want to use lvm |
306 | 11c05c42 | Manuel Franceschini | storage at all use the <option>--no-lvm-storage</option> option. |
307 | 11c05c42 | Manuel Franceschini | Once the cluster is initialized you can change this setup with the |
308 | 11c05c42 | Manuel Franceschini | <command>modify</command> command. |
309 | f3b100e1 | Guido Trotter | </para> |
310 | f3b100e1 | Guido Trotter | |
311 | f3b100e1 | Guido Trotter | <para> |
312 | f3b100e1 | Guido Trotter | The <option>--master-netdev</option> option is useful for specifying a |
313 | f3b100e1 | Guido Trotter | different interface on which the master will activate its IP address. |
314 | f3b100e1 | Guido Trotter | It's important that all nodes have this interface because you'll need |
315 | f3b100e1 | Guido Trotter | it for a master failover. |
316 | f3b100e1 | Guido Trotter | </para> |
317 | f3b100e1 | Guido Trotter | |
318 | f3b100e1 | Guido Trotter | <para> |
319 | f3b100e1 | Guido Trotter | The <option>-m</option> option will let you specify a three byte prefix |
320 | f3b100e1 | Guido Trotter | under which the virtual MAC addresses of your instances will be |
321 | f3b100e1 | Guido Trotter | generated. The prefix must be specified in the format XX:XX:XX and the |
322 | f3b100e1 | Guido Trotter | default is aa:00:00. |
323 | f3b100e1 | Guido Trotter | </para> |
324 | f3b100e1 | Guido Trotter | |
325 | 11c05c42 | Manuel Franceschini | <para> |
326 | b989b9d9 | Ken Wehr | The <option>--no-lvm-storage</option> option allows you to initialize |
327 | b989b9d9 | Ken Wehr | the cluster without lvm support. This means that only instances using |
328 | 11c05c42 | Manuel Franceschini | files as storage backend will be possible to create. Once the cluster |
329 | 11c05c42 | Manuel Franceschini | is initialized you can change this setup with the |
330 | 11c05c42 | Manuel Franceschini | <command>modify</command> command. |
331 | 11c05c42 | Manuel Franceschini | </para> |
332 | 19ae0895 | Alexander Schreiber | |
333 | 19ae0895 | Alexander Schreiber | <para> |
334 | b989b9d9 | Ken Wehr | The <option>--no-etc-hosts</option> option allows you to initialize the |
335 | b989b9d9 | Ken Wehr | cluster without modifying the <filename>/etc/hosts</filename> file. |
336 | b989b9d9 | Ken Wehr | </para> |
337 | b989b9d9 | Ken Wehr | |
338 | b989b9d9 | Ken Wehr | <para> |
339 | b989b9d9 | Ken Wehr | The <option>--no-ssh-init</option> option allows you to initialize the |
340 | b989b9d9 | Ken Wehr | cluster without creating or distributing SSH key pairs. |
341 | b989b9d9 | Ken Wehr | </para> |
342 | b989b9d9 | Ken Wehr | |
343 | b989b9d9 | Ken Wehr | <para> |
344 | 19ae0895 | Alexander Schreiber | The <option>--file-storage-dir</option> option allows you |
345 | 19ae0895 | Alexander Schreiber | set the directory to use for storing the instance disk |
346 | 19ae0895 | Alexander Schreiber | files when using file storage as backend for instance disks. |
347 | 19ae0895 | Alexander Schreiber | </para> |
348 | 19ae0895 | Alexander Schreiber | |
349 | 19ae0895 | Alexander Schreiber | <para> |
350 | 19ae0895 | Alexander Schreiber | The <option>--enabled-hypervisors</option> option allows you |
351 | 19ae0895 | Alexander Schreiber | to set the list of hypervisors that will be enabled for |
352 | ba0b05fe | Iustin Pop | this cluster. Instance hypervisors can only be chosen from |
353 | 066f465d | Guido Trotter | the list of enabled hypervisors, and the first entry of this list |
354 | 066f465d | Guido Trotter | will be used by default. Currently, the following hypervisors are |
355 | 066f465d | Guido Trotter | available: |
356 | 19ae0895 | Alexander Schreiber | </para> |
357 | 19ae0895 | Alexander Schreiber | |
358 | 19ae0895 | Alexander Schreiber | <para> |
359 | b18ecea2 | Renรฉ Nussbaumer | The <option>--prealloc-wipe-disks</option> sets a cluster wide |
360 | b18ecea2 | Renรฉ Nussbaumer | configuration value for wiping disks prior to allocation. This |
361 | b18ecea2 | Renรฉ Nussbaumer | increases security on instance level as the instance can't |
362 | b18ecea2 | Renรฉ Nussbaumer | access untouched data from it's underlying storage. |
363 | b18ecea2 | Renรฉ Nussbaumer | </para> |
364 | b18ecea2 | Renรฉ Nussbaumer | |
365 | b18ecea2 | Renรฉ Nussbaumer | <para> |
366 | 19ae0895 | Alexander Schreiber | <variablelist> |
367 | 19ae0895 | Alexander Schreiber | <varlistentry> |
368 | 19ae0895 | Alexander Schreiber | <term>xen-pvm</term> |
369 | 19ae0895 | Alexander Schreiber | <listitem> |
370 | 19ae0895 | Alexander Schreiber | <para> |
371 | 19ae0895 | Alexander Schreiber | Xen PVM hypervisor |
372 | 19ae0895 | Alexander Schreiber | </para> |
373 | 19ae0895 | Alexander Schreiber | </listitem> |
374 | 19ae0895 | Alexander Schreiber | </varlistentry> |
375 | 19ae0895 | Alexander Schreiber | <varlistentry> |
376 | 19ae0895 | Alexander Schreiber | <term>xen-hvm</term> |
377 | 19ae0895 | Alexander Schreiber | <listitem> |
378 | 19ae0895 | Alexander Schreiber | <para> |
379 | 19ae0895 | Alexander Schreiber | Xen HVM hypervisor |
380 | 19ae0895 | Alexander Schreiber | </para> |
381 | 19ae0895 | Alexander Schreiber | </listitem> |
382 | 19ae0895 | Alexander Schreiber | </varlistentry> |
383 | 19ae0895 | Alexander Schreiber | <varlistentry> |
384 | 19ae0895 | Alexander Schreiber | <term>kvm</term> |
385 | 19ae0895 | Alexander Schreiber | <listitem> |
386 | 19ae0895 | Alexander Schreiber | <para> |
387 | 19ae0895 | Alexander Schreiber | Linux KVM hypervisor |
388 | 19ae0895 | Alexander Schreiber | </para> |
389 | 19ae0895 | Alexander Schreiber | </listitem> |
390 | 19ae0895 | Alexander Schreiber | </varlistentry> |
391 | 19ae0895 | Alexander Schreiber | <varlistentry> |
392 | e8a3bf18 | Iustin Pop | <term>chroot</term> |
393 | e8a3bf18 | Iustin Pop | <listitem> |
394 | e8a3bf18 | Iustin Pop | <para> |
395 | e8a3bf18 | Iustin Pop | a simple chroot manager that starts chroot based on a |
396 | e8a3bf18 | Iustin Pop | script at the root of the filesystem holding the |
397 | e8a3bf18 | Iustin Pop | chroot |
398 | e8a3bf18 | Iustin Pop | <varlistentry> |
399 | 19ae0895 | Alexander Schreiber | <term>fake</term> |
400 | 19ae0895 | Alexander Schreiber | <listitem> |
401 | 19ae0895 | Alexander Schreiber | <para> |
402 | 19ae0895 | Alexander Schreiber | fake hypervisor for development/testing |
403 | 19ae0895 | Alexander Schreiber | </para> |
404 | 19ae0895 | Alexander Schreiber | </listitem> |
405 | 19ae0895 | Alexander Schreiber | </varlistentry> |
406 | 19ae0895 | Alexander Schreiber | </variablelist> |
407 | 19ae0895 | Alexander Schreiber | </para> |
408 | 19ae0895 | Alexander Schreiber | |
409 | 19ae0895 | Alexander Schreiber | <para> |
410 | 19ae0895 | Alexander Schreiber | Either a single hypervisor name or a comma-separated list of |
411 | 19ae0895 | Alexander Schreiber | hypervisor names can be specified. If this option is not |
412 | 19ae0895 | Alexander Schreiber | specified, only the xen-pvm hypervisor is enabled by default. |
413 | 19ae0895 | Alexander Schreiber | </para> |
414 | 19ae0895 | Alexander Schreiber | |
415 | 19ae0895 | Alexander Schreiber | <para> |
416 | e8a3bf18 | Iustin Pop | The <option>--hypervisor-parameters</option> option allows you |
417 | e8a3bf18 | Iustin Pop | to set default hypervisor specific parameters for the |
418 | e8a3bf18 | Iustin Pop | cluster. The format of this option is the name of the |
419 | e8a3bf18 | Iustin Pop | hypervisor, followed by a colon and a comma-separated list of |
420 | e8a3bf18 | Iustin Pop | key=value pairs. The keys available for each hypervisors are |
421 | e8a3bf18 | Iustin Pop | detailed in the <citerefentry> |
422 | e8a3bf18 | Iustin Pop | <refentrytitle>gnt-instance</refentrytitle> |
423 | e8a3bf18 | Iustin Pop | <manvolnum>8</manvolnum> </citerefentry> man page, in the |
424 | e8a3bf18 | Iustin Pop | <command>add</command> command plus the following parameters |
425 | e8a3bf18 | Iustin Pop | which are only configurable globally (at cluster level): |
426 | e8a3bf18 | Iustin Pop | |
427 | e8a3bf18 | Iustin Pop | <variablelist> |
428 | e8a3bf18 | Iustin Pop | <varlistentry> |
429 | e8a3bf18 | Iustin Pop | <term>migration_port</term> |
430 | e8a3bf18 | Iustin Pop | <listitem> |
431 | e8a3bf18 | Iustin Pop | <simpara>Valid for the Xen PVM and KVM hypervisors.</simpara> |
432 | e8a3bf18 | Iustin Pop | |
433 | e8a3bf18 | Iustin Pop | <para> |
434 | e8a3bf18 | Iustin Pop | This options specifies the TCP port to use for |
435 | e8a3bf18 | Iustin Pop | live-migration. For Xen, the same port should be |
436 | e8a3bf18 | Iustin Pop | configured on all nodes in |
437 | e8a3bf18 | Iustin Pop | the <filename>/etc/xen/xend-config.sxp</filename> |
438 | e8a3bf18 | Iustin Pop | file, under the |
439 | e8a3bf18 | Iustin Pop | key <quote>xend-relocation-port</quote>. |
440 | e8a3bf18 | Iustin Pop | </para> |
441 | e8a3bf18 | Iustin Pop | </listitem> |
442 | e8a3bf18 | Iustin Pop | </varlistentry> |
443 | e43d4f9f | Apollon Oikonomopoulos | <varlistentry> |
444 | e43d4f9f | Apollon Oikonomopoulos | <term>migration_bandwidth</term> |
445 | e43d4f9f | Apollon Oikonomopoulos | <listitem> |
446 | e43d4f9f | Apollon Oikonomopoulos | <simpara>Valid for the KVM hypervisor.</simpara> |
447 | e43d4f9f | Apollon Oikonomopoulos | |
448 | e43d4f9f | Apollon Oikonomopoulos | <para> |
449 | e43d4f9f | Apollon Oikonomopoulos | This option specifies the maximum bandwidth that KVM will |
450 | e43d4f9f | Apollon Oikonomopoulos | use for instance live migrations. The value is in MiB/s. |
451 | e43d4f9f | Apollon Oikonomopoulos | </para> |
452 | e43d4f9f | Apollon Oikonomopoulos | |
453 | e43d4f9f | Apollon Oikonomopoulos | <simpara>This option is only effective with kvm versions >= 78 |
454 | e43d4f9f | Apollon Oikonomopoulos | and qemu-kvm versions >= 0.10.0. |
455 | e43d4f9f | Apollon Oikonomopoulos | </simpara> |
456 | e43d4f9f | Apollon Oikonomopoulos | </listitem> |
457 | e43d4f9f | Apollon Oikonomopoulos | </varlistentry> |
458 | e8a3bf18 | Iustin Pop | </variablelist> |
459 | e8a3bf18 | Iustin Pop | |
460 | e8a3bf18 | Iustin Pop | </para> |
461 | e8a3bf18 | Iustin Pop | |
462 | e8a3bf18 | Iustin Pop | <para> |
463 | 280b79b3 | Guido Trotter | The <option>--backend-parameters</option> option allows you to set |
464 | 19ae0895 | Alexander Schreiber | the default backend parameters for the cluster. The parameter |
465 | 19ae0895 | Alexander Schreiber | format is a comma-separated list of key=value pairs with the |
466 | 19ae0895 | Alexander Schreiber | following supported keys: |
467 | 19ae0895 | Alexander Schreiber | </para> |
468 | 19ae0895 | Alexander Schreiber | |
469 | 19ae0895 | Alexander Schreiber | <para> |
470 | 19ae0895 | Alexander Schreiber | <variablelist> |
471 | 19ae0895 | Alexander Schreiber | <varlistentry> |
472 | 19ae0895 | Alexander Schreiber | <term>vcpus</term> |
473 | 19ae0895 | Alexander Schreiber | <listitem> |
474 | 19ae0895 | Alexander Schreiber | <para> |
475 | 19ae0895 | Alexander Schreiber | Number of VCPUs to set for an instance by default, must |
476 | 19ae0895 | Alexander Schreiber | be an integer, will be set to 1 if no specified. |
477 | 19ae0895 | Alexander Schreiber | </para> |
478 | 19ae0895 | Alexander Schreiber | </listitem> |
479 | 19ae0895 | Alexander Schreiber | </varlistentry> |
480 | 19ae0895 | Alexander Schreiber | <varlistentry> |
481 | 19ae0895 | Alexander Schreiber | <term>memory</term> |
482 | 19ae0895 | Alexander Schreiber | <listitem> |
483 | 19ae0895 | Alexander Schreiber | <para> |
484 | 19ae0895 | Alexander Schreiber | Amount of memory to allocate for an instance by default, |
485 | 19ae0895 | Alexander Schreiber | can be either an integer or an integer followed by a |
486 | 19ae0895 | Alexander Schreiber | unit (M for mebibytes and G for gibibytes are |
487 | 19ae0895 | Alexander Schreiber | supported), will be set to 128M if not specified. |
488 | 19ae0895 | Alexander Schreiber | </para> |
489 | 19ae0895 | Alexander Schreiber | </listitem> |
490 | 19ae0895 | Alexander Schreiber | </varlistentry> |
491 | 19ae0895 | Alexander Schreiber | <varlistentry> |
492 | 19ae0895 | Alexander Schreiber | <term>auto_balance</term> |
493 | 19ae0895 | Alexander Schreiber | <listitem> |
494 | 19ae0895 | Alexander Schreiber | <para> |
495 | 19ae0895 | Alexander Schreiber | Value of the auto_balance flag for instances to use by |
496 | 19ae0895 | Alexander Schreiber | default, will be set to true if not specified. |
497 | 19ae0895 | Alexander Schreiber | </para> |
498 | 19ae0895 | Alexander Schreiber | </listitem> |
499 | 19ae0895 | Alexander Schreiber | </varlistentry> |
500 | 19ae0895 | Alexander Schreiber | </variablelist> |
501 | 19ae0895 | Alexander Schreiber | </para> |
502 | 19ae0895 | Alexander Schreiber | |
503 | 19ae0895 | Alexander Schreiber | <para> |
504 | 7d713344 | Guido Trotter | The <option>--nic-parameters</option> option allows you to set |
505 | 7d713344 | Guido Trotter | the default nic parameters for the cluster. The parameter |
506 | 7d713344 | Guido Trotter | format is a comma-separated list of key=value pairs with the |
507 | 7d713344 | Guido Trotter | following supported keys: |
508 | 7d713344 | Guido Trotter | <variablelist> |
509 | 7d713344 | Guido Trotter | <varlistentry> |
510 | 7d713344 | Guido Trotter | <term>mode</term> |
511 | 7d713344 | Guido Trotter | <listitem> |
512 | 7d713344 | Guido Trotter | <para> |
513 | 7d713344 | Guido Trotter | The default nic mode, 'routed' or 'bridged'. |
514 | 7d713344 | Guido Trotter | </para> |
515 | 7d713344 | Guido Trotter | </listitem> |
516 | 7d713344 | Guido Trotter | </varlistentry> |
517 | 7d713344 | Guido Trotter | <varlistentry> |
518 | 7d713344 | Guido Trotter | <term>link</term> |
519 | 7d713344 | Guido Trotter | <listitem> |
520 | 7d713344 | Guido Trotter | <para> |
521 | 8063787e | Guido Trotter | In bridged mode the default NIC bridge. In routed mode it |
522 | 8063787e | Guido Trotter | represents an hypervisor-vif-script dependent value to allow |
523 | 8063787e | Guido Trotter | different instance groups. For example under the KVM default |
524 | 8063787e | Guido Trotter | network script it is interpreted as a routing table number or |
525 | 8063787e | Guido Trotter | name. |
526 | 7d713344 | Guido Trotter | </para> |
527 | 7d713344 | Guido Trotter | </listitem> |
528 | 7d713344 | Guido Trotter | </varlistentry> |
529 | 7d713344 | Guido Trotter | </variablelist> |
530 | 7d713344 | Guido Trotter | </para> |
531 | 7d713344 | Guido Trotter | |
532 | 3953242f | Iustin Pop | <para> |
533 | 3953242f | Iustin Pop | The option <option>--maintain-node-health</option> allows to |
534 | 3953242f | Iustin Pop | enable/disable automatic maintenance actions on |
535 | 3953242f | Iustin Pop | nodes. Currently these include automatic shutdown of instances |
536 | 3953242f | Iustin Pop | and deactivation of DRBD devices on offline nodes; in the |
537 | 3953242f | Iustin Pop | future it might be extended to automatic removal of unknown |
538 | 3953242f | Iustin Pop | LVM volumes, etc. |
539 | 3953242f | Iustin Pop | </para> |
540 | 3953242f | Iustin Pop | |
541 | 89100352 | Balazs Lecz | <para> |
542 | 89100352 | Balazs Lecz | The <option>--uid-pool</option> option initializes the user-id pool. |
543 | 89100352 | Balazs Lecz | The <replaceable>user-id pool definition</replaceable> can contain a |
544 | 89100352 | Balazs Lecz | list of user-ids and/or a list of user-id ranges. The parameter format |
545 | 89100352 | Balazs Lecz | is a comma-separated list of numeric user-ids or user-id ranges. |
546 | 89100352 | Balazs Lecz | The ranges are defined by a lower and higher boundary, separated |
547 | 89100352 | Balazs Lecz | by a dash. The boundaries are inclusive. |
548 | 89100352 | Balazs Lecz | If the <option>--uid-pool</option> option is not supplied, the |
549 | 89100352 | Balazs Lecz | user-id pool is initialized to an empty list. An empty list means that |
550 | 89100352 | Balazs Lecz | the user-id pool feature is disabled. |
551 | 89100352 | Balazs Lecz | </para> |
552 | 89100352 | Balazs Lecz | |
553 | 92be7021 | Apollon Oikonomopoulos | <para> |
554 | f38ea602 | Iustin Pop | The <option>-I (--default-iallocator)</option> option specifies the |
555 | f38ea602 | Iustin Pop | default instance allocator. The instance allocator will be used for |
556 | f38ea602 | Iustin Pop | operations like instance creation, instance and node migration, etc. |
557 | f38ea602 | Iustin Pop | when no manual override is specified. If this option is not specified, |
558 | f38ea602 | Iustin Pop | the default instance allocator will be blank, which means that relevant |
559 | f38ea602 | Iustin Pop | operations will require the administrator to manually specify either an |
560 | 92be7021 | Apollon Oikonomopoulos | instance allocator, or a set of nodes. |
561 | f38ea602 | Iustin Pop | The default iallocator can be changed later using the |
562 | 92be7021 | Apollon Oikonomopoulos | <command>modify</command> command. |
563 | 92be7021 | Apollon Oikonomopoulos | </para> |
564 | 92be7021 | Apollon Oikonomopoulos | |
565 | 69affe73 | Manuel Franceschini | <para> |
566 | 69affe73 | Manuel Franceschini | The <option>--primary-ip-version</option> option specifies the |
567 | 69affe73 | Manuel Franceschini | IP version used for the primary address. Possible values are 4 and |
568 | 69affe73 | Manuel Franceschini | 6 for IPv4 and IPv6, respectively. This option is used when resolving |
569 | 69affe73 | Manuel Franceschini | node names and the cluster name. |
570 | 69affe73 | Manuel Franceschini | </para> |
571 | 69affe73 | Manuel Franceschini | |
572 | 75f49d9b | Iustin Pop | </refsect2> |
573 | 75f49d9b | Iustin Pop | |
574 | 75f49d9b | Iustin Pop | <refsect2> |
575 | cc425644 | Iustin Pop | <title>LIST-TAGS</title> |
576 | cc425644 | Iustin Pop | |
577 | cc425644 | Iustin Pop | <cmdsynopsis> |
578 | cc425644 | Iustin Pop | <command>list-tags</command> |
579 | cc425644 | Iustin Pop | </cmdsynopsis> |
580 | cc425644 | Iustin Pop | |
581 | cc425644 | Iustin Pop | <para>List the tags of the cluster.</para> |
582 | cc425644 | Iustin Pop | </refsect2> |
583 | cc425644 | Iustin Pop | |
584 | cc425644 | Iustin Pop | <refsect2> |
585 | c28502b1 | Iustin Pop | <title>MASTER-FAILOVER</title> |
586 | 75f49d9b | Iustin Pop | |
587 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
588 | c28502b1 | Iustin Pop | <command>master-failover</command> |
589 | 8e2524c3 | Guido Trotter | <arg>--no-voting</arg> |
590 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
591 | 75f49d9b | Iustin Pop | |
592 | 75f49d9b | Iustin Pop | <para> |
593 | 75f49d9b | Iustin Pop | Failover the master role to the current node. |
594 | 75f49d9b | Iustin Pop | </para> |
595 | 8e2524c3 | Guido Trotter | |
596 | 8e2524c3 | Guido Trotter | <para> |
597 | 8e2524c3 | Guido Trotter | The <option>--no-voting</option> option skips the remote node agreement |
598 | 8e2524c3 | Guido Trotter | checks. This is dangerous, but necessary in some cases (for example |
599 | e0897adf | Michael Hanselmann | failing over the master role in a 2 node cluster with the original |
600 | e0897adf | Michael Hanselmann | master down). If the original master then comes up, it won't be able to |
601 | e0897adf | Michael Hanselmann | start its master daemon because it won't have enough votes, but so |
602 | e0897adf | Michael Hanselmann | won't the new master, if the master daemon ever needs a restart. You |
603 | e0897adf | Michael Hanselmann | can pass <option>--no-voting</option> to |
604 | e0897adf | Michael Hanselmann | <command>ganeti-masterd</command> on the new master to solve this |
605 | e0897adf | Michael Hanselmann | problem, and run <command>gnt-cluster redist-conf</command> to make |
606 | e0897adf | Michael Hanselmann | sure the cluster is consistent again. |
607 | 8e2524c3 | Guido Trotter | </para> |
608 | 8e2524c3 | Guido Trotter | |
609 | 75f49d9b | Iustin Pop | </refsect2> |
610 | 75f49d9b | Iustin Pop | |
611 | 75f49d9b | Iustin Pop | <refsect2> |
612 | 4404ffad | Iustin Pop | <title>MASTER-PING</title> |
613 | 4404ffad | Iustin Pop | |
614 | 4404ffad | Iustin Pop | <cmdsynopsis> |
615 | 4404ffad | Iustin Pop | <command>master-ping</command> |
616 | 4404ffad | Iustin Pop | </cmdsynopsis> |
617 | 4404ffad | Iustin Pop | |
618 | 4404ffad | Iustin Pop | <para> |
619 | 4404ffad | Iustin Pop | Checks if the master daemon is alive. |
620 | 4404ffad | Iustin Pop | </para> |
621 | 4404ffad | Iustin Pop | |
622 | 4404ffad | Iustin Pop | <para> |
623 | 4404ffad | Iustin Pop | If the master daemon is alive and can respond to a basic query |
624 | 4404ffad | Iustin Pop | (the equivalent of <command>gnt-cluster info</command>), then |
625 | 4404ffad | Iustin Pop | the exit code of the command will be 0. If the master daemon |
626 | 4404ffad | Iustin Pop | is not alive (either due to a crash or because this is not the |
627 | 4404ffad | Iustin Pop | master node), the exit code will be 1. |
628 | 4404ffad | Iustin Pop | </para> |
629 | 4404ffad | Iustin Pop | |
630 | 4404ffad | Iustin Pop | </refsect2> |
631 | 4404ffad | Iustin Pop | |
632 | 4404ffad | Iustin Pop | <refsect2> |
633 | 11c05c42 | Manuel Franceschini | <title>MODIFY</title> |
634 | 11c05c42 | Manuel Franceschini | |
635 | 11c05c42 | Manuel Franceschini | <cmdsynopsis> |
636 | 11c05c42 | Manuel Franceschini | <command>modify</command> |
637 | d3b4cf9f | Iustin Pop | <sbr> |
638 | 11c05c42 | Manuel Franceschini | <arg choice="opt">-g <replaceable>vg-name</replaceable></arg> |
639 | d3b4cf9f | Iustin Pop | <sbr> |
640 | 11c05c42 | Manuel Franceschini | <arg choice="opt">--no-lvm-storage</arg> |
641 | d3b4cf9f | Iustin Pop | <sbr> |
642 | 18fb5e1d | Alexander Schreiber | <arg choice="opt">--enabled-hypervisors |
643 | 18fb5e1d | Alexander Schreiber | <replaceable>hypervisors</replaceable></arg> |
644 | d3b4cf9f | Iustin Pop | <sbr> |
645 | 555918b3 | Guido Trotter | <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> |
646 | d3b4cf9f | Iustin Pop | <sbr> |
647 | 555918b3 | Guido Trotter | <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> |
648 | d3b4cf9f | Iustin Pop | <sbr> |
649 | 7d713344 | Guido Trotter | <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> |
650 | 7d713344 | Guido Trotter | <sbr> |
651 | 89100352 | Balazs Lecz | <arg choice="opt">--uid-pool <replaceable>user-id pool definition</replaceable></arg> |
652 | 89100352 | Balazs Lecz | <sbr> |
653 | 89100352 | Balazs Lecz | <arg choice="opt">--add-uids <replaceable>user-id pool definition</replaceable></arg> |
654 | 89100352 | Balazs Lecz | <sbr> |
655 | 89100352 | Balazs Lecz | <arg choice="opt">--remove-uids <replaceable>user-id pool definition</replaceable></arg> |
656 | 89100352 | Balazs Lecz | <sbr> |
657 | 6d4a1656 | Michael Hanselmann | <arg choice="opt">-C <replaceable>candidate_pool_size</replaceable></arg> |
658 | 3953242f | Iustin Pop | <sbr> |
659 | 3953242f | Iustin Pop | <arg>--maintain-node-health <group choice="req"><arg>yes</arg><arg>no</arg></group></arg> |
660 | 92be7021 | Apollon Oikonomopoulos | <sbr> |
661 | 92be7021 | Apollon Oikonomopoulos | <arg choice="opt">-I <replaceable>default instance allocator</replaceable></arg> |
662 | 18fb5e1d | Alexander Schreiber | |
663 | f38ea602 | Iustin Pop | <sbr> |
664 | f38ea602 | Iustin Pop | <arg>--reserved-lvs=<replaceable>NAMES</replaceable></arg> |
665 | f38ea602 | Iustin Pop | |
666 | 11c05c42 | Manuel Franceschini | </cmdsynopsis> |
667 | 11c05c42 | Manuel Franceschini | |
668 | 11c05c42 | Manuel Franceschini | <para> |
669 | 11c05c42 | Manuel Franceschini | Modify the options for the cluster. |
670 | 11c05c42 | Manuel Franceschini | </para> |
671 | 11c05c42 | Manuel Franceschini | |
672 | 11c05c42 | Manuel Franceschini | <para> |
673 | 18fb5e1d | Alexander Schreiber | The <option>-g</option>, <option>--no-lvm-storarge</option>, |
674 | 18fb5e1d | Alexander Schreiber | <option>--enabled-hypervisors</option>, |
675 | 7d713344 | Guido Trotter | <option>--hypervisor-parameters</option>, |
676 | 89100352 | Balazs Lecz | <option>--backend-parameters</option>, |
677 | 89100352 | Balazs Lecz | <option>--nic-parameters</option>, |
678 | 92be7021 | Apollon Oikonomopoulos | <option>--maintain-node-health</option>, |
679 | 92be7021 | Apollon Oikonomopoulos | <option>--uid-pool</option> and |
680 | 92be7021 | Apollon Oikonomopoulos | <option>-I</option> options are |
681 | 11c05c42 | Manuel Franceschini | described in the <command>init</command> command. |
682 | 11c05c42 | Manuel Franceschini | </para> |
683 | d3b4cf9f | Iustin Pop | |
684 | d3b4cf9f | Iustin Pop | <para> |
685 | 6d4a1656 | Michael Hanselmann | The <option>-C</option> option specifies the |
686 | d3b4cf9f | Iustin Pop | <varname>candidate_pool_size</varname> cluster parameter. This |
687 | d3b4cf9f | Iustin Pop | is the number of nodes that the master will try to keep as |
688 | d3b4cf9f | Iustin Pop | <literal>master_candidates</literal>. For more details about |
689 | d3b4cf9f | Iustin Pop | this role and other node roles, see the <citerefentry> |
690 | d3b4cf9f | Iustin Pop | <refentrytitle>ganeti</refentrytitle><manvolnum>7</manvolnum> |
691 | d3b4cf9f | Iustin Pop | </citerefentry>. If you increase the size, the master will |
692 | d3b4cf9f | Iustin Pop | automatically promote as many nodes as required and possible |
693 | d3b4cf9f | Iustin Pop | to reach the intended number. |
694 | d3b4cf9f | Iustin Pop | </para> |
695 | 89100352 | Balazs Lecz | |
696 | 89100352 | Balazs Lecz | <para> |
697 | 89100352 | Balazs Lecz | The <option>--add-uids</option> and <option>--remove-uids</option> |
698 | 89100352 | Balazs Lecz | options can be used to modify the user-id pool by adding/removing |
699 | 89100352 | Balazs Lecz | a list of user-ids or user-id ranges. |
700 | f38ea602 | Iustin Pop | </para> |
701 | f38ea602 | Iustin Pop | |
702 | f38ea602 | Iustin Pop | <para> |
703 | f38ea602 | Iustin Pop | The option <option>--reserved-lvs</option> specifies a list |
704 | f38ea602 | Iustin Pop | (comma-separated) of logical volume group names (regular |
705 | f38ea602 | Iustin Pop | expressions) that will be ignored by the cluster verify |
706 | f38ea602 | Iustin Pop | operation. This is useful if the volume group used for Ganeti |
707 | f38ea602 | Iustin Pop | is shared with the system for other uses. Note that it's not |
708 | f38ea602 | Iustin Pop | recommended to create and mark as ignored logical volume names |
709 | f38ea602 | Iustin Pop | which match Ganeti's own name format (starting with UUID and |
710 | f38ea602 | Iustin Pop | then <literal>.diskN</literal>), as this option only skips the |
711 | f38ea602 | Iustin Pop | verification, but not the actual use of the names given. |
712 | f38ea602 | Iustin Pop | </para> |
713 | f38ea602 | Iustin Pop | |
714 | f38ea602 | Iustin Pop | <para> |
715 | f38ea602 | Iustin Pop | To remove all reserved logical volumes, pass in an empty |
716 | f38ea602 | Iustin Pop | argument to the option, as in <option>--reserved-lvs=</option> |
717 | f38ea602 | Iustin Pop | or <option>--reserved-lvs ''</option>. |
718 | f38ea602 | Iustin Pop | </para> |
719 | f38ea602 | Iustin Pop | |
720 | 11c05c42 | Manuel Franceschini | </refsect2> |
721 | 11c05c42 | Manuel Franceschini | |
722 | 11c05c42 | Manuel Franceschini | <refsect2> |
723 | 18fb5e1d | Alexander Schreiber | <title>QUEUE</title> |
724 | 18fb5e1d | Alexander Schreiber | |
725 | 18fb5e1d | Alexander Schreiber | <cmdsynopsis> |
726 | 18fb5e1d | Alexander Schreiber | <command>queue</command> |
727 | 18fb5e1d | Alexander Schreiber | <arg choice="opt">drain</arg> |
728 | 18fb5e1d | Alexander Schreiber | <arg choice="opt">undrain</arg> |
729 | 18fb5e1d | Alexander Schreiber | <arg choice="opt">info</arg> |
730 | 18fb5e1d | Alexander Schreiber | |
731 | 18fb5e1d | Alexander Schreiber | </cmdsynopsis> |
732 | 18fb5e1d | Alexander Schreiber | |
733 | 18fb5e1d | Alexander Schreiber | <para> |
734 | 18fb5e1d | Alexander Schreiber | Change job queue properties. |
735 | 18fb5e1d | Alexander Schreiber | </para> |
736 | 18fb5e1d | Alexander Schreiber | |
737 | 18fb5e1d | Alexander Schreiber | <para> |
738 | 18fb5e1d | Alexander Schreiber | The <option>drain</option> option sets the drain flag on the |
739 | 18fb5e1d | Alexander Schreiber | job queue. No new jobs will be accepted, but jobs already in |
740 | 18fb5e1d | Alexander Schreiber | the queue will be processed. |
741 | 18fb5e1d | Alexander Schreiber | </para> |
742 | 18fb5e1d | Alexander Schreiber | |
743 | 18fb5e1d | Alexander Schreiber | <para> |
744 | 18fb5e1d | Alexander Schreiber | The <option>undrain</option> will unset the drain flag on the |
745 | 18fb5e1d | Alexander Schreiber | job queue. New jobs will be accepted. |
746 | 18fb5e1d | Alexander Schreiber | </para> |
747 | 18fb5e1d | Alexander Schreiber | |
748 | 18fb5e1d | Alexander Schreiber | <para> |
749 | 18fb5e1d | Alexander Schreiber | The <option>info</option> option shows the properties of the |
750 | 18fb5e1d | Alexander Schreiber | job queue. |
751 | 18fb5e1d | Alexander Schreiber | </para> |
752 | 18fb5e1d | Alexander Schreiber | </refsect2> |
753 | 18fb5e1d | Alexander Schreiber | |
754 | 18fb5e1d | Alexander Schreiber | <refsect2> |
755 | 95b2e626 | Michael Hanselmann | <title>WATCHER</title> |
756 | 95b2e626 | Michael Hanselmann | |
757 | 95b2e626 | Michael Hanselmann | <cmdsynopsis> |
758 | 95b2e626 | Michael Hanselmann | <command>watcher</command> |
759 | 95b2e626 | Michael Hanselmann | <group choice="req"> |
760 | 95b2e626 | Michael Hanselmann | <arg>pause <replaceable>duration</replaceable></arg> |
761 | 95b2e626 | Michael Hanselmann | <arg>continue</arg> |
762 | 95b2e626 | Michael Hanselmann | <arg>info</arg> |
763 | 95b2e626 | Michael Hanselmann | </group> |
764 | 95b2e626 | Michael Hanselmann | </cmdsynopsis> |
765 | 95b2e626 | Michael Hanselmann | |
766 | 95b2e626 | Michael Hanselmann | <para> |
767 | 95b2e626 | Michael Hanselmann | Make the watcher pause or let it continue. |
768 | 95b2e626 | Michael Hanselmann | </para> |
769 | 95b2e626 | Michael Hanselmann | |
770 | 95b2e626 | Michael Hanselmann | <para> |
771 | 95b2e626 | Michael Hanselmann | The <option>pause</option> option causes the watcher to pause for |
772 | 95b2e626 | Michael Hanselmann | <replaceable>duration</replaceable> seconds. |
773 | 95b2e626 | Michael Hanselmann | </para> |
774 | 95b2e626 | Michael Hanselmann | |
775 | 95b2e626 | Michael Hanselmann | <para> |
776 | 95b2e626 | Michael Hanselmann | The <option>continue</option> option will let the watcher continue. |
777 | 95b2e626 | Michael Hanselmann | </para> |
778 | 95b2e626 | Michael Hanselmann | |
779 | 95b2e626 | Michael Hanselmann | <para> |
780 | 95b2e626 | Michael Hanselmann | The <option>info</option> option shows whether the watcher is currently |
781 | 95b2e626 | Michael Hanselmann | paused. |
782 | 95b2e626 | Michael Hanselmann | </para> |
783 | 95b2e626 | Michael Hanselmann | </refsect2> |
784 | 95b2e626 | Michael Hanselmann | |
785 | 95b2e626 | Michael Hanselmann | <refsect2> |
786 | d3b4cf9f | Iustin Pop | <title>redist-conf</title> |
787 | d3b4cf9f | Iustin Pop | <cmdsynopsis> |
788 | d3b4cf9f | Iustin Pop | <command>redist-conf</command> |
789 | d3b4cf9f | Iustin Pop | <arg>--submit</arg> |
790 | d3b4cf9f | Iustin Pop | </cmdsynopsis> |
791 | d3b4cf9f | Iustin Pop | |
792 | d3b4cf9f | Iustin Pop | <para> |
793 | d3b4cf9f | Iustin Pop | This command forces a full push of configuration files from |
794 | d3b4cf9f | Iustin Pop | the master node to the other nodes in the cluster. This is |
795 | d3b4cf9f | Iustin Pop | normally not needed, but can be run if the |
796 | d3b4cf9f | Iustin Pop | <command>verify</command> complains about configuration |
797 | d3b4cf9f | Iustin Pop | mismatches. |
798 | d3b4cf9f | Iustin Pop | </para> |
799 | d3b4cf9f | Iustin Pop | |
800 | d3b4cf9f | Iustin Pop | <para> |
801 | d3b4cf9f | Iustin Pop | The <option>--submit</option> option is used to send the job |
802 | d3b4cf9f | Iustin Pop | to the master daemon but not wait for its completion. The job |
803 | d3b4cf9f | Iustin Pop | ID will be shown so that it can be examined via |
804 | d3b4cf9f | Iustin Pop | <command>gnt-job info</command>. |
805 | d3b4cf9f | Iustin Pop | </para> |
806 | d3b4cf9f | Iustin Pop | |
807 | d3b4cf9f | Iustin Pop | </refsect2> |
808 | d3b4cf9f | Iustin Pop | <refsect2> |
809 | cc425644 | Iustin Pop | <title>REMOVE-TAGS</title> |
810 | cc425644 | Iustin Pop | |
811 | cc425644 | Iustin Pop | <cmdsynopsis> |
812 | cc425644 | Iustin Pop | <command>remove-tags</command> |
813 | 810c50b7 | Iustin Pop | <arg choice="opt">--from <replaceable>file</replaceable></arg> |
814 | cc425644 | Iustin Pop | <arg choice="req" |
815 | cc425644 | Iustin Pop | rep="repeat"><replaceable>tag</replaceable></arg> |
816 | cc425644 | Iustin Pop | </cmdsynopsis> |
817 | cc425644 | Iustin Pop | |
818 | cc425644 | Iustin Pop | <para> |
819 | cc425644 | Iustin Pop | Remove tags from the cluster. If any of the tags are not |
820 | cc425644 | Iustin Pop | existing on the cluster, the entire operation will abort. |
821 | cc425644 | Iustin Pop | </para> |
822 | 810c50b7 | Iustin Pop | |
823 | 810c50b7 | Iustin Pop | <para> |
824 | 810c50b7 | Iustin Pop | If the <option>--from</option> option is given, the list of |
825 | 810c50b7 | Iustin Pop | tags will be extended with the contents of that file (each |
826 | 810c50b7 | Iustin Pop | line becomes a tag). In this case, there is not need to pass |
827 | 810c50b7 | Iustin Pop | tags on the command line (if you do, both sources will be |
828 | 810c50b7 | Iustin Pop | used). A file name of - will be interpreted as stdin. |
829 | 810c50b7 | Iustin Pop | </para> |
830 | cc425644 | Iustin Pop | </refsect2> |
831 | cc425644 | Iustin Pop | |
832 | cc425644 | Iustin Pop | <refsect2> |
833 | 75f49d9b | Iustin Pop | <title>RENAME</title> |
834 | 75f49d9b | Iustin Pop | |
835 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
836 | 75f49d9b | Iustin Pop | <command>rename</command> |
837 | 75f49d9b | Iustin Pop | <arg>-f</arg> |
838 | 75f49d9b | Iustin Pop | <arg choice="req"><replaceable>name</replaceable></arg> |
839 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
840 | 75f49d9b | Iustin Pop | |
841 | 75f49d9b | Iustin Pop | <para> |
842 | 75f49d9b | Iustin Pop | Renames the cluster and in the process updates the master IP |
843 | 75f49d9b | Iustin Pop | address to the one the new name resolves to. At least one of |
844 | 75f49d9b | Iustin Pop | either the name or the IP address must be different, otherwise |
845 | 75f49d9b | Iustin Pop | the operation will be aborted. |
846 | 75f49d9b | Iustin Pop | </para> |
847 | 75f49d9b | Iustin Pop | |
848 | 75f49d9b | Iustin Pop | <para> |
849 | 75f49d9b | Iustin Pop | Note that since this command can be dangerous (especially when |
850 | 75f49d9b | Iustin Pop | run over SSH), the command will require confirmation unless |
851 | 75f49d9b | Iustin Pop | run with the <option>-f</option> option. |
852 | 75f49d9b | Iustin Pop | </para> |
853 | 75f49d9b | Iustin Pop | </refsect2> |
854 | 60975797 | Iustin Pop | |
855 | 60975797 | Iustin Pop | <refsect2> |
856 | 6d4a1656 | Michael Hanselmann | <title>RENEW-CRYPTO</title> |
857 | 6d4a1656 | Michael Hanselmann | |
858 | 6d4a1656 | Michael Hanselmann | <cmdsynopsis> |
859 | 6d4a1656 | Michael Hanselmann | <command>renew-crypto</command> |
860 | 6d4a1656 | Michael Hanselmann | <arg>-f</arg> |
861 | 6d4a1656 | Michael Hanselmann | <sbr> |
862 | 6d4a1656 | Michael Hanselmann | <arg choice="opt">--new-cluster-certificate</arg> |
863 | 6b7d5878 | Michael Hanselmann | <arg choice="opt">--new-confd-hmac-key</arg> |
864 | 6d4a1656 | Michael Hanselmann | <sbr> |
865 | 6d4a1656 | Michael Hanselmann | <arg choice="opt">--new-rapi-certificate</arg> |
866 | 6d4a1656 | Michael Hanselmann | <arg choice="opt">--rapi-certificate <replaceable>rapi-cert</replaceable></arg> |
867 | 3db3eb2a | Michael Hanselmann | <sbr> |
868 | 3db3eb2a | Michael Hanselmann | <arg choice="opt">--new-cluster-domain-secret</arg> |
869 | 3db3eb2a | Michael Hanselmann | <arg choice="opt">--cluster-domain-secret <replaceable>filename</replaceable></arg> |
870 | 6d4a1656 | Michael Hanselmann | </cmdsynopsis> |
871 | 6d4a1656 | Michael Hanselmann | |
872 | 6d4a1656 | Michael Hanselmann | <para> |
873 | 6d4a1656 | Michael Hanselmann | This command will stop all |
874 | 6d4a1656 | Michael Hanselmann | Ganeti daemons in the cluster and start them again once the new |
875 | 6d4a1656 | Michael Hanselmann | certificates and keys are replicated. The options |
876 | 6d4a1656 | Michael Hanselmann | <option>--new-cluster-certificate</option> and |
877 | 6b7d5878 | Michael Hanselmann | <option>--new-confd-hmac-key</option> can be used to regenerate the |
878 | 6d4a1656 | Michael Hanselmann | cluster-internal SSL certificate respective the HMAC key used by |
879 | 6d4a1656 | Michael Hanselmann | <citerefentry> |
880 | 6d4a1656 | Michael Hanselmann | <refentrytitle>ganeti-confd</refentrytitle><manvolnum>8</manvolnum> |
881 | 3db3eb2a | Michael Hanselmann | </citerefentry>. |
882 | 3db3eb2a | Michael Hanselmann | </para> |
883 | 3db3eb2a | Michael Hanselmann | |
884 | 3db3eb2a | Michael Hanselmann | <para> |
885 | 3db3eb2a | Michael Hanselmann | To generate a new self-signed RAPI certificate (used by <citerefentry> |
886 | 6d4a1656 | Michael Hanselmann | <refentrytitle>ganeti-rapi</refentrytitle><manvolnum>8</manvolnum> |
887 | 6d4a1656 | Michael Hanselmann | </citerefentry>) specify <option>--new-rapi-certificate</option>. If |
888 | 6d4a1656 | Michael Hanselmann | you want to use your own certificate, e.g. one signed by a certificate |
889 | 6d4a1656 | Michael Hanselmann | authority (CA), pass its filename to |
890 | 6d4a1656 | Michael Hanselmann | <option>--rapi-certificate</option>. |
891 | 6d4a1656 | Michael Hanselmann | </para> |
892 | 3db3eb2a | Michael Hanselmann | |
893 | 3db3eb2a | Michael Hanselmann | <para> |
894 | 3db3eb2a | Michael Hanselmann | <option>--new-cluster-domain-secret</option> generates a new, random |
895 | 3db3eb2a | Michael Hanselmann | cluster domain secret. <option>--cluster-domain-secret</option> reads |
896 | 3db3eb2a | Michael Hanselmann | the secret from a file. The cluster domain secret is used to sign |
897 | 3db3eb2a | Michael Hanselmann | information exchanged between separate clusters via a third party. |
898 | 3db3eb2a | Michael Hanselmann | </para> |
899 | 6d4a1656 | Michael Hanselmann | </refsect2> |
900 | 6d4a1656 | Michael Hanselmann | |
901 | 6d4a1656 | Michael Hanselmann | <refsect2> |
902 | 60975797 | Iustin Pop | <title>REPAIR-DISK-SIZES</title> |
903 | 60975797 | Iustin Pop | |
904 | 60975797 | Iustin Pop | <cmdsynopsis> |
905 | 60975797 | Iustin Pop | <command>repair-disk-sizes</command> |
906 | 60975797 | Iustin Pop | <arg rep="repeat">instance</arg> |
907 | 60975797 | Iustin Pop | </cmdsynopsis> |
908 | 60975797 | Iustin Pop | |
909 | 60975797 | Iustin Pop | <para> |
910 | 60975797 | Iustin Pop | This command checks that the recorded size of the given |
911 | 60975797 | Iustin Pop | instance's disks matches the actual size and updates any |
912 | 60975797 | Iustin Pop | mismatches found. This is needed if the Ganeti configuration |
913 | 60975797 | Iustin Pop | is no longer consistent with reality, as it will impact some |
914 | 60975797 | Iustin Pop | disk operations. If no arguments are given, all instances will |
915 | 60975797 | Iustin Pop | be checked. |
916 | 60975797 | Iustin Pop | </para> |
917 | 60975797 | Iustin Pop | |
918 | 60975797 | Iustin Pop | <para> |
919 | 60975797 | Iustin Pop | Note that only active disks can be checked by this command; in |
920 | 60975797 | Iustin Pop | case a disk cannot be activated it's advised to use |
921 | a4f12da4 | Michael Hanselmann | <command>gnt-instance activate-disks --ignore-size ...</command> to |
922 | a4f12da4 | Michael Hanselmann | force activation without regard to the |
923 | 60975797 | Iustin Pop | current size. |
924 | 60975797 | Iustin Pop | </para> |
925 | 60975797 | Iustin Pop | |
926 | 60975797 | Iustin Pop | <para> |
927 | 60975797 | Iustin Pop | When the all disk sizes are consistent, the command will |
928 | 60975797 | Iustin Pop | return no output. Otherwise it will log details about the |
929 | 60975797 | Iustin Pop | inconsistencies in the configuration. |
930 | 60975797 | Iustin Pop | </para> |
931 | 60975797 | Iustin Pop | </refsect2> |
932 | 75f49d9b | Iustin Pop | |
933 | 75f49d9b | Iustin Pop | <refsect2> |
934 | 73415719 | Iustin Pop | <title>SEARCH-TAGS</title> |
935 | 73415719 | Iustin Pop | |
936 | 73415719 | Iustin Pop | <cmdsynopsis> |
937 | 73415719 | Iustin Pop | <command>search-tags</command> |
938 | 73415719 | Iustin Pop | <arg choice="req"><replaceable>pattern</replaceable></arg> |
939 | 73415719 | Iustin Pop | </cmdsynopsis> |
940 | 73415719 | Iustin Pop | |
941 | 73415719 | Iustin Pop | <para> |
942 | 73415719 | Iustin Pop | Searches the tags on all objects in the cluster (the cluster |
943 | 73415719 | Iustin Pop | itself, the nodes and the instances) for a given pattern. The |
944 | 73415719 | Iustin Pop | pattern is interpreted as a regular expression and a search |
945 | 73415719 | Iustin Pop | will be done on it (i.e. the given pattern is not anchored to |
946 | 73415719 | Iustin Pop | the beggining of the string; if you want that, prefix the |
947 | 73415719 | Iustin Pop | pattern with <literal>^</literal>). |
948 | 73415719 | Iustin Pop | </para> |
949 | 73415719 | Iustin Pop | |
950 | 73415719 | Iustin Pop | <para> |
951 | 73415719 | Iustin Pop | If no tags are matching the pattern, the exit code of the |
952 | 73415719 | Iustin Pop | command will be one. If there is at least one match, the exit |
953 | 73415719 | Iustin Pop | code will be zero. Each match is listed on one line, the |
954 | 73415719 | Iustin Pop | object and the tag separated by a space. The cluster will be |
955 | 73415719 | Iustin Pop | listed as <filename>/cluster</filename>, a node will be listed |
956 | 73415719 | Iustin Pop | as |
957 | 73415719 | Iustin Pop | <filename>/nodes/<replaceable>name</replaceable></filename>, |
958 | 73415719 | Iustin Pop | and an instance as |
959 | 73415719 | Iustin Pop | <filename>/instances/<replaceable>name</replaceable></filename>. |
960 | 73415719 | Iustin Pop | Example: |
961 | 73415719 | Iustin Pop | </para> |
962 | 73415719 | Iustin Pop | <screen> |
963 | 2f49d1d2 | Guido Trotter | # gnt-cluster search-tags time |
964 | 73415719 | Iustin Pop | /cluster ctime:2007-09-01 |
965 | 73415719 | Iustin Pop | /nodes/node1.example.com mtime:2007-10-04 |
966 | 73415719 | Iustin Pop | </screen> |
967 | 73415719 | Iustin Pop | </refsect2> |
968 | 73415719 | Iustin Pop | |
969 | 73415719 | Iustin Pop | <refsect2> |
970 | 75f49d9b | Iustin Pop | <title>VERIFY</title> |
971 | 75f49d9b | Iustin Pop | |
972 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
973 | 75f49d9b | Iustin Pop | <command>verify</command> |
974 | 3cf7c9fa | Guido Trotter | <arg choice="opt">--no-nplus1-mem</arg> |
975 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
976 | 75f49d9b | Iustin Pop | |
977 | 75f49d9b | Iustin Pop | <para> |
978 | 75f49d9b | Iustin Pop | Verify correctness of cluster configuration. This is safe with |
979 | 75f49d9b | Iustin Pop | respect to running instances, and incurs no downtime of the |
980 | 75f49d9b | Iustin Pop | instances. |
981 | 75f49d9b | Iustin Pop | </para> |
982 | 3cf7c9fa | Guido Trotter | |
983 | 3cf7c9fa | Guido Trotter | <para> |
984 | e0897adf | Michael Hanselmann | If the <option>--no-nplus1-mem</option> option is given, Ganeti won't |
985 | 3cf7c9fa | Guido Trotter | check whether if it loses a node it can restart all the instances on |
986 | 3cf7c9fa | Guido Trotter | their secondaries (and report an error otherwise). |
987 | 3cf7c9fa | Guido Trotter | </para> |
988 | 75f49d9b | Iustin Pop | </refsect2> |
989 | 75f49d9b | Iustin Pop | |
990 | 75f49d9b | Iustin Pop | <refsect2> |
991 | ed2d1409 | Iustin Pop | <title>VERIFY-DISKS</title> |
992 | ed2d1409 | Iustin Pop | |
993 | ed2d1409 | Iustin Pop | <cmdsynopsis> |
994 | ed2d1409 | Iustin Pop | <command>verify-disks</command> |
995 | ed2d1409 | Iustin Pop | </cmdsynopsis> |
996 | ed2d1409 | Iustin Pop | |
997 | ed2d1409 | Iustin Pop | <para> |
998 | ed2d1409 | Iustin Pop | The command checks which instances have degraded DRBD disks |
999 | ed2d1409 | Iustin Pop | and activates the disks of those instances. |
1000 | ed2d1409 | Iustin Pop | </para> |
1001 | ed2d1409 | Iustin Pop | |
1002 | ed2d1409 | Iustin Pop | <para> |
1003 | ed2d1409 | Iustin Pop | This command is run from the <command>ganeti-watcher</command> |
1004 | ed2d1409 | Iustin Pop | tool, which also has a different, complementary algorithm for |
1005 | ed2d1409 | Iustin Pop | doing this check. Together, these two should ensure that DRBD |
1006 | ed2d1409 | Iustin Pop | disks are kept consistent. |
1007 | ed2d1409 | Iustin Pop | </para> |
1008 | ed2d1409 | Iustin Pop | </refsect2> |
1009 | ed2d1409 | Iustin Pop | |
1010 | ed2d1409 | Iustin Pop | <refsect2> |
1011 | 75f49d9b | Iustin Pop | <title>VERSION</title> |
1012 | 75f49d9b | Iustin Pop | |
1013 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
1014 | 75f49d9b | Iustin Pop | <command>version</command> |
1015 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
1016 | 75f49d9b | Iustin Pop | |
1017 | 75f49d9b | Iustin Pop | <para> |
1018 | 75f49d9b | Iustin Pop | Show the cluster version. |
1019 | 75f49d9b | Iustin Pop | </para> |
1020 | 75f49d9b | Iustin Pop | </refsect2> |
1021 | a8083063 | Iustin Pop | |
1022 | a8083063 | Iustin Pop | </refsect1> |
1023 | a8083063 | Iustin Pop | |
1024 | a8083063 | Iustin Pop | &footer; |
1025 | a8083063 | Iustin Pop | |
1026 | a8083063 | Iustin Pop | </refentry> |
1027 | a8083063 | Iustin Pop | |
1028 | a8083063 | Iustin Pop | <!-- Keep this comment at the end of the file |
1029 | a8083063 | Iustin Pop | Local variables: |
1030 | a8083063 | Iustin Pop | mode: sgml |
1031 | a8083063 | Iustin Pop | sgml-omittag:t |
1032 | a8083063 | Iustin Pop | sgml-shorttag:t |
1033 | a8083063 | Iustin Pop | sgml-minimize-attributes:nil |
1034 | a8083063 | Iustin Pop | sgml-always-quote-attributes:t |
1035 | a8083063 | Iustin Pop | sgml-indent-step:2 |
1036 | a8083063 | Iustin Pop | sgml-indent-data:t |
1037 | a8083063 | Iustin Pop | sgml-parent-document:nil |
1038 | a8083063 | Iustin Pop | sgml-default-dtd-file:nil |
1039 | a8083063 | Iustin Pop | sgml-exposed-tags:nil |
1040 | a8083063 | Iustin Pop | sgml-local-catalogs:nil |
1041 | a8083063 | Iustin Pop | sgml-local-ecat-files:nil |
1042 | a8083063 | Iustin Pop | End: |
1043 | a8083063 | Iustin Pop | --> |