root / man / gnt-cluster.sgml @ 6d4a1656
History | View | Annotate | Download (28.9 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 | d3b4cf9f | Iustin Pop | <!ENTITY dhdate "<date>February 12, 2009</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 | d3b4cf9f | Iustin Pop | <refmiscinfo>ganeti 2.0</refmiscinfo> |
34 | a8083063 | Iustin Pop | </refmeta> |
35 | a8083063 | Iustin Pop | <refnamediv> |
36 | a8083063 | Iustin Pop | <refname>&dhpackage;</refname> |
37 | a8083063 | Iustin Pop | |
38 | a8083063 | Iustin Pop | <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 | a8083063 | Iustin Pop | 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 | 75f49d9b | Iustin Pop | <arg>-n <replaceable>node</replaceable></arg> |
142 | 75f49d9b | Iustin Pop | <arg choice="req"><replaceable>file</replaceable></arg> |
143 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
144 | 75f49d9b | Iustin Pop | |
145 | 75f49d9b | Iustin Pop | <para> |
146 | 75f49d9b | Iustin Pop | Copies a file to all or to some nodes. The argument specifies |
147 | 75f49d9b | Iustin Pop | the source file (on the current system), the |
148 | 75f49d9b | Iustin Pop | <option>-n</option> argument specifies the target node, or |
149 | 75f49d9b | Iustin Pop | nodes if the option is given multiple times. If |
150 | 75f49d9b | Iustin Pop | <option>-n</option> is not given at all, the file will be |
151 | 75f49d9b | Iustin Pop | copied to all nodes. |
152 | 75f49d9b | Iustin Pop | |
153 | 75f49d9b | Iustin Pop | Example: |
154 | 75f49d9b | Iustin Pop | <screen> |
155 | 75f49d9b | Iustin Pop | # gnt-cluster -n node1.example.com -n node2.example.com copyfile /tmp/test |
156 | 75f49d9b | Iustin Pop | </screen> |
157 | 75f49d9b | Iustin Pop | |
158 | 75f49d9b | Iustin Pop | This will copy the file <filename>/tmp/test</filename> from |
159 | 75f49d9b | Iustin Pop | the current node to the two named nodes. |
160 | 75f49d9b | Iustin Pop | </para> |
161 | 75f49d9b | Iustin Pop | </refsect2> |
162 | 75f49d9b | Iustin Pop | |
163 | 75f49d9b | Iustin Pop | <refsect2> |
164 | 75f49d9b | Iustin Pop | <title>DESTROY</title> |
165 | 75f49d9b | Iustin Pop | |
166 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
167 | 75f49d9b | Iustin Pop | <command>destroy</command> |
168 | f69dab6d | Iustin Pop | <arg choice="req">--yes-do-it</arg> |
169 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
170 | 75f49d9b | Iustin Pop | |
171 | 75f49d9b | Iustin Pop | <para> |
172 | 75f49d9b | Iustin Pop | Remove all configuration files related to the cluster, so that |
173 | 75f49d9b | Iustin Pop | a <command>gnt-cluster init</command> can be done again |
174 | 75f49d9b | Iustin Pop | afterwards. |
175 | 75f49d9b | Iustin Pop | </para> |
176 | f69dab6d | Iustin Pop | |
177 | f69dab6d | Iustin Pop | <para> |
178 | f69dab6d | Iustin Pop | Since this is a dangerous command, you are required to pass |
179 | f69dab6d | Iustin Pop | the argument <replaceable>--yes-do-it.</replaceable> |
180 | f69dab6d | Iustin Pop | </para> |
181 | 75f49d9b | Iustin Pop | </refsect2> |
182 | 75f49d9b | Iustin Pop | |
183 | 75f49d9b | Iustin Pop | <refsect2> |
184 | 75f49d9b | Iustin Pop | <title>GETMASTER</title> |
185 | 75f49d9b | Iustin Pop | |
186 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
187 | 75f49d9b | Iustin Pop | <command>getmaster</command> |
188 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
189 | 75f49d9b | Iustin Pop | |
190 | 75f49d9b | Iustin Pop | <para> |
191 | 75f49d9b | Iustin Pop | Displays the current master node. |
192 | 75f49d9b | Iustin Pop | </para> |
193 | 75f49d9b | Iustin Pop | </refsect2> |
194 | 75f49d9b | Iustin Pop | |
195 | 75f49d9b | Iustin Pop | <refsect2> |
196 | 75f49d9b | Iustin Pop | <title>INFO</title> |
197 | 75f49d9b | Iustin Pop | |
198 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
199 | 75f49d9b | Iustin Pop | <command>info</command> |
200 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
201 | 75f49d9b | Iustin Pop | |
202 | 75f49d9b | Iustin Pop | <para> |
203 | 75f49d9b | Iustin Pop | Shows runtime cluster information: cluster name, architecture |
204 | 75f49d9b | Iustin Pop | (32 or 64 bit), master node, node list and instance list. |
205 | 75f49d9b | Iustin Pop | </para> |
206 | 75f49d9b | Iustin Pop | </refsect2> |
207 | 75f49d9b | Iustin Pop | |
208 | 75f49d9b | Iustin Pop | <refsect2> |
209 | 75f49d9b | Iustin Pop | <title>INIT</title> |
210 | 75f49d9b | Iustin Pop | |
211 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
212 | 75f49d9b | Iustin Pop | <command>init</command> |
213 | d3b4cf9f | Iustin Pop | <sbr> |
214 | 75f49d9b | Iustin Pop | <arg>-s <replaceable>secondary_ip</replaceable></arg> |
215 | d3b4cf9f | Iustin Pop | <sbr> |
216 | f3b100e1 | Guido Trotter | <arg>-g <replaceable>vg-name</replaceable></arg> |
217 | d3b4cf9f | Iustin Pop | <sbr> |
218 | f3b100e1 | Guido Trotter | <arg>--master-netdev <replaceable>vg-name</replaceable></arg> |
219 | d3b4cf9f | Iustin Pop | <sbr> |
220 | f3b100e1 | Guido Trotter | <arg>-m <replaceable>mac-prefix</replaceable></arg> |
221 | d3b4cf9f | Iustin Pop | <sbr> |
222 | 11c05c42 | Manuel Franceschini | <arg>--no-lvm-storage</arg> |
223 | d3b4cf9f | Iustin Pop | <sbr> |
224 | b989b9d9 | Ken Wehr | <arg>--no-etc-hosts</arg> |
225 | b989b9d9 | Ken Wehr | <sbr> |
226 | b989b9d9 | Ken Wehr | <arg>--no-ssh-init</arg> |
227 | b989b9d9 | Ken Wehr | <sbr> |
228 | 19ae0895 | Alexander Schreiber | <arg>--file-storage-dir <replaceable>dir</replaceable></arg> |
229 | d3b4cf9f | Iustin Pop | <sbr> |
230 | 19ae0895 | Alexander Schreiber | <arg>--enabled-hypervisors <replaceable>hypervisors</replaceable></arg> |
231 | d3b4cf9f | Iustin Pop | <sbr> |
232 | 19ae0895 | Alexander Schreiber | <arg>-t <replaceable>hypervisor name</replaceable></arg> |
233 | d3b4cf9f | Iustin Pop | <sbr> |
234 | 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> |
235 | d3b4cf9f | Iustin Pop | <sbr> |
236 | 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> |
237 | d3b4cf9f | Iustin Pop | <sbr> |
238 | 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> |
239 | 7d713344 | Guido Trotter | <sbr> |
240 | 75f49d9b | Iustin Pop | <arg choice="req"><replaceable>clustername</replaceable></arg> |
241 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
242 | 75f49d9b | Iustin Pop | |
243 | 75f49d9b | Iustin Pop | <para> |
244 | 75f49d9b | Iustin Pop | This commands is only run once initially on the first node of |
245 | 75f49d9b | Iustin Pop | the cluster. It will initialize the cluster configuration and |
246 | 75f49d9b | Iustin Pop | setup ssh-keys and more. |
247 | 75f49d9b | Iustin Pop | </para> |
248 | 75f49d9b | Iustin Pop | |
249 | 75f49d9b | Iustin Pop | <para> |
250 | 75f49d9b | Iustin Pop | Note that the <replaceable>clustername</replaceable> is not |
251 | 75f49d9b | Iustin Pop | any random name. It has to be resolvable to an IP address |
252 | 75f49d9b | Iustin Pop | using DNS, and it is best if you give the fully-qualified |
253 | 56db8a84 | Alexander Schreiber | domain name. This hostname must resolve to an IP address |
254 | 56db8a84 | Alexander Schreiber | reserved exclusively for this purpose. |
255 | 75f49d9b | Iustin Pop | </para> |
256 | 75f49d9b | Iustin Pop | |
257 | 75f49d9b | Iustin Pop | <para> |
258 | 75f49d9b | Iustin Pop | The cluster can run in two modes: single-home or |
259 | 75f49d9b | Iustin Pop | dual-homed. In the first case, all traffic (both public |
260 | 75f49d9b | Iustin Pop | traffic, inter-node traffic and data replication traffic) goes |
261 | 75f49d9b | Iustin Pop | over the same interface. In the dual-homed case, the data |
262 | 75f49d9b | Iustin Pop | replication traffic goes over the second network. The |
263 | 75f49d9b | Iustin Pop | <option>-s</option> option here marks the cluster as |
264 | 75f49d9b | Iustin Pop | dual-homed and its parameter represents this node's address on |
265 | 75f49d9b | Iustin Pop | the second network. If you initialise the cluster with |
266 | 75f49d9b | Iustin Pop | <option>-s</option>, all nodes added must have a secondary IP |
267 | 75f49d9b | Iustin Pop | as well. |
268 | 75f49d9b | Iustin Pop | </para> |
269 | 75f49d9b | Iustin Pop | |
270 | 75f49d9b | Iustin Pop | <para> |
271 | 75f49d9b | Iustin Pop | Note that for Ganeti it doesn't matter if the secondary |
272 | 75f49d9b | Iustin Pop | network is actually a separate physical network, or is done |
273 | 75f49d9b | Iustin Pop | using tunneling, etc. For performance reasons, it's |
274 | 75f49d9b | Iustin Pop | recommended to use a separate network, of course. |
275 | 75f49d9b | Iustin Pop | </para> |
276 | 75f49d9b | Iustin Pop | |
277 | 75f49d9b | Iustin Pop | <para> |
278 | f3b100e1 | Guido Trotter | The <option>-g</option> option will let you specify a volume group |
279 | 11c05c42 | Manuel Franceschini | different than 'xenvg' for ganeti to use when creating instance disks. |
280 | 11c05c42 | Manuel Franceschini | This volume group must have the same name on all nodes. Once the |
281 | 11c05c42 | Manuel Franceschini | cluster is initialized this can be altered by using the |
282 | 11c05c42 | Manuel Franceschini | <command>modify</command> command. If you don't want to use lvm |
283 | 11c05c42 | Manuel Franceschini | storage at all use the <option>--no-lvm-storage</option> option. |
284 | 11c05c42 | Manuel Franceschini | Once the cluster is initialized you can change this setup with the |
285 | 11c05c42 | Manuel Franceschini | <command>modify</command> command. |
286 | f3b100e1 | Guido Trotter | </para> |
287 | f3b100e1 | Guido Trotter | |
288 | f3b100e1 | Guido Trotter | <para> |
289 | f3b100e1 | Guido Trotter | The <option>--master-netdev</option> option is useful for specifying a |
290 | f3b100e1 | Guido Trotter | different interface on which the master will activate its IP address. |
291 | f3b100e1 | Guido Trotter | It's important that all nodes have this interface because you'll need |
292 | f3b100e1 | Guido Trotter | it for a master failover. |
293 | f3b100e1 | Guido Trotter | </para> |
294 | f3b100e1 | Guido Trotter | |
295 | f3b100e1 | Guido Trotter | <para> |
296 | f3b100e1 | Guido Trotter | The <option>-m</option> option will let you specify a three byte prefix |
297 | f3b100e1 | Guido Trotter | under which the virtual MAC addresses of your instances will be |
298 | f3b100e1 | Guido Trotter | generated. The prefix must be specified in the format XX:XX:XX and the |
299 | f3b100e1 | Guido Trotter | default is aa:00:00. |
300 | f3b100e1 | Guido Trotter | </para> |
301 | f3b100e1 | Guido Trotter | |
302 | 11c05c42 | Manuel Franceschini | <para> |
303 | b989b9d9 | Ken Wehr | The <option>--no-lvm-storage</option> option allows you to initialize |
304 | b989b9d9 | Ken Wehr | the cluster without lvm support. This means that only instances using |
305 | 11c05c42 | Manuel Franceschini | files as storage backend will be possible to create. Once the cluster |
306 | 11c05c42 | Manuel Franceschini | is initialized you can change this setup with the |
307 | 11c05c42 | Manuel Franceschini | <command>modify</command> command. |
308 | 11c05c42 | Manuel Franceschini | </para> |
309 | 19ae0895 | Alexander Schreiber | |
310 | 19ae0895 | Alexander Schreiber | <para> |
311 | b989b9d9 | Ken Wehr | The <option>--no-etc-hosts</option> option allows you to initialize the |
312 | b989b9d9 | Ken Wehr | cluster without modifying the <filename>/etc/hosts</filename> file. |
313 | b989b9d9 | Ken Wehr | </para> |
314 | b989b9d9 | Ken Wehr | |
315 | b989b9d9 | Ken Wehr | <para> |
316 | b989b9d9 | Ken Wehr | The <option>--no-ssh-init</option> option allows you to initialize the |
317 | b989b9d9 | Ken Wehr | cluster without creating or distributing SSH key pairs. |
318 | b989b9d9 | Ken Wehr | </para> |
319 | b989b9d9 | Ken Wehr | |
320 | b989b9d9 | Ken Wehr | <para> |
321 | 19ae0895 | Alexander Schreiber | The <option>--file-storage-dir</option> option allows you |
322 | 19ae0895 | Alexander Schreiber | set the directory to use for storing the instance disk |
323 | 19ae0895 | Alexander Schreiber | files when using file storage as backend for instance disks. |
324 | 19ae0895 | Alexander Schreiber | </para> |
325 | 19ae0895 | Alexander Schreiber | |
326 | 19ae0895 | Alexander Schreiber | <para> |
327 | 19ae0895 | Alexander Schreiber | The <option>--enabled-hypervisors</option> option allows you |
328 | 19ae0895 | Alexander Schreiber | to set the list of hypervisors that will be enabled for |
329 | ba0b05fe | Iustin Pop | this cluster. Instance hypervisors can only be chosen from |
330 | 066f465d | Guido Trotter | the list of enabled hypervisors, and the first entry of this list |
331 | 066f465d | Guido Trotter | will be used by default. Currently, the following hypervisors are |
332 | 066f465d | Guido Trotter | available: |
333 | 19ae0895 | Alexander Schreiber | </para> |
334 | 19ae0895 | Alexander Schreiber | |
335 | 19ae0895 | Alexander Schreiber | <para> |
336 | 19ae0895 | Alexander Schreiber | <variablelist> |
337 | 19ae0895 | Alexander Schreiber | <varlistentry> |
338 | 19ae0895 | Alexander Schreiber | <term>xen-pvm</term> |
339 | 19ae0895 | Alexander Schreiber | <listitem> |
340 | 19ae0895 | Alexander Schreiber | <para> |
341 | 19ae0895 | Alexander Schreiber | Xen PVM hypervisor |
342 | 19ae0895 | Alexander Schreiber | </para> |
343 | 19ae0895 | Alexander Schreiber | </listitem> |
344 | 19ae0895 | Alexander Schreiber | </varlistentry> |
345 | 19ae0895 | Alexander Schreiber | <varlistentry> |
346 | 19ae0895 | Alexander Schreiber | <term>xen-hvm</term> |
347 | 19ae0895 | Alexander Schreiber | <listitem> |
348 | 19ae0895 | Alexander Schreiber | <para> |
349 | 19ae0895 | Alexander Schreiber | Xen HVM hypervisor |
350 | 19ae0895 | Alexander Schreiber | </para> |
351 | 19ae0895 | Alexander Schreiber | </listitem> |
352 | 19ae0895 | Alexander Schreiber | </varlistentry> |
353 | 19ae0895 | Alexander Schreiber | <varlistentry> |
354 | 19ae0895 | Alexander Schreiber | <term>kvm</term> |
355 | 19ae0895 | Alexander Schreiber | <listitem> |
356 | 19ae0895 | Alexander Schreiber | <para> |
357 | 19ae0895 | Alexander Schreiber | Linux KVM hypervisor |
358 | 19ae0895 | Alexander Schreiber | </para> |
359 | 19ae0895 | Alexander Schreiber | </listitem> |
360 | 19ae0895 | Alexander Schreiber | </varlistentry> |
361 | 19ae0895 | Alexander Schreiber | <varlistentry> |
362 | e8a3bf18 | Iustin Pop | <term>chroot</term> |
363 | e8a3bf18 | Iustin Pop | <listitem> |
364 | e8a3bf18 | Iustin Pop | <para> |
365 | e8a3bf18 | Iustin Pop | a simple chroot manager that starts chroot based on a |
366 | e8a3bf18 | Iustin Pop | script at the root of the filesystem holding the |
367 | e8a3bf18 | Iustin Pop | chroot |
368 | e8a3bf18 | Iustin Pop | <varlistentry> |
369 | 19ae0895 | Alexander Schreiber | <term>fake</term> |
370 | 19ae0895 | Alexander Schreiber | <listitem> |
371 | 19ae0895 | Alexander Schreiber | <para> |
372 | 19ae0895 | Alexander Schreiber | fake hypervisor for development/testing |
373 | 19ae0895 | Alexander Schreiber | </para> |
374 | 19ae0895 | Alexander Schreiber | </listitem> |
375 | 19ae0895 | Alexander Schreiber | </varlistentry> |
376 | 19ae0895 | Alexander Schreiber | </variablelist> |
377 | 19ae0895 | Alexander Schreiber | </para> |
378 | 19ae0895 | Alexander Schreiber | |
379 | 19ae0895 | Alexander Schreiber | <para> |
380 | 19ae0895 | Alexander Schreiber | Either a single hypervisor name or a comma-separated list of |
381 | 19ae0895 | Alexander Schreiber | hypervisor names can be specified. If this option is not |
382 | 19ae0895 | Alexander Schreiber | specified, only the xen-pvm hypervisor is enabled by default. |
383 | 19ae0895 | Alexander Schreiber | </para> |
384 | 19ae0895 | Alexander Schreiber | |
385 | 19ae0895 | Alexander Schreiber | <para> |
386 | e8a3bf18 | Iustin Pop | The <option>--hypervisor-parameters</option> option allows you |
387 | e8a3bf18 | Iustin Pop | to set default hypervisor specific parameters for the |
388 | e8a3bf18 | Iustin Pop | cluster. The format of this option is the name of the |
389 | e8a3bf18 | Iustin Pop | hypervisor, followed by a colon and a comma-separated list of |
390 | e8a3bf18 | Iustin Pop | key=value pairs. The keys available for each hypervisors are |
391 | e8a3bf18 | Iustin Pop | detailed in the <citerefentry> |
392 | e8a3bf18 | Iustin Pop | <refentrytitle>gnt-instance</refentrytitle> |
393 | e8a3bf18 | Iustin Pop | <manvolnum>8</manvolnum> </citerefentry> man page, in the |
394 | e8a3bf18 | Iustin Pop | <command>add</command> command plus the following parameters |
395 | e8a3bf18 | Iustin Pop | which are only configurable globally (at cluster level): |
396 | e8a3bf18 | Iustin Pop | |
397 | e8a3bf18 | Iustin Pop | <variablelist> |
398 | e8a3bf18 | Iustin Pop | <varlistentry> |
399 | e8a3bf18 | Iustin Pop | <term>migration_port</term> |
400 | e8a3bf18 | Iustin Pop | <listitem> |
401 | e8a3bf18 | Iustin Pop | <simpara>Valid for the Xen PVM and KVM hypervisors.</simpara> |
402 | e8a3bf18 | Iustin Pop | |
403 | e8a3bf18 | Iustin Pop | <para> |
404 | e8a3bf18 | Iustin Pop | This options specifies the TCP port to use for |
405 | e8a3bf18 | Iustin Pop | live-migration. For Xen, the same port should be |
406 | e8a3bf18 | Iustin Pop | configured on all nodes in |
407 | e8a3bf18 | Iustin Pop | the <filename>/etc/xen/xend-config.sxp</filename> |
408 | e8a3bf18 | Iustin Pop | file, under the |
409 | e8a3bf18 | Iustin Pop | key <quote>xend-relocation-port</quote>. |
410 | e8a3bf18 | Iustin Pop | </para> |
411 | e8a3bf18 | Iustin Pop | </listitem> |
412 | e8a3bf18 | Iustin Pop | </varlistentry> |
413 | e8a3bf18 | Iustin Pop | </variablelist> |
414 | e8a3bf18 | Iustin Pop | |
415 | e8a3bf18 | Iustin Pop | </para> |
416 | e8a3bf18 | Iustin Pop | |
417 | e8a3bf18 | Iustin Pop | <para> |
418 | 280b79b3 | Guido Trotter | The <option>--backend-parameters</option> option allows you to set |
419 | 19ae0895 | Alexander Schreiber | the default backend parameters for the cluster. The parameter |
420 | 19ae0895 | Alexander Schreiber | format is a comma-separated list of key=value pairs with the |
421 | 19ae0895 | Alexander Schreiber | following supported keys: |
422 | 19ae0895 | Alexander Schreiber | </para> |
423 | 19ae0895 | Alexander Schreiber | |
424 | 19ae0895 | Alexander Schreiber | <para> |
425 | 19ae0895 | Alexander Schreiber | <variablelist> |
426 | 19ae0895 | Alexander Schreiber | <varlistentry> |
427 | 19ae0895 | Alexander Schreiber | <term>vcpus</term> |
428 | 19ae0895 | Alexander Schreiber | <listitem> |
429 | 19ae0895 | Alexander Schreiber | <para> |
430 | 19ae0895 | Alexander Schreiber | Number of VCPUs to set for an instance by default, must |
431 | 19ae0895 | Alexander Schreiber | be an integer, will be set to 1 if no specified. |
432 | 19ae0895 | Alexander Schreiber | </para> |
433 | 19ae0895 | Alexander Schreiber | </listitem> |
434 | 19ae0895 | Alexander Schreiber | </varlistentry> |
435 | 19ae0895 | Alexander Schreiber | <varlistentry> |
436 | 19ae0895 | Alexander Schreiber | <term>memory</term> |
437 | 19ae0895 | Alexander Schreiber | <listitem> |
438 | 19ae0895 | Alexander Schreiber | <para> |
439 | 19ae0895 | Alexander Schreiber | Amount of memory to allocate for an instance by default, |
440 | 19ae0895 | Alexander Schreiber | can be either an integer or an integer followed by a |
441 | 19ae0895 | Alexander Schreiber | unit (M for mebibytes and G for gibibytes are |
442 | 19ae0895 | Alexander Schreiber | supported), will be set to 128M if not specified. |
443 | 19ae0895 | Alexander Schreiber | </para> |
444 | 19ae0895 | Alexander Schreiber | </listitem> |
445 | 19ae0895 | Alexander Schreiber | </varlistentry> |
446 | 19ae0895 | Alexander Schreiber | <varlistentry> |
447 | 19ae0895 | Alexander Schreiber | <term>auto_balance</term> |
448 | 19ae0895 | Alexander Schreiber | <listitem> |
449 | 19ae0895 | Alexander Schreiber | <para> |
450 | 19ae0895 | Alexander Schreiber | Value of the auto_balance flag for instances to use by |
451 | 19ae0895 | Alexander Schreiber | default, will be set to true if not specified. |
452 | 19ae0895 | Alexander Schreiber | </para> |
453 | 19ae0895 | Alexander Schreiber | </listitem> |
454 | 19ae0895 | Alexander Schreiber | </varlistentry> |
455 | 19ae0895 | Alexander Schreiber | </variablelist> |
456 | 19ae0895 | Alexander Schreiber | </para> |
457 | 19ae0895 | Alexander Schreiber | |
458 | 19ae0895 | Alexander Schreiber | <para> |
459 | 7d713344 | Guido Trotter | The <option>--nic-parameters</option> option allows you to set |
460 | 7d713344 | Guido Trotter | the default nic parameters for the cluster. The parameter |
461 | 7d713344 | Guido Trotter | format is a comma-separated list of key=value pairs with the |
462 | 7d713344 | Guido Trotter | following supported keys: |
463 | 7d713344 | Guido Trotter | <variablelist> |
464 | 7d713344 | Guido Trotter | <varlistentry> |
465 | 7d713344 | Guido Trotter | <term>mode</term> |
466 | 7d713344 | Guido Trotter | <listitem> |
467 | 7d713344 | Guido Trotter | <para> |
468 | 7d713344 | Guido Trotter | The default nic mode, 'routed' or 'bridged'. |
469 | 7d713344 | Guido Trotter | </para> |
470 | 7d713344 | Guido Trotter | </listitem> |
471 | 7d713344 | Guido Trotter | </varlistentry> |
472 | 7d713344 | Guido Trotter | <varlistentry> |
473 | 7d713344 | Guido Trotter | <term>link</term> |
474 | 7d713344 | Guido Trotter | <listitem> |
475 | 7d713344 | Guido Trotter | <para> |
476 | 8063787e | Guido Trotter | In bridged mode the default NIC bridge. In routed mode it |
477 | 8063787e | Guido Trotter | represents an hypervisor-vif-script dependent value to allow |
478 | 8063787e | Guido Trotter | different instance groups. For example under the KVM default |
479 | 8063787e | Guido Trotter | network script it is interpreted as a routing table number or |
480 | 8063787e | Guido Trotter | name. |
481 | 7d713344 | Guido Trotter | </para> |
482 | 7d713344 | Guido Trotter | </listitem> |
483 | 7d713344 | Guido Trotter | </varlistentry> |
484 | 7d713344 | Guido Trotter | </variablelist> |
485 | 7d713344 | Guido Trotter | </para> |
486 | 7d713344 | Guido Trotter | |
487 | 75f49d9b | Iustin Pop | </refsect2> |
488 | 75f49d9b | Iustin Pop | |
489 | 75f49d9b | Iustin Pop | <refsect2> |
490 | cc425644 | Iustin Pop | <title>LIST-TAGS</title> |
491 | cc425644 | Iustin Pop | |
492 | cc425644 | Iustin Pop | <cmdsynopsis> |
493 | cc425644 | Iustin Pop | <command>list-tags</command> |
494 | cc425644 | Iustin Pop | </cmdsynopsis> |
495 | cc425644 | Iustin Pop | |
496 | cc425644 | Iustin Pop | <para>List the tags of the cluster.</para> |
497 | cc425644 | Iustin Pop | </refsect2> |
498 | cc425644 | Iustin Pop | |
499 | cc425644 | Iustin Pop | <refsect2> |
500 | 75f49d9b | Iustin Pop | <title>MASTERFAILOVER</title> |
501 | 75f49d9b | Iustin Pop | |
502 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
503 | 75f49d9b | Iustin Pop | <command>masterfailover</command> |
504 | 8e2524c3 | Guido Trotter | <arg>--no-voting</arg> |
505 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
506 | 75f49d9b | Iustin Pop | |
507 | 75f49d9b | Iustin Pop | <para> |
508 | 75f49d9b | Iustin Pop | Failover the master role to the current node. |
509 | 75f49d9b | Iustin Pop | </para> |
510 | 8e2524c3 | Guido Trotter | |
511 | 8e2524c3 | Guido Trotter | <para> |
512 | 8e2524c3 | Guido Trotter | The <option>--no-voting</option> option skips the remote node agreement |
513 | 8e2524c3 | Guido Trotter | checks. This is dangerous, but necessary in some cases (for example |
514 | 8e2524c3 | Guido Trotter | failing over the master role in a 2 node cluster with the original master |
515 | 8e2524c3 | Guido Trotter | down). If the original master then comes up, it won't be able to start |
516 | 8e2524c3 | Guido Trotter | its master daemon because it won't have enough votes, but so won't the |
517 | 8e2524c3 | Guido Trotter | new master, if the master daemon ever needs a restart. You can pass |
518 | 8e2524c3 | Guido Trotter | --no-voting to ganeti-masterd on the new master to solve this problem, |
519 | 8e2524c3 | Guido Trotter | and gnt-cluster redist-conf to make sure the cluster is consistent again. |
520 | 8e2524c3 | Guido Trotter | </para> |
521 | 8e2524c3 | Guido Trotter | |
522 | 75f49d9b | Iustin Pop | </refsect2> |
523 | 75f49d9b | Iustin Pop | |
524 | 75f49d9b | Iustin Pop | <refsect2> |
525 | 11c05c42 | Manuel Franceschini | <title>MODIFY</title> |
526 | 11c05c42 | Manuel Franceschini | |
527 | 11c05c42 | Manuel Franceschini | <cmdsynopsis> |
528 | 11c05c42 | Manuel Franceschini | <command>modify</command> |
529 | d3b4cf9f | Iustin Pop | <sbr> |
530 | 11c05c42 | Manuel Franceschini | <arg choice="opt">-g <replaceable>vg-name</replaceable></arg> |
531 | d3b4cf9f | Iustin Pop | <sbr> |
532 | 11c05c42 | Manuel Franceschini | <arg choice="opt">--no-lvm-storage</arg> |
533 | d3b4cf9f | Iustin Pop | <sbr> |
534 | 18fb5e1d | Alexander Schreiber | <arg choice="opt">--enabled-hypervisors |
535 | 18fb5e1d | Alexander Schreiber | <replaceable>hypervisors</replaceable></arg> |
536 | d3b4cf9f | Iustin Pop | <sbr> |
537 | 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> |
538 | d3b4cf9f | Iustin Pop | <sbr> |
539 | 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> |
540 | d3b4cf9f | Iustin Pop | <sbr> |
541 | 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> |
542 | 7d713344 | Guido Trotter | <sbr> |
543 | 6d4a1656 | Michael Hanselmann | <arg choice="opt">-C <replaceable>candidate_pool_size</replaceable></arg> |
544 | 18fb5e1d | Alexander Schreiber | |
545 | 11c05c42 | Manuel Franceschini | </cmdsynopsis> |
546 | 11c05c42 | Manuel Franceschini | |
547 | 11c05c42 | Manuel Franceschini | <para> |
548 | 11c05c42 | Manuel Franceschini | Modify the options for the cluster. |
549 | 11c05c42 | Manuel Franceschini | </para> |
550 | 11c05c42 | Manuel Franceschini | |
551 | 11c05c42 | Manuel Franceschini | <para> |
552 | 18fb5e1d | Alexander Schreiber | The <option>-g</option>, <option>--no-lvm-storarge</option>, |
553 | 18fb5e1d | Alexander Schreiber | <option>--enabled-hypervisors</option>, |
554 | 7d713344 | Guido Trotter | <option>--hypervisor-parameters</option>, |
555 | 7d713344 | Guido Trotter | <option>--backend-parameters</option> and |
556 | 7d713344 | Guido Trotter | <option>--nic-parameters</option> and options are |
557 | 11c05c42 | Manuel Franceschini | described in the <command>init</command> command. |
558 | 11c05c42 | Manuel Franceschini | </para> |
559 | d3b4cf9f | Iustin Pop | |
560 | d3b4cf9f | Iustin Pop | <para> |
561 | 6d4a1656 | Michael Hanselmann | The <option>-C</option> option specifies the |
562 | d3b4cf9f | Iustin Pop | <varname>candidate_pool_size</varname> cluster parameter. This |
563 | d3b4cf9f | Iustin Pop | is the number of nodes that the master will try to keep as |
564 | d3b4cf9f | Iustin Pop | <literal>master_candidates</literal>. For more details about |
565 | d3b4cf9f | Iustin Pop | this role and other node roles, see the <citerefentry> |
566 | d3b4cf9f | Iustin Pop | <refentrytitle>ganeti</refentrytitle><manvolnum>7</manvolnum> |
567 | d3b4cf9f | Iustin Pop | </citerefentry>. If you increase the size, the master will |
568 | d3b4cf9f | Iustin Pop | automatically promote as many nodes as required and possible |
569 | d3b4cf9f | Iustin Pop | to reach the intended number. |
570 | d3b4cf9f | Iustin Pop | </para> |
571 | 11c05c42 | Manuel Franceschini | </refsect2> |
572 | 11c05c42 | Manuel Franceschini | |
573 | 11c05c42 | Manuel Franceschini | <refsect2> |
574 | 18fb5e1d | Alexander Schreiber | <title>QUEUE</title> |
575 | 18fb5e1d | Alexander Schreiber | |
576 | 18fb5e1d | Alexander Schreiber | <cmdsynopsis> |
577 | 18fb5e1d | Alexander Schreiber | <command>queue</command> |
578 | 18fb5e1d | Alexander Schreiber | <arg choice="opt">drain</arg> |
579 | 18fb5e1d | Alexander Schreiber | <arg choice="opt">undrain</arg> |
580 | 18fb5e1d | Alexander Schreiber | <arg choice="opt">info</arg> |
581 | 18fb5e1d | Alexander Schreiber | |
582 | 18fb5e1d | Alexander Schreiber | </cmdsynopsis> |
583 | 18fb5e1d | Alexander Schreiber | |
584 | 18fb5e1d | Alexander Schreiber | <para> |
585 | 18fb5e1d | Alexander Schreiber | Change job queue properties. |
586 | 18fb5e1d | Alexander Schreiber | </para> |
587 | 18fb5e1d | Alexander Schreiber | |
588 | 18fb5e1d | Alexander Schreiber | <para> |
589 | 18fb5e1d | Alexander Schreiber | The <option>drain</option> option sets the drain flag on the |
590 | 18fb5e1d | Alexander Schreiber | job queue. No new jobs will be accepted, but jobs already in |
591 | 18fb5e1d | Alexander Schreiber | the queue will be processed. |
592 | 18fb5e1d | Alexander Schreiber | </para> |
593 | 18fb5e1d | Alexander Schreiber | |
594 | 18fb5e1d | Alexander Schreiber | <para> |
595 | 18fb5e1d | Alexander Schreiber | The <option>undrain</option> will unset the drain flag on the |
596 | 18fb5e1d | Alexander Schreiber | job queue. New jobs will be accepted. |
597 | 18fb5e1d | Alexander Schreiber | </para> |
598 | 18fb5e1d | Alexander Schreiber | |
599 | 18fb5e1d | Alexander Schreiber | <para> |
600 | 18fb5e1d | Alexander Schreiber | The <option>info</option> option shows the properties of the |
601 | 18fb5e1d | Alexander Schreiber | job queue. |
602 | 18fb5e1d | Alexander Schreiber | </para> |
603 | 18fb5e1d | Alexander Schreiber | </refsect2> |
604 | 18fb5e1d | Alexander Schreiber | |
605 | 18fb5e1d | Alexander Schreiber | <refsect2> |
606 | 95b2e626 | Michael Hanselmann | <title>WATCHER</title> |
607 | 95b2e626 | Michael Hanselmann | |
608 | 95b2e626 | Michael Hanselmann | <cmdsynopsis> |
609 | 95b2e626 | Michael Hanselmann | <command>watcher</command> |
610 | 95b2e626 | Michael Hanselmann | <group choice="req"> |
611 | 95b2e626 | Michael Hanselmann | <arg>pause <replaceable>duration</replaceable></arg> |
612 | 95b2e626 | Michael Hanselmann | <arg>continue</arg> |
613 | 95b2e626 | Michael Hanselmann | <arg>info</arg> |
614 | 95b2e626 | Michael Hanselmann | </group> |
615 | 95b2e626 | Michael Hanselmann | </cmdsynopsis> |
616 | 95b2e626 | Michael Hanselmann | |
617 | 95b2e626 | Michael Hanselmann | <para> |
618 | 95b2e626 | Michael Hanselmann | Make the watcher pause or let it continue. |
619 | 95b2e626 | Michael Hanselmann | </para> |
620 | 95b2e626 | Michael Hanselmann | |
621 | 95b2e626 | Michael Hanselmann | <para> |
622 | 95b2e626 | Michael Hanselmann | The <option>pause</option> option causes the watcher to pause for |
623 | 95b2e626 | Michael Hanselmann | <replaceable>duration</replaceable> seconds. |
624 | 95b2e626 | Michael Hanselmann | </para> |
625 | 95b2e626 | Michael Hanselmann | |
626 | 95b2e626 | Michael Hanselmann | <para> |
627 | 95b2e626 | Michael Hanselmann | The <option>continue</option> option will let the watcher continue. |
628 | 95b2e626 | Michael Hanselmann | </para> |
629 | 95b2e626 | Michael Hanselmann | |
630 | 95b2e626 | Michael Hanselmann | <para> |
631 | 95b2e626 | Michael Hanselmann | The <option>info</option> option shows whether the watcher is currently |
632 | 95b2e626 | Michael Hanselmann | paused. |
633 | 95b2e626 | Michael Hanselmann | </para> |
634 | 95b2e626 | Michael Hanselmann | </refsect2> |
635 | 95b2e626 | Michael Hanselmann | |
636 | 95b2e626 | Michael Hanselmann | <refsect2> |
637 | d3b4cf9f | Iustin Pop | <title>redist-conf</title> |
638 | d3b4cf9f | Iustin Pop | <cmdsynopsis> |
639 | d3b4cf9f | Iustin Pop | <command>redist-conf</command> |
640 | d3b4cf9f | Iustin Pop | <arg>--submit</arg> |
641 | d3b4cf9f | Iustin Pop | </cmdsynopsis> |
642 | d3b4cf9f | Iustin Pop | |
643 | d3b4cf9f | Iustin Pop | <para> |
644 | d3b4cf9f | Iustin Pop | This command forces a full push of configuration files from |
645 | d3b4cf9f | Iustin Pop | the master node to the other nodes in the cluster. This is |
646 | d3b4cf9f | Iustin Pop | normally not needed, but can be run if the |
647 | d3b4cf9f | Iustin Pop | <command>verify</command> complains about configuration |
648 | d3b4cf9f | Iustin Pop | mismatches. |
649 | d3b4cf9f | Iustin Pop | </para> |
650 | d3b4cf9f | Iustin Pop | |
651 | d3b4cf9f | Iustin Pop | <para> |
652 | d3b4cf9f | Iustin Pop | The <option>--submit</option> option is used to send the job |
653 | d3b4cf9f | Iustin Pop | to the master daemon but not wait for its completion. The job |
654 | d3b4cf9f | Iustin Pop | ID will be shown so that it can be examined via |
655 | d3b4cf9f | Iustin Pop | <command>gnt-job info</command>. |
656 | d3b4cf9f | Iustin Pop | </para> |
657 | d3b4cf9f | Iustin Pop | |
658 | d3b4cf9f | Iustin Pop | </refsect2> |
659 | d3b4cf9f | Iustin Pop | <refsect2> |
660 | cc425644 | Iustin Pop | <title>REMOVE-TAGS</title> |
661 | cc425644 | Iustin Pop | |
662 | cc425644 | Iustin Pop | <cmdsynopsis> |
663 | cc425644 | Iustin Pop | <command>remove-tags</command> |
664 | 810c50b7 | Iustin Pop | <arg choice="opt">--from <replaceable>file</replaceable></arg> |
665 | cc425644 | Iustin Pop | <arg choice="req" |
666 | cc425644 | Iustin Pop | rep="repeat"><replaceable>tag</replaceable></arg> |
667 | cc425644 | Iustin Pop | </cmdsynopsis> |
668 | cc425644 | Iustin Pop | |
669 | cc425644 | Iustin Pop | <para> |
670 | cc425644 | Iustin Pop | Remove tags from the cluster. If any of the tags are not |
671 | cc425644 | Iustin Pop | existing on the cluster, the entire operation will abort. |
672 | cc425644 | Iustin Pop | </para> |
673 | 810c50b7 | Iustin Pop | |
674 | 810c50b7 | Iustin Pop | <para> |
675 | 810c50b7 | Iustin Pop | If the <option>--from</option> option is given, the list of |
676 | 810c50b7 | Iustin Pop | tags will be extended with the contents of that file (each |
677 | 810c50b7 | Iustin Pop | line becomes a tag). In this case, there is not need to pass |
678 | 810c50b7 | Iustin Pop | tags on the command line (if you do, both sources will be |
679 | 810c50b7 | Iustin Pop | used). A file name of - will be interpreted as stdin. |
680 | 810c50b7 | Iustin Pop | </para> |
681 | cc425644 | Iustin Pop | </refsect2> |
682 | cc425644 | Iustin Pop | |
683 | cc425644 | Iustin Pop | <refsect2> |
684 | 75f49d9b | Iustin Pop | <title>RENAME</title> |
685 | 75f49d9b | Iustin Pop | |
686 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
687 | 75f49d9b | Iustin Pop | <command>rename</command> |
688 | 75f49d9b | Iustin Pop | <arg>-f</arg> |
689 | 75f49d9b | Iustin Pop | <arg choice="req"><replaceable>name</replaceable></arg> |
690 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
691 | 75f49d9b | Iustin Pop | |
692 | 75f49d9b | Iustin Pop | <para> |
693 | 75f49d9b | Iustin Pop | Renames the cluster and in the process updates the master IP |
694 | 75f49d9b | Iustin Pop | address to the one the new name resolves to. At least one of |
695 | 75f49d9b | Iustin Pop | either the name or the IP address must be different, otherwise |
696 | 75f49d9b | Iustin Pop | the operation will be aborted. |
697 | 75f49d9b | Iustin Pop | </para> |
698 | 75f49d9b | Iustin Pop | |
699 | 75f49d9b | Iustin Pop | <para> |
700 | 75f49d9b | Iustin Pop | Note that since this command can be dangerous (especially when |
701 | 75f49d9b | Iustin Pop | run over SSH), the command will require confirmation unless |
702 | 75f49d9b | Iustin Pop | run with the <option>-f</option> option. |
703 | 75f49d9b | Iustin Pop | </para> |
704 | 75f49d9b | Iustin Pop | </refsect2> |
705 | 60975797 | Iustin Pop | |
706 | 60975797 | Iustin Pop | <refsect2> |
707 | 6d4a1656 | Michael Hanselmann | <title>RENEW-CRYPTO</title> |
708 | 6d4a1656 | Michael Hanselmann | |
709 | 6d4a1656 | Michael Hanselmann | <cmdsynopsis> |
710 | 6d4a1656 | Michael Hanselmann | <command>renew-crypto</command> |
711 | 6d4a1656 | Michael Hanselmann | <arg>-f</arg> |
712 | 6d4a1656 | Michael Hanselmann | <sbr> |
713 | 6d4a1656 | Michael Hanselmann | <arg choice="opt">--new-cluster-certificate</arg> |
714 | 6d4a1656 | Michael Hanselmann | <arg choice="opt">--new-hmac-key</arg> |
715 | 6d4a1656 | Michael Hanselmann | <sbr> |
716 | 6d4a1656 | Michael Hanselmann | <arg choice="opt">--new-rapi-certificate</arg> |
717 | 6d4a1656 | Michael Hanselmann | <arg choice="opt">--rapi-certificate <replaceable>rapi-cert</replaceable></arg> |
718 | 6d4a1656 | Michael Hanselmann | </cmdsynopsis> |
719 | 6d4a1656 | Michael Hanselmann | |
720 | 6d4a1656 | Michael Hanselmann | <para> |
721 | 6d4a1656 | Michael Hanselmann | This command will stop all |
722 | 6d4a1656 | Michael Hanselmann | Ganeti daemons in the cluster and start them again once the new |
723 | 6d4a1656 | Michael Hanselmann | certificates and keys are replicated. The options |
724 | 6d4a1656 | Michael Hanselmann | <option>--new-cluster-certificate</option> and |
725 | 6d4a1656 | Michael Hanselmann | <option>--new-hmac-key</option> can be used to regenerate the |
726 | 6d4a1656 | Michael Hanselmann | cluster-internal SSL certificate respective the HMAC key used by |
727 | 6d4a1656 | Michael Hanselmann | <citerefentry> |
728 | 6d4a1656 | Michael Hanselmann | <refentrytitle>ganeti-confd</refentrytitle><manvolnum>8</manvolnum> |
729 | 6d4a1656 | Michael Hanselmann | </citerefentry>. To generate a new self-signed RAPI certificate (used |
730 | 6d4a1656 | Michael Hanselmann | by <citerefentry> |
731 | 6d4a1656 | Michael Hanselmann | <refentrytitle>ganeti-rapi</refentrytitle><manvolnum>8</manvolnum> |
732 | 6d4a1656 | Michael Hanselmann | </citerefentry>) specify <option>--new-rapi-certificate</option>. If |
733 | 6d4a1656 | Michael Hanselmann | you want to use your own certificate, e.g. one signed by a certificate |
734 | 6d4a1656 | Michael Hanselmann | authority (CA), pass its filename to |
735 | 6d4a1656 | Michael Hanselmann | <option>--rapi-certificate</option>. |
736 | 6d4a1656 | Michael Hanselmann | </para> |
737 | 6d4a1656 | Michael Hanselmann | </refsect2> |
738 | 6d4a1656 | Michael Hanselmann | |
739 | 6d4a1656 | Michael Hanselmann | <refsect2> |
740 | 60975797 | Iustin Pop | <title>REPAIR-DISK-SIZES</title> |
741 | 60975797 | Iustin Pop | |
742 | 60975797 | Iustin Pop | <cmdsynopsis> |
743 | 60975797 | Iustin Pop | <command>repair-disk-sizes</command> |
744 | 60975797 | Iustin Pop | <arg rep="repeat">instance</arg> |
745 | 60975797 | Iustin Pop | </cmdsynopsis> |
746 | 60975797 | Iustin Pop | |
747 | 60975797 | Iustin Pop | <para> |
748 | 60975797 | Iustin Pop | This command checks that the recorded size of the given |
749 | 60975797 | Iustin Pop | instance's disks matches the actual size and updates any |
750 | 60975797 | Iustin Pop | mismatches found. This is needed if the Ganeti configuration |
751 | 60975797 | Iustin Pop | is no longer consistent with reality, as it will impact some |
752 | 60975797 | Iustin Pop | disk operations. If no arguments are given, all instances will |
753 | 60975797 | Iustin Pop | be checked. |
754 | 60975797 | Iustin Pop | </para> |
755 | 60975797 | Iustin Pop | |
756 | 60975797 | Iustin Pop | <para> |
757 | 60975797 | Iustin Pop | Note that only active disks can be checked by this command; in |
758 | 60975797 | Iustin Pop | case a disk cannot be activated it's advised to use |
759 | a4f12da4 | Michael Hanselmann | <command>gnt-instance activate-disks --ignore-size ...</command> to |
760 | a4f12da4 | Michael Hanselmann | force activation without regard to the |
761 | 60975797 | Iustin Pop | current size. |
762 | 60975797 | Iustin Pop | </para> |
763 | 60975797 | Iustin Pop | |
764 | 60975797 | Iustin Pop | <para> |
765 | 60975797 | Iustin Pop | When the all disk sizes are consistent, the command will |
766 | 60975797 | Iustin Pop | return no output. Otherwise it will log details about the |
767 | 60975797 | Iustin Pop | inconsistencies in the configuration. |
768 | 60975797 | Iustin Pop | </para> |
769 | 60975797 | Iustin Pop | </refsect2> |
770 | 75f49d9b | Iustin Pop | |
771 | 75f49d9b | Iustin Pop | <refsect2> |
772 | 73415719 | Iustin Pop | <title>SEARCH-TAGS</title> |
773 | 73415719 | Iustin Pop | |
774 | 73415719 | Iustin Pop | <cmdsynopsis> |
775 | 73415719 | Iustin Pop | <command>search-tags</command> |
776 | 73415719 | Iustin Pop | <arg choice="req"><replaceable>pattern</replaceable></arg> |
777 | 73415719 | Iustin Pop | </cmdsynopsis> |
778 | 73415719 | Iustin Pop | |
779 | 73415719 | Iustin Pop | <para> |
780 | 73415719 | Iustin Pop | Searches the tags on all objects in the cluster (the cluster |
781 | 73415719 | Iustin Pop | itself, the nodes and the instances) for a given pattern. The |
782 | 73415719 | Iustin Pop | pattern is interpreted as a regular expression and a search |
783 | 73415719 | Iustin Pop | will be done on it (i.e. the given pattern is not anchored to |
784 | 73415719 | Iustin Pop | the beggining of the string; if you want that, prefix the |
785 | 73415719 | Iustin Pop | pattern with <literal>^</literal>). |
786 | 73415719 | Iustin Pop | </para> |
787 | 73415719 | Iustin Pop | |
788 | 73415719 | Iustin Pop | <para> |
789 | 73415719 | Iustin Pop | If no tags are matching the pattern, the exit code of the |
790 | 73415719 | Iustin Pop | command will be one. If there is at least one match, the exit |
791 | 73415719 | Iustin Pop | code will be zero. Each match is listed on one line, the |
792 | 73415719 | Iustin Pop | object and the tag separated by a space. The cluster will be |
793 | 73415719 | Iustin Pop | listed as <filename>/cluster</filename>, a node will be listed |
794 | 73415719 | Iustin Pop | as |
795 | 73415719 | Iustin Pop | <filename>/nodes/<replaceable>name</replaceable></filename>, |
796 | 73415719 | Iustin Pop | and an instance as |
797 | 73415719 | Iustin Pop | <filename>/instances/<replaceable>name</replaceable></filename>. |
798 | 73415719 | Iustin Pop | Example: |
799 | 73415719 | Iustin Pop | </para> |
800 | 73415719 | Iustin Pop | <screen> |
801 | 2f49d1d2 | Guido Trotter | # gnt-cluster search-tags time |
802 | 73415719 | Iustin Pop | /cluster ctime:2007-09-01 |
803 | 73415719 | Iustin Pop | /nodes/node1.example.com mtime:2007-10-04 |
804 | 73415719 | Iustin Pop | </screen> |
805 | 73415719 | Iustin Pop | </refsect2> |
806 | 73415719 | Iustin Pop | |
807 | 73415719 | Iustin Pop | <refsect2> |
808 | 75f49d9b | Iustin Pop | <title>VERIFY</title> |
809 | 75f49d9b | Iustin Pop | |
810 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
811 | 75f49d9b | Iustin Pop | <command>verify</command> |
812 | 3cf7c9fa | Guido Trotter | <arg choice="opt">--no-nplus1-mem</arg> |
813 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
814 | 75f49d9b | Iustin Pop | |
815 | 75f49d9b | Iustin Pop | <para> |
816 | 75f49d9b | Iustin Pop | Verify correctness of cluster configuration. This is safe with |
817 | 75f49d9b | Iustin Pop | respect to running instances, and incurs no downtime of the |
818 | 75f49d9b | Iustin Pop | instances. |
819 | 75f49d9b | Iustin Pop | </para> |
820 | 3cf7c9fa | Guido Trotter | |
821 | 3cf7c9fa | Guido Trotter | <para> |
822 | 3cf7c9fa | Guido Trotter | If the <option>--no-nplus1-mem</option> option is given, ganeti won't |
823 | 3cf7c9fa | Guido Trotter | check whether if it loses a node it can restart all the instances on |
824 | 3cf7c9fa | Guido Trotter | their secondaries (and report an error otherwise). |
825 | 3cf7c9fa | Guido Trotter | </para> |
826 | 75f49d9b | Iustin Pop | </refsect2> |
827 | 75f49d9b | Iustin Pop | |
828 | 75f49d9b | Iustin Pop | <refsect2> |
829 | ed2d1409 | Iustin Pop | <title>VERIFY-DISKS</title> |
830 | ed2d1409 | Iustin Pop | |
831 | ed2d1409 | Iustin Pop | <cmdsynopsis> |
832 | ed2d1409 | Iustin Pop | <command>verify-disks</command> |
833 | ed2d1409 | Iustin Pop | </cmdsynopsis> |
834 | ed2d1409 | Iustin Pop | |
835 | ed2d1409 | Iustin Pop | <para> |
836 | ed2d1409 | Iustin Pop | The command checks which instances have degraded DRBD disks |
837 | ed2d1409 | Iustin Pop | and activates the disks of those instances. |
838 | ed2d1409 | Iustin Pop | </para> |
839 | ed2d1409 | Iustin Pop | |
840 | ed2d1409 | Iustin Pop | <para> |
841 | ed2d1409 | Iustin Pop | This command is run from the <command>ganeti-watcher</command> |
842 | ed2d1409 | Iustin Pop | tool, which also has a different, complementary algorithm for |
843 | ed2d1409 | Iustin Pop | doing this check. Together, these two should ensure that DRBD |
844 | ed2d1409 | Iustin Pop | disks are kept consistent. |
845 | ed2d1409 | Iustin Pop | </para> |
846 | ed2d1409 | Iustin Pop | </refsect2> |
847 | ed2d1409 | Iustin Pop | |
848 | ed2d1409 | Iustin Pop | <refsect2> |
849 | 75f49d9b | Iustin Pop | <title>VERSION</title> |
850 | 75f49d9b | Iustin Pop | |
851 | 75f49d9b | Iustin Pop | <cmdsynopsis> |
852 | 75f49d9b | Iustin Pop | <command>version</command> |
853 | 75f49d9b | Iustin Pop | </cmdsynopsis> |
854 | 75f49d9b | Iustin Pop | |
855 | 75f49d9b | Iustin Pop | <para> |
856 | 75f49d9b | Iustin Pop | Show the cluster version. |
857 | 75f49d9b | Iustin Pop | </para> |
858 | 75f49d9b | Iustin Pop | </refsect2> |
859 | a8083063 | Iustin Pop | |
860 | a8083063 | Iustin Pop | </refsect1> |
861 | a8083063 | Iustin Pop | |
862 | a8083063 | Iustin Pop | &footer; |
863 | a8083063 | Iustin Pop | |
864 | a8083063 | Iustin Pop | </refentry> |
865 | a8083063 | Iustin Pop | |
866 | a8083063 | Iustin Pop | <!-- Keep this comment at the end of the file |
867 | a8083063 | Iustin Pop | Local variables: |
868 | a8083063 | Iustin Pop | mode: sgml |
869 | a8083063 | Iustin Pop | sgml-omittag:t |
870 | a8083063 | Iustin Pop | sgml-shorttag:t |
871 | a8083063 | Iustin Pop | sgml-minimize-attributes:nil |
872 | a8083063 | Iustin Pop | sgml-always-quote-attributes:t |
873 | a8083063 | Iustin Pop | sgml-indent-step:2 |
874 | a8083063 | Iustin Pop | sgml-indent-data:t |
875 | a8083063 | Iustin Pop | sgml-parent-document:nil |
876 | a8083063 | Iustin Pop | sgml-default-dtd-file:nil |
877 | a8083063 | Iustin Pop | sgml-exposed-tags:nil |
878 | a8083063 | Iustin Pop | sgml-local-catalogs:nil |
879 | a8083063 | Iustin Pop | sgml-local-ecat-files:nil |
880 | a8083063 | Iustin Pop | End: |
881 | a8083063 | Iustin Pop | --> |