]> git.proxmox.com Git - pve-docs.git/blob - ha-manager.adoc
ssh: document PVE-specific setup
[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 hosts at the same time. The software itself needs to have a way
52 to detect errors and do failover. If you only want to serve read-only
53 web pages, then this is relatively simple. However, this is generally complex
54 and sometimes impossible, because you cannot modify the software yourself. The
55 following solutions works without modifying the software:
56
57 * Use reliable ``server'' components
58 +
59 NOTE: Computer components with the same functionality can have varying
60 reliability numbers, depending on the component quality. Most vendors
61 sell components with higher reliability as ``server'' components -
62 usually at higher price.
63
64 * Eliminate single point of failure (redundant components)
65 ** use an uninterruptible power supply (UPS)
66 ** use redundant power supplies on the main boards
67 ** use ECC-RAM
68 ** use redundant network hardware
69 ** use RAID for local storage
70 ** use distributed, redundant storage for VM data
71
72 * Reduce downtime
73 ** rapidly accessible administrators (24/7)
74 ** availability of spare parts (other nodes in a {pve} cluster)
75 ** automatic error detection (provided by `ha-manager`)
76 ** automatic failover (provided by `ha-manager`)
77
78 Virtualization environments like {pve} make it much easier to reach
79 high availability because they remove the ``hardware'' dependency. They
80 also support the setup and use of redundant storage and network
81 devices, so if one host fails, you can simply start those services on
82 another host within your cluster.
83
84 Better still, {pve} provides a software stack called `ha-manager`,
85 which can do that automatically for you. It is able to automatically
86 detect errors and do automatic failover.
87
88 {pve} `ha-manager` works like an ``automated'' administrator. First, you
89 configure what resources (VMs, containers, ...) it should
90 manage. Then, `ha-manager` observes the correct functionality, and handles
91 service failover to another node in case of errors. `ha-manager` can
92 also handle normal user requests which may start, stop, relocate and
93 migrate a service.
94
95 But high availability comes at a price. High quality components are
96 more expensive, and making them redundant doubles the costs at
97 least. Additional spare parts increase costs further. So you should
98 carefully calculate the benefits, and compare with those additional
99 costs.
100
101 TIP: Increasing availability from 99% to 99.9% is relatively
102 simple. But increasing availability from 99.9999% to 99.99999% is very
103 hard and costly. `ha-manager` has typical error detection and failover
104 times of about 2 minutes, so you can get no more than 99.999%
105 availability.
106
107
108 Requirements
109 ------------
110
111 You must meet the following requirements before you start with HA:
112
113 * at least three cluster nodes (to get reliable quorum)
114
115 * shared storage for VMs and containers
116
117 * hardware redundancy (everywhere)
118
119 * use reliable “server” components
120
121 * hardware watchdog - if not available we fall back to the
122 linux kernel software watchdog (`softdog`)
123
124 * optional hardware fencing devices
125
126
127 [[ha_manager_resources]]
128 Resources
129 ---------
130
131 We call the primary management unit handled by `ha-manager` a
132 resource. A resource (also called ``service'') is uniquely
133 identified by a service ID (SID), which consists of the resource type
134 and a type specific ID, for example `vm:100`. That example would be a
135 resource of type `vm` (virtual machine) with the ID 100.
136
137 For now we have two important resources types - virtual machines and
138 containers. One basic idea here is that we can bundle related software
139 into such a VM or container, so there is no need to compose one big
140 service from other services, as was done with `rgmanager`. In
141 general, a HA managed resource should not depend on other resources.
142
143
144 Management Tasks
145 ----------------
146
147 This section provides a short overview of common management tasks. The
148 first step is to enable HA for a resource. This is done by adding the
149 resource to the HA resource configuration. You can do this using the
150 GUI, or simply use the command line tool, for example:
151
152 ----
153 # ha-manager add vm:100
154 ----
155
156 The HA stack now tries to start the resources and keep them
157 running. Please note that you can configure the ``requested''
158 resources state. For example you may want the HA stack to stop the
159 resource:
160
161 ----
162 # ha-manager set vm:100 --state stopped
163 ----
164
165 and start it again later:
166
167 ----
168 # ha-manager set vm:100 --state started
169 ----
170
171 You can also use the normal VM and container management commands. They
172 automatically forward the commands to the HA stack, so
173
174 ----
175 # qm start 100
176 ----
177
178 simply sets the requested state to `started`. The same applies to `qm
179 stop`, which sets the requested state to `stopped`.
180
181 NOTE: The HA stack works fully asynchronous and needs to communicate
182 with other cluster members. Therefore, it takes some seconds until you see
183 the result of such actions.
184
185 To view the current HA resource configuration use:
186
187 ----
188 # ha-manager config
189 vm:100
190 state stopped
191 ----
192
193 And you can view the actual HA manager and resource state with:
194
195 ----
196 # ha-manager status
197 quorum OK
198 master node1 (active, Wed Nov 23 11:07:23 2016)
199 lrm elsa (active, Wed Nov 23 11:07:19 2016)
200 service vm:100 (node1, started)
201 ----
202
203 You can also initiate resource migration to other nodes:
204
205 ----
206 # ha-manager migrate vm:100 node2
207 ----
208
209 This uses online migration and tries to keep the VM running. Online
210 migration needs to transfer all used memory over the network, so it is
211 sometimes faster to stop the VM, then restart it on the new node. This can be
212 done using the `relocate` command:
213
214 ----
215 # ha-manager relocate vm:100 node2
216 ----
217
218 Finally, you can remove the resource from the HA configuration using
219 the following command:
220
221 ----
222 # ha-manager remove vm:100
223 ----
224
225 NOTE: This does not start or stop the resource.
226
227 But all HA related tasks can be done in the GUI, so there is no need to
228 use the command line at all.
229
230
231 How It Works
232 ------------
233
234 This section provides a detailed description of the {PVE} HA manager
235 internals. It describes all involved daemons and how they work
236 together. To provide HA, two daemons run on each node:
237
238 `pve-ha-lrm`::
239
240 The local resource manager (LRM), which controls the services running on
241 the local node. It reads the requested states for its services from
242 the current manager status file and executes the respective commands.
243
244 `pve-ha-crm`::
245
246 The cluster resource manager (CRM), which makes the cluster wide
247 decisions. It sends commands to the LRM, processes the results,
248 and moves resources to other nodes if something fails. The CRM also
249 handles node fencing.
250
251
252 .Locks in the LRM & CRM
253 [NOTE]
254 Locks are provided by our distributed configuration file system (pmxcfs).
255 They are used to guarantee that each LRM is active once and working. As an
256 LRM only executes actions when it holds its lock, we can mark a failed node
257 as fenced if we can acquire its lock. This then lets us recover any failed
258 HA services securely without any interference from the now unknown failed node.
259 This all gets supervised by the CRM which currently holds the manager master
260 lock.
261
262
263 Service States
264 ~~~~~~~~~~~~~~
265
266 The CRM uses a service state enumeration to record the current service
267 state. This state is displayed on the GUI and can be queried using
268 the `ha-manager` command line tool:
269
270 ----
271 # ha-manager status
272 quorum OK
273 master elsa (active, Mon Nov 21 07:23:29 2016)
274 lrm elsa (active, Mon Nov 21 07:23:22 2016)
275 service ct:100 (elsa, stopped)
276 service ct:102 (elsa, started)
277 service vm:501 (elsa, started)
278 ----
279
280 Here is the list of possible states:
281
282 stopped::
283
284 Service is stopped (confirmed by LRM). If the LRM detects a stopped
285 service is still running, it will stop it again.
286
287 request_stop::
288
289 Service should be stopped. The CRM waits for confirmation from the
290 LRM.
291
292 stopping::
293
294 Pending stop request. But the CRM did not get the request so far.
295
296 started::
297
298 Service is active an LRM should start it ASAP if not already running.
299 If the Service fails and is detected to be not running the LRM
300 restarts it
301 (see xref:ha_manager_start_failure_policy[Start Failure Policy]).
302
303 starting::
304
305 Pending start request. But the CRM has not got any confirmation from the
306 LRM that the service is running.
307
308 fence::
309
310 Wait for node fencing (service node is not inside quorate cluster
311 partition). As soon as node gets fenced successfully the service will
312 be recovered to another node, if possible
313 (see xref:ha_manager_fencing[Fencing]).
314
315 freeze::
316
317 Do not touch the service state. We use this state while we reboot a
318 node, or when we restart the LRM daemon
319 (see xref:ha_manager_package_updates[Package Updates]).
320
321 ignored::
322
323 Act as if the service were not managed by HA at all.
324 Useful, when full control over the service is desired temporarily,
325 without removing it from the HA configuration.
326
327
328 migrate::
329
330 Migrate service (live) to other node.
331
332 error::
333
334 Service is disabled because of LRM errors. Needs manual intervention
335 (see xref:ha_manager_error_recovery[Error Recovery]).
336
337 queued::
338
339 Service is newly added, and the CRM has not seen it so far.
340
341 disabled::
342
343 Service is stopped and marked as `disabled`
344
345
346 Local Resource Manager
347 ~~~~~~~~~~~~~~~~~~~~~~
348
349 The local resource manager (`pve-ha-lrm`) is started as a daemon on
350 boot and waits until the HA cluster is quorate and thus cluster wide
351 locks are working.
352
353 It can be in three states:
354
355 wait for agent lock::
356
357 The LRM waits for our exclusive lock. This is also used as idle state if no
358 service is configured.
359
360 active::
361
362 The LRM holds its exclusive lock and has services configured.
363
364 lost agent lock::
365
366 The LRM lost its lock, this means a failure happened and quorum was lost.
367
368 After the LRM gets in the active state it reads the manager status
369 file in `/etc/pve/ha/manager_status` and determines the commands it
370 has to execute for the services it owns.
371 For each command a worker gets started, these workers are running in
372 parallel and are limited to at most 4 by default. This default setting
373 may be changed through the datacenter configuration key `max_worker`.
374 When finished the worker process gets collected and its result saved for
375 the CRM.
376
377 .Maximum Concurrent Worker Adjustment Tips
378 [NOTE]
379 The default value of at most 4 concurrent workers may be unsuited for
380 a specific setup. For example, 4 live migrations may occur at the same
381 time, which can lead to network congestions with slower networks and/or
382 big (memory wise) services. Also, ensure that in the worst case, congestion is
383 at a minimum, even if this means lowering the `max_worker` value. On the
384 contrary, if you have a particularly powerful, high-end setup you may also want
385 to increase it.
386
387 Each command requested by the CRM is uniquely identifiable by a UID. When
388 the worker finishes, its result will be processed and written in the LRM
389 status file `/etc/pve/nodes/<nodename>/lrm_status`. There the CRM may collect
390 it and let its state machine - respective to the commands output - act on it.
391
392 The actions on each service between CRM and LRM are normally always synced.
393 This means that the CRM requests a state uniquely marked by a UID, the LRM
394 then executes this action *one time* and writes back the result, which is also
395 identifiable by the same UID. This is needed so that the LRM does not
396 execute an outdated command.
397 The only exceptions to this behaviour are the `stop` and `error` commands;
398 these two do not depend on the result produced and are executed
399 always in the case of the stopped state and once in the case of
400 the error state.
401
402 .Read the Logs
403 [NOTE]
404 The HA Stack logs every action it makes. This helps to understand what
405 and also why something happens in the cluster. Here its important to see
406 what both daemons, the LRM and the CRM, did. You may use
407 `journalctl -u pve-ha-lrm` on the node(s) where the service is and
408 the same command for the pve-ha-crm on the node which is the current master.
409
410 Cluster Resource Manager
411 ~~~~~~~~~~~~~~~~~~~~~~~~
412
413 The cluster resource manager (`pve-ha-crm`) starts on each node and
414 waits there for the manager lock, which can only be held by one node
415 at a time. The node which successfully acquires the manager lock gets
416 promoted to the CRM master.
417
418 It can be in three states:
419
420 wait for agent lock::
421
422 The CRM waits for our exclusive lock. This is also used as idle state if no
423 service is configured
424
425 active::
426
427 The CRM holds its exclusive lock and has services configured
428
429 lost agent lock::
430
431 The CRM lost its lock, this means a failure happened and quorum was lost.
432
433 Its main task is to manage the services which are configured to be highly
434 available and try to always enforce the requested state. For example, a
435 service with the requested state 'started' will be started if its not
436 already running. If it crashes it will be automatically started again.
437 Thus the CRM dictates the actions the LRM needs to execute.
438
439 When a node leaves the cluster quorum, its state changes to unknown.
440 If the current CRM can then secure the failed node's lock, the services
441 will be 'stolen' and restarted on another node.
442
443 When a cluster member determines that it is no longer in the cluster
444 quorum, the LRM waits for a new quorum to form. As long as there is no
445 quorum the node cannot reset the watchdog. This will trigger a reboot
446 after the watchdog times out (this happens after 60 seconds).
447
448
449 HA Simulator
450 ------------
451
452 [thumbnail="screenshot/gui-ha-manager-status.png"]
453
454 By using the HA simulator you can test and learn all functionalities of the
455 Proxmox VE HA solutions.
456
457 By default, the simulator allows you to watch and test the behaviour of a
458 real-world 3 node cluster with 6 VMs. You can also add or remove additional VMs
459 or Container.
460
461 You do not have to setup or configure a real cluster, the HA simulator runs out
462 of the box.
463
464 Install with apt:
465
466 ----
467 apt install pve-ha-simulator
468 ----
469
470 You can even install the package on any Debian-based system without any
471 other Proxmox VE packages. For that you will need to download the package and
472 copy it to the system you want to run it on for installation. When you install
473 the package with apt from the local file system it will also resolve the
474 required dependencies for you.
475
476
477 To start the simulator on a remote machine you must have an X11 redirection to
478 your current system.
479
480 If you are on a Linux machine you can use:
481
482 ----
483 ssh root@<IPofPVE> -Y
484 ----
485
486 On Windows it works with https://mobaxterm.mobatek.net/[mobaxterm].
487
488 After connecting to an existing {pve} with the simulator installed or
489 installing it on your local Debian-based system manually, you can try it out as
490 follows.
491
492 First you need to create a working directory where the simulator saves its
493 current state and writes its default config:
494
495 ----
496 mkdir working
497 ----
498
499 Then, simply pass the created directory as a parameter to 'pve-ha-simulator':
500
501 ----
502 pve-ha-simulator working/
503 ----
504
505 You can then start, stop, migrate the simulated HA services, or even check out
506 what happens on a node failure.
507
508 Configuration
509 -------------
510
511 The HA stack is well integrated into the {pve} API. So, for example,
512 HA can be configured via the `ha-manager` command line interface, or
513 the {pve} web interface - both interfaces provide an easy way to
514 manage HA. Automation tools can use the API directly.
515
516 All HA configuration files are within `/etc/pve/ha/`, so they get
517 automatically distributed to the cluster nodes, and all nodes share
518 the same HA configuration.
519
520
521 [[ha_manager_resource_config]]
522 Resources
523 ~~~~~~~~~
524
525 [thumbnail="screenshot/gui-ha-manager-status.png"]
526
527
528 The resource configuration file `/etc/pve/ha/resources.cfg` stores
529 the list of resources managed by `ha-manager`. A resource configuration
530 inside that list looks like this:
531
532 ----
533 <type>: <name>
534 <property> <value>
535 ...
536 ----
537
538 It starts with a resource type followed by a resource specific name,
539 separated with colon. Together this forms the HA resource ID, which is
540 used by all `ha-manager` commands to uniquely identify a resource
541 (example: `vm:100` or `ct:101`). The next lines contain additional
542 properties:
543
544 include::ha-resources-opts.adoc[]
545
546 Here is a real world example with one VM and one container. As you see,
547 the syntax of those files is really simple, so it is even possible to
548 read or edit those files using your favorite editor:
549
550 .Configuration Example (`/etc/pve/ha/resources.cfg`)
551 ----
552 vm: 501
553 state started
554 max_relocate 2
555
556 ct: 102
557 # Note: use default settings for everything
558 ----
559
560 [thumbnail="screenshot/gui-ha-manager-add-resource.png"]
561
562 The above config was generated using the `ha-manager` command line tool:
563
564 ----
565 # ha-manager add vm:501 --state started --max_relocate 2
566 # ha-manager add ct:102
567 ----
568
569
570 [[ha_manager_groups]]
571 Groups
572 ~~~~~~
573
574 [thumbnail="screenshot/gui-ha-manager-groups-view.png"]
575
576 The HA group configuration file `/etc/pve/ha/groups.cfg` is used to
577 define groups of cluster nodes. A resource can be restricted to run
578 only on the members of such group. A group configuration look like
579 this:
580
581 ----
582 group: <group>
583 nodes <node_list>
584 <property> <value>
585 ...
586 ----
587
588 include::ha-groups-opts.adoc[]
589
590 [thumbnail="screenshot/gui-ha-manager-add-group.png"]
591
592 A common requirement is that a resource should run on a specific
593 node. Usually the resource is able to run on other nodes, so you can define
594 an unrestricted group with a single member:
595
596 ----
597 # ha-manager groupadd prefer_node1 --nodes node1
598 ----
599
600 For bigger clusters, it makes sense to define a more detailed failover
601 behavior. For example, you may want to run a set of services on
602 `node1` if possible. If `node1` is not available, you want to run them
603 equally split on `node2` and `node3`. If those nodes also fail, the
604 services should run on `node4`. To achieve this you could set the node
605 list to:
606
607 ----
608 # ha-manager groupadd mygroup1 -nodes "node1:2,node2:1,node3:1,node4"
609 ----
610
611 Another use case is if a resource uses other resources only available
612 on specific nodes, lets say `node1` and `node2`. We need to make sure
613 that HA manager does not use other nodes, so we need to create a
614 restricted group with said nodes:
615
616 ----
617 # ha-manager groupadd mygroup2 -nodes "node1,node2" -restricted
618 ----
619
620 The above commands created the following group configuration file:
621
622 .Configuration Example (`/etc/pve/ha/groups.cfg`)
623 ----
624 group: prefer_node1
625 nodes node1
626
627 group: mygroup1
628 nodes node2:1,node4,node1:2,node3:1
629
630 group: mygroup2
631 nodes node2,node1
632 restricted 1
633 ----
634
635
636 The `nofailback` options is mostly useful to avoid unwanted resource
637 movements during administration tasks. For example, if you need to
638 migrate a service to a node which doesn't have the highest priority in the
639 group, you need to tell the HA manager not to instantly move this service
640 back by setting the `nofailback` option.
641
642 Another scenario is when a service was fenced and it got recovered to
643 another node. The admin tries to repair the fenced node and brings it
644 up online again to investigate the cause of failure and check if it runs
645 stably again. Setting the `nofailback` flag prevents the recovered services from
646 moving straight back to the fenced node.
647
648
649 [[ha_manager_fencing]]
650 Fencing
651 -------
652
653 On node failures, fencing ensures that the erroneous node is
654 guaranteed to be offline. This is required to make sure that no
655 resource runs twice when it gets recovered on another node. This is a
656 really important task, because without this, it would not be possible to
657 recover a resource on another node.
658
659 If a node did not get fenced, it would be in an unknown state where
660 it may have still access to shared resources. This is really
661 dangerous! Imagine that every network but the storage one broke. Now,
662 while not reachable from the public network, the VM still runs and
663 writes to the shared storage.
664
665 If we then simply start up this VM on another node, we would get a
666 dangerous race condition, because we write from both nodes. Such
667 conditions can destroy all VM data and the whole VM could be rendered
668 unusable. The recovery could also fail if the storage protects against
669 multiple mounts.
670
671
672 How {pve} Fences
673 ~~~~~~~~~~~~~~~~
674
675 There are different methods to fence a node, for example, fence
676 devices which cut off the power from the node or disable their
677 communication completely. Those are often quite expensive and bring
678 additional critical components into a system, because if they fail you
679 cannot recover any service.
680
681 We thus wanted to integrate a simpler fencing method, which does not
682 require additional external hardware. This can be done using
683 watchdog timers.
684
685 .Possible Fencing Methods
686 - external power switches
687 - isolate nodes by disabling complete network traffic on the switch
688 - self fencing using watchdog timers
689
690 Watchdog timers have been widely used in critical and dependable systems
691 since the beginning of microcontrollers. They are often simple, independent
692 integrated circuits which are used to detect and recover from computer malfunctions.
693
694 During normal operation, `ha-manager` regularly resets the watchdog
695 timer to prevent it from elapsing. If, due to a hardware fault or
696 program error, the computer fails to reset the watchdog, the timer
697 will elapse and trigger a reset of the whole server (reboot).
698
699 Recent server motherboards often include such hardware watchdogs, but
700 these need to be configured. If no watchdog is available or
701 configured, we fall back to the Linux Kernel 'softdog'. While still
702 reliable, it is not independent of the servers hardware, and thus has
703 a lower reliability than a hardware watchdog.
704
705
706 Configure Hardware Watchdog
707 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
708
709 By default, all hardware watchdog modules are blocked for security
710 reasons. They are like a loaded gun if not correctly initialized. To
711 enable a hardware watchdog, you need to specify the module to load in
712 '/etc/default/pve-ha-manager', for example:
713
714 ----
715 # select watchdog module (default is softdog)
716 WATCHDOG_MODULE=iTCO_wdt
717 ----
718
719 This configuration is read by the 'watchdog-mux' service, which loads
720 the specified module at startup.
721
722
723 Recover Fenced Services
724 ~~~~~~~~~~~~~~~~~~~~~~~
725
726 After a node failed and its fencing was successful, the CRM tries to
727 move services from the failed node to nodes which are still online.
728
729 The selection of nodes, on which those services gets recovered, is
730 influenced by the resource `group` settings, the list of currently active
731 nodes, and their respective active service count.
732
733 The CRM first builds a set out of the intersection between user selected
734 nodes (from `group` setting) and available nodes. It then choose the
735 subset of nodes with the highest priority, and finally select the node
736 with the lowest active service count. This minimizes the possibility
737 of an overloaded node.
738
739 CAUTION: On node failure, the CRM distributes services to the
740 remaining nodes. This increases the service count on those nodes, and
741 can lead to high load, especially on small clusters. Please design
742 your cluster so that it can handle such worst case scenarios.
743
744
745 [[ha_manager_start_failure_policy]]
746 Start Failure Policy
747 ---------------------
748
749 The start failure policy comes into effect if a service failed to start on a
750 node one or more times. It can be used to configure how often a restart
751 should be triggered on the same node and how often a service should be
752 relocated, so that it has an attempt to be started on another node.
753 The aim of this policy is to circumvent temporary unavailability of shared
754 resources on a specific node. For example, if a shared storage isn't available
755 on a quorate node anymore, for instance due to network problems, but is still
756 available on other nodes, the relocate policy allows the service to start
757 nonetheless.
758
759 There are two service start recover policy settings which can be configured
760 specific for each resource.
761
762 max_restart::
763
764 Maximum number of attempts to restart a failed service on the actual
765 node. The default is set to one.
766
767 max_relocate::
768
769 Maximum number of attempts to relocate the service to a different node.
770 A relocate only happens after the max_restart value is exceeded on the
771 actual node. The default is set to one.
772
773 NOTE: The relocate count state will only reset to zero when the
774 service had at least one successful start. That means if a service is
775 re-started without fixing the error only the restart policy gets
776 repeated.
777
778
779 [[ha_manager_error_recovery]]
780 Error Recovery
781 --------------
782
783 If, after all attempts, the service state could not be recovered, it gets
784 placed in an error state. In this state, the service won't get touched
785 by the HA stack anymore. The only way out is disabling a service:
786
787 ----
788 # ha-manager set vm:100 --state disabled
789 ----
790
791 This can also be done in the web interface.
792
793 To recover from the error state you should do the following:
794
795 * bring the resource back into a safe and consistent state (e.g.:
796 kill its process if the service could not be stopped)
797
798 * disable the resource to remove the error flag
799
800 * fix the error which led to this failures
801
802 * *after* you fixed all errors you may request that the service starts again
803
804
805 [[ha_manager_package_updates]]
806 Package Updates
807 ---------------
808
809 When updating the ha-manager, you should do one node after the other, never
810 all at once for various reasons. First, while we test our software
811 thoroughly, a bug affecting your specific setup cannot totally be ruled out.
812 Updating one node after the other and checking the functionality of each node
813 after finishing the update helps to recover from eventual problems, while
814 updating all at once could result in a broken cluster and is generally not
815 good practice.
816
817 Also, the {pve} HA stack uses a request acknowledge protocol to perform
818 actions between the cluster and the local resource manager. For restarting,
819 the LRM makes a request to the CRM to freeze all its services. This prevents
820 them from getting touched by the Cluster during the short time the LRM is restarting.
821 After that, the LRM may safely close the watchdog during a restart.
822 Such a restart happens normally during a package update and, as already stated,
823 an active master CRM is needed to acknowledge the requests from the LRM. If
824 this is not the case the update process can take too long which, in the worst
825 case, may result in a reset triggered by the watchdog.
826
827
828 Node Maintenance
829 ----------------
830
831 It is sometimes necessary to shutdown or reboot a node to do maintenance tasks,
832 such as to replace hardware, or simply to install a new kernel image. This is
833 also true when using the HA stack. The behaviour of the HA stack during a
834 shutdown can be configured.
835
836 [[ha_manager_shutdown_policy]]
837 Shutdown Policy
838 ~~~~~~~~~~~~~~~
839
840 Below you will find a description of the different HA policies for a node
841 shutdown. Currently 'Conditional' is the default due to backward compatibility.
842 Some users may find that 'Migrate' behaves more as expected.
843
844 Migrate
845 ^^^^^^^
846
847 Once the Local Resource manager (LRM) gets a shutdown request and this policy
848 is enabled, it will mark itself as unavailable for the current HA manager.
849 This triggers a migration of all HA Services currently located on this node.
850 The LRM will try to delay the shutdown process, until all running services get
851 moved away. But, this expects that the running services *can* be migrated to
852 another node. In other words, the service must not be locally bound, for example
853 by using hardware passthrough. As non-group member nodes are considered as
854 runnable target if no group member is available, this policy can still be used
855 when making use of HA groups with only some nodes selected. But, marking a group
856 as 'restricted' tells the HA manager that the service cannot run outside of the
857 chosen set of nodes. If all of those nodes are unavailable, the shutdown will
858 hang until you manually intervene. Once the shut down node comes back online
859 again, the previously displaced services will be moved back, if they were not
860 already manually migrated in-between.
861
862 NOTE: The watchdog is still active during the migration process on shutdown.
863 If the node loses quorum it will be fenced and the services will be recovered.
864
865 If you start a (previously stopped) service on a node which is currently being
866 maintained, the node needs to be fenced to ensure that the service can be moved
867 and started on another available node.
868
869 Failover
870 ^^^^^^^^
871
872 This mode ensures that all services get stopped, but that they will also be
873 recovered, if the current node is not online soon. It can be useful when doing
874 maintenance on a cluster scale, where live-migrating VMs may not be possible if
875 too many nodes are powered off at a time, but you still want to ensure HA
876 services get recovered and started again as soon as possible.
877
878 Freeze
879 ^^^^^^
880
881 This mode ensures that all services get stopped and frozen, so that they won't
882 get recovered until the current node is online again.
883
884 Conditional
885 ^^^^^^^^^^^
886
887 The 'Conditional' shutdown policy automatically detects if a shutdown or a
888 reboot is requested, and changes behaviour accordingly.
889
890 .Shutdown
891
892 A shutdown ('poweroff') is usually done if it is planned for the node to stay
893 down for some time. The LRM stops all managed services in this case. This means
894 that other nodes will take over those services afterwards.
895
896 NOTE: Recent hardware has large amounts of memory (RAM). So we stop all
897 resources, then restart them to avoid online migration of all that RAM. If you
898 want to use online migration, you need to invoke that manually before you
899 shutdown the node.
900
901
902 .Reboot
903
904 Node reboots are initiated with the 'reboot' command. This is usually done
905 after installing a new kernel. Please note that this is different from
906 ``shutdown'', because the node immediately starts again.
907
908 The LRM tells the CRM that it wants to restart, and waits until the CRM puts
909 all resources into the `freeze` state (same mechanism is used for
910 xref:ha_manager_package_updates[Package Updates]). This prevents those resources
911 from being moved to other nodes. Instead, the CRM starts the resources after the
912 reboot on the same node.
913
914
915 Manual Resource Movement
916 ^^^^^^^^^^^^^^^^^^^^^^^^
917
918 Last but not least, you can also manually move resources to other nodes, before
919 you shutdown or restart a node. The advantage is that you have full control,
920 and you can decide if you want to use online migration or not.
921
922 NOTE: Please do not 'kill' services like `pve-ha-crm`, `pve-ha-lrm` or
923 `watchdog-mux`. They manage and use the watchdog, so this can result in an
924 immediate node reboot or even reset.
925
926
927 ifdef::manvolnum[]
928 include::pve-copyright.adoc[]
929 endif::manvolnum[]
930