root / man / gnt-cluster.rst @ dcedd81a
History | View | Annotate | Download (33.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 | fb926117 | Andrea Spadaccini | ACTIVATE-MASTER-IP |
24 | fb926117 | Andrea Spadaccini | ~~~~~~~~~~~~~~~~~~ |
25 | fb926117 | Andrea Spadaccini | |
26 | fb926117 | Andrea Spadaccini | **activate-master-ip** |
27 | fb926117 | Andrea Spadaccini | |
28 | fb926117 | Andrea Spadaccini | Activates the master IP on the master node. |
29 | fb926117 | Andrea Spadaccini | |
30 | 3cb9e1fe | Iustin Pop | COMMAND |
31 | 3cb9e1fe | Iustin Pop | ~~~~~~~ |
32 | 3cb9e1fe | Iustin Pop | |
33 | a24aed2a | Michael Hanselmann | **command** [-n *node*] [-g *group*] [-M] {*command*} |
34 | 3cb9e1fe | Iustin Pop | |
35 | 0ab31d67 | Michael Hanselmann | Executes a command on all nodes. This command is designed for simple |
36 | 354c4f62 | Michael Hanselmann | usage. For more complex use cases the commands **dsh**\(1) or **cssh**\(1) |
37 | 0ab31d67 | Michael Hanselmann | should be used instead. |
38 | 0ab31d67 | Michael Hanselmann | |
39 | 0ab31d67 | Michael Hanselmann | If the option ``-n`` is not given, the command will be executed on all |
40 | 0ab31d67 | Michael Hanselmann | nodes, otherwise it will be executed only on the node(s) specified. Use |
41 | 0ab31d67 | Michael Hanselmann | the option multiple times for running it on multiple nodes, like:: |
42 | 3cb9e1fe | Iustin Pop | |
43 | 3cb9e1fe | Iustin Pop | # gnt-cluster command -n node1.example.com -n node2.example.com date |
44 | 3cb9e1fe | Iustin Pop | |
45 | b6e88032 | Michael Hanselmann | The ``-g`` option can be used to run a command only on a specific node |
46 | b6e88032 | Michael Hanselmann | group, e.g.:: |
47 | b6e88032 | Michael Hanselmann | |
48 | b6e88032 | Michael Hanselmann | # gnt-cluster command -g default date |
49 | b6e88032 | Michael Hanselmann | |
50 | a24aed2a | Michael Hanselmann | The ``-M`` option can be used to prepend the node name to all output |
51 | d5b031dc | Michael Hanselmann | lines. The ``--failure-only`` option hides successful commands, making |
52 | d5b031dc | Michael Hanselmann | it easier to see failures. |
53 | a24aed2a | 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 | e8f936b0 | Iustin Pop | | **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 | fb926117 | Andrea Spadaccini | DEACTIVATE-MASTER-IP |
93 | fb926117 | Andrea Spadaccini | ~~~~~~~~~~~~~~~~~~~~ |
94 | fb926117 | Andrea Spadaccini | |
95 | e8f936b0 | Iustin Pop | **deactivate-master-ip** [\--yes] |
96 | fb926117 | Andrea Spadaccini | |
97 | fb926117 | Andrea Spadaccini | Deactivates the master IP on the master node. |
98 | fb926117 | Andrea Spadaccini | |
99 | fb926117 | Andrea Spadaccini | This should be run only locally or on a connection to the node ip |
100 | fb926117 | Andrea Spadaccini | directly, as a connection to the master ip will be broken by this |
101 | fb926117 | Andrea Spadaccini | operation. Because of this risk it will require user confirmation |
102 | fb926117 | Andrea Spadaccini | unless the ``--yes`` option is passed. |
103 | fb926117 | Andrea Spadaccini | |
104 | 3cb9e1fe | Iustin Pop | DESTROY |
105 | 3cb9e1fe | Iustin Pop | ~~~~~~~ |
106 | 3cb9e1fe | Iustin Pop | |
107 | e8f936b0 | Iustin Pop | **destroy** {\--yes-do-it} |
108 | 3cb9e1fe | Iustin Pop | |
109 | 3cb9e1fe | Iustin Pop | Remove all configuration files related to the cluster, so that a |
110 | 3cb9e1fe | Iustin Pop | **gnt-cluster init** can be done again afterwards. |
111 | 3cb9e1fe | Iustin Pop | |
112 | 3cb9e1fe | Iustin Pop | Since this is a dangerous command, you are required to pass the |
113 | e8f936b0 | Iustin Pop | argument *\--yes-do-it.* |
114 | 3cb9e1fe | Iustin Pop | |
115 | 66d1f035 | René Nussbaumer | EPO |
116 | 66d1f035 | René Nussbaumer | ~~~ |
117 | 66d1f035 | René Nussbaumer | |
118 | e8f936b0 | Iustin Pop | **epo** [\--on] [\--groups|\--all] [\--power-delay] *arguments* |
119 | cfed3b9f | René Nussbaumer | |
120 | cfed3b9f | René Nussbaumer | Performs an emergency power-off on nodes given as arguments. If |
121 | cfed3b9f | René Nussbaumer | ``--groups`` is given, arguments are node groups. If ``--all`` is |
122 | cfed3b9f | René Nussbaumer | provided, the whole cluster will be shut down. |
123 | cfed3b9f | René Nussbaumer | |
124 | cfed3b9f | René Nussbaumer | The ``--on`` flag recovers the cluster after an emergency power-off. |
125 | cfed3b9f | René Nussbaumer | When powering on the cluster you can use ``--power-delay`` to define the |
126 | cfed3b9f | René Nussbaumer | time in seconds (fractions allowed) waited between powering on |
127 | cfed3b9f | René Nussbaumer | individual nodes. |
128 | cfed3b9f | René Nussbaumer | |
129 | cfed3b9f | René Nussbaumer | Please note that the master node will not be turned down or up |
130 | cfed3b9f | René Nussbaumer | automatically. It will just be left in a state, where you can manully |
131 | cfed3b9f | René Nussbaumer | perform the shutdown of that one node. If the master is in the list of |
132 | cfed3b9f | René Nussbaumer | affected nodes and this is not a complete cluster emergency power-off |
133 | cfed3b9f | René Nussbaumer | (e.g. using ``--all``), you're required to do a master failover to |
134 | cfed3b9f | René Nussbaumer | another node not affected. |
135 | 66d1f035 | René Nussbaumer | |
136 | 3cb9e1fe | Iustin Pop | GETMASTER |
137 | 3cb9e1fe | Iustin Pop | ~~~~~~~~~ |
138 | 3cb9e1fe | Iustin Pop | |
139 | 3cb9e1fe | Iustin Pop | **getmaster** |
140 | 3cb9e1fe | Iustin Pop | |
141 | 3cb9e1fe | Iustin Pop | Displays the current master node. |
142 | 3cb9e1fe | Iustin Pop | |
143 | 3cb9e1fe | Iustin Pop | INFO |
144 | 3cb9e1fe | Iustin Pop | ~~~~ |
145 | 3cb9e1fe | Iustin Pop | |
146 | e8f936b0 | Iustin Pop | **info** [\--roman] |
147 | 3cb9e1fe | Iustin Pop | |
148 | 3cb9e1fe | Iustin Pop | Shows runtime cluster information: cluster name, architecture (32 |
149 | 3cb9e1fe | Iustin Pop | or 64 bit), master node, node list and instance list. |
150 | 3cb9e1fe | Iustin Pop | |
151 | 3cb9e1fe | Iustin Pop | Passing the ``--roman`` option gnt-cluster info will try to print |
152 | 3cb9e1fe | Iustin Pop | its integer fields in a latin friendly way. This allows further |
153 | 3cb9e1fe | Iustin Pop | diffusion of Ganeti among ancient cultures. |
154 | 3cb9e1fe | Iustin Pop | |
155 | ea9d3b40 | Bernardo Dal Seno | SHOW-ISPECS-CMD |
156 | ea9d3b40 | Bernardo Dal Seno | ~~~~~~~~~~~~~~~ |
157 | ea9d3b40 | Bernardo Dal Seno | |
158 | ea9d3b40 | Bernardo Dal Seno | **show-ispecs-cmd** |
159 | ea9d3b40 | Bernardo Dal Seno | |
160 | ea9d3b40 | Bernardo Dal Seno | Shows the command line that can be used to recreate the cluster with the |
161 | ea9d3b40 | Bernardo Dal Seno | same options relative to specs in the instance policies. |
162 | ea9d3b40 | Bernardo Dal Seno | |
163 | 3cb9e1fe | Iustin Pop | INIT |
164 | 3cb9e1fe | Iustin Pop | ~~~~ |
165 | 3cb9e1fe | Iustin Pop | |
166 | 3cb9e1fe | Iustin Pop | | **init** |
167 | e8f936b0 | Iustin Pop | | [{-s|\--secondary-ip} *secondary\_ip*] |
168 | e8f936b0 | Iustin Pop | | [\--vg-name *vg-name*] |
169 | e8f936b0 | Iustin Pop | | [\--master-netdev *interface-name*] |
170 | e8f936b0 | Iustin Pop | | [\--master-netmask *netmask*] |
171 | e8f936b0 | Iustin Pop | | [\--use-external-mip-script {yes \| no}] |
172 | e8f936b0 | Iustin Pop | | [{-m|\--mac-prefix} *mac-prefix*] |
173 | e8f936b0 | Iustin Pop | | [\--no-lvm-storage] |
174 | e8f936b0 | Iustin Pop | | [\--no-etc-hosts] |
175 | e8f936b0 | Iustin Pop | | [\--no-ssh-init] |
176 | e8f936b0 | Iustin Pop | | [\--file-storage-dir *dir*] |
177 | e8f936b0 | Iustin Pop | | [\--enabled-hypervisors *hypervisors*] |
178 | e8f936b0 | Iustin Pop | | [{-H|\--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]] |
179 | e8f936b0 | Iustin Pop | | [{-B|\--backend-parameters} *be-param*=*value*[,*be-param*=*value*...]] |
180 | e8f936b0 | Iustin Pop | | [{-N|\--nic-parameters} *nic-param*=*value*[,*nic-param*=*value*...]] |
181 | e8f936b0 | Iustin Pop | | [{-D|\--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]] |
182 | e8f936b0 | Iustin Pop | | [\--maintain-node-health {yes \| no}] |
183 | e8f936b0 | Iustin Pop | | [\--uid-pool *user-id pool definition*] |
184 | e8f936b0 | Iustin Pop | | [{-I|\--default-iallocator} *default instance allocator*] |
185 | e8f936b0 | Iustin Pop | | [\--primary-ip-version *version*] |
186 | e8f936b0 | Iustin Pop | | [\--prealloc-wipe-disks {yes \| no}] |
187 | e8f936b0 | Iustin Pop | | [\--node-parameters *ndparams*] |
188 | e8f936b0 | Iustin Pop | | [{-C|\--candidate-pool-size} *candidate\_pool\_size*] |
189 | e8f936b0 | Iustin Pop | | [\--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]] |
190 | e8f936b0 | Iustin Pop | | [\--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]] |
191 | e8f936b0 | Iustin Pop | | [\--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]] |
192 | e8f936b0 | Iustin Pop | | [\--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]] |
193 | e8f936b0 | Iustin Pop | | [\--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]] |
194 | d2d3935a | Bernardo Dal Seno | | [\--ipolicy-std-specs *spec*=*value* [,*spec*=*value*...]] |
195 | d2d3935a | Bernardo Dal Seno | | [\--ipolicy-bounds-specs *bounds_ispecs*] |
196 | 75c7a686 | Bernardo Dal Seno | | [\--ipolicy-disk-templates *template* [,*template*...]] |
197 | d307d38c | Bernardo Dal Seno | | [\--ipolicy-spindle-ratio *ratio*] |
198 | d307d38c | Bernardo Dal Seno | | [\--ipolicy-vcpu-ratio *ratio*] |
199 | e8f936b0 | Iustin Pop | | [\--disk-state *diskstate*] |
200 | e8f936b0 | Iustin Pop | | [\--hypervisor-state *hvstate*] |
201 | 5914192c | Helga Velroyen | | [\--enabled-disk-templates *template* [,*template*...]] |
202 | 3cb9e1fe | Iustin Pop | | {*clustername*} |
203 | 3cb9e1fe | Iustin Pop | |
204 | 3cb9e1fe | Iustin Pop | This commands is only run once initially on the first node of the |
205 | 3cb9e1fe | Iustin Pop | cluster. It will initialize the cluster configuration, setup the |
206 | 3cb9e1fe | Iustin Pop | ssh-keys, start the daemons on the master node, etc. in order to have |
207 | 3cb9e1fe | Iustin Pop | a working one-node cluster. |
208 | 3cb9e1fe | Iustin Pop | |
209 | 3cb9e1fe | Iustin Pop | Note that the *clustername* is not any random name. It has to be |
210 | 3cb9e1fe | Iustin Pop | resolvable to an IP address using DNS, and it is best if you give the |
211 | 3cb9e1fe | Iustin Pop | fully-qualified domain name. This hostname must resolve to an IP |
212 | 3cb9e1fe | Iustin Pop | address reserved exclusively for this purpose, i.e. not already in |
213 | 3cb9e1fe | Iustin Pop | use. |
214 | 3cb9e1fe | Iustin Pop | |
215 | 3cb9e1fe | Iustin Pop | The cluster can run in two modes: single-home or dual-homed. In the |
216 | 0a68e0ff | Iustin Pop | first case, all traffic (both public traffic, inter-node traffic and |
217 | 0a68e0ff | Iustin Pop | data replication traffic) goes over the same interface. In the |
218 | 3cb9e1fe | Iustin Pop | dual-homed case, the data replication traffic goes over the second |
219 | 0a68e0ff | Iustin Pop | network. The ``-s (--secondary-ip)`` option here marks the cluster as |
220 | 0a68e0ff | Iustin Pop | dual-homed and its parameter represents this node's address on the |
221 | 0a68e0ff | Iustin Pop | second network. If you initialise the cluster with ``-s``, all nodes |
222 | 0a68e0ff | Iustin Pop | added must have a secondary IP as well. |
223 | 3cb9e1fe | Iustin Pop | |
224 | 3cb9e1fe | Iustin Pop | Note that for Ganeti it doesn't matter if the secondary network is |
225 | 3cb9e1fe | Iustin Pop | actually a separate physical network, or is done using tunneling, |
226 | 3cb9e1fe | Iustin Pop | etc. For performance reasons, it's recommended to use a separate |
227 | 3cb9e1fe | Iustin Pop | network, of course. |
228 | 3cb9e1fe | Iustin Pop | |
229 | 3cb9e1fe | Iustin Pop | The ``--vg-name`` option will let you specify a volume group |
230 | 3cb9e1fe | Iustin Pop | different than "xenvg" for Ganeti to use when creating instance |
231 | 3cb9e1fe | Iustin Pop | disks. This volume group must have the same name on all nodes. Once |
232 | 3cb9e1fe | Iustin Pop | the cluster is initialized this can be altered by using the |
233 | 568d21e4 | Michele Tartara | **modify** command. Note that if the volume group name is modified after |
234 | 568d21e4 | Michele Tartara | the cluster creation and DRBD support is enabled you might have to |
235 | 568d21e4 | Michele Tartara | manually modify the metavg as well. |
236 | 7ba93b8a | Michele Tartara | |
237 | 7ba93b8a | Michele Tartara | If you don't want to use lvm storage at all use |
238 | 3cb9e1fe | Iustin Pop | the ``--no-lvm-storage`` option. Once the cluster is initialized |
239 | 3cb9e1fe | Iustin Pop | you can change this setup with the **modify** command. |
240 | 3cb9e1fe | Iustin Pop | |
241 | 3cb9e1fe | Iustin Pop | The ``--master-netdev`` option is useful for specifying a different |
242 | 3cb9e1fe | Iustin Pop | interface on which the master will activate its IP address. It's |
243 | 3cb9e1fe | Iustin Pop | important that all nodes have this interface because you'll need it |
244 | 3cb9e1fe | Iustin Pop | for a master failover. |
245 | 3cb9e1fe | Iustin Pop | |
246 | 5a8648eb | Andrea Spadaccini | The ``--master-netmask`` option allows to specify a netmask for the |
247 | 5a8648eb | Andrea Spadaccini | master IP. The netmask must be specified as an integer, and will be |
248 | 5a8648eb | Andrea Spadaccini | interpreted as a CIDR netmask. The default value is 32 for an IPv4 |
249 | 5a8648eb | Andrea Spadaccini | address and 128 for an IPv6 address. |
250 | 5a8648eb | Andrea Spadaccini | |
251 | a6c79f3a | Iustin Pop | The ``--use-external-mip-script`` option allows to specify whether to |
252 | a6c79f3a | Iustin Pop | use an user-supplied master IP address setup script, whose location is |
253 | a6c79f3a | Iustin Pop | ``@SYSCONFDIR@/ganeti/scripts/master-ip-setup``. If the option value is |
254 | a6c79f3a | Iustin Pop | set to False, the default script (located at |
255 | a6c79f3a | Iustin Pop | ``@PKGLIBDIR@/tools/master-ip-setup``) will be executed. |
256 | bf689b7a | Andrea Spadaccini | |
257 | 0a68e0ff | Iustin Pop | The ``-m (--mac-prefix)`` option will let you specify a three byte |
258 | 0a68e0ff | Iustin Pop | prefix under which the virtual MAC addresses of your instances will be |
259 | 0a68e0ff | Iustin Pop | generated. The prefix must be specified in the format ``XX:XX:XX`` and |
260 | 0a68e0ff | Iustin Pop | the default is ``aa:00:00``. |
261 | 3cb9e1fe | Iustin Pop | |
262 | 3cb9e1fe | Iustin Pop | The ``--no-lvm-storage`` option allows you to initialize the |
263 | 3cb9e1fe | Iustin Pop | cluster without lvm support. This means that only instances using |
264 | 3cb9e1fe | Iustin Pop | files as storage backend will be possible to create. Once the |
265 | 3cb9e1fe | Iustin Pop | cluster is initialized you can change this setup with the |
266 | 3cb9e1fe | Iustin Pop | **modify** command. |
267 | 3cb9e1fe | Iustin Pop | |
268 | 3cb9e1fe | Iustin Pop | The ``--no-etc-hosts`` option allows you to initialize the cluster |
269 | 3cb9e1fe | Iustin Pop | without modifying the /etc/hosts file. |
270 | 3cb9e1fe | Iustin Pop | |
271 | 3cb9e1fe | Iustin Pop | The ``--no-ssh-init`` option allows you to initialize the cluster |
272 | 3cb9e1fe | Iustin Pop | without creating or distributing SSH key pairs. |
273 | 3cb9e1fe | Iustin Pop | |
274 | 3cb9e1fe | Iustin Pop | The ``--file-storage-dir`` option allows you set the directory to |
275 | 3cb9e1fe | Iustin Pop | use for storing the instance disk files when using file storage as |
276 | 3cb9e1fe | Iustin Pop | backend for instance disks. |
277 | 3cb9e1fe | Iustin Pop | |
278 | fa8ef9d6 | Michael Hanselmann | The ``--prealloc-wipe-disks`` sets a cluster wide configuration value |
279 | fa8ef9d6 | Michael Hanselmann | for wiping disks prior to allocation and size changes (``gnt-instance |
280 | fa8ef9d6 | Michael Hanselmann | grow-disk``). This increases security on instance level as the instance |
281 | fa8ef9d6 | Michael Hanselmann | can't access untouched data from its underlying storage. |
282 | 3cb9e1fe | Iustin Pop | |
283 | 3cb9e1fe | Iustin Pop | The ``--enabled-hypervisors`` option allows you to set the list of |
284 | 3cb9e1fe | Iustin Pop | hypervisors that will be enabled for this cluster. Instance |
285 | 3cb9e1fe | Iustin Pop | hypervisors can only be chosen from the list of enabled |
286 | 3cb9e1fe | Iustin Pop | hypervisors, and the first entry of this list will be used by |
287 | 3cb9e1fe | Iustin Pop | default. Currently, the following hypervisors are available: |
288 | 3cb9e1fe | Iustin Pop | |
289 | 3cb9e1fe | Iustin Pop | xen-pvm |
290 | 3cb9e1fe | Iustin Pop | Xen PVM hypervisor |
291 | 3cb9e1fe | Iustin Pop | |
292 | 3cb9e1fe | Iustin Pop | xen-hvm |
293 | 3cb9e1fe | Iustin Pop | Xen HVM hypervisor |
294 | 3cb9e1fe | Iustin Pop | |
295 | 3cb9e1fe | Iustin Pop | kvm |
296 | 3cb9e1fe | Iustin Pop | Linux KVM hypervisor |
297 | 3cb9e1fe | Iustin Pop | |
298 | 3cb9e1fe | Iustin Pop | chroot |
299 | 3cb9e1fe | Iustin Pop | a simple chroot manager that starts chroot based on a script at the |
300 | 3cb9e1fe | Iustin Pop | root of the filesystem holding the chroot |
301 | 3cb9e1fe | Iustin Pop | |
302 | 3cb9e1fe | Iustin Pop | fake |
303 | 3cb9e1fe | Iustin Pop | fake hypervisor for development/testing |
304 | 3cb9e1fe | Iustin Pop | |
305 | 3cb9e1fe | Iustin Pop | Either a single hypervisor name or a comma-separated list of |
306 | 3cb9e1fe | Iustin Pop | hypervisor names can be specified. If this option is not specified, |
307 | 3cb9e1fe | Iustin Pop | only the xen-pvm hypervisor is enabled by default. |
308 | 3cb9e1fe | Iustin Pop | |
309 | 0a68e0ff | Iustin Pop | The ``-H (--hypervisor-parameters)`` option allows you to set default |
310 | 3cb9e1fe | Iustin Pop | hypervisor specific parameters for the cluster. The format of this |
311 | 3cb9e1fe | Iustin Pop | option is the name of the hypervisor, followed by a colon and a |
312 | 0a68e0ff | Iustin Pop | comma-separated list of key=value pairs. The keys available for each |
313 | 354c4f62 | Michael Hanselmann | hypervisors are detailed in the **gnt-instance**\(8) man page, in the |
314 | 0a68e0ff | Iustin Pop | **add** command plus the following parameters which are only |
315 | 3cb9e1fe | Iustin Pop | configurable globally (at cluster level): |
316 | 3cb9e1fe | Iustin Pop | |
317 | 3cb9e1fe | Iustin Pop | migration\_port |
318 | 3cb9e1fe | Iustin Pop | Valid for the Xen PVM and KVM hypervisors. |
319 | 3cb9e1fe | Iustin Pop | |
320 | 3cb9e1fe | Iustin Pop | This options specifies the TCP port to use for live-migration. For |
321 | 3cb9e1fe | Iustin Pop | Xen, the same port should be configured on all nodes in the |
322 | a8e8c0c6 | Michael Hanselmann | ``@XEN_CONFIG_DIR@/xend-config.sxp`` file, under the key |
323 | 3cb9e1fe | Iustin Pop | "xend-relocation-port". |
324 | 3cb9e1fe | Iustin Pop | |
325 | 3cb9e1fe | Iustin Pop | migration\_bandwidth |
326 | 3cb9e1fe | Iustin Pop | Valid for the KVM hypervisor. |
327 | 3cb9e1fe | Iustin Pop | |
328 | 3cb9e1fe | Iustin Pop | This option specifies the maximum bandwidth that KVM will use for |
329 | 3cb9e1fe | Iustin Pop | instance live migrations. The value is in MiB/s. |
330 | 3cb9e1fe | Iustin Pop | |
331 | 3cb9e1fe | Iustin Pop | This option is only effective with kvm versions >= 78 and qemu-kvm |
332 | 3cb9e1fe | Iustin Pop | versions >= 0.10.0. |
333 | 3cb9e1fe | Iustin Pop | |
334 | 0a68e0ff | Iustin Pop | The ``-B (--backend-parameters)`` option allows you to set the default |
335 | 3cb9e1fe | Iustin Pop | backend parameters for the cluster. The parameter format is a |
336 | 0a68e0ff | Iustin Pop | comma-separated list of key=value pairs with the following supported |
337 | 0a68e0ff | Iustin Pop | keys: |
338 | 3cb9e1fe | Iustin Pop | |
339 | 3cb9e1fe | Iustin Pop | vcpus |
340 | 3cb9e1fe | Iustin Pop | Number of VCPUs to set for an instance by default, must be an |
341 | 3cb9e1fe | Iustin Pop | integer, will be set to 1 if no specified. |
342 | 3cb9e1fe | Iustin Pop | |
343 | 90bb3fe1 | Guido Trotter | maxmem |
344 | 90bb3fe1 | Guido Trotter | Maximum amount of memory to allocate for an instance by default, can |
345 | 90bb3fe1 | Guido Trotter | be either an integer or an integer followed by a unit (M for |
346 | 90bb3fe1 | Guido Trotter | mebibytes and G for gibibytes are supported), will be set to 128M if |
347 | 90bb3fe1 | Guido Trotter | not specified. |
348 | 90bb3fe1 | Guido Trotter | |
349 | 90bb3fe1 | Guido Trotter | minmem |
350 | 90bb3fe1 | Guido Trotter | Minimum amount of memory to allocate for an instance by default, can |
351 | 90bb3fe1 | Guido Trotter | be either an integer or an integer followed by a unit (M for |
352 | 90bb3fe1 | Guido Trotter | mebibytes and G for gibibytes are supported), will be set to 128M if |
353 | 90bb3fe1 | Guido Trotter | not specified. |
354 | 3cb9e1fe | Iustin Pop | |
355 | 3cb9e1fe | Iustin Pop | auto\_balance |
356 | 3cb9e1fe | Iustin Pop | Value of the auto\_balance flag for instances to use by default, |
357 | 3cb9e1fe | Iustin Pop | will be set to true if not specified. |
358 | 3cb9e1fe | Iustin Pop | |
359 | 11dc66f3 | Bernardo Dal Seno | always\_failover |
360 | 22ac4136 | Michael Hanselmann | Default value for the ``always_failover`` flag for instances; if |
361 | 11dc66f3 | Bernardo Dal Seno | not set, ``False`` is used. |
362 | 11dc66f3 | Bernardo Dal Seno | |
363 | 3cb9e1fe | Iustin Pop | |
364 | 42653ebd | Michael Hanselmann | The ``-N (--nic-parameters)`` option allows you to set the default |
365 | 42653ebd | Michael Hanselmann | network interface parameters for the cluster. The parameter format is a |
366 | 42653ebd | Michael Hanselmann | comma-separated list of key=value pairs with the following supported |
367 | 42653ebd | Michael Hanselmann | keys: |
368 | 3cb9e1fe | Iustin Pop | |
369 | 3cb9e1fe | Iustin Pop | mode |
370 | 42653ebd | Michael Hanselmann | The default NIC mode, one of ``routed``, ``bridged`` or |
371 | 42653ebd | Michael Hanselmann | ``openvswitch``. |
372 | 3cb9e1fe | Iustin Pop | |
373 | 3cb9e1fe | Iustin Pop | link |
374 | 42653ebd | Michael Hanselmann | In ``bridged`` or ``openvswitch`` mode the default interface where |
375 | 42653ebd | Michael Hanselmann | to attach NICs. In ``routed`` mode it represents an |
376 | 42653ebd | Michael Hanselmann | hypervisor-vif-script dependent value to allow different instance |
377 | 42653ebd | Michael Hanselmann | groups. For example under the KVM default network script it is |
378 | 42653ebd | Michael Hanselmann | interpreted as a routing table number or name. Openvswitch support |
379 | 42653ebd | Michael Hanselmann | is also hypervisor dependent and currently works for the default KVM |
380 | 42653ebd | Michael Hanselmann | network script. Under Xen a custom network script must be provided. |
381 | 3cb9e1fe | Iustin Pop | |
382 | a46b1883 | Andrea Spadaccini | The ``-D (--disk-parameters)`` option allows you to set the default disk |
383 | a46b1883 | Andrea Spadaccini | template parameters at cluster level. The format used for this option is |
384 | a46b1883 | Andrea Spadaccini | similar to the one use by the ``-H`` option: the disk template name |
385 | a46b1883 | Andrea Spadaccini | must be specified first, followed by a colon and by a comma-separated |
386 | a46b1883 | Andrea Spadaccini | list of key-value pairs. These parameters can only be specified at |
387 | a46b1883 | Andrea Spadaccini | cluster and node group level; the cluster-level parameter are inherited |
388 | a46b1883 | Andrea Spadaccini | by the node group at the moment of its creation, and can be further |
389 | 354c4f62 | Michael Hanselmann | modified at node group level using the **gnt-group**\(8) command. |
390 | a46b1883 | Andrea Spadaccini | |
391 | 9475189d | Andrea Spadaccini | The following is the list of disk parameters available for the **drbd** |
392 | 9475189d | Andrea Spadaccini | template, with measurement units specified in square brackets at the end |
393 | 9475189d | Andrea Spadaccini | of the description (when applicable): |
394 | a46b1883 | Andrea Spadaccini | |
395 | a46b1883 | Andrea Spadaccini | resync-rate |
396 | 9475189d | Andrea Spadaccini | Static re-synchronization rate. [KiB/s] |
397 | a46b1883 | Andrea Spadaccini | |
398 | a46b1883 | Andrea Spadaccini | data-stripes |
399 | 9475189d | Andrea Spadaccini | Number of stripes to use for data LVs. |
400 | a46b1883 | Andrea Spadaccini | |
401 | a46b1883 | Andrea Spadaccini | meta-stripes |
402 | 9475189d | Andrea Spadaccini | Number of stripes to use for meta LVs. |
403 | a46b1883 | Andrea Spadaccini | |
404 | a46b1883 | Andrea Spadaccini | disk-barriers |
405 | a46b1883 | Andrea Spadaccini | What kind of barriers to **disable** for disks. It can either assume |
406 | a46b1883 | Andrea Spadaccini | the value "n", meaning no barrier disabled, or a non-empty string |
407 | a46b1883 | Andrea Spadaccini | containing a subset of the characters "bfd". "b" means disable disk |
408 | 9475189d | Andrea Spadaccini | barriers, "f" means disable disk flushes, "d" disables disk drains. |
409 | a46b1883 | Andrea Spadaccini | |
410 | a46b1883 | Andrea Spadaccini | meta-barriers |
411 | a46b1883 | Andrea Spadaccini | Boolean value indicating whether the meta barriers should be |
412 | a46b1883 | Andrea Spadaccini | disabled (True) or not (False). |
413 | a46b1883 | Andrea Spadaccini | |
414 | a46b1883 | Andrea Spadaccini | metavg |
415 | a46b1883 | Andrea Spadaccini | String containing the name of the default LVM volume group for DRBD |
416 | a46b1883 | Andrea Spadaccini | metadata. By default, it is set to ``xenvg``. It can be overridden |
417 | a46b1883 | Andrea Spadaccini | during the instance creation process by using the ``metavg`` key of |
418 | a46b1883 | Andrea Spadaccini | the ``--disk`` parameter. |
419 | a46b1883 | Andrea Spadaccini | |
420 | a46b1883 | Andrea Spadaccini | disk-custom |
421 | a46b1883 | Andrea Spadaccini | String containing additional parameters to be appended to the |
422 | a46b1883 | Andrea Spadaccini | arguments list of ``drbdsetup disk``. |
423 | a46b1883 | Andrea Spadaccini | |
424 | a46b1883 | Andrea Spadaccini | net-custom |
425 | a46b1883 | Andrea Spadaccini | String containing additional parameters to be appended to the |
426 | a46b1883 | Andrea Spadaccini | arguments list of ``drbdsetup net``. |
427 | a46b1883 | Andrea Spadaccini | |
428 | 9475189d | Andrea Spadaccini | dynamic-resync |
429 | 9475189d | Andrea Spadaccini | Boolean indicating whether to use the dynamic resync speed |
430 | 9475189d | Andrea Spadaccini | controller or not. If enabled, c-plan-ahead must be non-zero and all |
431 | 9475189d | Andrea Spadaccini | the c-* parameters will be used by DRBD. Otherwise, the value of |
432 | 9475189d | Andrea Spadaccini | resync-rate will be used as a static resync speed. |
433 | 9475189d | Andrea Spadaccini | |
434 | 9475189d | Andrea Spadaccini | c-plan-ahead |
435 | 9475189d | Andrea Spadaccini | Agility factor of the dynamic resync speed controller. (the higher, |
436 | 9475189d | Andrea Spadaccini | the slower the algorithm will adapt the resync speed). A value of 0 |
437 | 9475189d | Andrea Spadaccini | (that is the default) disables the controller. [ds] |
438 | 9475189d | Andrea Spadaccini | |
439 | 9475189d | Andrea Spadaccini | c-fill-target |
440 | 9475189d | Andrea Spadaccini | Maximum amount of in-flight resync data for the dynamic resync speed |
441 | 9475189d | Andrea Spadaccini | controller. [sectors] |
442 | 9475189d | Andrea Spadaccini | |
443 | 9475189d | Andrea Spadaccini | c-delay-target |
444 | 9475189d | Andrea Spadaccini | Maximum estimated peer response latency for the dynamic resync speed |
445 | 9475189d | Andrea Spadaccini | controller. [ds] |
446 | 9475189d | Andrea Spadaccini | |
447 | 9475189d | Andrea Spadaccini | c-min-rate |
448 | 9475189d | Andrea Spadaccini | Minimum resync speed for the dynamic resync speed controller. [KiB/s] |
449 | 9475189d | Andrea Spadaccini | |
450 | 9475189d | Andrea Spadaccini | c-max-rate |
451 | 9475189d | Andrea Spadaccini | Upper bound on resync speed for the dynamic resync speed controller. |
452 | 9475189d | Andrea Spadaccini | [KiB/s] |
453 | 9475189d | Andrea Spadaccini | |
454 | a46b1883 | Andrea Spadaccini | List of parameters available for the **plain** template: |
455 | a46b1883 | Andrea Spadaccini | |
456 | a46b1883 | Andrea Spadaccini | stripes |
457 | 9475189d | Andrea Spadaccini | Number of stripes to use for new LVs. |
458 | a46b1883 | Andrea Spadaccini | |
459 | 7ed400f0 | Stratos Psomadakis | List of parameters available for the **rbd** template: |
460 | 7ed400f0 | Stratos Psomadakis | |
461 | 7ed400f0 | Stratos Psomadakis | pool |
462 | 7ed400f0 | Stratos Psomadakis | The RADOS cluster pool, inside which all rbd volumes will reside. |
463 | 7ed400f0 | Stratos Psomadakis | When a new RADOS cluster is deployed, the default pool to put rbd |
464 | 7ed400f0 | Stratos Psomadakis | volumes (Images in RADOS terminology) is 'rbd'. |
465 | 7ed400f0 | Stratos Psomadakis | |
466 | f7b769b1 | Iustin Pop | The option ``--maintain-node-health`` allows one to enable/disable |
467 | 3cb9e1fe | Iustin Pop | automatic maintenance actions on nodes. Currently these include |
468 | 3cb9e1fe | Iustin Pop | automatic shutdown of instances and deactivation of DRBD devices on |
469 | 3cb9e1fe | Iustin Pop | offline nodes; in the future it might be extended to automatic |
470 | d29036c1 | Iustin Pop | removal of unknown LVM volumes, etc. Note that this option is only |
471 | d29036c1 | Iustin Pop | useful if the use of ``ganeti-confd`` was enabled at compilation. |
472 | 3cb9e1fe | Iustin Pop | |
473 | 3cb9e1fe | Iustin Pop | The ``--uid-pool`` option initializes the user-id pool. The |
474 | 3cb9e1fe | Iustin Pop | *user-id pool definition* can contain a list of user-ids and/or a |
475 | 3cb9e1fe | Iustin Pop | list of user-id ranges. The parameter format is a comma-separated |
476 | 3cb9e1fe | Iustin Pop | list of numeric user-ids or user-id ranges. The ranges are defined |
477 | 3cb9e1fe | Iustin Pop | by a lower and higher boundary, separated by a dash. The boundaries |
478 | 3cb9e1fe | Iustin Pop | are inclusive. If the ``--uid-pool`` option is not supplied, the |
479 | 3cb9e1fe | Iustin Pop | user-id pool is initialized to an empty list. An empty list means |
480 | 3cb9e1fe | Iustin Pop | that the user-id pool feature is disabled. |
481 | 3cb9e1fe | Iustin Pop | |
482 | 3cb9e1fe | Iustin Pop | The ``-I (--default-iallocator)`` option specifies the default |
483 | d1e9c98d | Iustin Pop | instance allocator. The instance allocator will be used for operations |
484 | d1e9c98d | Iustin Pop | like instance creation, instance and node migration, etc. when no |
485 | d1e9c98d | Iustin Pop | manual override is specified. If this option is not specified and |
486 | d1e9c98d | Iustin Pop | htools was not enabled at build time, the default instance allocator |
487 | d1e9c98d | Iustin Pop | will be blank, which means that relevant operations will require the |
488 | d1e9c98d | Iustin Pop | administrator to manually specify either an instance allocator, or a |
489 | d1e9c98d | Iustin Pop | set of nodes. If the option is not specified but htools was enabled, |
490 | 354c4f62 | Michael Hanselmann | the default iallocator will be **hail**\(1) (assuming it can be found |
491 | d1e9c98d | Iustin Pop | on disk). The default iallocator can be changed later using the |
492 | d1e9c98d | Iustin Pop | **modify** command. |
493 | 3cb9e1fe | Iustin Pop | |
494 | 3cb9e1fe | Iustin Pop | The ``--primary-ip-version`` option specifies the IP version used |
495 | 3cb9e1fe | Iustin Pop | for the primary address. Possible values are 4 and 6 for IPv4 and |
496 | 3cb9e1fe | Iustin Pop | IPv6, respectively. This option is used when resolving node names |
497 | 3cb9e1fe | Iustin Pop | and the cluster name. |
498 | 3cb9e1fe | Iustin Pop | |
499 | 6204ee71 | René Nussbaumer | The ``--node-parameters`` option allows you to set default node |
500 | 354c4f62 | Michael Hanselmann | parameters for the cluster. Please see **ganeti**\(7) for more |
501 | 6204ee71 | René Nussbaumer | information about supported key=value pairs. |
502 | 6204ee71 | René Nussbaumer | |
503 | 0a68e0ff | Iustin Pop | The ``-C (--candidate-pool-size)`` option specifies the |
504 | 0a68e0ff | Iustin Pop | ``candidate_pool_size`` cluster parameter. This is the number of nodes |
505 | 0a68e0ff | Iustin Pop | that the master will try to keep as master\_candidates. For more |
506 | 354c4f62 | Michael Hanselmann | details about this role and other node roles, see the **ganeti**\(7). |
507 | 0a68e0ff | Iustin Pop | |
508 | d307d38c | Bernardo Dal Seno | The ``--specs-...`` and ``--ipolicy-...`` options specify the instance |
509 | d2d3935a | Bernardo Dal Seno | policy on the cluster. The ``--ipolicy-bounds-specs`` option sets the |
510 | d2d3935a | Bernardo Dal Seno | minimum and maximum specifications for instances. The format is: |
511 | ef99e3e8 | Bernardo Dal Seno | min:*param*=*value*,.../max:*param*=*value*,... and further |
512 | ef99e3e8 | Bernardo Dal Seno | specifications pairs can be added by using ``//`` as a separator. The |
513 | d2d3935a | Bernardo Dal Seno | ``--ipolicy-std-specs`` option takes a list of parameter/value pairs. |
514 | d2d3935a | Bernardo Dal Seno | For both options, *param* can be: |
515 | d2d3935a | Bernardo Dal Seno | |
516 | d2d3935a | Bernardo Dal Seno | - ``cpu-count``: number of VCPUs for an instance |
517 | d2d3935a | Bernardo Dal Seno | - ``disk-count``: number of disk for an instance |
518 | d2d3935a | Bernardo Dal Seno | - ``disk-size``: size of each disk |
519 | d2d3935a | Bernardo Dal Seno | - ``memory-size``: instance memory |
520 | d2d3935a | Bernardo Dal Seno | - ``nic-count``: number of network interface |
521 | d2d3935a | Bernardo Dal Seno | - ``spindle-use``: spindle usage for an instance |
522 | d2d3935a | Bernardo Dal Seno | |
523 | d2d3935a | Bernardo Dal Seno | For the ``--specs-...`` options, each option can have three values: |
524 | d2d3935a | Bernardo Dal Seno | ``min``, ``max`` and ``std``, which can also be modified on group level |
525 | d2d3935a | Bernardo Dal Seno | (except for ``std``, which is defined once for the entire cluster). |
526 | d2d3935a | Bernardo Dal Seno | Please note, that ``std`` values are not the same as defaults set by |
527 | d2d3935a | Bernardo Dal Seno | ``--beparams``, but they are used for the capacity calculations. |
528 | 0ce212e5 | Iustin Pop | |
529 | 0ce212e5 | Iustin Pop | - ``--specs-cpu-count`` limits the number of VCPUs that can be used by an |
530 | 0ce212e5 | Iustin Pop | instance. |
531 | 0ce212e5 | Iustin Pop | - ``--specs-disk-count`` limits the number of disks |
532 | 0ce212e5 | Iustin Pop | - ``--specs-disk-size`` limits the disk size for every disk used |
533 | 0ce212e5 | Iustin Pop | - ``--specs-mem-size`` limits the amount of memory available |
534 | 0ce212e5 | Iustin Pop | - ``--specs-nic-count`` sets limits on the number of NICs used |
535 | d2d3935a | Bernardo Dal Seno | |
536 | d2d3935a | Bernardo Dal Seno | The ``--ipolicy-disk-templates`` and ``--ipolicy-spindle-ratio`` options |
537 | d2d3935a | Bernardo Dal Seno | take a decimal number. The ``--ipolicy-disk-templates`` option takes a |
538 | d2d3935a | Bernardo Dal Seno | comma-separated list of disk templates. |
539 | d2d3935a | Bernardo Dal Seno | |
540 | 75c7a686 | Bernardo Dal Seno | - ``--ipolicy-disk-templates`` limits the allowed disk templates |
541 | d307d38c | Bernardo Dal Seno | - ``--ipolicy-spindle-ratio`` limits the instances-spindles ratio |
542 | d307d38c | Bernardo Dal Seno | - ``--ipolicy-vcpu-ratio`` limits the vcpu-cpu ratio |
543 | e37c5129 | Agata Murawska | |
544 | 919db916 | Bernardo Dal Seno | All the instance policy elements can be overridden at group level. Group |
545 | 919db916 | Bernardo Dal Seno | level overrides can be removed by specifying ``default`` as the value of |
546 | 919db916 | Bernardo Dal Seno | an item. |
547 | 919db916 | Bernardo Dal Seno | |
548 | c4929a8b | René Nussbaumer | For details about how to use ``--hypervisor-state`` and ``--disk-state`` |
549 | 354c4f62 | Michael Hanselmann | have a look at **ganeti**\(7). |
550 | c4929a8b | René Nussbaumer | |
551 | 5914192c | Helga Velroyen | The ``--enabled-disk-templates`` option specifies a list of disk templates |
552 | 5914192c | Helga Velroyen | that can be used by instances of the cluster. For the possible values in |
553 | 5914192c | Helga Velroyen | this list, see **gnt-instance**\(8). Note that in contrast to the list of |
554 | 5914192c | Helga Velroyen | disk templates in the ipolicy, this list is a hard restriction. It is not |
555 | 5914192c | Helga Velroyen | possible to create instances with disk templates that are not enabled in |
556 | 5914192c | Helga Velroyen | the cluster. It is also not possible to disable a disk template when there |
557 | 5914192c | Helga Velroyen | are still instances using it. |
558 | 5914192c | Helga Velroyen | |
559 | 3cb9e1fe | Iustin Pop | MASTER-FAILOVER |
560 | 3cb9e1fe | Iustin Pop | ~~~~~~~~~~~~~~~ |
561 | 3cb9e1fe | Iustin Pop | |
562 | dc1e9a74 | Iustin Pop | **master-failover** [\--no-voting] [\--yes-do-it] |
563 | 3cb9e1fe | Iustin Pop | |
564 | 3cb9e1fe | Iustin Pop | Failover the master role to the current node. |
565 | 3cb9e1fe | Iustin Pop | |
566 | 3cb9e1fe | Iustin Pop | The ``--no-voting`` option skips the remote node agreement checks. |
567 | 3cb9e1fe | Iustin Pop | This is dangerous, but necessary in some cases (for example failing |
568 | 3cb9e1fe | Iustin Pop | over the master role in a 2 node cluster with the original master |
569 | 3cb9e1fe | Iustin Pop | down). If the original master then comes up, it won't be able to |
570 | 3cb9e1fe | Iustin Pop | start its master daemon because it won't have enough votes, but so |
571 | 3cb9e1fe | Iustin Pop | won't the new master, if the master daemon ever needs a restart. |
572 | 3cb9e1fe | Iustin Pop | You can pass ``--no-voting`` to **ganeti-masterd** on the new |
573 | 3cb9e1fe | Iustin Pop | master to solve this problem, and run **gnt-cluster redist-conf** |
574 | 3cb9e1fe | Iustin Pop | to make sure the cluster is consistent again. |
575 | 3cb9e1fe | Iustin Pop | |
576 | dc1e9a74 | Iustin Pop | The option ``--yes-do-it`` is used together with ``--no-voting``, for |
577 | dc1e9a74 | Iustin Pop | skipping the interactive checks. This is even more dangerous, and should |
578 | dc1e9a74 | Iustin Pop | only be used in conjunction with other means (e.g. a HA suite) to |
579 | dc1e9a74 | Iustin Pop | confirm that the operation is indeed safe. |
580 | dc1e9a74 | Iustin Pop | |
581 | 3cb9e1fe | Iustin Pop | MASTER-PING |
582 | 3cb9e1fe | Iustin Pop | ~~~~~~~~~~~ |
583 | 3cb9e1fe | Iustin Pop | |
584 | 3cb9e1fe | Iustin Pop | **master-ping** |
585 | 3cb9e1fe | Iustin Pop | |
586 | 3cb9e1fe | Iustin Pop | Checks if the master daemon is alive. |
587 | 3cb9e1fe | Iustin Pop | |
588 | 3cb9e1fe | Iustin Pop | If the master daemon is alive and can respond to a basic query (the |
589 | 3cb9e1fe | Iustin Pop | equivalent of **gnt-cluster info**), then the exit code of the |
590 | 3cb9e1fe | Iustin Pop | command will be 0. If the master daemon is not alive (either due to |
591 | 3cb9e1fe | Iustin Pop | a crash or because this is not the master node), the exit code will |
592 | 3cb9e1fe | Iustin Pop | be 1. |
593 | 3cb9e1fe | Iustin Pop | |
594 | 3cb9e1fe | Iustin Pop | MODIFY |
595 | 3cb9e1fe | Iustin Pop | ~~~~~~ |
596 | 3cb9e1fe | Iustin Pop | |
597 | 745dae57 | Michael Hanselmann | | **modify** [\--submit] |
598 | 2f836021 | Klaus Aehlig | | [\--force] |
599 | e8f936b0 | Iustin Pop | | [\--vg-name *vg-name*] |
600 | e8f936b0 | Iustin Pop | | [\--no-lvm-storage] |
601 | e8f936b0 | Iustin Pop | | [\--enabled-hypervisors *hypervisors*] |
602 | e8f936b0 | Iustin Pop | | [{-H|\--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]] |
603 | e8f936b0 | Iustin Pop | | [{-B|\--backend-parameters} *be-param*=*value*[,*be-param*=*value*...]] |
604 | e8f936b0 | Iustin Pop | | [{-N|\--nic-parameters} *nic-param*=*value*[,*nic-param*=*value*...]] |
605 | e8f936b0 | Iustin Pop | | [{-D|\--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]] |
606 | e8f936b0 | Iustin Pop | | [\--uid-pool *user-id pool definition*] |
607 | e8f936b0 | Iustin Pop | | [\--add-uids *user-id pool definition*] |
608 | e8f936b0 | Iustin Pop | | [\--remove-uids *user-id pool definition*] |
609 | e8f936b0 | Iustin Pop | | [{-C|\--candidate-pool-size} *candidate\_pool\_size*] |
610 | e8f936b0 | Iustin Pop | | [\--maintain-node-health {yes \| no}] |
611 | e8f936b0 | Iustin Pop | | [\--prealloc-wipe-disks {yes \| no}] |
612 | e8f936b0 | Iustin Pop | | [{-I|\--default-iallocator} *default instance allocator*] |
613 | e8f936b0 | Iustin Pop | | [\--reserved-lvs=*NAMES*] |
614 | e8f936b0 | Iustin Pop | | [\--node-parameters *ndparams*] |
615 | e8f936b0 | Iustin Pop | | [\--master-netdev *interface-name*] |
616 | e8f936b0 | Iustin Pop | | [\--master-netmask *netmask*] |
617 | e8f936b0 | Iustin Pop | | [\--use-external-mip-script {yes \| no}] |
618 | e8f936b0 | Iustin Pop | | [\--hypervisor-state *hvstate*] |
619 | e8f936b0 | Iustin Pop | | [\--disk-state *diskstate*] |
620 | d2d3935a | Bernardo Dal Seno | | [\--ipolicy-std-specs *spec*=*value* [,*spec*=*value*...]] |
621 | d2d3935a | Bernardo Dal Seno | | [\--ipolicy-bounds-specs *bounds_ispecs*] |
622 | 75c7a686 | Bernardo Dal Seno | | [\--ipolicy-disk-templates *template* [,*template*...]] |
623 | d307d38c | Bernardo Dal Seno | | [\--ipolicy-spindle-ratio *ratio*] |
624 | d307d38c | Bernardo Dal Seno | | [\--ipolicy-vcpu-ratio *ratio*] |
625 | 5914192c | Helga Velroyen | | [\--enabled-disk-templates *template* [,*template*...]] |
626 | e37c5129 | Agata Murawska | |
627 | 3cb9e1fe | Iustin Pop | |
628 | 3cb9e1fe | Iustin Pop | Modify the options for the cluster. |
629 | 3cb9e1fe | Iustin Pop | |
630 | 75c7a686 | Bernardo Dal Seno | The ``--vg-name``, ``--no-lvm-storage``, ``--enabled-hypervisors``, |
631 | 0a68e0ff | Iustin Pop | ``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)``, |
632 | a46b1883 | Andrea Spadaccini | ``-D (--disk-parameters)``, ``--nic-parameters``, ``-C |
633 | a46b1883 | Andrea Spadaccini | (--candidate-pool-size)``, ``--maintain-node-health``, |
634 | a46b1883 | Andrea Spadaccini | ``--prealloc-wipe-disks``, ``--uid-pool``, ``--node-parameters``, |
635 | 5914192c | Helga Velroyen | ``--master-netdev``, ``--master-netmask``, ``--use-external-mip-script``, |
636 | 5914192c | Helga Velroyen | and ``--enabled-disk-templates`` options are described in the **init** |
637 | a46b1883 | Andrea Spadaccini | command. |
638 | 3cb9e1fe | Iustin Pop | |
639 | 2da9f556 | René Nussbaumer | The ``--hypervisor-state`` and ``--disk-state`` options are described in |
640 | 354c4f62 | Michael Hanselmann | detail in **ganeti**\(7). |
641 | 2da9f556 | René Nussbaumer | |
642 | 3cb9e1fe | Iustin Pop | The ``--add-uids`` and ``--remove-uids`` options can be used to |
643 | 3cb9e1fe | Iustin Pop | modify the user-id pool by adding/removing a list of user-ids or |
644 | 3cb9e1fe | Iustin Pop | user-id ranges. |
645 | 3cb9e1fe | Iustin Pop | |
646 | 3cb9e1fe | Iustin Pop | The option ``--reserved-lvs`` specifies a list (comma-separated) of |
647 | 3cb9e1fe | Iustin Pop | logical volume group names (regular expressions) that will be |
648 | 3cb9e1fe | Iustin Pop | ignored by the cluster verify operation. This is useful if the |
649 | 3cb9e1fe | Iustin Pop | volume group used for Ganeti is shared with the system for other |
650 | 3cb9e1fe | Iustin Pop | uses. Note that it's not recommended to create and mark as ignored |
651 | 3cb9e1fe | Iustin Pop | logical volume names which match Ganeti's own name format (starting |
652 | 3cb9e1fe | Iustin Pop | with UUID and then .diskN), as this option only skips the |
653 | 3cb9e1fe | Iustin Pop | verification, but not the actual use of the names given. |
654 | 3cb9e1fe | Iustin Pop | |
655 | 3cb9e1fe | Iustin Pop | To remove all reserved logical volumes, pass in an empty argument |
656 | 3cb9e1fe | Iustin Pop | to the option, as in ``--reserved-lvs=`` or ``--reserved-lvs ''``. |
657 | 3cb9e1fe | Iustin Pop | |
658 | 0a68e0ff | Iustin Pop | The ``-I (--default-iallocator)`` is described in the **init** |
659 | 0a68e0ff | Iustin Pop | command. To clear the default iallocator, just pass an empty string |
660 | 0a68e0ff | Iustin Pop | (''). |
661 | 3cb9e1fe | Iustin Pop | |
662 | 919db916 | Bernardo Dal Seno | The ``--ipolicy-...`` options are described in the **init** command. |
663 | e37c5129 | Agata Murawska | |
664 | 354c4f62 | Michael Hanselmann | See **ganeti**\(7) for a description of ``--submit`` and other common |
665 | 745dae57 | Michael Hanselmann | options. |
666 | 745dae57 | Michael Hanselmann | |
667 | 3cb9e1fe | Iustin Pop | QUEUE |
668 | 3cb9e1fe | Iustin Pop | ~~~~~ |
669 | 3cb9e1fe | Iustin Pop | |
670 | 3cb9e1fe | Iustin Pop | **queue** {drain | undrain | info} |
671 | 3cb9e1fe | Iustin Pop | |
672 | 3cb9e1fe | Iustin Pop | Change job queue properties. |
673 | 3cb9e1fe | Iustin Pop | |
674 | 3cb9e1fe | Iustin Pop | The ``drain`` option sets the drain flag on the job queue. No new |
675 | 3cb9e1fe | Iustin Pop | jobs will be accepted, but jobs already in the queue will be |
676 | 3cb9e1fe | Iustin Pop | processed. |
677 | 3cb9e1fe | Iustin Pop | |
678 | 3cb9e1fe | Iustin Pop | The ``undrain`` will unset the drain flag on the job queue. New |
679 | 3cb9e1fe | Iustin Pop | jobs will be accepted. |
680 | 3cb9e1fe | Iustin Pop | |
681 | 3cb9e1fe | Iustin Pop | The ``info`` option shows the properties of the job queue. |
682 | 3cb9e1fe | Iustin Pop | |
683 | 3cb9e1fe | Iustin Pop | WATCHER |
684 | 3cb9e1fe | Iustin Pop | ~~~~~~~ |
685 | 3cb9e1fe | Iustin Pop | |
686 | 3cb9e1fe | Iustin Pop | **watcher** {pause *duration* | continue | info} |
687 | 3cb9e1fe | Iustin Pop | |
688 | 3cb9e1fe | Iustin Pop | Make the watcher pause or let it continue. |
689 | 3cb9e1fe | Iustin Pop | |
690 | 3cb9e1fe | Iustin Pop | The ``pause`` option causes the watcher to pause for *duration* |
691 | 3cb9e1fe | Iustin Pop | seconds. |
692 | 3cb9e1fe | Iustin Pop | |
693 | 3cb9e1fe | Iustin Pop | The ``continue`` option will let the watcher continue. |
694 | 3cb9e1fe | Iustin Pop | |
695 | 3cb9e1fe | Iustin Pop | The ``info`` option shows whether the watcher is currently paused. |
696 | 3cb9e1fe | Iustin Pop | |
697 | 3bc145d8 | Bernardo Dal Seno | REDIST-CONF |
698 | 3cb9e1fe | Iustin Pop | ~~~~~~~~~~~ |
699 | 3cb9e1fe | Iustin Pop | |
700 | e8f936b0 | Iustin Pop | **redist-conf** [\--submit] |
701 | 3cb9e1fe | Iustin Pop | |
702 | 3cb9e1fe | Iustin Pop | This command forces a full push of configuration files from the |
703 | 3cb9e1fe | Iustin Pop | master node to the other nodes in the cluster. This is normally not |
704 | 3cb9e1fe | Iustin Pop | needed, but can be run if the **verify** complains about |
705 | 3cb9e1fe | Iustin Pop | configuration mismatches. |
706 | 3cb9e1fe | Iustin Pop | |
707 | 354c4f62 | Michael Hanselmann | See **ganeti**\(7) for a description of ``--submit`` and other common |
708 | 13ddcb50 | Michael Hanselmann | options. |
709 | 3cb9e1fe | Iustin Pop | |
710 | 3cb9e1fe | Iustin Pop | RENAME |
711 | 3cb9e1fe | Iustin Pop | ~~~~~~ |
712 | 3cb9e1fe | Iustin Pop | |
713 | 3cb9e1fe | Iustin Pop | **rename** [-f] {*name*} |
714 | 3cb9e1fe | Iustin Pop | |
715 | 3cb9e1fe | Iustin Pop | Renames the cluster and in the process updates the master IP |
716 | 3cb9e1fe | Iustin Pop | address to the one the new name resolves to. At least one of either |
717 | 3cb9e1fe | Iustin Pop | the name or the IP address must be different, otherwise the |
718 | 3cb9e1fe | Iustin Pop | operation will be aborted. |
719 | 3cb9e1fe | Iustin Pop | |
720 | 3cb9e1fe | Iustin Pop | Note that since this command can be dangerous (especially when run |
721 | 3cb9e1fe | Iustin Pop | over SSH), the command will require confirmation unless run with |
722 | 3cb9e1fe | Iustin Pop | the ``-f`` option. |
723 | 3cb9e1fe | Iustin Pop | |
724 | 3cb9e1fe | Iustin Pop | RENEW-CRYPTO |
725 | 3cb9e1fe | Iustin Pop | ~~~~~~~~~~~~ |
726 | 3cb9e1fe | Iustin Pop | |
727 | 3cb9e1fe | Iustin Pop | | **renew-crypto** [-f] |
728 | e8f936b0 | Iustin Pop | | [\--new-cluster-certificate] [\--new-confd-hmac-key] |
729 | e8f936b0 | Iustin Pop | | [\--new-rapi-certificate] [\--rapi-certificate *rapi-cert*] |
730 | e8f936b0 | Iustin Pop | | [\--new-spice-certificate | \--spice-certificate *spice-cert* |
731 | e8f936b0 | Iustin Pop | | \--spice-ca-certificate *spice-ca-cert*] |
732 | e8f936b0 | Iustin Pop | | [\--new-cluster-domain-secret] [\--cluster-domain-secret *filename*] |
733 | 3cb9e1fe | Iustin Pop | |
734 | 3cb9e1fe | Iustin Pop | This command will stop all Ganeti daemons in the cluster and start |
735 | 3cb9e1fe | Iustin Pop | them again once the new certificates and keys are replicated. The |
736 | 3cb9e1fe | Iustin Pop | options ``--new-cluster-certificate`` and ``--new-confd-hmac-key`` |
737 | 2707f483 | Guido Trotter | can be used to regenerate respectively the cluster-internal SSL |
738 | 2707f483 | Guido Trotter | certificate and the HMAC key used by **ganeti-confd**\(8). |
739 | 3cb9e1fe | Iustin Pop | |
740 | 3cb9e1fe | Iustin Pop | To generate a new self-signed RAPI certificate (used by |
741 | 354c4f62 | Michael Hanselmann | **ganeti-rapi**\(8)) specify ``--new-rapi-certificate``. If you want to |
742 | 3cb9e1fe | Iustin Pop | use your own certificate, e.g. one signed by a certificate |
743 | 3cb9e1fe | Iustin Pop | authority (CA), pass its filename to ``--rapi-certificate``. |
744 | 3cb9e1fe | Iustin Pop | |
745 | 2707f483 | Guido Trotter | To generate a new self-signed SPICE certificate, used for SPICE |
746 | b8a10435 | Andrea Spadaccini | connections to the KVM hypervisor, specify the |
747 | b8a10435 | Andrea Spadaccini | ``--new-spice-certificate`` option. If you want to provide a |
748 | b8a10435 | Andrea Spadaccini | certificate, pass its filename to ``--spice-certificate`` and pass the |
749 | b8a10435 | Andrea Spadaccini | signing CA certificate to ``--spice-ca-certificate``. |
750 | b8a10435 | Andrea Spadaccini | |
751 | 2707f483 | Guido Trotter | Finally ``--new-cluster-domain-secret`` generates a new, random |
752 | 2707f483 | Guido Trotter | cluster domain secret, and ``--cluster-domain-secret`` reads the |
753 | 2707f483 | Guido Trotter | secret from a file. The cluster domain secret is used to sign |
754 | 2707f483 | Guido Trotter | information exchanged between separate clusters via a third party. |
755 | 3cb9e1fe | Iustin Pop | |
756 | 3cb9e1fe | Iustin Pop | REPAIR-DISK-SIZES |
757 | 3cb9e1fe | Iustin Pop | ~~~~~~~~~~~~~~~~~ |
758 | 3cb9e1fe | Iustin Pop | |
759 | 3cb9e1fe | Iustin Pop | **repair-disk-sizes** [instance...] |
760 | 3cb9e1fe | Iustin Pop | |
761 | 3cb9e1fe | Iustin Pop | This command checks that the recorded size of the given instance's |
762 | 3cb9e1fe | Iustin Pop | disks matches the actual size and updates any mismatches found. |
763 | 3cb9e1fe | Iustin Pop | This is needed if the Ganeti configuration is no longer consistent |
764 | 3cb9e1fe | Iustin Pop | with reality, as it will impact some disk operations. If no |
765 | 3cb9e1fe | Iustin Pop | arguments are given, all instances will be checked. |
766 | 3cb9e1fe | Iustin Pop | |
767 | 3cb9e1fe | Iustin Pop | Note that only active disks can be checked by this command; in case |
768 | 3cb9e1fe | Iustin Pop | a disk cannot be activated it's advised to use |
769 | e8f936b0 | Iustin Pop | **gnt-instance activate-disks \--ignore-size ...** to force |
770 | 3cb9e1fe | Iustin Pop | activation without regard to the current size. |
771 | 3cb9e1fe | Iustin Pop | |
772 | 3cb9e1fe | Iustin Pop | When the all disk sizes are consistent, the command will return no |
773 | 3cb9e1fe | Iustin Pop | output. Otherwise it will log details about the inconsistencies in |
774 | 3cb9e1fe | Iustin Pop | the configuration. |
775 | 3cb9e1fe | Iustin Pop | |
776 | 3cb9e1fe | Iustin Pop | VERIFY |
777 | 3cb9e1fe | Iustin Pop | ~~~~~~ |
778 | 3cb9e1fe | Iustin Pop | |
779 | e8f936b0 | Iustin Pop | | **verify** [\--no-nplus1-mem] [\--node-group *nodegroup*] |
780 | e8f936b0 | Iustin Pop | | [\--error-codes] [{-I|\--ignore-errors} *errorcode*] |
781 | e8f936b0 | Iustin Pop | | [{-I|\--ignore-errors} *errorcode*...] |
782 | 3cb9e1fe | Iustin Pop | |
783 | 3cb9e1fe | Iustin Pop | Verify correctness of cluster configuration. This is safe with |
784 | 3cb9e1fe | Iustin Pop | respect to running instances, and incurs no downtime of the |
785 | 3cb9e1fe | Iustin Pop | instances. |
786 | 3cb9e1fe | Iustin Pop | |
787 | 3cb9e1fe | Iustin Pop | If the ``--no-nplus1-mem`` option is given, Ganeti won't check |
788 | 3cb9e1fe | Iustin Pop | whether if it loses a node it can restart all the instances on |
789 | 3cb9e1fe | Iustin Pop | their secondaries (and report an error otherwise). |
790 | 3cb9e1fe | Iustin Pop | |
791 | 40167d65 | Adeodato Simo | With ``--node-group``, restrict the verification to those nodes and |
792 | 40167d65 | Adeodato Simo | instances that live in the named group. This will not verify global |
793 | 40167d65 | Adeodato Simo | settings, but will allow to perform verification of a group while other |
794 | 40167d65 | Adeodato Simo | operations are ongoing in other groups. |
795 | 40167d65 | Adeodato Simo | |
796 | 830fc5da | Andrea Spadaccini | The ``--error-codes`` option outputs each error in the following |
797 | 830fc5da | Andrea Spadaccini | parseable format: *ftype*:*ecode*:*edomain*:*name*:*msg*. |
798 | 830fc5da | Andrea Spadaccini | These fields have the following meaning: |
799 | 830fc5da | Andrea Spadaccini | |
800 | 830fc5da | Andrea Spadaccini | ftype |
801 | 830fc5da | Andrea Spadaccini | Failure type. Can be *WARNING* or *ERROR*. |
802 | 830fc5da | Andrea Spadaccini | |
803 | 830fc5da | Andrea Spadaccini | ecode |
804 | 830fc5da | Andrea Spadaccini | Error code of the failure. See below for a list of error codes. |
805 | 830fc5da | Andrea Spadaccini | |
806 | 830fc5da | Andrea Spadaccini | edomain |
807 | 830fc5da | Andrea Spadaccini | Can be *cluster*, *node* or *instance*. |
808 | 830fc5da | Andrea Spadaccini | |
809 | 830fc5da | Andrea Spadaccini | name |
810 | 830fc5da | Andrea Spadaccini | Contains the name of the item that is affected from the failure. |
811 | 830fc5da | Andrea Spadaccini | |
812 | 830fc5da | Andrea Spadaccini | msg |
813 | 830fc5da | Andrea Spadaccini | Contains a descriptive error message about the error |
814 | 830fc5da | Andrea Spadaccini | |
815 | 830fc5da | Andrea Spadaccini | ``gnt-cluster verify`` will have a non-zero exit code if at least one of |
816 | 830fc5da | Andrea Spadaccini | the failures that are found are of type *ERROR*. |
817 | 830fc5da | Andrea Spadaccini | |
818 | 830fc5da | Andrea Spadaccini | The ``--ignore-errors`` option can be used to change this behaviour, |
819 | 830fc5da | Andrea Spadaccini | because it demotes the error represented by the error code received as a |
820 | 830fc5da | Andrea Spadaccini | parameter to a warning. The option must be repeated for each error that |
821 | 830fc5da | Andrea Spadaccini | should be ignored (e.g.: ``-I ENODEVERSION -I ENODEORPHANLV``). The |
822 | 830fc5da | Andrea Spadaccini | ``--error-codes`` option can be used to determine the error code of a |
823 | 830fc5da | Andrea Spadaccini | given error. |
824 | 830fc5da | Andrea Spadaccini | |
825 | 830fc5da | Andrea Spadaccini | List of error codes: |
826 | 830fc5da | Andrea Spadaccini | |
827 | 830fc5da | Andrea Spadaccini | @CONSTANTS_ECODES@ |
828 | 830fc5da | Andrea Spadaccini | |
829 | 3cb9e1fe | Iustin Pop | VERIFY-DISKS |
830 | 3cb9e1fe | Iustin Pop | ~~~~~~~~~~~~ |
831 | 3cb9e1fe | Iustin Pop | |
832 | 3cb9e1fe | Iustin Pop | **verify-disks** |
833 | 3cb9e1fe | Iustin Pop | |
834 | 3cb9e1fe | Iustin Pop | The command checks which instances have degraded DRBD disks and |
835 | 3cb9e1fe | Iustin Pop | activates the disks of those instances. |
836 | 3cb9e1fe | Iustin Pop | |
837 | 3cb9e1fe | Iustin Pop | This command is run from the **ganeti-watcher** tool, which also |
838 | 3cb9e1fe | Iustin Pop | has a different, complementary algorithm for doing this check. |
839 | 3cb9e1fe | Iustin Pop | Together, these two should ensure that DRBD disks are kept |
840 | 3cb9e1fe | Iustin Pop | consistent. |
841 | 3cb9e1fe | Iustin Pop | |
842 | 3cb9e1fe | Iustin Pop | VERSION |
843 | 3cb9e1fe | Iustin Pop | ~~~~~~~ |
844 | 3cb9e1fe | Iustin Pop | |
845 | 3cb9e1fe | Iustin Pop | **version** |
846 | 3cb9e1fe | Iustin Pop | |
847 | 3cb9e1fe | Iustin Pop | Show the cluster version. |
848 | 9ff4f2c0 | Michael Hanselmann | |
849 | 7322bf7b | Iustin Pop | Tags |
850 | 7322bf7b | Iustin Pop | ~~~~ |
851 | 7322bf7b | Iustin Pop | |
852 | 7322bf7b | Iustin Pop | ADD-TAGS |
853 | 7322bf7b | Iustin Pop | ^^^^^^^^ |
854 | 7322bf7b | Iustin Pop | |
855 | 7322bf7b | Iustin Pop | **add-tags** [\--from *file*] {*tag*...} |
856 | 7322bf7b | Iustin Pop | |
857 | 7322bf7b | Iustin Pop | Add tags to the cluster. If any of the tags contains invalid |
858 | 7322bf7b | Iustin Pop | characters, the entire operation will abort. |
859 | 7322bf7b | Iustin Pop | |
860 | 7322bf7b | Iustin Pop | If the ``--from`` option is given, the list of tags will be |
861 | 7322bf7b | Iustin Pop | extended with the contents of that file (each line becomes a tag). |
862 | 7322bf7b | Iustin Pop | In this case, there is not need to pass tags on the command line |
863 | 7322bf7b | Iustin Pop | (if you do, both sources will be used). A file name of - will be |
864 | 7322bf7b | Iustin Pop | interpreted as stdin. |
865 | 7322bf7b | Iustin Pop | |
866 | 7322bf7b | Iustin Pop | LIST-TAGS |
867 | 7322bf7b | Iustin Pop | ^^^^^^^^^ |
868 | 7322bf7b | Iustin Pop | |
869 | 7322bf7b | Iustin Pop | **list-tags** |
870 | 7322bf7b | Iustin Pop | |
871 | 7322bf7b | Iustin Pop | List the tags of the cluster. |
872 | 7322bf7b | Iustin Pop | |
873 | 7322bf7b | Iustin Pop | REMOVE-TAGS |
874 | 7322bf7b | Iustin Pop | ^^^^^^^^^^^ |
875 | 7322bf7b | Iustin Pop | |
876 | 7322bf7b | Iustin Pop | **remove-tags** [\--from *file*] {*tag*...} |
877 | 7322bf7b | Iustin Pop | |
878 | 7322bf7b | Iustin Pop | Remove tags from the cluster. If any of the tags are not existing |
879 | 7322bf7b | Iustin Pop | on the cluster, the entire operation will abort. |
880 | 7322bf7b | Iustin Pop | |
881 | 7322bf7b | Iustin Pop | If the ``--from`` option is given, the list of tags to be removed will |
882 | 7322bf7b | Iustin Pop | be extended with the contents of that file (each line becomes a tag). |
883 | 7322bf7b | Iustin Pop | In this case, there is not need to pass tags on the command line (if |
884 | 7322bf7b | Iustin Pop | you do, tags from both sources will be removed). A file name of - will |
885 | 7322bf7b | Iustin Pop | be interpreted as stdin. |
886 | 7322bf7b | Iustin Pop | |
887 | 7322bf7b | Iustin Pop | SEARCH-TAGS |
888 | 7322bf7b | Iustin Pop | ^^^^^^^^^^^ |
889 | 7322bf7b | Iustin Pop | |
890 | 7322bf7b | Iustin Pop | **search-tags** {*pattern*} |
891 | 7322bf7b | Iustin Pop | |
892 | 7322bf7b | Iustin Pop | Searches the tags on all objects in the cluster (the cluster |
893 | 7322bf7b | Iustin Pop | itself, the nodes and the instances) for a given pattern. The |
894 | 7322bf7b | Iustin Pop | pattern is interpreted as a regular expression and a search will be |
895 | 7322bf7b | Iustin Pop | done on it (i.e. the given pattern is not anchored to the beggining |
896 | 7322bf7b | Iustin Pop | of the string; if you want that, prefix the pattern with ^). |
897 | 7322bf7b | Iustin Pop | |
898 | 7322bf7b | Iustin Pop | If no tags are matching the pattern, the exit code of the command |
899 | 7322bf7b | Iustin Pop | will be one. If there is at least one match, the exit code will be |
900 | 7322bf7b | Iustin Pop | zero. Each match is listed on one line, the object and the tag |
901 | 7322bf7b | Iustin Pop | separated by a space. The cluster will be listed as /cluster, a |
902 | 7322bf7b | Iustin Pop | node will be listed as /nodes/*name*, and an instance as |
903 | 7322bf7b | Iustin Pop | /instances/*name*. Example: |
904 | 7322bf7b | Iustin Pop | |
905 | 7322bf7b | Iustin Pop | :: |
906 | 7322bf7b | Iustin Pop | |
907 | 7322bf7b | Iustin Pop | # gnt-cluster search-tags time |
908 | 7322bf7b | Iustin Pop | /cluster ctime:2007-09-01 |
909 | 7322bf7b | Iustin Pop | /nodes/node1.example.com mtime:2007-10-04 |
910 | 7322bf7b | Iustin Pop | |
911 | 9ff4f2c0 | Michael Hanselmann | .. vim: set textwidth=72 : |
912 | 9ff4f2c0 | Michael Hanselmann | .. Local Variables: |
913 | 9ff4f2c0 | Michael Hanselmann | .. mode: rst |
914 | 9ff4f2c0 | Michael Hanselmann | .. fill-column: 72 |
915 | 9ff4f2c0 | Michael Hanselmann | .. End: |