root / man / gnt-cluster.rst @ 54f834df
History | View | Annotate | Download (22.1 kB)
1 | 3cb9e1fe | Iustin Pop | gnt-cluster(8) Ganeti | Version @GANETI_VERSION@ |
---|---|---|---|
2 | 3cb9e1fe | Iustin Pop | ================================================ |
3 | 3cb9e1fe | Iustin Pop | |
4 | 3cb9e1fe | Iustin Pop | Name |
5 | 3cb9e1fe | Iustin Pop | ---- |
6 | 3cb9e1fe | Iustin Pop | |
7 | 3cb9e1fe | Iustin Pop | gnt-cluster - Ganeti administration, cluster-wide |
8 | 3cb9e1fe | Iustin Pop | |
9 | 3cb9e1fe | Iustin Pop | Synopsis |
10 | 3cb9e1fe | Iustin Pop | -------- |
11 | 3cb9e1fe | Iustin Pop | |
12 | 3cb9e1fe | Iustin Pop | **gnt-cluster** {command} [arguments...] |
13 | 3cb9e1fe | Iustin Pop | |
14 | 3cb9e1fe | Iustin Pop | DESCRIPTION |
15 | 3cb9e1fe | Iustin Pop | ----------- |
16 | 3cb9e1fe | Iustin Pop | |
17 | 3cb9e1fe | Iustin Pop | The **gnt-cluster** is used for cluster-wide administration in the |
18 | 3cb9e1fe | Iustin Pop | Ganeti system. |
19 | 3cb9e1fe | Iustin Pop | |
20 | 3cb9e1fe | Iustin Pop | COMMANDS |
21 | 3cb9e1fe | Iustin Pop | -------- |
22 | 3cb9e1fe | Iustin Pop | |
23 | 3cb9e1fe | Iustin Pop | ADD-TAGS |
24 | 3cb9e1fe | Iustin Pop | ~~~~~~~~ |
25 | 3cb9e1fe | Iustin Pop | |
26 | 3cb9e1fe | Iustin Pop | **add-tags** [--from *file*] {*tag*...} |
27 | 3cb9e1fe | Iustin Pop | |
28 | 3cb9e1fe | Iustin Pop | Add tags to the cluster. If any of the tags contains invalid |
29 | 3cb9e1fe | Iustin Pop | characters, the entire operation will abort. |
30 | 3cb9e1fe | Iustin Pop | |
31 | 3cb9e1fe | Iustin Pop | If the ``--from`` option is given, the list of tags will be |
32 | 3cb9e1fe | Iustin Pop | extended with the contents of that file (each line becomes a tag). |
33 | 3cb9e1fe | Iustin Pop | In this case, there is not need to pass tags on the command line |
34 | 3cb9e1fe | Iustin Pop | (if you do, both sources will be used). A file name of - will be |
35 | 3cb9e1fe | Iustin Pop | interpreted as stdin. |
36 | 3cb9e1fe | Iustin Pop | |
37 | 3cb9e1fe | Iustin Pop | COMMAND |
38 | 3cb9e1fe | Iustin Pop | ~~~~~~~ |
39 | 3cb9e1fe | Iustin Pop | |
40 | b6e88032 | Michael Hanselmann | **command** [-n *node*] [-g *group*] {*command*} |
41 | 3cb9e1fe | Iustin Pop | |
42 | 3cb9e1fe | Iustin Pop | Executes a command on all nodes. If the option ``-n`` is not given, |
43 | 3cb9e1fe | Iustin Pop | the command will be executed on all nodes, otherwise it will be |
44 | 3cb9e1fe | Iustin Pop | executed only on the node(s) specified. Use the option multiple |
45 | 3cb9e1fe | Iustin Pop | times for running it on multiple nodes, like:: |
46 | 3cb9e1fe | Iustin Pop | |
47 | 3cb9e1fe | Iustin Pop | # gnt-cluster command -n node1.example.com -n node2.example.com date |
48 | 3cb9e1fe | Iustin Pop | |
49 | b6e88032 | Michael Hanselmann | The ``-g`` option can be used to run a command only on a specific node |
50 | b6e88032 | Michael Hanselmann | group, e.g.:: |
51 | b6e88032 | Michael Hanselmann | |
52 | b6e88032 | Michael Hanselmann | # gnt-cluster command -g default date |
53 | b6e88032 | Michael Hanselmann | |
54 | 3cb9e1fe | Iustin Pop | The command is executed serially on the selected nodes. If the |
55 | 3cb9e1fe | Iustin Pop | master node is present in the list, the command will be executed |
56 | 3cb9e1fe | Iustin Pop | last on the master. Regarding the other nodes, the execution order |
57 | 3cb9e1fe | Iustin Pop | is somewhat alphabetic, so that node2.example.com will be earlier |
58 | 3cb9e1fe | Iustin Pop | than node10.example.com but after node1.example.com. |
59 | 3cb9e1fe | Iustin Pop | |
60 | 3cb9e1fe | Iustin Pop | So given the node names node1, node2, node3, node10, node11, with |
61 | 3cb9e1fe | Iustin Pop | node3 being the master, the order will be: node1, node2, node10, |
62 | 3cb9e1fe | Iustin Pop | node11, node3. |
63 | 3cb9e1fe | Iustin Pop | |
64 | 3cb9e1fe | Iustin Pop | The command is constructed by concatenating all other command line |
65 | 3cb9e1fe | Iustin Pop | arguments. For example, to list the contents of the /etc directory |
66 | 3cb9e1fe | Iustin Pop | on all nodes, run:: |
67 | 3cb9e1fe | Iustin Pop | |
68 | 3cb9e1fe | Iustin Pop | # gnt-cluster command ls -l /etc |
69 | 3cb9e1fe | Iustin Pop | |
70 | 3cb9e1fe | Iustin Pop | and the command which will be executed will be ``ls -l /etc``. |
71 | 3cb9e1fe | Iustin Pop | |
72 | 3cb9e1fe | Iustin Pop | COPYFILE |
73 | 3cb9e1fe | Iustin Pop | ~~~~~~~~ |
74 | 3cb9e1fe | Iustin Pop | |
75 | b6e88032 | Michael Hanselmann | | **copyfile** [--use-replication-network] [-n *node*] [-g *group*] |
76 | b6e88032 | Michael Hanselmann | | {*file*} |
77 | 3cb9e1fe | Iustin Pop | |
78 | 3cb9e1fe | Iustin Pop | Copies a file to all or to some nodes. The argument specifies the |
79 | 3cb9e1fe | Iustin Pop | source file (on the current system), the ``-n`` argument specifies |
80 | 3cb9e1fe | Iustin Pop | the target node, or nodes if the option is given multiple times. If |
81 | b6e88032 | Michael Hanselmann | ``-n`` is not given at all, the file will be copied to all nodes. The |
82 | b6e88032 | Michael Hanselmann | ``-g`` option can be used to only select nodes in a specific node group. |
83 | 3cb9e1fe | Iustin Pop | Passing the ``--use-replication-network`` option will cause the |
84 | 3cb9e1fe | Iustin Pop | copy to be done over the replication network (only matters if the |
85 | 3cb9e1fe | Iustin Pop | primary/secondary IPs are different). Example:: |
86 | 3cb9e1fe | Iustin Pop | |
87 | 3cb9e1fe | Iustin Pop | # gnt-cluster -n node1.example.com -n node2.example.com copyfile /tmp/test |
88 | 3cb9e1fe | Iustin Pop | |
89 | 3cb9e1fe | Iustin Pop | This will copy the file /tmp/test from the current node to the two |
90 | 3cb9e1fe | Iustin Pop | named nodes. |
91 | 3cb9e1fe | Iustin Pop | |
92 | 3cb9e1fe | Iustin Pop | DESTROY |
93 | 3cb9e1fe | Iustin Pop | ~~~~~~~ |
94 | 3cb9e1fe | Iustin Pop | |
95 | 3cb9e1fe | Iustin Pop | **destroy** {--yes-do-it} |
96 | 3cb9e1fe | Iustin Pop | |
97 | 3cb9e1fe | Iustin Pop | Remove all configuration files related to the cluster, so that a |
98 | 3cb9e1fe | Iustin Pop | **gnt-cluster init** can be done again afterwards. |
99 | 3cb9e1fe | Iustin Pop | |
100 | 3cb9e1fe | Iustin Pop | Since this is a dangerous command, you are required to pass the |
101 | 3cb9e1fe | Iustin Pop | argument *--yes-do-it.* |
102 | 3cb9e1fe | Iustin Pop | |
103 | 66d1f035 | René Nussbaumer | EPO |
104 | 66d1f035 | René Nussbaumer | ~~~ |
105 | 66d1f035 | René Nussbaumer | |
106 | cfed3b9f | René Nussbaumer | **epo** [--on] [--groups|--all] [--power-delay] *arguments* |
107 | cfed3b9f | René Nussbaumer | |
108 | cfed3b9f | René Nussbaumer | Performs an emergency power-off on nodes given as arguments. If |
109 | cfed3b9f | René Nussbaumer | ``--groups`` is given, arguments are node groups. If ``--all`` is |
110 | cfed3b9f | René Nussbaumer | provided, the whole cluster will be shut down. |
111 | cfed3b9f | René Nussbaumer | |
112 | cfed3b9f | René Nussbaumer | The ``--on`` flag recovers the cluster after an emergency power-off. |
113 | cfed3b9f | René Nussbaumer | When powering on the cluster you can use ``--power-delay`` to define the |
114 | cfed3b9f | René Nussbaumer | time in seconds (fractions allowed) waited between powering on |
115 | cfed3b9f | René Nussbaumer | individual nodes. |
116 | cfed3b9f | René Nussbaumer | |
117 | cfed3b9f | René Nussbaumer | Please note that the master node will not be turned down or up |
118 | cfed3b9f | René Nussbaumer | automatically. It will just be left in a state, where you can manully |
119 | cfed3b9f | René Nussbaumer | perform the shutdown of that one node. If the master is in the list of |
120 | cfed3b9f | René Nussbaumer | affected nodes and this is not a complete cluster emergency power-off |
121 | cfed3b9f | René Nussbaumer | (e.g. using ``--all``), you're required to do a master failover to |
122 | cfed3b9f | René Nussbaumer | another node not affected. |
123 | 66d1f035 | René Nussbaumer | |
124 | 3cb9e1fe | Iustin Pop | GETMASTER |
125 | 3cb9e1fe | Iustin Pop | ~~~~~~~~~ |
126 | 3cb9e1fe | Iustin Pop | |
127 | 3cb9e1fe | Iustin Pop | **getmaster** |
128 | 3cb9e1fe | Iustin Pop | |
129 | 3cb9e1fe | Iustin Pop | Displays the current master node. |
130 | 3cb9e1fe | Iustin Pop | |
131 | 3cb9e1fe | Iustin Pop | INFO |
132 | 3cb9e1fe | Iustin Pop | ~~~~ |
133 | 3cb9e1fe | Iustin Pop | |
134 | 3cb9e1fe | Iustin Pop | **info** [--roman] |
135 | 3cb9e1fe | Iustin Pop | |
136 | 3cb9e1fe | Iustin Pop | Shows runtime cluster information: cluster name, architecture (32 |
137 | 3cb9e1fe | Iustin Pop | or 64 bit), master node, node list and instance list. |
138 | 3cb9e1fe | Iustin Pop | |
139 | 3cb9e1fe | Iustin Pop | Passing the ``--roman`` option gnt-cluster info will try to print |
140 | 3cb9e1fe | Iustin Pop | its integer fields in a latin friendly way. This allows further |
141 | 3cb9e1fe | Iustin Pop | diffusion of Ganeti among ancient cultures. |
142 | 3cb9e1fe | Iustin Pop | |
143 | 3cb9e1fe | Iustin Pop | INIT |
144 | 3cb9e1fe | Iustin Pop | ~~~~ |
145 | 3cb9e1fe | Iustin Pop | |
146 | 3cb9e1fe | Iustin Pop | | **init** |
147 | 0a68e0ff | Iustin Pop | | [{-s|--secondary-ip} *secondary\_ip*] |
148 | 3cb9e1fe | Iustin Pop | | [--vg-name *vg-name*] |
149 | 3cb9e1fe | Iustin Pop | | [--master-netdev *interface-name*] |
150 | 0a68e0ff | Iustin Pop | | [{-m|--mac-prefix} *mac-prefix*] |
151 | 3cb9e1fe | Iustin Pop | | [--no-lvm-storage] |
152 | 3cb9e1fe | Iustin Pop | | [--no-etc-hosts] |
153 | 3cb9e1fe | Iustin Pop | | [--no-ssh-init] |
154 | 3cb9e1fe | Iustin Pop | | [--file-storage-dir *dir*] |
155 | 3cb9e1fe | Iustin Pop | | [--enabled-hypervisors *hypervisors*] |
156 | 0a68e0ff | Iustin Pop | | [{-H|--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]] |
157 | 0a68e0ff | Iustin Pop | | [{-B|--backend-parameters} *be-param*=*value* [,*be-param*=*value*...]] |
158 | 0a68e0ff | Iustin Pop | | [{-N|--nic-parameters} *nic-param*=*value* [,*nic-param*=*value*...]] |
159 | 3cb9e1fe | Iustin Pop | | [--maintain-node-health {yes \| no}] |
160 | 3cb9e1fe | Iustin Pop | | [--uid-pool *user-id pool definition*] |
161 | 0a68e0ff | Iustin Pop | | [{-I|--default-iallocator} *default instance allocator*] |
162 | 3cb9e1fe | Iustin Pop | | [--primary-ip-version *version*] |
163 | 3cb9e1fe | Iustin Pop | | [--prealloc-wipe-disks {yes \| no}] |
164 | 6204ee71 | René Nussbaumer | | [--node-parameters *ndparams*] |
165 | 0a68e0ff | Iustin Pop | | [{-C|--candidate-pool-size} *candidate\_pool\_size*] |
166 | 3cb9e1fe | Iustin Pop | | {*clustername*} |
167 | 3cb9e1fe | Iustin Pop | |
168 | 3cb9e1fe | Iustin Pop | This commands is only run once initially on the first node of the |
169 | 3cb9e1fe | Iustin Pop | cluster. It will initialize the cluster configuration, setup the |
170 | 3cb9e1fe | Iustin Pop | ssh-keys, start the daemons on the master node, etc. in order to have |
171 | 3cb9e1fe | Iustin Pop | a working one-node cluster. |
172 | 3cb9e1fe | Iustin Pop | |
173 | 3cb9e1fe | Iustin Pop | Note that the *clustername* is not any random name. It has to be |
174 | 3cb9e1fe | Iustin Pop | resolvable to an IP address using DNS, and it is best if you give the |
175 | 3cb9e1fe | Iustin Pop | fully-qualified domain name. This hostname must resolve to an IP |
176 | 3cb9e1fe | Iustin Pop | address reserved exclusively for this purpose, i.e. not already in |
177 | 3cb9e1fe | Iustin Pop | use. |
178 | 3cb9e1fe | Iustin Pop | |
179 | 3cb9e1fe | Iustin Pop | The cluster can run in two modes: single-home or dual-homed. In the |
180 | 0a68e0ff | Iustin Pop | first case, all traffic (both public traffic, inter-node traffic and |
181 | 0a68e0ff | Iustin Pop | data replication traffic) goes over the same interface. In the |
182 | 3cb9e1fe | Iustin Pop | dual-homed case, the data replication traffic goes over the second |
183 | 0a68e0ff | Iustin Pop | network. The ``-s (--secondary-ip)`` option here marks the cluster as |
184 | 0a68e0ff | Iustin Pop | dual-homed and its parameter represents this node's address on the |
185 | 0a68e0ff | Iustin Pop | second network. If you initialise the cluster with ``-s``, all nodes |
186 | 0a68e0ff | Iustin Pop | added must have a secondary IP as well. |
187 | 3cb9e1fe | Iustin Pop | |
188 | 3cb9e1fe | Iustin Pop | Note that for Ganeti it doesn't matter if the secondary network is |
189 | 3cb9e1fe | Iustin Pop | actually a separate physical network, or is done using tunneling, |
190 | 3cb9e1fe | Iustin Pop | etc. For performance reasons, it's recommended to use a separate |
191 | 3cb9e1fe | Iustin Pop | network, of course. |
192 | 3cb9e1fe | Iustin Pop | |
193 | 3cb9e1fe | Iustin Pop | The ``--vg-name`` option will let you specify a volume group |
194 | 3cb9e1fe | Iustin Pop | different than "xenvg" for Ganeti to use when creating instance |
195 | 3cb9e1fe | Iustin Pop | disks. This volume group must have the same name on all nodes. Once |
196 | 3cb9e1fe | Iustin Pop | the cluster is initialized this can be altered by using the |
197 | 3cb9e1fe | Iustin Pop | **modify** command. If you don't want to use lvm storage at all use |
198 | 3cb9e1fe | Iustin Pop | the ``--no-lvm-storage`` option. Once the cluster is initialized |
199 | 3cb9e1fe | Iustin Pop | you can change this setup with the **modify** command. |
200 | 3cb9e1fe | Iustin Pop | |
201 | 3cb9e1fe | Iustin Pop | The ``--master-netdev`` option is useful for specifying a different |
202 | 3cb9e1fe | Iustin Pop | interface on which the master will activate its IP address. It's |
203 | 3cb9e1fe | Iustin Pop | important that all nodes have this interface because you'll need it |
204 | 3cb9e1fe | Iustin Pop | for a master failover. |
205 | 3cb9e1fe | Iustin Pop | |
206 | 0a68e0ff | Iustin Pop | The ``-m (--mac-prefix)`` option will let you specify a three byte |
207 | 0a68e0ff | Iustin Pop | prefix under which the virtual MAC addresses of your instances will be |
208 | 0a68e0ff | Iustin Pop | generated. The prefix must be specified in the format ``XX:XX:XX`` and |
209 | 0a68e0ff | Iustin Pop | the default is ``aa:00:00``. |
210 | 3cb9e1fe | Iustin Pop | |
211 | 3cb9e1fe | Iustin Pop | The ``--no-lvm-storage`` option allows you to initialize the |
212 | 3cb9e1fe | Iustin Pop | cluster without lvm support. This means that only instances using |
213 | 3cb9e1fe | Iustin Pop | files as storage backend will be possible to create. Once the |
214 | 3cb9e1fe | Iustin Pop | cluster is initialized you can change this setup with the |
215 | 3cb9e1fe | Iustin Pop | **modify** command. |
216 | 3cb9e1fe | Iustin Pop | |
217 | 3cb9e1fe | Iustin Pop | The ``--no-etc-hosts`` option allows you to initialize the cluster |
218 | 3cb9e1fe | Iustin Pop | without modifying the /etc/hosts file. |
219 | 3cb9e1fe | Iustin Pop | |
220 | 3cb9e1fe | Iustin Pop | The ``--no-ssh-init`` option allows you to initialize the cluster |
221 | 3cb9e1fe | Iustin Pop | without creating or distributing SSH key pairs. |
222 | 3cb9e1fe | Iustin Pop | |
223 | 3cb9e1fe | Iustin Pop | The ``--file-storage-dir`` option allows you set the directory to |
224 | 3cb9e1fe | Iustin Pop | use for storing the instance disk files when using file storage as |
225 | 3cb9e1fe | Iustin Pop | backend for instance disks. |
226 | 3cb9e1fe | Iustin Pop | |
227 | 3cb9e1fe | Iustin Pop | The ``--prealloc-wipe-disks`` sets a cluster wide configuration |
228 | 3cb9e1fe | Iustin Pop | value for wiping disks prior to allocation. This increases security |
229 | 3cb9e1fe | Iustin Pop | on instance level as the instance can't access untouched data from |
230 | 3cb9e1fe | Iustin Pop | it's underlying storage. |
231 | 3cb9e1fe | Iustin Pop | |
232 | 3cb9e1fe | Iustin Pop | The ``--enabled-hypervisors`` option allows you to set the list of |
233 | 3cb9e1fe | Iustin Pop | hypervisors that will be enabled for this cluster. Instance |
234 | 3cb9e1fe | Iustin Pop | hypervisors can only be chosen from the list of enabled |
235 | 3cb9e1fe | Iustin Pop | hypervisors, and the first entry of this list will be used by |
236 | 3cb9e1fe | Iustin Pop | default. Currently, the following hypervisors are available: |
237 | 3cb9e1fe | Iustin Pop | |
238 | 3cb9e1fe | Iustin Pop | xen-pvm |
239 | 3cb9e1fe | Iustin Pop | Xen PVM hypervisor |
240 | 3cb9e1fe | Iustin Pop | |
241 | 3cb9e1fe | Iustin Pop | xen-hvm |
242 | 3cb9e1fe | Iustin Pop | Xen HVM hypervisor |
243 | 3cb9e1fe | Iustin Pop | |
244 | 3cb9e1fe | Iustin Pop | kvm |
245 | 3cb9e1fe | Iustin Pop | Linux KVM hypervisor |
246 | 3cb9e1fe | Iustin Pop | |
247 | 3cb9e1fe | Iustin Pop | chroot |
248 | 3cb9e1fe | Iustin Pop | a simple chroot manager that starts chroot based on a script at the |
249 | 3cb9e1fe | Iustin Pop | root of the filesystem holding the chroot |
250 | 3cb9e1fe | Iustin Pop | |
251 | 3cb9e1fe | Iustin Pop | fake |
252 | 3cb9e1fe | Iustin Pop | fake hypervisor for development/testing |
253 | 3cb9e1fe | Iustin Pop | |
254 | 3cb9e1fe | Iustin Pop | Either a single hypervisor name or a comma-separated list of |
255 | 3cb9e1fe | Iustin Pop | hypervisor names can be specified. If this option is not specified, |
256 | 3cb9e1fe | Iustin Pop | only the xen-pvm hypervisor is enabled by default. |
257 | 3cb9e1fe | Iustin Pop | |
258 | 0a68e0ff | Iustin Pop | The ``-H (--hypervisor-parameters)`` option allows you to set default |
259 | 3cb9e1fe | Iustin Pop | hypervisor specific parameters for the cluster. The format of this |
260 | 3cb9e1fe | Iustin Pop | option is the name of the hypervisor, followed by a colon and a |
261 | 0a68e0ff | Iustin Pop | comma-separated list of key=value pairs. The keys available for each |
262 | 0a68e0ff | Iustin Pop | hypervisors are detailed in the gnt-instance(8) man page, in the |
263 | 0a68e0ff | Iustin Pop | **add** command plus the following parameters which are only |
264 | 3cb9e1fe | Iustin Pop | configurable globally (at cluster level): |
265 | 3cb9e1fe | Iustin Pop | |
266 | 3cb9e1fe | Iustin Pop | migration\_port |
267 | 3cb9e1fe | Iustin Pop | Valid for the Xen PVM and KVM hypervisors. |
268 | 3cb9e1fe | Iustin Pop | |
269 | 3cb9e1fe | Iustin Pop | This options specifies the TCP port to use for live-migration. For |
270 | 3cb9e1fe | Iustin Pop | Xen, the same port should be configured on all nodes in the |
271 | 3cb9e1fe | Iustin Pop | ``/etc/xen/xend-config.sxp`` file, under the key |
272 | 3cb9e1fe | Iustin Pop | "xend-relocation-port". |
273 | 3cb9e1fe | Iustin Pop | |
274 | 3cb9e1fe | Iustin Pop | migration\_bandwidth |
275 | 3cb9e1fe | Iustin Pop | Valid for the KVM hypervisor. |
276 | 3cb9e1fe | Iustin Pop | |
277 | 3cb9e1fe | Iustin Pop | This option specifies the maximum bandwidth that KVM will use for |
278 | 3cb9e1fe | Iustin Pop | instance live migrations. The value is in MiB/s. |
279 | 3cb9e1fe | Iustin Pop | |
280 | 3cb9e1fe | Iustin Pop | This option is only effective with kvm versions >= 78 and qemu-kvm |
281 | 3cb9e1fe | Iustin Pop | versions >= 0.10.0. |
282 | 3cb9e1fe | Iustin Pop | |
283 | 0a68e0ff | Iustin Pop | The ``-B (--backend-parameters)`` option allows you to set the default |
284 | 3cb9e1fe | Iustin Pop | backend parameters for the cluster. The parameter format is a |
285 | 0a68e0ff | Iustin Pop | comma-separated list of key=value pairs with the following supported |
286 | 0a68e0ff | Iustin Pop | keys: |
287 | 3cb9e1fe | Iustin Pop | |
288 | 3cb9e1fe | Iustin Pop | vcpus |
289 | 3cb9e1fe | Iustin Pop | Number of VCPUs to set for an instance by default, must be an |
290 | 3cb9e1fe | Iustin Pop | integer, will be set to 1 if no specified. |
291 | 3cb9e1fe | Iustin Pop | |
292 | 3cb9e1fe | Iustin Pop | memory |
293 | 3cb9e1fe | Iustin Pop | Amount of memory to allocate for an instance by default, can be |
294 | 3cb9e1fe | Iustin Pop | either an integer or an integer followed by a unit (M for mebibytes |
295 | 3cb9e1fe | Iustin Pop | and G for gibibytes are supported), will be set to 128M if not |
296 | 3cb9e1fe | Iustin Pop | specified. |
297 | 3cb9e1fe | Iustin Pop | |
298 | 3cb9e1fe | Iustin Pop | auto\_balance |
299 | 3cb9e1fe | Iustin Pop | Value of the auto\_balance flag for instances to use by default, |
300 | 3cb9e1fe | Iustin Pop | will be set to true if not specified. |
301 | 3cb9e1fe | Iustin Pop | |
302 | 3cb9e1fe | Iustin Pop | |
303 | 0a68e0ff | Iustin Pop | The ``-N (--nic-parameters)`` option allows you to set the default nic |
304 | 0a68e0ff | Iustin Pop | parameters for the cluster. The parameter format is a comma-separated |
305 | 0a68e0ff | Iustin Pop | list of key=value pairs with the following supported keys: |
306 | 3cb9e1fe | Iustin Pop | |
307 | 3cb9e1fe | Iustin Pop | mode |
308 | 3cb9e1fe | Iustin Pop | The default nic mode, 'routed' or 'bridged'. |
309 | 3cb9e1fe | Iustin Pop | |
310 | 3cb9e1fe | Iustin Pop | link |
311 | 3cb9e1fe | Iustin Pop | In bridged mode the default NIC bridge. In routed mode it |
312 | 3cb9e1fe | Iustin Pop | represents an hypervisor-vif-script dependent value to allow |
313 | 3cb9e1fe | Iustin Pop | different instance groups. For example under the KVM default |
314 | 3cb9e1fe | Iustin Pop | network script it is interpreted as a routing table number or |
315 | 3cb9e1fe | Iustin Pop | name. |
316 | 3cb9e1fe | Iustin Pop | |
317 | f7b769b1 | Iustin Pop | The option ``--maintain-node-health`` allows one to enable/disable |
318 | 3cb9e1fe | Iustin Pop | automatic maintenance actions on nodes. Currently these include |
319 | 3cb9e1fe | Iustin Pop | automatic shutdown of instances and deactivation of DRBD devices on |
320 | 3cb9e1fe | Iustin Pop | offline nodes; in the future it might be extended to automatic |
321 | 3cb9e1fe | Iustin Pop | removal of unknown LVM volumes, etc. |
322 | 3cb9e1fe | Iustin Pop | |
323 | 3cb9e1fe | Iustin Pop | The ``--uid-pool`` option initializes the user-id pool. The |
324 | 3cb9e1fe | Iustin Pop | *user-id pool definition* can contain a list of user-ids and/or a |
325 | 3cb9e1fe | Iustin Pop | list of user-id ranges. The parameter format is a comma-separated |
326 | 3cb9e1fe | Iustin Pop | list of numeric user-ids or user-id ranges. The ranges are defined |
327 | 3cb9e1fe | Iustin Pop | by a lower and higher boundary, separated by a dash. The boundaries |
328 | 3cb9e1fe | Iustin Pop | are inclusive. If the ``--uid-pool`` option is not supplied, the |
329 | 3cb9e1fe | Iustin Pop | user-id pool is initialized to an empty list. An empty list means |
330 | 3cb9e1fe | Iustin Pop | that the user-id pool feature is disabled. |
331 | 3cb9e1fe | Iustin Pop | |
332 | 3cb9e1fe | Iustin Pop | The ``-I (--default-iallocator)`` option specifies the default |
333 | d1e9c98d | Iustin Pop | instance allocator. The instance allocator will be used for operations |
334 | d1e9c98d | Iustin Pop | like instance creation, instance and node migration, etc. when no |
335 | d1e9c98d | Iustin Pop | manual override is specified. If this option is not specified and |
336 | d1e9c98d | Iustin Pop | htools was not enabled at build time, the default instance allocator |
337 | d1e9c98d | Iustin Pop | will be blank, which means that relevant operations will require the |
338 | d1e9c98d | Iustin Pop | administrator to manually specify either an instance allocator, or a |
339 | d1e9c98d | Iustin Pop | set of nodes. If the option is not specified but htools was enabled, |
340 | d1e9c98d | Iustin Pop | the default iallocator will be **hail**(1) (assuming it can be found |
341 | d1e9c98d | Iustin Pop | on disk). The default iallocator can be changed later using the |
342 | d1e9c98d | Iustin Pop | **modify** command. |
343 | 3cb9e1fe | Iustin Pop | |
344 | 3cb9e1fe | Iustin Pop | The ``--primary-ip-version`` option specifies the IP version used |
345 | 3cb9e1fe | Iustin Pop | for the primary address. Possible values are 4 and 6 for IPv4 and |
346 | 3cb9e1fe | Iustin Pop | IPv6, respectively. This option is used when resolving node names |
347 | 3cb9e1fe | Iustin Pop | and the cluster name. |
348 | 3cb9e1fe | Iustin Pop | |
349 | 6204ee71 | René Nussbaumer | The ``--node-parameters`` option allows you to set default node |
350 | 6204ee71 | René Nussbaumer | parameters for the cluster. Please see **ganeti**(7) for more |
351 | 6204ee71 | René Nussbaumer | information about supported key=value pairs. |
352 | 6204ee71 | René Nussbaumer | |
353 | 0a68e0ff | Iustin Pop | The ``-C (--candidate-pool-size)`` option specifies the |
354 | 0a68e0ff | Iustin Pop | ``candidate_pool_size`` cluster parameter. This is the number of nodes |
355 | 0a68e0ff | Iustin Pop | that the master will try to keep as master\_candidates. For more |
356 | 0a68e0ff | Iustin Pop | details about this role and other node roles, see the ganeti(7). |
357 | 0a68e0ff | Iustin Pop | |
358 | 3cb9e1fe | Iustin Pop | LIST-TAGS |
359 | 3cb9e1fe | Iustin Pop | ~~~~~~~~~ |
360 | 3cb9e1fe | Iustin Pop | |
361 | 3cb9e1fe | Iustin Pop | **list-tags** |
362 | 3cb9e1fe | Iustin Pop | |
363 | 3cb9e1fe | Iustin Pop | List the tags of the cluster. |
364 | 3cb9e1fe | Iustin Pop | |
365 | 3cb9e1fe | Iustin Pop | MASTER-FAILOVER |
366 | 3cb9e1fe | Iustin Pop | ~~~~~~~~~~~~~~~ |
367 | 3cb9e1fe | Iustin Pop | |
368 | 3cb9e1fe | Iustin Pop | **master-failover** [--no-voting] |
369 | 3cb9e1fe | Iustin Pop | |
370 | 3cb9e1fe | Iustin Pop | Failover the master role to the current node. |
371 | 3cb9e1fe | Iustin Pop | |
372 | 3cb9e1fe | Iustin Pop | The ``--no-voting`` option skips the remote node agreement checks. |
373 | 3cb9e1fe | Iustin Pop | This is dangerous, but necessary in some cases (for example failing |
374 | 3cb9e1fe | Iustin Pop | over the master role in a 2 node cluster with the original master |
375 | 3cb9e1fe | Iustin Pop | down). If the original master then comes up, it won't be able to |
376 | 3cb9e1fe | Iustin Pop | start its master daemon because it won't have enough votes, but so |
377 | 3cb9e1fe | Iustin Pop | won't the new master, if the master daemon ever needs a restart. |
378 | 3cb9e1fe | Iustin Pop | You can pass ``--no-voting`` to **ganeti-masterd** on the new |
379 | 3cb9e1fe | Iustin Pop | master to solve this problem, and run **gnt-cluster redist-conf** |
380 | 3cb9e1fe | Iustin Pop | to make sure the cluster is consistent again. |
381 | 3cb9e1fe | Iustin Pop | |
382 | 3cb9e1fe | Iustin Pop | MASTER-PING |
383 | 3cb9e1fe | Iustin Pop | ~~~~~~~~~~~ |
384 | 3cb9e1fe | Iustin Pop | |
385 | 3cb9e1fe | Iustin Pop | **master-ping** |
386 | 3cb9e1fe | Iustin Pop | |
387 | 3cb9e1fe | Iustin Pop | Checks if the master daemon is alive. |
388 | 3cb9e1fe | Iustin Pop | |
389 | 3cb9e1fe | Iustin Pop | If the master daemon is alive and can respond to a basic query (the |
390 | 3cb9e1fe | Iustin Pop | equivalent of **gnt-cluster info**), then the exit code of the |
391 | 3cb9e1fe | Iustin Pop | command will be 0. If the master daemon is not alive (either due to |
392 | 3cb9e1fe | Iustin Pop | a crash or because this is not the master node), the exit code will |
393 | 3cb9e1fe | Iustin Pop | be 1. |
394 | 3cb9e1fe | Iustin Pop | |
395 | 3cb9e1fe | Iustin Pop | MODIFY |
396 | 3cb9e1fe | Iustin Pop | ~~~~~~ |
397 | 3cb9e1fe | Iustin Pop | |
398 | 3cb9e1fe | Iustin Pop | | **modify** |
399 | 3cb9e1fe | Iustin Pop | | [--vg-name *vg-name*] |
400 | 3cb9e1fe | Iustin Pop | | [--no-lvm-storage] |
401 | 3cb9e1fe | Iustin Pop | | [--enabled-hypervisors *hypervisors*] |
402 | 0a68e0ff | Iustin Pop | | [{-H|--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]] |
403 | 0a68e0ff | Iustin Pop | | [{-B|--backend-parameters} *be-param*=*value* [,*be-param*=*value*...]] |
404 | 0a68e0ff | Iustin Pop | | [{-N|--nic-parameters} *nic-param*=*value* [,*nic-param*=*value*...]] |
405 | 3cb9e1fe | Iustin Pop | | [--uid-pool *user-id pool definition*] |
406 | 3cb9e1fe | Iustin Pop | | [--add-uids *user-id pool definition*] |
407 | 3cb9e1fe | Iustin Pop | | [--remove-uids *user-id pool definition*] |
408 | 0a68e0ff | Iustin Pop | | [{-C|--candidate-pool-size} *candidate\_pool\_size*] |
409 | 3cb9e1fe | Iustin Pop | | [--maintain-node-health {yes \| no}] |
410 | 3cb9e1fe | Iustin Pop | | [--prealloc-wipe-disks {yes \| no}] |
411 | 0a68e0ff | Iustin Pop | | [{-I|--default-iallocator} *default instance allocator*] |
412 | 3cb9e1fe | Iustin Pop | | [--reserved-lvs=*NAMES*] |
413 | 6204ee71 | René Nussbaumer | | [--node-parameters *ndparams*] |
414 | 38f9d2cf | Guido Trotter | | [--master-netdev *interface-name*] |
415 | 3cb9e1fe | Iustin Pop | |
416 | 3cb9e1fe | Iustin Pop | Modify the options for the cluster. |
417 | 3cb9e1fe | Iustin Pop | |
418 | 6204ee71 | René Nussbaumer | The ``--vg-name``, ``--no-lvm-storarge``, ``--enabled-hypervisors``, |
419 | 0a68e0ff | Iustin Pop | ``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)``, |
420 | 0a68e0ff | Iustin Pop | ``--nic-parameters``, ``-C (--candidate-pool-size)``, |
421 | 0a68e0ff | Iustin Pop | ``--maintain-node-health``, ``--prealloc-wipe-disks``, ``--uid-pool``, |
422 | 0a68e0ff | Iustin Pop | ``--node-parameters``, ``--master-netdev`` options are described in |
423 | 0a68e0ff | Iustin Pop | the **init** command. |
424 | 3cb9e1fe | Iustin Pop | |
425 | 3cb9e1fe | Iustin Pop | The ``--add-uids`` and ``--remove-uids`` options can be used to |
426 | 3cb9e1fe | Iustin Pop | modify the user-id pool by adding/removing a list of user-ids or |
427 | 3cb9e1fe | Iustin Pop | user-id ranges. |
428 | 3cb9e1fe | Iustin Pop | |
429 | 3cb9e1fe | Iustin Pop | The option ``--reserved-lvs`` specifies a list (comma-separated) of |
430 | 3cb9e1fe | Iustin Pop | logical volume group names (regular expressions) that will be |
431 | 3cb9e1fe | Iustin Pop | ignored by the cluster verify operation. This is useful if the |
432 | 3cb9e1fe | Iustin Pop | volume group used for Ganeti is shared with the system for other |
433 | 3cb9e1fe | Iustin Pop | uses. Note that it's not recommended to create and mark as ignored |
434 | 3cb9e1fe | Iustin Pop | logical volume names which match Ganeti's own name format (starting |
435 | 3cb9e1fe | Iustin Pop | with UUID and then .diskN), as this option only skips the |
436 | 3cb9e1fe | Iustin Pop | verification, but not the actual use of the names given. |
437 | 3cb9e1fe | Iustin Pop | |
438 | 3cb9e1fe | Iustin Pop | To remove all reserved logical volumes, pass in an empty argument |
439 | 3cb9e1fe | Iustin Pop | to the option, as in ``--reserved-lvs=`` or ``--reserved-lvs ''``. |
440 | 3cb9e1fe | Iustin Pop | |
441 | 0a68e0ff | Iustin Pop | The ``-I (--default-iallocator)`` is described in the **init** |
442 | 0a68e0ff | Iustin Pop | command. To clear the default iallocator, just pass an empty string |
443 | 0a68e0ff | Iustin Pop | (''). |
444 | 3cb9e1fe | Iustin Pop | |
445 | 3cb9e1fe | Iustin Pop | QUEUE |
446 | 3cb9e1fe | Iustin Pop | ~~~~~ |
447 | 3cb9e1fe | Iustin Pop | |
448 | 3cb9e1fe | Iustin Pop | **queue** {drain | undrain | info} |
449 | 3cb9e1fe | Iustin Pop | |
450 | 3cb9e1fe | Iustin Pop | Change job queue properties. |
451 | 3cb9e1fe | Iustin Pop | |
452 | 3cb9e1fe | Iustin Pop | The ``drain`` option sets the drain flag on the job queue. No new |
453 | 3cb9e1fe | Iustin Pop | jobs will be accepted, but jobs already in the queue will be |
454 | 3cb9e1fe | Iustin Pop | processed. |
455 | 3cb9e1fe | Iustin Pop | |
456 | 3cb9e1fe | Iustin Pop | The ``undrain`` will unset the drain flag on the job queue. New |
457 | 3cb9e1fe | Iustin Pop | jobs will be accepted. |
458 | 3cb9e1fe | Iustin Pop | |
459 | 3cb9e1fe | Iustin Pop | The ``info`` option shows the properties of the job queue. |
460 | 3cb9e1fe | Iustin Pop | |
461 | 3cb9e1fe | Iustin Pop | WATCHER |
462 | 3cb9e1fe | Iustin Pop | ~~~~~~~ |
463 | 3cb9e1fe | Iustin Pop | |
464 | 3cb9e1fe | Iustin Pop | **watcher** {pause *duration* | continue | info} |
465 | 3cb9e1fe | Iustin Pop | |
466 | 3cb9e1fe | Iustin Pop | Make the watcher pause or let it continue. |
467 | 3cb9e1fe | Iustin Pop | |
468 | 3cb9e1fe | Iustin Pop | The ``pause`` option causes the watcher to pause for *duration* |
469 | 3cb9e1fe | Iustin Pop | seconds. |
470 | 3cb9e1fe | Iustin Pop | |
471 | 3cb9e1fe | Iustin Pop | The ``continue`` option will let the watcher continue. |
472 | 3cb9e1fe | Iustin Pop | |
473 | 3cb9e1fe | Iustin Pop | The ``info`` option shows whether the watcher is currently paused. |
474 | 3cb9e1fe | Iustin Pop | |
475 | 3cb9e1fe | Iustin Pop | redist-conf |
476 | 3cb9e1fe | Iustin Pop | ~~~~~~~~~~~ |
477 | 3cb9e1fe | Iustin Pop | |
478 | 3cb9e1fe | Iustin Pop | **redist-conf** [--submit] |
479 | 3cb9e1fe | Iustin Pop | |
480 | 3cb9e1fe | Iustin Pop | This command forces a full push of configuration files from the |
481 | 3cb9e1fe | Iustin Pop | master node to the other nodes in the cluster. This is normally not |
482 | 3cb9e1fe | Iustin Pop | needed, but can be run if the **verify** complains about |
483 | 3cb9e1fe | Iustin Pop | configuration mismatches. |
484 | 3cb9e1fe | Iustin Pop | |
485 | 3cb9e1fe | Iustin Pop | The ``--submit`` option is used to send the job to the master |
486 | 3cb9e1fe | Iustin Pop | daemon but not wait for its completion. The job ID will be shown so |
487 | 3cb9e1fe | Iustin Pop | that it can be examined via **gnt-job info**. |
488 | 3cb9e1fe | Iustin Pop | |
489 | 3cb9e1fe | Iustin Pop | REMOVE-TAGS |
490 | 3cb9e1fe | Iustin Pop | ~~~~~~~~~~~ |
491 | 3cb9e1fe | Iustin Pop | |
492 | 3cb9e1fe | Iustin Pop | **remove-tags** [--from *file*] {*tag*...} |
493 | 3cb9e1fe | Iustin Pop | |
494 | 3cb9e1fe | Iustin Pop | Remove tags from the cluster. If any of the tags are not existing |
495 | 3cb9e1fe | Iustin Pop | on the cluster, the entire operation will abort. |
496 | 3cb9e1fe | Iustin Pop | |
497 | 3cb9e1fe | Iustin Pop | If the ``--from`` option is given, the list of tags to be removed will |
498 | 3cb9e1fe | Iustin Pop | be extended with the contents of that file (each line becomes a tag). |
499 | 3cb9e1fe | Iustin Pop | In this case, there is not need to pass tags on the command line (if |
500 | 3cb9e1fe | Iustin Pop | you do, tags from both sources will be removed). A file name of - will |
501 | 3cb9e1fe | Iustin Pop | be interpreted as stdin. |
502 | 3cb9e1fe | Iustin Pop | |
503 | 3cb9e1fe | Iustin Pop | RENAME |
504 | 3cb9e1fe | Iustin Pop | ~~~~~~ |
505 | 3cb9e1fe | Iustin Pop | |
506 | 3cb9e1fe | Iustin Pop | **rename** [-f] {*name*} |
507 | 3cb9e1fe | Iustin Pop | |
508 | 3cb9e1fe | Iustin Pop | Renames the cluster and in the process updates the master IP |
509 | 3cb9e1fe | Iustin Pop | address to the one the new name resolves to. At least one of either |
510 | 3cb9e1fe | Iustin Pop | the name or the IP address must be different, otherwise the |
511 | 3cb9e1fe | Iustin Pop | operation will be aborted. |
512 | 3cb9e1fe | Iustin Pop | |
513 | 3cb9e1fe | Iustin Pop | Note that since this command can be dangerous (especially when run |
514 | 3cb9e1fe | Iustin Pop | over SSH), the command will require confirmation unless run with |
515 | 3cb9e1fe | Iustin Pop | the ``-f`` option. |
516 | 3cb9e1fe | Iustin Pop | |
517 | 3cb9e1fe | Iustin Pop | RENEW-CRYPTO |
518 | 3cb9e1fe | Iustin Pop | ~~~~~~~~~~~~ |
519 | 3cb9e1fe | Iustin Pop | |
520 | 3cb9e1fe | Iustin Pop | | **renew-crypto** [-f] |
521 | 3cb9e1fe | Iustin Pop | | [--new-cluster-certificate] [--new-confd-hmac-key] |
522 | 3cb9e1fe | Iustin Pop | | [--new-rapi-certificate] [--rapi-certificate *rapi-cert*] |
523 | b8a10435 | Andrea Spadaccini | | [--new-spice-certificate | --spice-certificate *spice-cert* |
524 | b8a10435 | Andrea Spadaccini | | -- spice-ca-certificate *spice-ca-cert*] |
525 | 3cb9e1fe | Iustin Pop | | [--new-cluster-domain-secret] [--cluster-domain-secret *filename*] |
526 | 3cb9e1fe | Iustin Pop | |
527 | 3cb9e1fe | Iustin Pop | This command will stop all Ganeti daemons in the cluster and start |
528 | 3cb9e1fe | Iustin Pop | them again once the new certificates and keys are replicated. The |
529 | 3cb9e1fe | Iustin Pop | options ``--new-cluster-certificate`` and ``--new-confd-hmac-key`` |
530 | 3cb9e1fe | Iustin Pop | can be used to regenerate the cluster-internal SSL certificate |
531 | 3cb9e1fe | Iustin Pop | respective the HMAC key used by ganeti-confd(8). |
532 | 3cb9e1fe | Iustin Pop | |
533 | 3cb9e1fe | Iustin Pop | To generate a new self-signed RAPI certificate (used by |
534 | 3cb9e1fe | Iustin Pop | ganeti-rapi(8)) specify ``--new-rapi-certificate``. If you want to |
535 | 3cb9e1fe | Iustin Pop | use your own certificate, e.g. one signed by a certificate |
536 | 3cb9e1fe | Iustin Pop | authority (CA), pass its filename to ``--rapi-certificate``. |
537 | 3cb9e1fe | Iustin Pop | |
538 | b8a10435 | Andrea Spadaccini | To generate a new self-signed SPICE certificate, used by SPICE |
539 | b8a10435 | Andrea Spadaccini | connections to the KVM hypervisor, specify the |
540 | b8a10435 | Andrea Spadaccini | ``--new-spice-certificate`` option. If you want to provide a |
541 | b8a10435 | Andrea Spadaccini | certificate, pass its filename to ``--spice-certificate`` and pass the |
542 | b8a10435 | Andrea Spadaccini | signing CA certificate to ``--spice-ca-certificate``. |
543 | b8a10435 | Andrea Spadaccini | |
544 | 3cb9e1fe | Iustin Pop | ``--new-cluster-domain-secret`` generates a new, random cluster |
545 | 3cb9e1fe | Iustin Pop | domain secret. ``--cluster-domain-secret`` reads the secret from a |
546 | 3cb9e1fe | Iustin Pop | file. The cluster domain secret is used to sign information |
547 | 3cb9e1fe | Iustin Pop | exchanged between separate clusters via a third party. |
548 | 3cb9e1fe | Iustin Pop | |
549 | 3cb9e1fe | Iustin Pop | REPAIR-DISK-SIZES |
550 | 3cb9e1fe | Iustin Pop | ~~~~~~~~~~~~~~~~~ |
551 | 3cb9e1fe | Iustin Pop | |
552 | 3cb9e1fe | Iustin Pop | **repair-disk-sizes** [instance...] |
553 | 3cb9e1fe | Iustin Pop | |
554 | 3cb9e1fe | Iustin Pop | This command checks that the recorded size of the given instance's |
555 | 3cb9e1fe | Iustin Pop | disks matches the actual size and updates any mismatches found. |
556 | 3cb9e1fe | Iustin Pop | This is needed if the Ganeti configuration is no longer consistent |
557 | 3cb9e1fe | Iustin Pop | with reality, as it will impact some disk operations. If no |
558 | 3cb9e1fe | Iustin Pop | arguments are given, all instances will be checked. |
559 | 3cb9e1fe | Iustin Pop | |
560 | 3cb9e1fe | Iustin Pop | Note that only active disks can be checked by this command; in case |
561 | 3cb9e1fe | Iustin Pop | a disk cannot be activated it's advised to use |
562 | 3cb9e1fe | Iustin Pop | **gnt-instance activate-disks --ignore-size ...** to force |
563 | 3cb9e1fe | Iustin Pop | activation without regard to the current size. |
564 | 3cb9e1fe | Iustin Pop | |
565 | 3cb9e1fe | Iustin Pop | When the all disk sizes are consistent, the command will return no |
566 | 3cb9e1fe | Iustin Pop | output. Otherwise it will log details about the inconsistencies in |
567 | 3cb9e1fe | Iustin Pop | the configuration. |
568 | 3cb9e1fe | Iustin Pop | |
569 | 3cb9e1fe | Iustin Pop | SEARCH-TAGS |
570 | 3cb9e1fe | Iustin Pop | ~~~~~~~~~~~ |
571 | 3cb9e1fe | Iustin Pop | |
572 | 3cb9e1fe | Iustin Pop | **search-tags** {*pattern*} |
573 | 3cb9e1fe | Iustin Pop | |
574 | 3cb9e1fe | Iustin Pop | Searches the tags on all objects in the cluster (the cluster |
575 | 3cb9e1fe | Iustin Pop | itself, the nodes and the instances) for a given pattern. The |
576 | 3cb9e1fe | Iustin Pop | pattern is interpreted as a regular expression and a search will be |
577 | 3cb9e1fe | Iustin Pop | done on it (i.e. the given pattern is not anchored to the beggining |
578 | 3cb9e1fe | Iustin Pop | of the string; if you want that, prefix the pattern with ^). |
579 | 3cb9e1fe | Iustin Pop | |
580 | 3cb9e1fe | Iustin Pop | If no tags are matching the pattern, the exit code of the command |
581 | 3cb9e1fe | Iustin Pop | will be one. If there is at least one match, the exit code will be |
582 | 3cb9e1fe | Iustin Pop | zero. Each match is listed on one line, the object and the tag |
583 | 3cb9e1fe | Iustin Pop | separated by a space. The cluster will be listed as /cluster, a |
584 | 3cb9e1fe | Iustin Pop | node will be listed as /nodes/*name*, and an instance as |
585 | 3cb9e1fe | Iustin Pop | /instances/*name*. Example: |
586 | 3cb9e1fe | Iustin Pop | |
587 | 3cb9e1fe | Iustin Pop | :: |
588 | 3cb9e1fe | Iustin Pop | |
589 | 3cb9e1fe | Iustin Pop | # gnt-cluster search-tags time |
590 | 3cb9e1fe | Iustin Pop | /cluster ctime:2007-09-01 |
591 | 3cb9e1fe | Iustin Pop | /nodes/node1.example.com mtime:2007-10-04 |
592 | 3cb9e1fe | Iustin Pop | |
593 | 3cb9e1fe | Iustin Pop | VERIFY |
594 | 3cb9e1fe | Iustin Pop | ~~~~~~ |
595 | 3cb9e1fe | Iustin Pop | |
596 | 40167d65 | Adeodato Simo | **verify** [--no-nplus1-mem] [--node-group *nodegroup*] |
597 | 3cb9e1fe | Iustin Pop | |
598 | 3cb9e1fe | Iustin Pop | Verify correctness of cluster configuration. This is safe with |
599 | 3cb9e1fe | Iustin Pop | respect to running instances, and incurs no downtime of the |
600 | 3cb9e1fe | Iustin Pop | instances. |
601 | 3cb9e1fe | Iustin Pop | |
602 | 3cb9e1fe | Iustin Pop | If the ``--no-nplus1-mem`` option is given, Ganeti won't check |
603 | 3cb9e1fe | Iustin Pop | whether if it loses a node it can restart all the instances on |
604 | 3cb9e1fe | Iustin Pop | their secondaries (and report an error otherwise). |
605 | 3cb9e1fe | Iustin Pop | |
606 | 40167d65 | Adeodato Simo | With ``--node-group``, restrict the verification to those nodes and |
607 | 40167d65 | Adeodato Simo | instances that live in the named group. This will not verify global |
608 | 40167d65 | Adeodato Simo | settings, but will allow to perform verification of a group while other |
609 | 40167d65 | Adeodato Simo | operations are ongoing in other groups. |
610 | 40167d65 | Adeodato Simo | |
611 | 3cb9e1fe | Iustin Pop | VERIFY-DISKS |
612 | 3cb9e1fe | Iustin Pop | ~~~~~~~~~~~~ |
613 | 3cb9e1fe | Iustin Pop | |
614 | 3cb9e1fe | Iustin Pop | **verify-disks** |
615 | 3cb9e1fe | Iustin Pop | |
616 | 3cb9e1fe | Iustin Pop | The command checks which instances have degraded DRBD disks and |
617 | 3cb9e1fe | Iustin Pop | activates the disks of those instances. |
618 | 3cb9e1fe | Iustin Pop | |
619 | 3cb9e1fe | Iustin Pop | This command is run from the **ganeti-watcher** tool, which also |
620 | 3cb9e1fe | Iustin Pop | has a different, complementary algorithm for doing this check. |
621 | 3cb9e1fe | Iustin Pop | Together, these two should ensure that DRBD disks are kept |
622 | 3cb9e1fe | Iustin Pop | consistent. |
623 | 3cb9e1fe | Iustin Pop | |
624 | 3cb9e1fe | Iustin Pop | VERSION |
625 | 3cb9e1fe | Iustin Pop | ~~~~~~~ |
626 | 3cb9e1fe | Iustin Pop | |
627 | 3cb9e1fe | Iustin Pop | **version** |
628 | 3cb9e1fe | Iustin Pop | |
629 | 3cb9e1fe | Iustin Pop | Show the cluster version. |
630 | 9ff4f2c0 | Michael Hanselmann | |
631 | 9ff4f2c0 | Michael Hanselmann | .. vim: set textwidth=72 : |
632 | 9ff4f2c0 | Michael Hanselmann | .. Local Variables: |
633 | 9ff4f2c0 | Michael Hanselmann | .. mode: rst |
634 | 9ff4f2c0 | Michael Hanselmann | .. fill-column: 72 |
635 | 9ff4f2c0 | Michael Hanselmann | .. End: |