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