79c90435601012813df4253b0f748a0f2f1c5c3d
[pve-docs.git] / ha-manager.adoc
1 [[chapter_ha_manager]]
2 ifdef::manvolnum[]
3 ha-manager(1)
4 =============
5 :pve-toplevel:
6
7 NAME
8 ----
9
10 ha-manager - Proxmox VE HA Manager
11
12 SYNOPSIS
13 --------
14
15 include::ha-manager.1-synopsis.adoc[]
16
17 DESCRIPTION
18 -----------
19 endif::manvolnum[]
20 ifndef::manvolnum[]
21 High Availability
22 =================
23 :pve-toplevel:
24 endif::manvolnum[]
25
26 Our modern society depends heavily on information provided by
27 computers over the network. Mobile devices amplified that dependency,
28 because people can access the network any time from anywhere. If you
29 provide such services, it is very important that they are available
30 most of the time.
31
32 We can mathematically define the availability as the ratio of (A) the
33 total time a service is capable of being used during a given interval
34 to (B) the length of the interval. It is normally expressed as a
35 percentage of uptime in a given year.
36
37 .Availability - Downtime per Year
38 [width="60%",cols="<d,d",options="header"]
39 |===========================================================
40 |Availability % |Downtime per year
41 |99             |3.65 days
42 |99.9           |8.76 hours
43 |99.99          |52.56 minutes
44 |99.999         |5.26 minutes
45 |99.9999        |31.5 seconds
46 |99.99999       |3.15 seconds
47 |===========================================================
48
49 There are several ways to increase availability. The most elegant
50 solution is to rewrite your software, so that you can run it on
51 several host at the same time. The software itself need to have a way
52 to detect errors and do failover. This is relatively easy if you just
53 want to serve read-only web pages. But in general this is complex, and
54 sometimes impossible because you cannot modify the software
55 yourself. The following solutions works without modifying the
56 software:
57
58 * Use reliable ``server'' components
59
60 NOTE: Computer components with same functionality can have varying
61 reliability numbers, depending on the component quality. Most vendors
62 sell components with higher reliability as ``server'' components -
63 usually at higher price.
64
65 * Eliminate single point of failure (redundant components)
66 ** use an uninterruptible power supply (UPS)
67 ** use redundant power supplies on the main boards
68 ** use ECC-RAM
69 ** use redundant network hardware
70 ** use RAID for local storage
71 ** use distributed, redundant storage for VM data
72
73 * Reduce downtime
74 ** rapidly accessible administrators (24/7)
75 ** availability of spare parts (other nodes in a {pve} cluster)
76 ** automatic error detection (provided by `ha-manager`)
77 ** automatic failover (provided by `ha-manager`)
78
79 Virtualization environments like {pve} make it much easier to reach
80 high availability because they remove the ``hardware'' dependency. They
81 also support to setup and use redundant storage and network
82 devices. So if one host fail, you can simply start those services on
83 another host within your cluster.
84
85 Even better, {pve} provides a software stack called `ha-manager`,
86 which can do that automatically for you. It is able to automatically
87 detect errors and do automatic failover.
88
89 {pve} `ha-manager` works like an ``automated'' administrator. First, you
90 configure what resources (VMs, containers, ...) it should
91 manage. `ha-manager` then observes correct functionality, and handles
92 service failover to another node in case of errors. `ha-manager` can
93 also handle normal user requests which may start, stop, relocate and
94 migrate a service.
95
96 But high availability comes at a price. High quality components are
97 more expensive, and making them redundant duplicates the costs at
98 least. Additional spare parts increase costs further. So you should
99 carefully calculate the benefits, and compare with those additional
100 costs.
101
102 TIP: Increasing availability from 99% to 99.9% is relatively
103 simply. But increasing availability from 99.9999% to 99.99999% is very
104 hard and costly. `ha-manager` has typical error detection and failover
105 times of about 2 minutes, so you can get no more than 99.999%
106 availability.
107
108 Requirements
109 ------------
110
111 * at least three cluster nodes (to get reliable quorum)
112
113 * shared storage for VMs and containers
114
115 * hardware redundancy (everywhere)
116
117 * hardware watchdog - if not available we fall back to the
118   linux kernel software watchdog (`softdog`)
119
120 * optional hardware fencing devices
121
122
123 [[ha_manager_resources]]
124 Resources
125 ---------
126
127 We call the primary management unit handled by `ha-manager` a
128 resource. A resource (also called ``service'') is uniquely
129 identified by a service ID (SID), which consists of the resource type
130 and an type specific ID, e.g.: `vm:100`. That example would be a
131 resource of type `vm` (virtual machine) with the ID 100.
132
133 For now we have two important resources types - virtual machines and
134 containers. One basic idea here is that we can bundle related software
135 into such VM or container, so there is no need to compose one big
136 service from other services, like it was done with `rgmanager`. In
137 general, a HA enabled resource should not depend on other resources.
138
139
140 How It Works
141 ------------
142
143 This section provides an in detail description of the {PVE} HA-manager
144 internals. It describes how the CRM and the LRM work together.
145
146 To provide High Availability two daemons run on each node:
147
148 `pve-ha-lrm`::
149
150 The local resource manager (LRM), it controls the services running on
151 the local node.
152 It reads the requested states for its services from the current manager
153 status file and executes the respective commands.
154
155 `pve-ha-crm`::
156
157 The cluster resource manager (CRM), it controls the cluster wide
158 actions of the services, processes the LRM results and includes the state
159 machine which controls the state of each service.
160
161 .Locks in the LRM & CRM
162 [NOTE]
163 Locks are provided by our distributed configuration file system (pmxcfs).
164 They are used to guarantee that each LRM is active once and working. As a
165 LRM only executes actions when it holds its lock we can mark a failed node
166 as fenced if we can acquire its lock. This lets us then recover any failed
167 HA services securely without any interference from the now unknown failed node.
168 This all gets supervised by the CRM which holds currently the manager master
169 lock.
170
171 Local Resource Manager
172 ~~~~~~~~~~~~~~~~~~~~~~
173
174 The local resource manager (`pve-ha-lrm`) is started as a daemon on
175 boot and waits until the HA cluster is quorate and thus cluster wide
176 locks are working.
177
178 It can be in three states:
179
180 wait for agent lock::
181
182 The LRM waits for our exclusive lock. This is also used as idle state if no
183 service is configured.
184
185 active::
186
187 The LRM holds its exclusive lock and has services configured.
188
189 lost agent lock::
190
191 The LRM lost its lock, this means a failure happened and quorum was lost.
192
193 After the LRM gets in the active state it reads the manager status
194 file in `/etc/pve/ha/manager_status` and determines the commands it
195 has to execute for the services it owns.
196 For each command a worker gets started, this workers are running in
197 parallel and are limited to at most 4 by default. This default setting
198 may be changed through the datacenter configuration key `max_worker`.
199 When finished the worker process gets collected and its result saved for
200 the CRM.
201
202 .Maximum Concurrent Worker Adjustment Tips
203 [NOTE]
204 The default value of at most 4 concurrent workers may be unsuited for
205 a specific setup. For example may 4 live migrations happen at the same
206 time, which can lead to network congestions with slower networks and/or
207 big (memory wise) services. Ensure that also in the worst case no congestion
208 happens and lower the `max_worker` value if needed. In the contrary, if you
209 have a particularly powerful high end setup you may also want to increase it.
210
211 Each command requested by the CRM is uniquely identifiable by an UID, when
212 the worker finished its result will be processed and written in the LRM
213 status file `/etc/pve/nodes/<nodename>/lrm_status`. There the CRM may collect
214 it and let its state machine - respective the commands output - act on it.
215
216 The actions on each service between CRM and LRM are normally always synced.
217 This means that the CRM requests a state uniquely marked by an UID, the LRM
218 then executes this action *one time* and writes back the result, also
219 identifiable by the same UID. This is needed so that the LRM does not
220 executes an outdated command.
221 With the exception of the `stop` and the `error` command,
222 those two do not depend on the result produced and are executed
223 always in the case of the stopped state and once in the case of
224 the error state.
225
226 .Read the Logs
227 [NOTE]
228 The HA Stack logs every action it makes. This helps to understand what
229 and also why something happens in the cluster. Here its important to see
230 what both daemons, the LRM and the CRM, did. You may use
231 `journalctl -u pve-ha-lrm` on the node(s) where the service is and
232 the same command for the pve-ha-crm on the node which is the current master.
233
234 Cluster Resource Manager
235 ~~~~~~~~~~~~~~~~~~~~~~~~
236
237 The cluster resource manager (`pve-ha-crm`) starts on each node and
238 waits there for the manager lock, which can only be held by one node
239 at a time.  The node which successfully acquires the manager lock gets
240 promoted to the CRM master.
241
242 It can be in three states:
243
244 wait for agent lock::
245
246 The CRM waits for our exclusive lock. This is also used as idle state if no
247 service is configured
248
249 active::
250
251 The CRM holds its exclusive lock and has services configured
252
253 lost agent lock::
254
255 The CRM lost its lock, this means a failure happened and quorum was lost.
256
257 It main task is to manage the services which are configured to be highly
258 available and try to always enforce them to the wanted state, e.g.: a
259 enabled service will be started if its not running, if it crashes it will
260 be started again. Thus it dictates the LRM the actions it needs to execute.
261
262 When an node leaves the cluster quorum, its state changes to unknown.
263 If the current CRM then can secure the failed nodes lock, the services
264 will be 'stolen' and restarted on another node.
265
266 When a cluster member determines that it is no longer in the cluster
267 quorum, the LRM waits for a new quorum to form. As long as there is no
268 quorum the node cannot reset the watchdog. This will trigger a reboot
269 after the watchdog then times out, this happens after 60 seconds.
270
271 Configuration
272 -------------
273
274 The HA stack is well integrated in the Proxmox VE API2. So, for
275 example, HA can be configured via `ha-manager` or the PVE web
276 interface, which both provide an easy to use tool.
277
278 The resource configuration file can be located at
279 `/etc/pve/ha/resources.cfg` and the group configuration file at
280 `/etc/pve/ha/groups.cfg`. Use the provided tools to make changes,
281 there shouldn't be any need to edit them manually.
282
283 Node Power Status
284 -----------------
285
286 If a node needs maintenance you should migrate and or relocate all
287 services which are required to run always on another node first.
288 After that you can stop the LRM and CRM services. But note that the
289 watchdog triggers if you stop it with active services.
290
291 Package Updates
292 ---------------
293
294 When updating the ha-manager you should do one node after the other, never
295 all at once for various reasons. First, while we test our software
296 thoughtfully, a bug affecting your specific setup cannot totally be ruled out.
297 Upgrading one node after the other and checking the functionality of each node
298 after finishing the update helps to recover from an eventual problems, while
299 updating all could render you in a broken cluster state and is generally not
300 good practice.
301
302 Also, the {pve} HA stack uses a request acknowledge protocol to perform
303 actions between the cluster and the local resource manager. For restarting,
304 the LRM makes a request to the CRM to freeze all its services. This prevents
305 that they get touched by the Cluster during the short time the LRM is restarting.
306 After that the LRM may safely close the watchdog during a restart.
307 Such a restart happens on a update and as already stated a active master
308 CRM is needed to acknowledge the requests from the LRM, if this is not the case
309 the update process can be too long which, in the worst case, may result in
310 a watchdog reset.
311
312
313 [[ha_manager_fencing]]
314 Fencing
315 -------
316
317 What is Fencing
318 ~~~~~~~~~~~~~~~
319
320 Fencing secures that on a node failure the dangerous node gets will be rendered
321 unable to do any damage and  that no resource runs twice when it gets recovered
322 from the failed node. This is a really important task and one of the base
323 principles to make a system Highly Available.
324
325 If a node would not get fenced it would be in an unknown state where it may
326 have still access to shared resources, this is really dangerous!
327 Imagine that every network but the storage one broke, now while not
328 reachable from the public network the VM still runs and writes on the shared
329 storage. If we would not fence the node and just start up this VM on another
330 Node we would get dangerous race conditions, atomicity violations the whole VM
331 could be rendered unusable. The recovery could also simply fail if the storage
332 protects from multiple mounts and thus defeat the purpose of HA.
333
334 How {pve} Fences
335 ~~~~~~~~~~~~~~~~~
336
337 There are different methods to fence a node, for example fence devices which
338 cut off the power from the node or disable their communication completely.
339
340 Those are often quite expensive and bring additional critical components in
341 a system, because if they fail you cannot recover any service.
342
343 We thus wanted to integrate a simpler method in the HA Manager first, namely
344 self fencing with watchdogs.
345
346 Watchdogs are widely used in critical and dependable systems since the
347 beginning of micro controllers, they are often independent and simple
348 integrated circuit which  programs can use to watch them. After opening they need to
349 report periodically. If, for whatever reason, a program becomes unable to do
350 so the watchdogs triggers a reset of the whole server.
351
352 Server motherboards often already include such hardware watchdogs, these need
353 to be configured. If no watchdog is available or configured we fall back to the
354 Linux Kernel softdog while still reliable it is not independent of the servers
355 Hardware and thus has a lower reliability then a hardware watchdog.
356
357 Configure Hardware Watchdog
358 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
359 By default all watchdog modules are blocked for security reasons as they are
360 like a loaded gun if not correctly initialized.
361 If you have a hardware watchdog available remove its kernel module from the
362 blacklist, load it with insmod and restart the `watchdog-mux` service or reboot
363 the node.
364
365 Recover Fenced Services
366 ~~~~~~~~~~~~~~~~~~~~~~~
367
368 After a node failed and its fencing was successful we start to recover services
369 to other available nodes and restart them there so that they can provide service
370 again.
371
372 The selection of the node on which the services gets recovered is influenced
373 by the users group settings, the currently active nodes and their respective
374 active service count.
375 First we build a set out of the intersection between user selected nodes and
376 available nodes. Then the subset with the highest priority of those nodes
377 gets chosen as possible nodes for recovery. We select the node with the
378 currently lowest active service count as a new node for the service.
379 That minimizes the possibility of an overload, which else could cause an
380 unresponsive node and as a result a chain reaction of node failures in the
381 cluster.
382
383 [[ha_manager_groups]]
384 Groups
385 ------
386
387 A group is a collection of cluster nodes which a service may be bound to.
388
389 Group Settings
390 ~~~~~~~~~~~~~~
391
392 nodes::
393
394 List of group node members where a priority can be given to each node.
395 A service bound to this group will run on the nodes with the highest priority
396 available. If more nodes are in the highest priority class the services will
397 get distributed to those node if not already there. The priorities have a
398 relative meaning only.
399   Example;;
400   You want to run all services from a group on `node1` if possible. If this node
401   is not available, you want them to run equally splitted on `node2` and `node3`, and
402   if those fail it should use `node4`.
403   To achieve this you could set the node list to:
404 [source,bash]
405   ha-manager groupset mygroup -nodes "node1:2,node2:1,node3:1,node4"
406
407 restricted::
408
409 Resources bound to this group may only run on nodes defined by the
410 group. If no group node member is available the resource will be
411 placed in the stopped state.
412   Example;;
413   Lets say a service uses resources only available on `node1` and `node2`,
414   so we need to make sure that HA manager does not use other nodes.
415   We need to create a 'restricted' group with said nodes:
416 [source,bash]
417   ha-manager groupset mygroup -nodes "node1,node2" -restricted 
418
419 nofailback::
420
421 The resource won't automatically fail back when a more preferred node
422 (re)joins the cluster.
423   Examples;;
424   * You need to migrate a service to a node which hasn't the highest priority
425   in the group at the moment, to tell the HA manager to not move this service
426   instantly back set the 'nofailback' option and the service will stay on
427   the current node.
428
429   * A service was fenced and it got recovered to another node. The admin
430   repaired the node and brought it up online again but does not want that the
431   recovered services move straight back to the repaired node as he wants to
432   first investigate the failure cause and check if it runs stable. He can use
433   the 'nofailback' option to achieve this.
434
435
436 Start Failure Policy
437 ---------------------
438
439 The start failure policy comes in effect if a service failed to start on a
440 node once ore more times. It can be used to configure how often a restart
441 should be triggered on the same node and how often a service should be
442 relocated so that it gets a try to be started on another node.
443 The aim of this policy is to circumvent temporary unavailability of shared
444 resources on a specific node. For example, if a shared storage isn't available
445 on a quorate node anymore, e.g. network problems, but still on other nodes,
446 the relocate policy allows then that the service gets started nonetheless.
447
448 There are two service start recover policy settings which can be configured
449 specific for each resource.
450
451 max_restart::
452
453 Maximum number of tries to restart an failed service on the actual
454 node.  The default is set to one.
455
456 max_relocate::
457
458 Maximum number of tries to relocate the service to a different node.
459 A relocate only happens after the max_restart value is exceeded on the
460 actual node. The default is set to one.
461
462 NOTE: The relocate count state will only reset to zero when the
463 service had at least one successful start. That means if a service is
464 re-enabled without fixing the error only the restart policy gets
465 repeated.
466
467 Error Recovery
468 --------------
469
470 If after all tries the service state could not be recovered it gets
471 placed in an error state. In this state the service won't get touched
472 by the HA stack anymore.  To recover from this state you should follow
473 these steps:
474
475 * bring the resource back into a safe and consistent state (e.g.,
476 killing its process)
477
478 * disable the ha resource to place it in an stopped state
479
480 * fix the error which led to this failures
481
482 * *after* you fixed all errors you may enable the service again
483
484
485 [[ha_manager_service_operations]]
486 Service Operations
487 ------------------
488
489 This are how the basic user-initiated service operations (via
490 `ha-manager`) work.
491
492 enable::
493
494 The service will be started by the LRM if not already running.
495
496 disable::
497
498 The service will be stopped by the LRM if running.
499
500 migrate/relocate::
501
502 The service will be relocated (live) to another node.
503
504 remove::
505
506 The service will be removed from the HA managed resource list. Its
507 current state will not be touched.
508
509 start/stop::
510
511 `start` and `stop` commands can be issued to the resource specific tools
512 (like `qm` or `pct`), they will forward the request to the
513 `ha-manager` which then will execute the action and set the resulting
514 service state (enabled, disabled).
515
516
517 Service States
518 --------------
519
520 stopped::
521
522 Service is stopped (confirmed by LRM), if detected running it will get stopped
523 again.
524
525 request_stop::
526
527 Service should be stopped. Waiting for confirmation from LRM.
528
529 started::
530
531 Service is active an LRM should start it ASAP if not already running.
532 If the Service fails and is detected to be not running the LRM restarts it.
533
534 fence::
535
536 Wait for node fencing (service node is not inside quorate cluster
537 partition).
538 As soon as node gets fenced successfully the service will be recovered to
539 another node, if possible.
540
541 freeze::
542
543 Do not touch the service state. We use this state while we reboot a
544 node, or when we restart the LRM daemon.
545
546 migrate::
547
548 Migrate service (live) to other node.
549
550 error::
551
552 Service disabled because of LRM errors. Needs manual intervention.
553
554
555 ifdef::manvolnum[]
556 include::pve-copyright.adoc[]
557 endif::manvolnum[]
558