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