root / doc / iallocator.rst @ 861610e9
History | View | Annotate | Download (15.6 kB)
1 | 876860a3 | Iustin Pop | Ganeti automatic instance allocation |
---|---|---|---|
2 | 876860a3 | Iustin Pop | ==================================== |
3 | 876860a3 | Iustin Pop | |
4 | 9f604ab8 | Michael Hanselmann | Documents Ganeti version 2.5 |
5 | 876860a3 | Iustin Pop | |
6 | 876860a3 | Iustin Pop | .. contents:: |
7 | 876860a3 | Iustin Pop | |
8 | 876860a3 | Iustin Pop | Introduction |
9 | 876860a3 | Iustin Pop | ------------ |
10 | 876860a3 | Iustin Pop | |
11 | 876860a3 | Iustin Pop | Currently in Ganeti the admin has to specify the exact locations for |
12 | 876860a3 | Iustin Pop | an instance's node(s). This prevents a completely automatic node |
13 | 876860a3 | Iustin Pop | evacuation, and is in general a nuisance. |
14 | 876860a3 | Iustin Pop | |
15 | 876860a3 | Iustin Pop | The *iallocator* framework will enable automatic placement via |
16 | 876860a3 | Iustin Pop | external scripts, which allows customization of the cluster layout per |
17 | 876860a3 | Iustin Pop | the site's requirements. |
18 | 876860a3 | Iustin Pop | |
19 | 876860a3 | Iustin Pop | User-visible changes |
20 | 876860a3 | Iustin Pop | ~~~~~~~~~~~~~~~~~~~~ |
21 | 876860a3 | Iustin Pop | |
22 | 876860a3 | Iustin Pop | There are two parts of the ganeti operation that are impacted by the |
23 | 876860a3 | Iustin Pop | auto-allocation: how the cluster knows what the allocator algorithms |
24 | 876860a3 | Iustin Pop | are and how the admin uses these in creating instances. |
25 | 876860a3 | Iustin Pop | |
26 | 876860a3 | Iustin Pop | An allocation algorithm is just the filename of a program installed in |
27 | 876860a3 | Iustin Pop | a defined list of directories. |
28 | 876860a3 | Iustin Pop | |
29 | 876860a3 | Iustin Pop | Cluster configuration |
30 | 876860a3 | Iustin Pop | ~~~~~~~~~~~~~~~~~~~~~ |
31 | 876860a3 | Iustin Pop | |
32 | 876860a3 | Iustin Pop | At configure time, the list of the directories can be selected via the |
33 | 876860a3 | Iustin Pop | ``--with-iallocator-search-path=LIST`` option, where *LIST* is a |
34 | 876860a3 | Iustin Pop | comma-separated list of directories. If not given, this defaults to |
35 | 876860a3 | Iustin Pop | ``$libdir/ganeti/iallocators``, i.e. for an installation under |
36 | 876860a3 | Iustin Pop | ``/usr``, this will be ``/usr/lib/ganeti/iallocators``. |
37 | 876860a3 | Iustin Pop | |
38 | 876860a3 | Iustin Pop | Ganeti will then search for allocator script in the configured list, |
39 | 876860a3 | Iustin Pop | using the first one whose filename matches the one given by the user. |
40 | 876860a3 | Iustin Pop | |
41 | 876860a3 | Iustin Pop | Command line interface changes |
42 | 876860a3 | Iustin Pop | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
43 | 876860a3 | Iustin Pop | |
44 | 876860a3 | Iustin Pop | The node selection options in instanece add and instance replace disks |
45 | 876860a3 | Iustin Pop | can be replace by the new ``--iallocator=NAME`` option (shortened to |
46 | 876860a3 | Iustin Pop | ``-I``), which will cause the auto-assignement of nodes with the |
47 | 876860a3 | Iustin Pop | passed iallocator. The selected node(s) will be show as part of the |
48 | 876860a3 | Iustin Pop | command output. |
49 | 876860a3 | Iustin Pop | |
50 | 876860a3 | Iustin Pop | IAllocator API |
51 | 876860a3 | Iustin Pop | -------------- |
52 | 876860a3 | Iustin Pop | |
53 | 876860a3 | Iustin Pop | The protocol for communication between Ganeti and an allocator script |
54 | 876860a3 | Iustin Pop | will be the following: |
55 | 876860a3 | Iustin Pop | |
56 | 876860a3 | Iustin Pop | #. ganeti launches the program with a single argument, a filename that |
57 | 876860a3 | Iustin Pop | contains a JSON-encoded structure (the input message) |
58 | 876860a3 | Iustin Pop | |
59 | 876860a3 | Iustin Pop | #. if the script finishes with exit code different from zero, it is |
60 | 876860a3 | Iustin Pop | considered a general failure and the full output will be reported to |
61 | 876860a3 | Iustin Pop | the users; this can be the case when the allocator can't parse the |
62 | 876860a3 | Iustin Pop | input message |
63 | 876860a3 | Iustin Pop | |
64 | 876860a3 | Iustin Pop | #. if the allocator finishes with exit code zero, it is expected to |
65 | 876860a3 | Iustin Pop | output (on its stdout) a JSON-encoded structure (the response) |
66 | 876860a3 | Iustin Pop | |
67 | 876860a3 | Iustin Pop | Input message |
68 | 876860a3 | Iustin Pop | ~~~~~~~~~~~~~ |
69 | 876860a3 | Iustin Pop | |
70 | 876860a3 | Iustin Pop | The input message will be the JSON encoding of a dictionary containing |
71 | 61791108 | Adeodato Simo | all the required information to perform the operation. We explain the |
72 | 61791108 | Adeodato Simo | contents of this dictionary in two parts: common information that every |
73 | 61791108 | Adeodato Simo | type of operation requires, and operation-specific information. |
74 | 61791108 | Adeodato Simo | |
75 | 61791108 | Adeodato Simo | Common information |
76 | 61791108 | Adeodato Simo | ++++++++++++++++++ |
77 | 61791108 | Adeodato Simo | |
78 | 61791108 | Adeodato Simo | All input dictionaries to the IAllocator must carry the following keys: |
79 | 876860a3 | Iustin Pop | |
80 | 876860a3 | Iustin Pop | version |
81 | 876860a3 | Iustin Pop | the version of the protocol; this document |
82 | 77031881 | Iustin Pop | specifies version 2 |
83 | 876860a3 | Iustin Pop | |
84 | 876860a3 | Iustin Pop | cluster_name |
85 | 876860a3 | Iustin Pop | the cluster name |
86 | 876860a3 | Iustin Pop | |
87 | 876860a3 | Iustin Pop | cluster_tags |
88 | 876860a3 | Iustin Pop | the list of cluster tags |
89 | 876860a3 | Iustin Pop | |
90 | 77031881 | Iustin Pop | enabled_hypervisors |
91 | 77031881 | Iustin Pop | the list of enabled hypervisors |
92 | 77031881 | Iustin Pop | |
93 | 876860a3 | Iustin Pop | request |
94 | 61791108 | Adeodato Simo | a dictionary containing the details of the request; the keys vary |
95 | 61791108 | Adeodato Simo | depending on the type of operation that's being requested, as |
96 | 61791108 | Adeodato Simo | explained in `Operation-specific input`_ below. |
97 | 632fb7ec | Iustin Pop | |
98 | 622444e5 | Iustin Pop | nodegroups |
99 | 622444e5 | Iustin Pop | a dictionary with the data for the cluster's node groups; it is keyed |
100 | 622444e5 | Iustin Pop | on the group UUID, and the values are a dictionary with the following |
101 | 622444e5 | Iustin Pop | keys: |
102 | 622444e5 | Iustin Pop | |
103 | 622444e5 | Iustin Pop | name |
104 | 622444e5 | Iustin Pop | the node group name |
105 | 913639fe | Balazs Lecz | alloc_policy |
106 | 5e9bcdf4 | Adeodato Simo | the allocation policy of the node group (consult the semantics of |
107 | 5e9bcdf4 | Adeodato Simo | this attribute in the :manpage:`gnt-group(8)` manpage) |
108 | 622444e5 | Iustin Pop | |
109 | 876860a3 | Iustin Pop | instances |
110 | 876860a3 | Iustin Pop | a dictionary with the data for the current existing instance on the |
111 | 876860a3 | Iustin Pop | cluster, indexed by instance name; the contents are similar to the |
112 | 876860a3 | Iustin Pop | instance definitions for the allocate mode, with the addition of: |
113 | 876860a3 | Iustin Pop | |
114 | 9ca8a7c5 | Agata Murawska | admin_state |
115 | 876860a3 | Iustin Pop | if this instance is set to run (but not the actual status of the |
116 | 876860a3 | Iustin Pop | instance) |
117 | 876860a3 | Iustin Pop | |
118 | 876860a3 | Iustin Pop | nodes |
119 | 876860a3 | Iustin Pop | list of nodes on which this instance is placed; the primary node |
120 | 876860a3 | Iustin Pop | of the instance is always the first one |
121 | 876860a3 | Iustin Pop | |
122 | 876860a3 | Iustin Pop | nodes |
123 | 876860a3 | Iustin Pop | dictionary with the data for the nodes in the cluster, indexed by |
124 | 0d853843 | Iustin Pop | the node name; the dict contains [*]_ : |
125 | 876860a3 | Iustin Pop | |
126 | 876860a3 | Iustin Pop | total_disk |
127 | 876860a3 | Iustin Pop | the total disk size of this node (mebibytes) |
128 | 876860a3 | Iustin Pop | |
129 | 876860a3 | Iustin Pop | free_disk |
130 | 876860a3 | Iustin Pop | the free disk space on the node |
131 | 876860a3 | Iustin Pop | |
132 | 876860a3 | Iustin Pop | total_memory |
133 | 876860a3 | Iustin Pop | the total memory size |
134 | 876860a3 | Iustin Pop | |
135 | 876860a3 | Iustin Pop | free_memory |
136 | 876860a3 | Iustin Pop | free memory on the node; note that currently this does not take |
137 | 876860a3 | Iustin Pop | into account the instances which are down on the node |
138 | 876860a3 | Iustin Pop | |
139 | 876860a3 | Iustin Pop | total_cpus |
140 | 876860a3 | Iustin Pop | the physical number of CPUs present on the machine; depending on |
141 | 876860a3 | Iustin Pop | the hypervisor, this might or might not be equal to how many CPUs |
142 | 876860a3 | Iustin Pop | the node operating system sees; |
143 | 876860a3 | Iustin Pop | |
144 | 876860a3 | Iustin Pop | primary_ip |
145 | 876860a3 | Iustin Pop | the primary IP address of the node |
146 | 876860a3 | Iustin Pop | |
147 | 876860a3 | Iustin Pop | secondary_ip |
148 | 876860a3 | Iustin Pop | the secondary IP address of the node (the one used for the DRBD |
149 | 876860a3 | Iustin Pop | replication); note that this can be the same as the primary one |
150 | 876860a3 | Iustin Pop | |
151 | 876860a3 | Iustin Pop | tags |
152 | 876860a3 | Iustin Pop | list with the tags of the node |
153 | 876860a3 | Iustin Pop | |
154 | 77031881 | Iustin Pop | master_candidate: |
155 | 77031881 | Iustin Pop | a boolean flag denoting whether this node is a master candidate |
156 | 77031881 | Iustin Pop | |
157 | 77031881 | Iustin Pop | drained: |
158 | 77031881 | Iustin Pop | a boolean flag denoting whether this node is being drained |
159 | 77031881 | Iustin Pop | |
160 | 77031881 | Iustin Pop | offline: |
161 | 77031881 | Iustin Pop | a boolean flag denoting whether this node is offline |
162 | 77031881 | Iustin Pop | |
163 | 77031881 | Iustin Pop | i_pri_memory: |
164 | 77031881 | Iustin Pop | total memory required by primary instances |
165 | 77031881 | Iustin Pop | |
166 | 77031881 | Iustin Pop | i_pri_up_memory: |
167 | 77031881 | Iustin Pop | total memory required by running primary instances |
168 | 77031881 | Iustin Pop | |
169 | 1116c3b2 | Iustin Pop | group: |
170 | 1116c3b2 | Iustin Pop | the node group that this node belongs to |
171 | 1116c3b2 | Iustin Pop | |
172 | 77031881 | Iustin Pop | No allocations should be made on nodes having either the ``drained`` |
173 | 77031881 | Iustin Pop | or ``offline`` flags set. More details about these of node status |
174 | fd07c6b3 | Iustin Pop | flags is available in the manpage :manpage:`ganeti(7)`. |
175 | 77031881 | Iustin Pop | |
176 | a1cef11c | Iustin Pop | .. [*] Note that no run-time data is present for offline, drained or |
177 | a1cef11c | Iustin Pop | non-vm_capable nodes; this means the tags total_memory, |
178 | a1cef11c | Iustin Pop | reserved_memory, free_memory, total_disk, free_disk, total_cpus, |
179 | a1cef11c | Iustin Pop | i_pri_memory and i_pri_up memory will be absent |
180 | 77031881 | Iustin Pop | |
181 | 61791108 | Adeodato Simo | Operation-specific input |
182 | 61791108 | Adeodato Simo | ++++++++++++++++++++++++ |
183 | 61791108 | Adeodato Simo | |
184 | 61791108 | Adeodato Simo | All input dictionaries to the IAllocator carry, in the ``request`` |
185 | 61791108 | Adeodato Simo | dictionary, detailed information about the operation that's being |
186 | 61791108 | Adeodato Simo | requested. The required keys vary depending on the type of operation, as |
187 | 61791108 | Adeodato Simo | follows. |
188 | 61791108 | Adeodato Simo | |
189 | 61791108 | Adeodato Simo | In all cases, it includes: |
190 | 61791108 | Adeodato Simo | |
191 | 61791108 | Adeodato Simo | type |
192 | 6d267b81 | Adeodato Simo | the request type; this can be either ``allocate``, ``relocate``, |
193 | f0edfcf6 | Michael Hanselmann | ``change-group`` or ``node-evacuate``. The |
194 | 172679c9 | Michael Hanselmann | ``allocate`` request is used when a new instance needs to be placed |
195 | 172679c9 | Michael Hanselmann | on the cluster. The ``relocate`` request is used when an existing |
196 | 172679c9 | Michael Hanselmann | instance needs to be moved within its node group. |
197 | 25ee7fd8 | Michael Hanselmann | |
198 | 25ee7fd8 | Michael Hanselmann | The ``multi-evacuate`` protocol used to request that the script |
199 | 25ee7fd8 | Michael Hanselmann | computes the optimal relocate solution for all secondary instances |
200 | f0edfcf6 | Michael Hanselmann | of the given nodes. It is now deprecated and needs only be |
201 | f0edfcf6 | Michael Hanselmann | implemented if backwards compatibility with Ganeti 2.4 and lower is |
202 | f0edfcf6 | Michael Hanselmann | needed. |
203 | 25ee7fd8 | Michael Hanselmann | |
204 | 25ee7fd8 | Michael Hanselmann | The ``change-group`` request is used to relocate multiple instances |
205 | 25ee7fd8 | Michael Hanselmann | across multiple node groups. ``node-evacuate`` evacuates instances |
206 | 25ee7fd8 | Michael Hanselmann | off their node(s). These are described in a separate :ref:`design |
207 | 25ee7fd8 | Michael Hanselmann | document <multi-reloc-detailed-design>`. |
208 | 61791108 | Adeodato Simo | |
209 | 61791108 | Adeodato Simo | For both allocate and relocate mode, the following extra keys are needed |
210 | 61791108 | Adeodato Simo | in the ``request`` dictionary: |
211 | 61791108 | Adeodato Simo | |
212 | 61791108 | Adeodato Simo | name |
213 | 61791108 | Adeodato Simo | the name of the instance; if the request is a realocation, then this |
214 | 61791108 | Adeodato Simo | name will be found in the list of instances (see below), otherwise |
215 | 297b0cd3 | Iustin Pop | is the FQDN of the new instance; type *string* |
216 | 61791108 | Adeodato Simo | |
217 | 61791108 | Adeodato Simo | required_nodes |
218 | 61791108 | Adeodato Simo | how many nodes should the algorithm return; while this information |
219 | 61791108 | Adeodato Simo | can be deduced from the instace's disk template, it's better if |
220 | 61791108 | Adeodato Simo | this computation is left to Ganeti as then allocator scripts are |
221 | 297b0cd3 | Iustin Pop | less sensitive to changes to the disk templates; type *integer* |
222 | 61791108 | Adeodato Simo | |
223 | 61791108 | Adeodato Simo | disk_space_total |
224 | 61791108 | Adeodato Simo | the total disk space that will be used by this instance on the |
225 | 61791108 | Adeodato Simo | (new) nodes; again, this information can be computed from the list |
226 | 61791108 | Adeodato Simo | of instance disks and its template type, but Ganeti is better |
227 | 297b0cd3 | Iustin Pop | suited to compute it; type *integer* |
228 | 61791108 | Adeodato Simo | |
229 | 63fb7526 | Michael Hanselmann | .. pyassert:: |
230 | 63fb7526 | Michael Hanselmann | |
231 | 63fb7526 | Michael Hanselmann | constants.DISK_ACCESS_SET == set([constants.DISK_RDONLY, |
232 | 63fb7526 | Michael Hanselmann | constants.DISK_RDWR]) |
233 | 63fb7526 | Michael Hanselmann | |
234 | 61791108 | Adeodato Simo | Allocation needs, in addition: |
235 | 61791108 | Adeodato Simo | |
236 | 61791108 | Adeodato Simo | disks |
237 | 61791108 | Adeodato Simo | list of dictionaries holding the disk definitions for this |
238 | 61791108 | Adeodato Simo | instance (in the order they are exported to the hypervisor): |
239 | 61791108 | Adeodato Simo | |
240 | 61791108 | Adeodato Simo | mode |
241 | 63fb7526 | Michael Hanselmann | either :pyeval:`constants.DISK_RDONLY` or |
242 | 63fb7526 | Michael Hanselmann | :pyeval:`constants.DISK_RDWR` denoting if the disk is read-only or |
243 | 61791108 | Adeodato Simo | writable |
244 | 61791108 | Adeodato Simo | |
245 | 61791108 | Adeodato Simo | size |
246 | 61791108 | Adeodato Simo | the size of this disk in mebibytes |
247 | 61791108 | Adeodato Simo | |
248 | 61791108 | Adeodato Simo | nics |
249 | 61791108 | Adeodato Simo | a list of dictionaries holding the network interfaces for this |
250 | 61791108 | Adeodato Simo | instance, containing: |
251 | 61791108 | Adeodato Simo | |
252 | 61791108 | Adeodato Simo | ip |
253 | 61791108 | Adeodato Simo | the IP address that Ganeti know for this instance, or null |
254 | 61791108 | Adeodato Simo | |
255 | 61791108 | Adeodato Simo | mac |
256 | 61791108 | Adeodato Simo | the MAC address for this interface |
257 | 61791108 | Adeodato Simo | |
258 | 61791108 | Adeodato Simo | bridge |
259 | 61791108 | Adeodato Simo | the bridge to which this interface will be connected |
260 | 61791108 | Adeodato Simo | |
261 | 61791108 | Adeodato Simo | vcpus |
262 | 61791108 | Adeodato Simo | the number of VCPUs for the instance |
263 | 61791108 | Adeodato Simo | |
264 | 61791108 | Adeodato Simo | disk_template |
265 | 61791108 | Adeodato Simo | the disk template for the instance |
266 | 61791108 | Adeodato Simo | |
267 | 61791108 | Adeodato Simo | memory |
268 | 61791108 | Adeodato Simo | the memory size for the instance |
269 | 61791108 | Adeodato Simo | |
270 | 61791108 | Adeodato Simo | os |
271 | 61791108 | Adeodato Simo | the OS type for the instance |
272 | 61791108 | Adeodato Simo | |
273 | 61791108 | Adeodato Simo | tags |
274 | 61791108 | Adeodato Simo | the list of the instance's tags |
275 | 61791108 | Adeodato Simo | |
276 | 61791108 | Adeodato Simo | hypervisor |
277 | 61791108 | Adeodato Simo | the hypervisor of this instance |
278 | 61791108 | Adeodato Simo | |
279 | 61791108 | Adeodato Simo | Relocation: |
280 | 61791108 | Adeodato Simo | |
281 | 61791108 | Adeodato Simo | relocate_from |
282 | 61791108 | Adeodato Simo | a list of nodes to move the instance away from (note that with |
283 | 61791108 | Adeodato Simo | Ganeti 2.0, this list will always contain a single node, the |
284 | 297b0cd3 | Iustin Pop | current secondary of the instance); type *list of strings* |
285 | 61791108 | Adeodato Simo | |
286 | 25ee7fd8 | Michael Hanselmann | As for ``node-evacuate``, it needs the following request arguments: |
287 | 6d267b81 | Adeodato Simo | |
288 | 6d267b81 | Adeodato Simo | instances |
289 | 25ee7fd8 | Michael Hanselmann | a list of instance names to evacuate; type *list of strings* |
290 | 25ee7fd8 | Michael Hanselmann | |
291 | 25ee7fd8 | Michael Hanselmann | evac_mode |
292 | 25ee7fd8 | Michael Hanselmann | specify which instances to evacuate; one of ``primary-only``, |
293 | 25ee7fd8 | Michael Hanselmann | ``secondary-only``, ``all``, type *string* |
294 | 6d267b81 | Adeodato Simo | |
295 | 25ee7fd8 | Michael Hanselmann | ``change-group`` needs the following request arguments: |
296 | 25ee7fd8 | Michael Hanselmann | |
297 | 25ee7fd8 | Michael Hanselmann | instances |
298 | 25ee7fd8 | Michael Hanselmann | a list of instance names whose group to change; type |
299 | 25ee7fd8 | Michael Hanselmann | *list of strings* |
300 | 6d267b81 | Adeodato Simo | |
301 | 6d267b81 | Adeodato Simo | target_groups |
302 | 25ee7fd8 | Michael Hanselmann | must either be the empty list, or contain a list of group UUIDs that |
303 | 25ee7fd8 | Michael Hanselmann | should be considered for relocating instances to; type |
304 | 25ee7fd8 | Michael Hanselmann | *list of strings* |
305 | 6d267b81 | Adeodato Simo | |
306 | 0d853843 | Iustin Pop | Response message |
307 | 0d853843 | Iustin Pop | ~~~~~~~~~~~~~~~~ |
308 | 876860a3 | Iustin Pop | |
309 | 876860a3 | Iustin Pop | The response message is much more simple than the input one. It is |
310 | 876860a3 | Iustin Pop | also a dict having three keys: |
311 | 876860a3 | Iustin Pop | |
312 | 876860a3 | Iustin Pop | success |
313 | 5bbd3f7f | Michael Hanselmann | a boolean value denoting if the allocation was successful or not |
314 | 876860a3 | Iustin Pop | |
315 | 876860a3 | Iustin Pop | info |
316 | 876860a3 | Iustin Pop | a string with information from the scripts; if the allocation fails, |
317 | 876860a3 | Iustin Pop | this will be shown to the user |
318 | 876860a3 | Iustin Pop | |
319 | 632fb7ec | Iustin Pop | result |
320 | 632fb7ec | Iustin Pop | the output of the algorithm; even if the algorithm failed |
321 | 632fb7ec | Iustin Pop | (i.e. success is false), this must be returned as an empty list |
322 | 632fb7ec | Iustin Pop | |
323 | 632fb7ec | Iustin Pop | for allocate/relocate, this is the list of node(s) for the instance; |
324 | 632fb7ec | Iustin Pop | note that the length of this list must equal the ``requested_nodes`` |
325 | 632fb7ec | Iustin Pop | entry in the input message, otherwise Ganeti will consider the result |
326 | 632fb7ec | Iustin Pop | as failed |
327 | 632fb7ec | Iustin Pop | |
328 | 172679c9 | Michael Hanselmann | for the ``node-evacuate`` and ``change-group`` modes, this is a |
329 | 172679c9 | Michael Hanselmann | dictionary containing, among other information, a list of lists of |
330 | 172679c9 | Michael Hanselmann | serialized opcodes; see the :ref:`design document |
331 | 172679c9 | Michael Hanselmann | <multi-reloc-result>` for a detailed description |
332 | 6d267b81 | Adeodato Simo | |
333 | 632fb7ec | Iustin Pop | .. note:: Current Ganeti version accepts either ``result`` or ``nodes`` |
334 | 632fb7ec | Iustin Pop | as a backwards-compatibility measure (older versions only supported |
335 | 632fb7ec | Iustin Pop | ``nodes``) |
336 | 876860a3 | Iustin Pop | |
337 | 876860a3 | Iustin Pop | Examples |
338 | 876860a3 | Iustin Pop | -------- |
339 | 876860a3 | Iustin Pop | |
340 | 876860a3 | Iustin Pop | Input messages to scripts |
341 | 876860a3 | Iustin Pop | ~~~~~~~~~~~~~~~~~~~~~~~~~ |
342 | 876860a3 | Iustin Pop | |
343 | 61791108 | Adeodato Simo | Input message, new instance allocation (common elements are listed this |
344 | 61791108 | Adeodato Simo | time, but not included in further examples below):: |
345 | 876860a3 | Iustin Pop | |
346 | 876860a3 | Iustin Pop | { |
347 | 61791108 | Adeodato Simo | "version": 2, |
348 | 61791108 | Adeodato Simo | "cluster_name": "cluster1.example.com", |
349 | 876860a3 | Iustin Pop | "cluster_tags": [], |
350 | 61791108 | Adeodato Simo | "enabled_hypervisors": [ |
351 | 61791108 | Adeodato Simo | "xen-pvm" |
352 | 61791108 | Adeodato Simo | ], |
353 | 61791108 | Adeodato Simo | "nodegroups": { |
354 | 61791108 | Adeodato Simo | "f4e06e0d-528a-4963-a5ad-10f3e114232d": { |
355 | 61791108 | Adeodato Simo | "name": "default", |
356 | 61791108 | Adeodato Simo | "alloc_policy": "preferred" |
357 | 61791108 | Adeodato Simo | } |
358 | 876860a3 | Iustin Pop | }, |
359 | 876860a3 | Iustin Pop | "instances": { |
360 | 876860a3 | Iustin Pop | "instance1.example.com": { |
361 | 876860a3 | Iustin Pop | "tags": [], |
362 | 876860a3 | Iustin Pop | "should_run": false, |
363 | 876860a3 | Iustin Pop | "disks": [ |
364 | 876860a3 | Iustin Pop | { |
365 | 876860a3 | Iustin Pop | "mode": "w", |
366 | 876860a3 | Iustin Pop | "size": 64 |
367 | 876860a3 | Iustin Pop | }, |
368 | 876860a3 | Iustin Pop | { |
369 | 876860a3 | Iustin Pop | "mode": "w", |
370 | 876860a3 | Iustin Pop | "size": 512 |
371 | 876860a3 | Iustin Pop | } |
372 | 876860a3 | Iustin Pop | ], |
373 | 876860a3 | Iustin Pop | "nics": [ |
374 | 876860a3 | Iustin Pop | { |
375 | 876860a3 | Iustin Pop | "ip": null, |
376 | 876860a3 | Iustin Pop | "mac": "aa:00:00:00:60:bf", |
377 | 876860a3 | Iustin Pop | "bridge": "xen-br0" |
378 | 876860a3 | Iustin Pop | } |
379 | 876860a3 | Iustin Pop | ], |
380 | 876860a3 | Iustin Pop | "vcpus": 1, |
381 | 876860a3 | Iustin Pop | "disk_template": "plain", |
382 | 876860a3 | Iustin Pop | "memory": 128, |
383 | 876860a3 | Iustin Pop | "nodes": [ |
384 | 876860a3 | Iustin Pop | "nodee1.com" |
385 | 876860a3 | Iustin Pop | ], |
386 | 6f547f96 | Guido Trotter | "os": "debootstrap+default" |
387 | 876860a3 | Iustin Pop | }, |
388 | 876860a3 | Iustin Pop | "instance2.example.com": { |
389 | 876860a3 | Iustin Pop | "tags": [], |
390 | 876860a3 | Iustin Pop | "should_run": false, |
391 | 876860a3 | Iustin Pop | "disks": [ |
392 | 876860a3 | Iustin Pop | { |
393 | 876860a3 | Iustin Pop | "mode": "w", |
394 | 876860a3 | Iustin Pop | "size": 512 |
395 | 876860a3 | Iustin Pop | }, |
396 | 876860a3 | Iustin Pop | { |
397 | 876860a3 | Iustin Pop | "mode": "w", |
398 | 876860a3 | Iustin Pop | "size": 256 |
399 | 876860a3 | Iustin Pop | } |
400 | 876860a3 | Iustin Pop | ], |
401 | 876860a3 | Iustin Pop | "nics": [ |
402 | 876860a3 | Iustin Pop | { |
403 | 876860a3 | Iustin Pop | "ip": null, |
404 | 876860a3 | Iustin Pop | "mac": "aa:00:00:55:f8:38", |
405 | 876860a3 | Iustin Pop | "bridge": "xen-br0" |
406 | 876860a3 | Iustin Pop | } |
407 | 876860a3 | Iustin Pop | ], |
408 | 876860a3 | Iustin Pop | "vcpus": 1, |
409 | 876860a3 | Iustin Pop | "disk_template": "drbd", |
410 | 876860a3 | Iustin Pop | "memory": 512, |
411 | 876860a3 | Iustin Pop | "nodes": [ |
412 | 876860a3 | Iustin Pop | "node2.example.com", |
413 | 876860a3 | Iustin Pop | "node3.example.com" |
414 | 876860a3 | Iustin Pop | ], |
415 | 6f547f96 | Guido Trotter | "os": "debootstrap+default" |
416 | 876860a3 | Iustin Pop | } |
417 | 876860a3 | Iustin Pop | }, |
418 | 876860a3 | Iustin Pop | "nodes": { |
419 | 876860a3 | Iustin Pop | "node1.example.com": { |
420 | 876860a3 | Iustin Pop | "total_disk": 858276, |
421 | 926feaf1 | Manuel Franceschini | "primary_ip": "198.51.100.1", |
422 | 926feaf1 | Manuel Franceschini | "secondary_ip": "192.0.2.1", |
423 | 876860a3 | Iustin Pop | "tags": [], |
424 | 61791108 | Adeodato Simo | "group": "f4e06e0d-528a-4963-a5ad-10f3e114232d", |
425 | 876860a3 | Iustin Pop | "free_memory": 3505, |
426 | 876860a3 | Iustin Pop | "free_disk": 856740, |
427 | 876860a3 | Iustin Pop | "total_memory": 4095 |
428 | 876860a3 | Iustin Pop | }, |
429 | 876860a3 | Iustin Pop | "node2.example.com": { |
430 | 876860a3 | Iustin Pop | "total_disk": 858240, |
431 | 926feaf1 | Manuel Franceschini | "primary_ip": "198.51.100.2", |
432 | 926feaf1 | Manuel Franceschini | "secondary_ip": "192.0.2.2", |
433 | 876860a3 | Iustin Pop | "tags": ["test"], |
434 | 61791108 | Adeodato Simo | "group": "f4e06e0d-528a-4963-a5ad-10f3e114232d", |
435 | 876860a3 | Iustin Pop | "free_memory": 3505, |
436 | 876860a3 | Iustin Pop | "free_disk": 848320, |
437 | 876860a3 | Iustin Pop | "total_memory": 4095 |
438 | 876860a3 | Iustin Pop | }, |
439 | 876860a3 | Iustin Pop | "node3.example.com.com": { |
440 | 876860a3 | Iustin Pop | "total_disk": 572184, |
441 | 926feaf1 | Manuel Franceschini | "primary_ip": "198.51.100.3", |
442 | 926feaf1 | Manuel Franceschini | "secondary_ip": "192.0.2.3", |
443 | 876860a3 | Iustin Pop | "tags": [], |
444 | 61791108 | Adeodato Simo | "group": "f4e06e0d-528a-4963-a5ad-10f3e114232d", |
445 | 876860a3 | Iustin Pop | "free_memory": 3505, |
446 | 876860a3 | Iustin Pop | "free_disk": 570648, |
447 | 876860a3 | Iustin Pop | "total_memory": 4095 |
448 | 876860a3 | Iustin Pop | } |
449 | 61791108 | Adeodato Simo | }, |
450 | 61791108 | Adeodato Simo | "request": { |
451 | 61791108 | Adeodato Simo | "type": "allocate", |
452 | 61791108 | Adeodato Simo | "name": "instance3.example.com", |
453 | 61791108 | Adeodato Simo | "required_nodes": 2, |
454 | 61791108 | Adeodato Simo | "disk_space_total": 3328, |
455 | 61791108 | Adeodato Simo | "disks": [ |
456 | 61791108 | Adeodato Simo | { |
457 | 61791108 | Adeodato Simo | "mode": "w", |
458 | 61791108 | Adeodato Simo | "size": 1024 |
459 | 61791108 | Adeodato Simo | }, |
460 | 61791108 | Adeodato Simo | { |
461 | 61791108 | Adeodato Simo | "mode": "w", |
462 | 61791108 | Adeodato Simo | "size": 2048 |
463 | 61791108 | Adeodato Simo | } |
464 | 61791108 | Adeodato Simo | ], |
465 | 61791108 | Adeodato Simo | "nics": [ |
466 | 61791108 | Adeodato Simo | { |
467 | 61791108 | Adeodato Simo | "ip": null, |
468 | 61791108 | Adeodato Simo | "mac": "00:11:22:33:44:55", |
469 | 61791108 | Adeodato Simo | "bridge": null |
470 | 61791108 | Adeodato Simo | } |
471 | 61791108 | Adeodato Simo | ], |
472 | 61791108 | Adeodato Simo | "vcpus": 1, |
473 | 61791108 | Adeodato Simo | "disk_template": "drbd", |
474 | 61791108 | Adeodato Simo | "memory": 2048, |
475 | 61791108 | Adeodato Simo | "os": "debootstrap+default", |
476 | 61791108 | Adeodato Simo | "tags": [ |
477 | 61791108 | Adeodato Simo | "type:test", |
478 | 61791108 | Adeodato Simo | "owner:foo" |
479 | 61791108 | Adeodato Simo | ], |
480 | 61791108 | Adeodato Simo | hypervisor: "xen-pvm" |
481 | 876860a3 | Iustin Pop | } |
482 | 876860a3 | Iustin Pop | } |
483 | 876860a3 | Iustin Pop | |
484 | 61791108 | Adeodato Simo | Input message, reallocation:: |
485 | 876860a3 | Iustin Pop | |
486 | 61791108 | Adeodato Simo | { |
487 | 61791108 | Adeodato Simo | "version": 2, |
488 | 61791108 | Adeodato Simo | ... |
489 | 61791108 | Adeodato Simo | "request": { |
490 | 61791108 | Adeodato Simo | "type": "relocate", |
491 | 61791108 | Adeodato Simo | "name": "instance2.example.com", |
492 | 61791108 | Adeodato Simo | "required_nodes": 1, |
493 | 61791108 | Adeodato Simo | "disk_space_total": 832, |
494 | 61791108 | Adeodato Simo | "relocate_from": [ |
495 | 61791108 | Adeodato Simo | "node3.example.com" |
496 | 61791108 | Adeodato Simo | ] |
497 | 61791108 | Adeodato Simo | } |
498 | 61791108 | Adeodato Simo | } |
499 | 876860a3 | Iustin Pop | |
500 | 632fb7ec | Iustin Pop | |
501 | 876860a3 | Iustin Pop | Response messages |
502 | 876860a3 | Iustin Pop | ~~~~~~~~~~~~~~~~~ |
503 | 876860a3 | Iustin Pop | Successful response message:: |
504 | 876860a3 | Iustin Pop | |
505 | 876860a3 | Iustin Pop | { |
506 | 61791108 | Adeodato Simo | "success": true, |
507 | 876860a3 | Iustin Pop | "info": "Allocation successful", |
508 | 632fb7ec | Iustin Pop | "result": [ |
509 | 876860a3 | Iustin Pop | "node2.example.com", |
510 | 876860a3 | Iustin Pop | "node1.example.com" |
511 | 61791108 | Adeodato Simo | ] |
512 | 876860a3 | Iustin Pop | } |
513 | 876860a3 | Iustin Pop | |
514 | 876860a3 | Iustin Pop | Failed response message:: |
515 | 876860a3 | Iustin Pop | |
516 | 876860a3 | Iustin Pop | { |
517 | 61791108 | Adeodato Simo | "success": false, |
518 | 876860a3 | Iustin Pop | "info": "Can't find a suitable node for position 2 (already selected: node2.example.com)", |
519 | 61791108 | Adeodato Simo | "result": [] |
520 | 876860a3 | Iustin Pop | } |
521 | 876860a3 | Iustin Pop | |
522 | 632fb7ec | Iustin Pop | Successful node evacuation message:: |
523 | 632fb7ec | Iustin Pop | |
524 | 632fb7ec | Iustin Pop | { |
525 | 61791108 | Adeodato Simo | "success": true, |
526 | 632fb7ec | Iustin Pop | "info": "Request successful", |
527 | 632fb7ec | Iustin Pop | "result": [ |
528 | 632fb7ec | Iustin Pop | [ |
529 | 632fb7ec | Iustin Pop | "instance1", |
530 | 632fb7ec | Iustin Pop | "node3" |
531 | 632fb7ec | Iustin Pop | ], |
532 | 632fb7ec | Iustin Pop | [ |
533 | 632fb7ec | Iustin Pop | "instance2", |
534 | 632fb7ec | Iustin Pop | "node1" |
535 | 632fb7ec | Iustin Pop | ] |
536 | 61791108 | Adeodato Simo | ] |
537 | 632fb7ec | Iustin Pop | } |
538 | 632fb7ec | Iustin Pop | |
539 | 632fb7ec | Iustin Pop | |
540 | 876860a3 | Iustin Pop | Command line messages |
541 | 876860a3 | Iustin Pop | ~~~~~~~~~~~~~~~~~~~~~ |
542 | 876860a3 | Iustin Pop | :: |
543 | 876860a3 | Iustin Pop | |
544 | 6f547f96 | Guido Trotter | # gnt-instance add -t plain -m 2g --os-size 1g --swap-size 512m --iallocator hail -o debootstrap+default instance3 |
545 | 876860a3 | Iustin Pop | Selected nodes for the instance: node1.example.com |
546 | 876860a3 | Iustin Pop | * creating instance disks... |
547 | 876860a3 | Iustin Pop | [...] |
548 | 876860a3 | Iustin Pop | |
549 | 6f547f96 | Guido Trotter | # gnt-instance add -t plain -m 3400m --os-size 1g --swap-size 512m --iallocator hail -o debootstrap+default instance4 |
550 | 876860a3 | Iustin Pop | Failure: prerequisites not met for this operation: |
551 | 6f547f96 | Guido Trotter | Can't compute nodes using iallocator 'hail': Can't find a suitable node for position 1 (already selected: ) |
552 | 876860a3 | Iustin Pop | |
553 | 6f547f96 | Guido Trotter | # gnt-instance add -t drbd -m 1400m --os-size 1g --swap-size 512m --iallocator hail -o debootstrap+default instance5 |
554 | 876860a3 | Iustin Pop | Failure: prerequisites not met for this operation: |
555 | 6f547f96 | Guido Trotter | Can't compute nodes using iallocator 'hail': Can't find a suitable node for position 2 (already selected: node1.example.com) |
556 | 6f547f96 | Guido Trotter | |
557 | 6f547f96 | Guido Trotter | Reference implementation |
558 | 6f547f96 | Guido Trotter | ~~~~~~~~~~~~~~~~~~~~~~~~ |
559 | 6f547f96 | Guido Trotter | |
560 | 1ebe6dbd | Iustin Pop | Ganeti's default iallocator is "hail" which is available when "htools" |
561 | 1ebe6dbd | Iustin Pop | components have been enabled at build time (see :doc:`install-quick` for |
562 | 1ebe6dbd | Iustin Pop | more details). |
563 | 558fd122 | Michael Hanselmann | |
564 | 558fd122 | Michael Hanselmann | .. vim: set textwidth=72 : |
565 | 632fb7ec | Iustin Pop | .. Local Variables: |
566 | 632fb7ec | Iustin Pop | .. mode: rst |
567 | 632fb7ec | Iustin Pop | .. fill-column: 72 |
568 | 632fb7ec | Iustin Pop | .. End: |