pve-installation.adoc: cleanup previos commit

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

diff --git a/ha-manager.adoc b/ha-manager.adoc
index c7c65f4fe2772548f211caf39314c3d52a681a1d..d49a8c6d1ced7cdad6fe6e6f7be5e62242cc65c6 100644 (file)
--- a/ha-manager.adoc
+++ b/ha-manager.adoc
@@ -1,15 +1,16 @@
-[[chapter-ha-manager]]
+[[chapter_ha_manager]]
 ifdef::manvolnum[]
-PVE({manvolnum})
-================
+ha-manager(1)
+=============
 include::attributes.txt[]
+:pve-toplevel:
 
 NAME
 ----
 
 ha-manager - Proxmox VE HA Manager
 
-SYNOPSYS
+SYNOPSIS
 --------
 
 include::ha-manager.1-synopsis.adoc[]
@@ -17,14 +18,13 @@ include::ha-manager.1-synopsis.adoc[]
 DESCRIPTION
 -----------
 endif::manvolnum[]
-
 ifndef::manvolnum[]
 High Availability
 =================
 include::attributes.txt[]
+:pve-toplevel:
 endif::manvolnum[]
 
-
 Our modern society depends heavily on information provided by
 computers over the network. Mobile devices amplified that dependency,
 because people can access the network any time from anywhere. If you
@@ -122,6 +122,7 @@ Requirements
 * optional hardware fencing devices
 
 
+[[ha_manager_resources]]
 Resources
 ---------
 
@@ -311,6 +312,7 @@ the update process can be too long which, in the worst case, may result in
 a watchdog reset.
 
 
+[[ha_manager_fencing]]
 Fencing
 -------
 
@@ -380,6 +382,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.
 
+[[ha_manager_groups]]
 Groups
 ------
 
@@ -396,9 +399,9 @@ available. If more nodes are in the highest priority class the services will
 get distributed to those node if not already there. The priorities have a
 relative meaning only.
   Example;;
-  You want to run all services from a group on node1 if possible, if this node
-  is not available you want them to run equally splitted on node2 and node3 and
-  if those fail it should use the other group members.
+  You want to run all services from a group on `node1` if possible. If this node
+  is not available, you want them to run equally splitted on `node2` and `node3`, and
+  if those fail it should use `node4`.
   To achieve this you could set the node list to:
 [source,bash]
   ha-manager groupset mygroup -nodes "node1:2,node2:1,node3:1,node4"
@@ -409,10 +412,11 @@ Resources bound to this group may only run on nodes defined by the
 group. If no group node member is available the resource will be
 placed in the stopped state.
   Example;;
-  A Service can run just on a few nodes, as he uses resources from only found
-  on those, we created a group with said nodes and as we know that else all
-  other nodes get implicitly added with lowest priority we set the restricted
-  option.
+  Lets say a service uses resources only available on `node1` and `node2`,
+  so we need to make sure that HA manager does not use other nodes.
+  We need to create a 'restricted' group with said nodes:
+[source,bash]
+  ha-manager groupset mygroup -nodes "node1,node2" -restricted 
 
 nofailback::
 
@@ -421,13 +425,14 @@ The resource won't automatically fail back when a more preferred node
   Examples;;
   * You need to migrate a service to a node which hasn't the highest priority
   in the group at the moment, to tell the HA manager to not move this service
-  instantly back set the nofailnback option and the service will stay on
+  instantly back set the 'nofailback' option and the service will stay on
+  the current node.
 
-  * A service was fenced and he got recovered to another node. The admin
-  repaired the node and brang it up online again but does not want that the
+  * A service was fenced and it got recovered to another node. The admin
+  repaired the node and brought it up online again but does not want that the
   recovered services move straight back to the repaired node as he wants to
   first investigate the failure cause and check if it runs stable. He can use
-  the nofailback option to achieve this.
+  the 'nofailback' option to achieve this.
 
 
 Start Failure Policy
@@ -479,6 +484,7 @@ killing its process)
 * *after* you fixed all errors you may enable the service again
 
 
+[[ha_manager_service_operations]]
 Service Operations
 ------------------