ha-manager.adoc: bind note to list item using a continuation

[pve-docs.git] / ha-manager.adoc

diff --git a/ha-manager.adoc b/ha-manager.adoc
index 052eefc1fe1e6101cc4bce95b55f3e15638f601c..6ebba70e2290082f861186fc437e6a478419e19b 100644 (file)
--- a/ha-manager.adoc
+++ b/ha-manager.adoc
@@ -1,9 +1,7 @@
-[[chapter-ha-manager]]
+[[chapter_ha_manager]]

 ifdef::manvolnum[]
 ifdef::manvolnum[]

-PVE({manvolnum})
-================
-include::attributes.txt[]
-
+ha-manager(1)
+=============

 :pve-toplevel:
 
 NAME
 :pve-toplevel:
 
 NAME


@@ -19,16 +17,11 @@ include::ha-manager.1-synopsis.adoc[]
 DESCRIPTION
 -----------
 endif::manvolnum[]
 DESCRIPTION
 -----------
 endif::manvolnum[]

-

 ifndef::manvolnum[]
 High Availability
 =================
 ifndef::manvolnum[]
 High Availability
 =================

-include::attributes.txt[]
-endif::manvolnum[]
-
-ifdef::wiki[]

 :pve-toplevel:
 :pve-toplevel:

-endif::wiki[]
+endif::manvolnum[]

 
 Our modern society depends heavily on information provided by
 computers over the network. Mobile devices amplified that dependency,
 
 Our modern society depends heavily on information provided by
 computers over the network. Mobile devices amplified that dependency,


@@ -63,7 +56,7 @@ yourself. The following solutions works without modifying the
 software:
 
 * Use reliable ``server'' components
 software:
 
 * Use reliable ``server'' components

-
++

 NOTE: Computer components with same functionality can have varying
 reliability numbers, depending on the component quality. Most vendors
 sell components with higher reliability as ``server'' components -
 NOTE: Computer components with same functionality can have varying
 reliability numbers, depending on the component quality. Most vendors
 sell components with higher reliability as ``server'' components -


@@ -127,6 +120,7 @@ Requirements
 * optional hardware fencing devices
 
 
 * optional hardware fencing devices
 
 

+[[ha_manager_resources]]

 Resources
 ---------
 
 Resources
 ---------
 


@@ -153,16 +147,17 @@ To provide High Availability two daemons run on each node:
 
 `pve-ha-lrm`::
 
 
 `pve-ha-lrm`::
 

-The local resource manager (LRM), it controls the services running on
-the local node.
-It reads the requested states for its services from the current manager
-status file and executes the respective commands.
+The local resource manager (LRM), which controls the services running on
+the local node. It reads the requested states for its services from
+the current manager status file and executes the respective commands.

 
 `pve-ha-crm`::
 
 
 `pve-ha-crm`::
 

-The cluster resource manager (CRM), it controls the cluster wide
-actions of the services, processes the LRM results and includes the state
-machine which controls the state of each service.
+The cluster resource manager (CRM), which makes the cluster wide
+decisions. It sends commands to the LRM, processes the results,
+and moves resources to other nodes if something fails. The CRM also
+handles node fencing.
+

 
 .Locks in the LRM & CRM
 [NOTE]
 
 .Locks in the LRM & CRM
 [NOTE]


@@ -274,17 +269,56 @@ quorum, the LRM waits for a new quorum to form. As long as there is no
 quorum the node cannot reset the watchdog. This will trigger a reboot
 after the watchdog then times out, this happens after 60 seconds.
 
 quorum the node cannot reset the watchdog. This will trigger a reboot
 after the watchdog then times out, this happens after 60 seconds.
 

+

 Configuration
 -------------
 
 Configuration
 -------------
 

-The HA stack is well integrated in the Proxmox VE API2. So, for
-example, HA can be configured via `ha-manager` or the PVE web
-interface, which both provide an easy to use tool.
+The HA stack is well integrated into the {pve} API. So, for example,
+HA can be configured via the `ha-manager` command line interface, or
+the {pve} web interface - both interfaces provide an easy way to
+manage HA. Automation tools can use the API directly.
+
+All HA configuration files are within `/etc/pve/ha/`, so they get
+automatically distributed to the cluster nodes, and all nodes share
+the same HA configuration.
+
+
+Resources
+~~~~~~~~~
+
+The resource configuration file `/etc/pve/ha/resources.cfg` stores
+the list of resources managed by `ha-manager`. A resource configuration
+inside that list look like this:
+
+----
+<sid>:
+       <property> <value>
+       ...
+----
+
+It starts with the service ID followed by a collon. The next lines
+contain additional properties:
+
+include::ha-resources-opts.adoc[]
+
+
+Groups
+~~~~~~
+
+The HA group configuration file `/etc/pve/ha/groups.cfg` is used to
+define groups of cluster nodes. A resource can be restricted to run
+only on the members of such group. A group configuration look like
+this:
+
+----
+group: <group>
+       nodes <node_list>
+       <property> <value>
+       ...
+----
+
+include::ha-groups-opts.adoc[]

 
 

-The resource configuration file can be located at
-`/etc/pve/ha/resources.cfg` and the group configuration file at
-`/etc/pve/ha/groups.cfg`. Use the provided tools to make changes,
-there shouldn't be any need to edit them manually.

 
 Node Power Status
 -----------------
 
 Node Power Status
 -----------------


@@ -316,6 +350,7 @@ the update process can be too long which, in the worst case, may result in
 a watchdog reset.
 
 
 a watchdog reset.
 
 

+[[ha_manager_fencing]]

 Fencing
 -------
 
 Fencing
 -------
 


@@ -385,6 +420,7 @@ That minimizes the possibility of an overload, which else could cause an
 unresponsive node and as a result a chain reaction of node failures in the
 cluster.
 
 unresponsive node and as a result a chain reaction of node failures in the
 cluster.
 

+[[ha_manager_groups]]

 Groups
 ------
 
 Groups
 ------
 


@@ -486,6 +522,7 @@ killing its process)
 * *after* you fixed all errors you may enable the service again
 
 
 * *after* you fixed all errors you may enable the service again
 
 

+[[ha_manager_service_operations]]

 Service Operations
 ------------------
 
 Service Operations
 ------------------