root / man / gnt-group.rst @ 46118ed2
History | View | Annotate | Download (7.8 kB)
1 | 667dbd6b | Adeodato Simo | gnt-group(8) Ganeti | Version @GANETI_VERSION@ |
---|---|---|---|
2 | 667dbd6b | Adeodato Simo | ============================================== |
3 | 667dbd6b | Adeodato Simo | |
4 | 667dbd6b | Adeodato Simo | Name |
5 | 667dbd6b | Adeodato Simo | ---- |
6 | 667dbd6b | Adeodato Simo | |
7 | 667dbd6b | Adeodato Simo | gnt-group - Ganeti node-group administration |
8 | 667dbd6b | Adeodato Simo | |
9 | 667dbd6b | Adeodato Simo | Synopsis |
10 | 667dbd6b | Adeodato Simo | -------- |
11 | 667dbd6b | Adeodato Simo | |
12 | 667dbd6b | Adeodato Simo | **gnt-group** {command} [arguments...] |
13 | 667dbd6b | Adeodato Simo | |
14 | 667dbd6b | Adeodato Simo | DESCRIPTION |
15 | 667dbd6b | Adeodato Simo | ----------- |
16 | 667dbd6b | Adeodato Simo | |
17 | 667dbd6b | Adeodato Simo | The **gnt-group** command is used for node group administration in |
18 | 667dbd6b | Adeodato Simo | the Ganeti system. |
19 | 667dbd6b | Adeodato Simo | |
20 | 667dbd6b | Adeodato Simo | COMMANDS |
21 | 667dbd6b | Adeodato Simo | -------- |
22 | 667dbd6b | Adeodato Simo | |
23 | 66e884e1 | Adeodato Simo | ADD |
24 | 66e884e1 | Adeodato Simo | ~~~ |
25 | 66e884e1 | Adeodato Simo | |
26 | dcbeccd9 | Michael Hanselmann | | **add** [\--submit] |
27 | e8f936b0 | Iustin Pop | | [\--node-parameters=*NDPARAMS*] |
28 | e8f936b0 | Iustin Pop | | [\--alloc-policy=*POLICY*] |
29 | e8f936b0 | Iustin Pop | | [{-D|\--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]] |
30 | e8f936b0 | Iustin Pop | | [\--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]] |
31 | e8f936b0 | Iustin Pop | | [\--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]] |
32 | e8f936b0 | Iustin Pop | | [\--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]] |
33 | e8f936b0 | Iustin Pop | | [\--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]] |
34 | e8f936b0 | Iustin Pop | | [\--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]] |
35 | e8f936b0 | Iustin Pop | | [\--ipol-disk-templates *template* [,*template*...]] |
36 | e8f936b0 | Iustin Pop | | [\--disk-state *diskstate*] |
37 | e8f936b0 | Iustin Pop | | [\--hypervisor-state *hvstate*] |
38 | 483be60d | Adeodato Simo | | {*group*} |
39 | 66e884e1 | Adeodato Simo | |
40 | 66e884e1 | Adeodato Simo | Creates a new group with the given name. The node group will be |
41 | 919852da | Adeodato Simo | initially empty; to add nodes to it, use ``gnt-group assign-nodes``. |
42 | 66e884e1 | Adeodato Simo | |
43 | 483be60d | Adeodato Simo | The ``--node-parameters`` option allows you to set default node |
44 | 483be60d | Adeodato Simo | parameters for nodes in the group. Please see **ganeti**(7) for more |
45 | e4c03256 | René Nussbaumer | information about supported key=value pairs and their corresponding |
46 | e4c03256 | René Nussbaumer | options. |
47 | 483be60d | Adeodato Simo | |
48 | 90e99856 | Adeodato Simo | The ``--alloc-policy`` option allows you to set an allocation policy for |
49 | 90e99856 | Adeodato Simo | the group at creation time. Possible values are: |
50 | 90e99856 | Adeodato Simo | |
51 | 90e99856 | Adeodato Simo | unallocable |
52 | 90e99856 | Adeodato Simo | nodes in the group should not be candidates for instance allocation, |
53 | 90e99856 | Adeodato Simo | and the operation (e.g., instance creation) should fail if only |
54 | 90e99856 | Adeodato Simo | groups in this state could be found to satisfy the requirements. |
55 | 90e99856 | Adeodato Simo | |
56 | 90e99856 | Adeodato Simo | last_resort |
57 | 90e99856 | Adeodato Simo | nodes in the group should not be used for instance allocations, |
58 | 90e99856 | Adeodato Simo | unless this would be the only way to have the operation succeed. |
59 | 90e99856 | Adeodato Simo | |
60 | 90e99856 | Adeodato Simo | preferred |
61 | 90e99856 | Adeodato Simo | nodes in the group can be used freely for allocation of instances |
62 | 90e99856 | Adeodato Simo | (this is the default). Note that prioritization among groups in this |
63 | 90e99856 | Adeodato Simo | state will be deferred to the iallocator plugin that's being used. |
64 | 90e99856 | Adeodato Simo | |
65 | a46b1883 | Andrea Spadaccini | The ``-D (--disk-parameters)`` option allows you to set the disk |
66 | a46b1883 | Andrea Spadaccini | parameters for the node group; please see the section about |
67 | a46b1883 | Andrea Spadaccini | **gnt-cluster add** in **gnt-cluster**(8) for more information about |
68 | a46b1883 | Andrea Spadaccini | disk parameters |
69 | a46b1883 | Andrea Spadaccini | |
70 | d04c9d45 | Iustin Pop | The ``--specs-...`` and ``--ipol-disk-templates`` options specify |
71 | d04c9d45 | Iustin Pop | instance policies on the node group, and are documented in the |
72 | d04c9d45 | Iustin Pop | **gnt-cluster**(8) man page. |
73 | d6033c14 | Agata Murawska | |
74 | dcbeccd9 | Michael Hanselmann | See **ganeti(7)** for a description of ``--submit`` and other common |
75 | dcbeccd9 | Michael Hanselmann | options. |
76 | dcbeccd9 | Michael Hanselmann | |
77 | 919852da | Adeodato Simo | ASSIGN-NODES |
78 | 919852da | Adeodato Simo | ~~~~~~~~~~~~ |
79 | 919852da | Adeodato Simo | |
80 | 919852da | Adeodato Simo | | **assign-nodes** |
81 | dcbeccd9 | Michael Hanselmann | | [\--force] [\--submit] |
82 | 919852da | Adeodato Simo | | {*group*} {*node*...} |
83 | 919852da | Adeodato Simo | |
84 | 919852da | Adeodato Simo | Assigns one or more nodes to the specified group, moving them from their |
85 | 919852da | Adeodato Simo | original group (or groups). |
86 | 919852da | Adeodato Simo | |
87 | 919852da | Adeodato Simo | By default, this command will refuse to proceed if the move would split |
88 | 919852da | Adeodato Simo | between groups any instance that was not previously split (a split |
89 | 919852da | Adeodato Simo | instance is an instance with a mirrored disk template, e.g. DRBD, that |
90 | 919852da | Adeodato Simo | has the primary and secondary nodes in different node groups). You can |
91 | 919852da | Adeodato Simo | force the operation with ``--force``. |
92 | 90e99856 | Adeodato Simo | |
93 | dcbeccd9 | Michael Hanselmann | See **ganeti(7)** for a description of ``--submit`` and other common |
94 | dcbeccd9 | Michael Hanselmann | options. |
95 | dcbeccd9 | Michael Hanselmann | |
96 | 4da7909a | Adeodato Simo | MODIFY |
97 | 4da7909a | Adeodato Simo | ~~~~~~ |
98 | 4da7909a | Adeodato Simo | |
99 | dcbeccd9 | Michael Hanselmann | | **modify** [\--submit] |
100 | e8f936b0 | Iustin Pop | | [\--node-parameters=*NDPARAMS*] |
101 | e8f936b0 | Iustin Pop | | [\--alloc-policy=*POLICY*] |
102 | e8f936b0 | Iustin Pop | | [\--hypervisor-state *hvstate*] |
103 | e8f936b0 | Iustin Pop | | [{-D|\--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]] |
104 | e8f936b0 | Iustin Pop | | [\--disk-state *diskstate*] |
105 | e8f936b0 | Iustin Pop | | [\--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]] |
106 | e8f936b0 | Iustin Pop | | [\--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]] |
107 | e8f936b0 | Iustin Pop | | [\--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]] |
108 | e8f936b0 | Iustin Pop | | [\--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]] |
109 | e8f936b0 | Iustin Pop | | [\--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]] |
110 | e8f936b0 | Iustin Pop | | [\--ipol-disk-templates *template* [,*template*...]] |
111 | 4da7909a | Adeodato Simo | | {*group*} |
112 | 4da7909a | Adeodato Simo | |
113 | 4da7909a | Adeodato Simo | Modifies some parameters from the node group. |
114 | 4da7909a | Adeodato Simo | |
115 | a8282327 | René Nussbaumer | The ``--node-parameters`` and ``--alloc-policy`` options are documented |
116 | a8282327 | René Nussbaumer | in the **add** command above. ``--hypervisor-state`` as well as |
117 | a8282327 | René Nussbaumer | ``--disk-state`` are documented in detail in **ganeti**(7). |
118 | 4da7909a | Adeodato Simo | |
119 | d6033c14 | Agata Murawska | The ``--node-parameters``, ``--alloc-policy``, ``-D |
120 | 0ce212e5 | Iustin Pop | (--disk-parameters)`` options are documented in the **add** command |
121 | 0ce212e5 | Iustin Pop | above. |
122 | 0ce212e5 | Iustin Pop | |
123 | d04c9d45 | Iustin Pop | The ``--specs-...`` and ``--ipol-disk-templates`` options specify |
124 | d04c9d45 | Iustin Pop | instance policies on the node group, and are documented in the |
125 | d04c9d45 | Iustin Pop | **gnt-cluster**(8) man page. |
126 | a46b1883 | Andrea Spadaccini | |
127 | dcbeccd9 | Michael Hanselmann | See **ganeti(7)** for a description of ``--submit`` and other common |
128 | dcbeccd9 | Michael Hanselmann | options. |
129 | dcbeccd9 | Michael Hanselmann | |
130 | 66e884e1 | Adeodato Simo | REMOVE |
131 | 66e884e1 | Adeodato Simo | ~~~~~~ |
132 | 66e884e1 | Adeodato Simo | |
133 | dcbeccd9 | Michael Hanselmann | | **remove** [\--submit] {*group*} |
134 | 66e884e1 | Adeodato Simo | |
135 | a7c5085d | Stephen Shirley | Deletes the indicated node group, which must be empty. There must always be at |
136 | a7c5085d | Stephen Shirley | least one group, so the last group cannot be removed. |
137 | 66e884e1 | Adeodato Simo | |
138 | dcbeccd9 | Michael Hanselmann | See **ganeti(7)** for a description of ``--submit`` and other common |
139 | dcbeccd9 | Michael Hanselmann | options. |
140 | dcbeccd9 | Michael Hanselmann | |
141 | 667dbd6b | Adeodato Simo | LIST |
142 | 667dbd6b | Adeodato Simo | ~~~~ |
143 | 667dbd6b | Adeodato Simo | |
144 | e8f936b0 | Iustin Pop | | **list** [\--no-headers] [\--separator=*SEPARATOR*] [-v] |
145 | e8f936b0 | Iustin Pop | | [-o *[+]FIELD,...*] [\--filter] [group...] |
146 | 667dbd6b | Adeodato Simo | |
147 | 667dbd6b | Adeodato Simo | Lists all existing node groups in the cluster. |
148 | 667dbd6b | Adeodato Simo | |
149 | 667dbd6b | Adeodato Simo | The ``--no-headers`` option will skip the initial header line. The |
150 | 667dbd6b | Adeodato Simo | ``--separator`` option takes an argument which denotes what will be |
151 | 667dbd6b | Adeodato Simo | used between the output fields. Both these options are to help |
152 | 667dbd6b | Adeodato Simo | scripting. |
153 | 667dbd6b | Adeodato Simo | |
154 | f0b1bafe | Iustin Pop | The ``-v`` option activates verbose mode, which changes the display of |
155 | f0b1bafe | Iustin Pop | special field states (see **ganeti(7)**). |
156 | f0b1bafe | Iustin Pop | |
157 | 667dbd6b | Adeodato Simo | The ``-o`` option takes a comma-separated list of output fields. |
158 | 667dbd6b | Adeodato Simo | If the value of the option starts with the character ``+``, the new |
159 | f7b769b1 | Iustin Pop | fields will be added to the default list. This allows one to quickly |
160 | 667dbd6b | Adeodato Simo | see the default list plus a few other fields, instead of retyping |
161 | 667dbd6b | Adeodato Simo | the entire list of fields. |
162 | 667dbd6b | Adeodato Simo | |
163 | 667dbd6b | Adeodato Simo | The available fields and their meaning are: |
164 | 667dbd6b | Adeodato Simo | |
165 | fcdb582d | Michael Hanselmann | @QUERY_FIELDS_GROUP@ |
166 | 4edc512c | Adeodato Simo | |
167 | 1b1a08e8 | Michael Hanselmann | If exactly one argument is given and it appears to be a query filter |
168 | 1b1a08e8 | Michael Hanselmann | (see **ganeti(7)**), the query result is filtered accordingly. For |
169 | 1b1a08e8 | Michael Hanselmann | ambiguous cases (e.g. a single field name as a filter) the ``--filter`` |
170 | 1b1a08e8 | Michael Hanselmann | (``-F``) option forces the argument to be treated as a filter. |
171 | 1b1a08e8 | Michael Hanselmann | |
172 | 667dbd6b | Adeodato Simo | If no group names are given, then all groups are included. Otherwise, |
173 | 667dbd6b | Adeodato Simo | only the named groups will be listed. |
174 | 66e884e1 | Adeodato Simo | |
175 | ca4ac9c9 | Adeodato Simo | LIST-FIELDS |
176 | ca4ac9c9 | Adeodato Simo | ~~~~~~~~~~~ |
177 | ca4ac9c9 | Adeodato Simo | |
178 | ca4ac9c9 | Adeodato Simo | **list-fields** [field...] |
179 | ca4ac9c9 | Adeodato Simo | |
180 | ca4ac9c9 | Adeodato Simo | List available fields for node groups. |
181 | ca4ac9c9 | Adeodato Simo | |
182 | 66e884e1 | Adeodato Simo | RENAME |
183 | 66e884e1 | Adeodato Simo | ~~~~~~ |
184 | 66e884e1 | Adeodato Simo | |
185 | dcbeccd9 | Michael Hanselmann | | **rename** [\--submit] {*oldname*} {*newname*} |
186 | 66e884e1 | Adeodato Simo | |
187 | 66e884e1 | Adeodato Simo | Renames a given group from *oldname* to *newname*. |
188 | 9ff4f2c0 | Michael Hanselmann | |
189 | dcbeccd9 | Michael Hanselmann | See **ganeti(7)** for a description of ``--submit`` and other common |
190 | dcbeccd9 | Michael Hanselmann | options. |
191 | dcbeccd9 | Michael Hanselmann | |
192 | 819cbfe5 | Michael Hanselmann | |
193 | f6eb380d | Michael Hanselmann | EVACUATE |
194 | f6eb380d | Michael Hanselmann | ~~~~~~~~ |
195 | f6eb380d | Michael Hanselmann | |
196 | dcbeccd9 | Michael Hanselmann | **evacuate** [\--submit] [\--iallocator *NAME*] [\--to *GROUP*...] {*group*} |
197 | f6eb380d | Michael Hanselmann | |
198 | f6eb380d | Michael Hanselmann | This command will move all instances out of the given node group. |
199 | f6eb380d | Michael Hanselmann | Instances are placed in a new group by an iallocator, either given on |
200 | f6eb380d | Michael Hanselmann | the command line or as a cluster default. |
201 | f6eb380d | Michael Hanselmann | |
202 | f6eb380d | Michael Hanselmann | If no specific destination groups are specified using ``--to``, all |
203 | f6eb380d | Michael Hanselmann | groups except the evacuated group are considered. |
204 | f6eb380d | Michael Hanselmann | |
205 | dcbeccd9 | Michael Hanselmann | See **ganeti(7)** for a description of ``--submit`` and other common |
206 | dcbeccd9 | Michael Hanselmann | options. |
207 | dcbeccd9 | Michael Hanselmann | |
208 | f6eb380d | Michael Hanselmann | Example:: |
209 | f6eb380d | Michael Hanselmann | |
210 | f6eb380d | Michael Hanselmann | # gnt-group evacuate -I hail --to rack4 rack1 |
211 | f6eb380d | Michael Hanselmann | |
212 | f6eb380d | Michael Hanselmann | |
213 | 819cbfe5 | Michael Hanselmann | TAGS |
214 | 819cbfe5 | Michael Hanselmann | ~~~~ |
215 | 819cbfe5 | Michael Hanselmann | |
216 | 819cbfe5 | Michael Hanselmann | ADD-TAGS |
217 | 819cbfe5 | Michael Hanselmann | ^^^^^^^^ |
218 | 819cbfe5 | Michael Hanselmann | |
219 | e8f936b0 | Iustin Pop | **add-tags** [\--from *file*] {*groupname*} {*tag*...} |
220 | 819cbfe5 | Michael Hanselmann | |
221 | 819cbfe5 | Michael Hanselmann | Add tags to the given node group. If any of the tags contains invalid |
222 | 819cbfe5 | Michael Hanselmann | characters, the entire operation will abort. |
223 | 819cbfe5 | Michael Hanselmann | |
224 | 819cbfe5 | Michael Hanselmann | If the ``--from`` option is given, the list of tags will be extended |
225 | 819cbfe5 | Michael Hanselmann | with the contents of that file (each line becomes a tag). In this case, |
226 | 819cbfe5 | Michael Hanselmann | there is not need to pass tags on the command line (if you do, both |
227 | 819cbfe5 | Michael Hanselmann | sources will be used). A file name of ``-`` will be interpreted as |
228 | 819cbfe5 | Michael Hanselmann | stdin. |
229 | 819cbfe5 | Michael Hanselmann | |
230 | 819cbfe5 | Michael Hanselmann | LIST-TAGS |
231 | 819cbfe5 | Michael Hanselmann | ^^^^^^^^^ |
232 | 819cbfe5 | Michael Hanselmann | |
233 | 819cbfe5 | Michael Hanselmann | **list-tags** {*groupname*} |
234 | 819cbfe5 | Michael Hanselmann | |
235 | 819cbfe5 | Michael Hanselmann | List the tags of the given node group. |
236 | 819cbfe5 | Michael Hanselmann | |
237 | 819cbfe5 | Michael Hanselmann | REMOVE-TAGS |
238 | 819cbfe5 | Michael Hanselmann | ^^^^^^^^^^^ |
239 | 819cbfe5 | Michael Hanselmann | |
240 | e8f936b0 | Iustin Pop | **remove-tags** [\--from *file*] {*groupname*} {*tag*...} |
241 | 819cbfe5 | Michael Hanselmann | |
242 | 819cbfe5 | Michael Hanselmann | Remove tags from the given node group. If any of the tags are not |
243 | 819cbfe5 | Michael Hanselmann | existing on the node, the entire operation will abort. |
244 | 819cbfe5 | Michael Hanselmann | |
245 | 819cbfe5 | Michael Hanselmann | If the ``--from`` option is given, the list of tags to be removed will |
246 | 819cbfe5 | Michael Hanselmann | be extended with the contents of that file (each line becomes a tag). In |
247 | 819cbfe5 | Michael Hanselmann | this case, there is not need to pass tags on the command line (if you |
248 | 819cbfe5 | Michael Hanselmann | do, tags from both sources will be removed). A file name of ``-`` will |
249 | 819cbfe5 | Michael Hanselmann | be interpreted as stdin. |
250 | 819cbfe5 | Michael Hanselmann | |
251 | 216d23c0 | René Nussbaumer | INFO |
252 | 216d23c0 | René Nussbaumer | ~~~~ |
253 | 216d23c0 | René Nussbaumer | |
254 | 216d23c0 | René Nussbaumer | **info** [group...] |
255 | 216d23c0 | René Nussbaumer | |
256 | 216d23c0 | René Nussbaumer | Shows config information for all (or given) groups. |
257 | 216d23c0 | René Nussbaumer | |
258 | 216d23c0 | René Nussbaumer | |
259 | 9ff4f2c0 | Michael Hanselmann | .. vim: set textwidth=72 : |
260 | 9ff4f2c0 | Michael Hanselmann | .. Local Variables: |
261 | 9ff4f2c0 | Michael Hanselmann | .. mode: rst |
262 | 9ff4f2c0 | Michael Hanselmann | .. fill-column: 72 |
263 | 9ff4f2c0 | Michael Hanselmann | .. End: |