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