diff --git a/doc/sphinx/Pacemaker_Explained/acls.rst b/doc/sphinx/Pacemaker_Explained/acls.rst index 1786768a76..7385f97e70 100644 --- a/doc/sphinx/Pacemaker_Explained/acls.rst +++ b/doc/sphinx/Pacemaker_Explained/acls.rst @@ -1,335 +1,337 @@ +.. _acl: + Access Control Lists (ACLs) --------------------------- .. Convert_to_RST: anchor:ch-acls[Chapter 13, ACLs] indexterm:[access control list] indexterm:[ACL] By default, the +root+ user or any user in the +haclient+ group can modify Pacemaker's CIB without restriction. Pacemaker offers 'access control lists (ACLs)' to provide more fine-grained authorization. == ACL Prerequisites == In order to use ACLs: * The Pacemaker software must have been compiled with ACL support. If the output of the command `pacemakerd --features` contains `acls`, your installation supports ACLs. * Desired users must have user accounts in the +haclient+ group on all nodes in the cluster. * If your CIB was created before Pacemaker 1.1.12, it may need to be updated to the current schema using `cibadmin --upgrade` in order to use the syntax documented here. * The +enable-acl+ <> must be set to true. == ACL Configuration == ACLs are specified within an +acls+ element of the CIB. The +acls+ element may contain any number of +acl_role+, +acl_target+, and +acl_group+ elements. == ACL Roles == An ACL role is a collection of permissions allowing or denying access to particular portions of the CIB. .Properties of an ACL Role [width="95%",cols="1m,<3",options="header",align="center"] |==== |Attribute |Description |id |A unique name for the role (required) indexterm:[id,acl_role] indexterm:[access control list,acl_role,id] |description |Arbitrary text (not used by Pacemaker) indexterm:[description,acl_role] indexterm:[access control list,acl_role,description] |==== An +acl_role+ element may contain any number of +acl_permission+ elements. .Properties of an ACL Permission [width="95%",cols="1m,<3",options="header",align="center"] |==== |Attribute |Description |id |A unique name for the permission (required) indexterm:[id,acl_permission] indexterm:[access control list,acl_permission,id] |description |Arbitrary text (not used by Pacemaker) indexterm:[description,acl_permission] indexterm:[access control list,acl_permission,description] |kind |The access being granted. Allowed values are +read+, +write+, and +deny+. A value of +write+ grants both read and write access. indexterm:[kind,acl_permission] indexterm:[access control list,acl_permission,kind] |object-type |The name of an XML element in the CIB to which the permission applies. (Exactly one of +object-type+, +xpath+, and +reference+ must be specified for a permission.) indexterm:[object-type,acl_permission] indexterm:[access control list,acl_permission,object-type] |attribute |If specified, the permission applies only to +object-type+ elements that have this attribute set (to any value). If not specified, the permission applies to all +object-type+ elements. May only be used with +object-type+. indexterm:[attribute,acl_permission] indexterm:[access control list,acl_permission,attribute] |reference |The ID of an XML element in the CIB to which the permission applies. (Exactly one of +object-type+, +xpath+, and +reference+ must be specified for a permission.) indexterm:[reference,acl_permission] indexterm:[access control list,acl_permission,reference] |xpath |An https://www.w3.org/TR/xpath-10/[XPath] specification selecting an XML element in the CIB to which the permission applies. Attributes may be specified in the XPath to select particular elements, but the permissions apply to the entire element. (Exactly one of +object-type+, +xpath+, and +reference+ must be specified for a permission.) indexterm:[xpath,acl_permission] indexterm:[access control list,acl_permission,xpath] |==== [IMPORTANT] ==== * Permissions are applied to the selected XML element's entire XML subtree (all elements enclosed within it). * Write permission grants the ability to create, modify, or remove the element and its subtree, and also the ability to create any "scaffolding" elements (enclosing elements that do not have attributes other than an ID). * Permissions for more specific matches (more deeply nested elements) take precedence over more general ones. * If multiple permissions are configured for the same match (for example, in different roles applied to the same user), any +deny+ permission takes precedence, then +write+, then lastly +read+. ==== == ACL Targets and Groups == ACL targets correspond to user accounts on the system. .Properties of an ACL Target [width="95%",cols="1m,<3",options="header",align="center"] |==== |Attribute |Description |id |The name of a user on the system (required) indexterm:[id,acl_target] indexterm:[access control list,acl_target,id] |==== ACL groups may be specified, but are not currently used by Pacemaker. This is expected to change in a future version. .Properties of an ACL Group [width="95%",cols="1m,<3",options="header",align="center"] |==== |Attribute |Description |id |The name of a group on the system (required) indexterm:[id,acl_group] indexterm:[access control list,acl_group,id] |==== Each +acl_target+ and +acl_group+ element may contain any number of +role+ elements. .Properties of an ACL Role Reference [width="95%",cols="1m,<3",options="header",align="center"] |==== |Attribute |Description |id |The +id+ of an +acl_role+ element that specifies permissions granted to the enclosing target or group indexterm:[id,role] indexterm:[access control list,role,id] |==== [IMPORTANT] ==== The +root+ and +hacluster+ user accounts always have full access to the CIB, regardless of ACLs. For other user accounts, when +enable-acl+ is true, permission to all parts of the CIB is denied by default (permissions must be explicitly granted). ==== == ACL Examples == [source,XML] ---- ---- In the above example, the user +alice+ has the minimal permissions necessary to run basic Pacemaker CLI tools, including using `crm_mon` to view the cluster status, without being able to modify anything. The user +bob+ can view the entire configuration and status of the cluster, but not make any changes. The user +carol+ can read everything, and change selected cluster properties as well as resource roles and location constraints. Finally, +dave+ has full read and write access to the entire CIB. Looking at the +minimal+ role in more depth, it is designed to allow read access to the +cib+ tag itself, while denying access to particular portions of its subtree (which is the entire CIB). This is because the DC node is indicated in the +cib+ tag, so `crm_mon` will not be able to report the DC otherwise. However, this does change the security model to allow by default, since any portions of the CIB not explicitly denied will be readable. The +cib+ read access could be removed and replaced with read access to just the +crm_config+ and +status+ sections, for a safer approach at the cost of not seeing the DC in status output. For a simpler configuration, the +minimal+ role allows read access to the entire +crm_config+ section, which contains cluster properties. It would be possible to allow read access to specific properties instead (such as +stonith-enabled+, +dc-uuid+, +have-quorum+, and +cluster-name+) to restrict access further while still allowing status output, but cluster properties are unlikely to be considered sensitive. diff --git a/doc/sphinx/Pacemaker_Explained/advanced-options.rst b/doc/sphinx/Pacemaker_Explained/advanced-options.rst index 5ee5c9b5ed..ec064b33af 100644 --- a/doc/sphinx/Pacemaker_Explained/advanced-options.rst +++ b/doc/sphinx/Pacemaker_Explained/advanced-options.rst @@ -1,759 +1,776 @@ Advanced Configuration ---------------------- .. Convert_to_RST: [[s-recurring-start]] == Specifying When Recurring Actions are Performed == By default, recurring actions are scheduled relative to when the resource started. So if your resource was last started at 14:32 and you have a backup set to be performed every 24 hours, then the backup will always run in the middle of the business day -- hardly desirable. To specify a date and time that the operation should be relative to, set the operation's +interval-origin+. The cluster uses this point to calculate the correct +start-delay+ such that the operation will occur at _origin + (interval * N)_. So, if the operation's interval is 24h, its interval-origin is set to 02:00 and it is currently 14:32, then the cluster would initiate the operation with a start delay of 11 hours and 28 minutes. If the resource is moved to another node before 2am, then the operation is cancelled. The value specified for +interval+ and +interval-origin+ can be any date/time conforming to the http://en.wikipedia.org/wiki/ISO_8601[ISO8601 standard]. By way of example, to specify an operation that would run on the first Monday of 2009 and every Monday after that, you would add: .Specifying a Base for Recurring Action Intervals ===== [source,XML] ===== - - [[s-failure-handling]] - == Handling Resource Failure == + + +.. _failure-handling: + +Handling Resource Failure +######################### + + +.. Convert_to_RST_2: By default, Pacemaker will attempt to recover failed resources by restarting them. However, failure recovery is highly configurable. === Failure Counts === Pacemaker tracks resource failures for each combination of node, resource, and operation (start, stop, monitor, etc.). You can query the fail count for a particular node, resource, and/or operation using the `crm_failcount` command. For example, to see how many times the 10-second monitor for +myrsc+ has failed on +node1+, run: ---- # crm_failcount --query -r myrsc -N node1 -n monitor -I 10s ---- If you omit the node, `crm_failcount` will use the local node. If you omit the operation and interval, `crm_failcount` will display the sum of the fail counts for all operations on the resource. You can use `crm_resource --cleanup` or `crm_failcount --delete` to clear fail counts. For example, to clear the above monitor failures, run: ---- # crm_resource --cleanup -r myrsc -N node1 -n monitor -I 10s ---- If you omit the resource, `crm_resource --cleanup` will clear failures for all resources. If you omit the node, it will clear failures on all nodes. If you omit the operation and interval, it will clear the failures for all operations on the resource. [NOTE] ==== Even when cleaning up only a single operation, all failed operations will disappear from the status display. This allows us to trigger a re-check of the resource's current status. ==== Higher-level tools may provide other commands for querying and clearing fail counts. The `crm_mon` tool shows the current cluster status, including any failed operations. To see the current fail counts for any failed resources, call `crm_mon` with the `--failcounts` option. This shows the fail counts per resource (that is, the sum of any operation fail counts for the resource). === Failure Response === Normally, if a running resource fails, pacemaker will try to stop it and start it again. Pacemaker will choose the best location to start it each time, which may be the same node that it failed on. However, if a resource fails repeatedly, it is possible that there is an underlying problem on that node, and you might desire trying a different node in such a case. Pacemaker allows you to set your preference via the +migration-threshold+ resource meta-attribute. footnote:[ The naming of this option was perhaps unfortunate as it is easily confused with live migration, the process of moving a resource from one node to another without stopping it. Xen virtual guests are the most common example of resources that can be migrated in this manner. ] If you define +migration-threshold=pass:[N]+ for a resource, it will be banned from the original node after 'N' failures. [NOTE] ==== The +migration-threshold+ is per 'resource', even though fail counts are tracked per 'operation'. The operation fail counts are added together to compare against the +migration-threshold+. ==== By default, fail counts remain until manually cleared by an administrator using `crm_resource --cleanup` or `crm_failcount --delete` (hopefully after first fixing the failure's cause). It is possible to have fail counts expire automatically by setting the +failure-timeout+ resource meta-attribute. [IMPORTANT] ==== A successful operation does not clear past failures. If a recurring monitor operation fails once, succeeds many times, then fails again days later, its fail count is 2. Fail counts are cleared only by manual intervention or falure timeout. ==== For example, a setting of +migration-threshold=2+ and +failure-timeout=60s+ would cause the resource to move to a new node after 2 failures, and allow it to move back (depending on stickiness and constraint scores) after one minute. [NOTE] ==== +failure-timeout+ is measured since the most recent failure. That is, older failures do not individually time out and lower the fail count. Instead, all failures are timed out simultaneously (and the fail count is reset to 0) if there is no new failure for the timeout period. ==== There are two exceptions to the migration threshold concept: when a resource either fails to start or fails to stop. If the cluster property +start-failure-is-fatal+ is set to +true+ (which is the default), start failures cause the fail count to be set to +INFINITY+ and thus always cause the resource to move immediately. Stop failures are slightly different and crucial. If a resource fails to stop and STONITH is enabled, then the cluster will fence the node in order to be able to start the resource elsewhere. If STONITH is not enabled, then the cluster has no way to continue and will not try to start the resource elsewhere, but will try to stop it again after the failure timeout. == Moving Resources == indexterm:[Moving,Resources] indexterm:[Resource,Moving] === Moving Resources Manually === There are primarily two occasions when you would want to move a resource from its current location: when the whole node is under maintenance, and when a single resource needs to be moved. ==== Standby Mode ==== Since everything eventually comes down to a score, you could create constraints for every resource to prevent them from running on one node. While pacemaker configuration can seem convoluted at times, not even we would require this of administrators. Instead, one can set a special node attribute which tells the cluster "don't let anything run here". There is even a helpful tool to help query and set it, called `crm_standby`. To check the standby status of the current machine, run: ---- # crm_standby -G ---- A value of +on+ indicates that the node is _not_ able to host any resources, while a value of +off+ says that it _can_. You can also check the status of other nodes in the cluster by specifying the `--node` option: ---- # crm_standby -G --node sles-2 ---- To change the current node's standby status, use `-v` instead of `-G`: ---- # crm_standby -v on ---- Again, you can change another host's value by supplying a hostname with `--node`. A cluster node in standby mode will not run resources, but still contributes to quorum, and may fence or be fenced by nodes. ==== Moving One Resource ==== When only one resource is required to move, we could do this by creating location constraints. However, once again we provide a user-friendly shortcut as part of the `crm_resource` command, which creates and modifies the extra constraints for you. If +Email+ were running on +sles-1+ and you wanted it moved to a specific location, the command would look something like: ---- # crm_resource -M -r Email -H sles-2 ---- Behind the scenes, the tool will create the following location constraint: [source,XML] It is important to note that subsequent invocations of `crm_resource -M` are not cumulative. So, if you ran these commands ---- # crm_resource -M -r Email -H sles-2 # crm_resource -M -r Email -H sles-3 ---- then it is as if you had never performed the first command. To allow the resource to move back again, use: ---- # crm_resource -U -r Email ---- Note the use of the word _allow_. The resource can move back to its original location but, depending on +resource-stickiness+, it might stay where it is. To be absolutely certain that it moves back to +sles-1+, move it there before issuing the call to `crm_resource -U`: ---- # crm_resource -M -r Email -H sles-1 # crm_resource -U -r Email ---- Alternatively, if you only care that the resource should be moved from its current location, try: ---- # crm_resource -B -r Email ---- Which will instead create a negative constraint, like [source,XML] This will achieve the desired effect, but will also have long-term consequences. As the tool will warn you, the creation of a +-INFINITY+ constraint will prevent the resource from running on that node until `crm_resource -U` is used. This includes the situation where every other cluster node is no longer available! In some cases, such as when +resource-stickiness+ is set to +INFINITY+, it is possible that you will end up with the problem described in <>. The tool can detect some of these cases and deals with them by creating both positive and negative constraints. E.g. +Email+ prefers +sles-1+ with a score of +-INFINITY+ +Email+ prefers +sles-2+ with a score of +INFINITY+ which has the same long-term consequences as discussed earlier. === Moving Resources Due to Connectivity Changes === You can configure the cluster to move resources when external connectivity is lost in two steps. ==== Tell Pacemaker to Monitor Connectivity ==== First, add an *ocf:pacemaker:ping* resource to the cluster. The *ping* resource uses the system utility of the same name to a test whether list of machines (specified by DNS hostname or IPv4/IPv6 address) are reachable and uses the results to maintain a node attribute called +pingd+ by default. footnote:[ The attribute name is customizable, in order to allow multiple ping groups to be defined. ] [NOTE] =========== Older versions of Pacemaker used a different agent *ocf:pacemaker:pingd* which is now deprecated in favor of *ping*. If your version of Pacemaker does not contain the *ping* resource agent, download the latest version from https://github.com/ClusterLabs/pacemaker/tree/master/extra/resources/ping =========== Normally, the ping resource should run on all cluster nodes, which means that you'll need to create a clone. A template for this can be found below along with a description of the most interesting parameters. .Common Options for a 'ping' Resource [width="95%",cols="1m,<4",options="header",align="center"] |========================================================= |Field |Description |dampen |The time to wait (dampening) for further changes to occur. Use this to prevent a resource from bouncing around the cluster when cluster nodes notice the loss of connectivity at slightly different times. indexterm:[dampen,Ping Resource Option] indexterm:[Ping Resource,Option,dampen] |multiplier |The number of connected ping nodes gets multiplied by this value to get a score. Useful when there are multiple ping nodes configured. indexterm:[multiplier,Ping Resource Option] indexterm:[Ping Resource,Option,multiplier] |host_list |The machines to contact in order to determine the current connectivity status. Allowed values include resolvable DNS host names, IPv4 and IPv6 addresses. indexterm:[host_list,Ping Resource Option] indexterm:[Ping Resource,Option,host_list] |========================================================= .An example ping cluster resource that checks node connectivity once every minute ===== [source,XML] ------------ ------------ ===== [IMPORTANT] =========== You're only half done. The next section deals with telling Pacemaker how to deal with the connectivity status that +ocf:pacemaker:ping+ is recording. =========== ==== Tell Pacemaker How to Interpret the Connectivity Data ==== [IMPORTANT] ====== Before attempting the following, make sure you understand <>. ====== There are a number of ways to use the connectivity data. The most common setup is for people to have a single ping target (e.g. the service network's default gateway), to prevent the cluster from running a resource on any unconnected node. .Don't run a resource on unconnected nodes ===== [source,XML] ------- ------- ===== A more complex setup is to have a number of ping targets configured. You can require the cluster to only run resources on nodes that can connect to all (or a minimum subset) of them. .Run only on nodes connected to three or more ping targets. ===== [source,XML] ------- ... ... ... ------- ===== Alternatively, you can tell the cluster only to _prefer_ nodes with the best connectivity. Just be sure to set +multiplier+ to a value higher than that of +resource-stickiness+ (and don't set either of them to +INFINITY+). .Prefer the node with the most connected ping nodes ===== [source,XML] ------- ------- ===== It is perhaps easier to think of this in terms of the simple constraints that the cluster translates it into. For example, if *sles-1* is connected to all five ping nodes but *sles-2* is only connected to two, then it would be as if you instead had the following constraints in your configuration: .How the cluster translates the above location constraint ===== [source,XML] ------- ------- ===== The advantage is that you don't have to manually update any constraints whenever your network connectivity changes. You can also combine the concepts above into something even more complex. The example below shows how you can prefer the node with the most connected ping nodes provided they have connectivity to at least three (again assuming that +multiplier+ is set to 1000). .A more complex example of choosing a location based on connectivity ===== [source,XML] ------- ------- ===== - - [[s-migrating-resources]] - === Migrating Resources === + + +.. _live-migration: + +Migrating Resources +___________________ + + +.. Convert_to_RST_3: Normally, when the cluster needs to move a resource, it fully restarts the resource (i.e. stops the resource on the current node and starts it on the new node). However, some types of resources, such as Xen virtual guests, are able to move to another location without loss of state (often referred to as live migration or hot migration). In pacemaker, this is called resource migration. Pacemaker can be configured to migrate a resource when moving it, rather than restarting it. Not all resources are able to migrate; see the Migration Checklist below, and those that can, won't do so in all situations. Conceptually, there are two requirements from which the other prerequisites follow: * The resource must be active and healthy at the old location; and * everything required for the resource to run must be available on both the old and new locations. The cluster is able to accommodate both 'push' and 'pull' migration models by requiring the resource agent to support two special actions: +migrate_to+ (performed on the current location) and +migrate_from+ (performed on the destination). In push migration, the process on the current location transfers the resource to the new location where is it later activated. In this scenario, most of the work would be done in the +migrate_to+ action and, if anything, the activation would occur during +migrate_from+. Conversely for pull, the +migrate_to+ action is practically empty and +migrate_from+ does most of the work, extracting the relevant resource state from the old location and activating it. There is no wrong or right way for a resource agent to implement migration, as long as it works. .Migration Checklist * The resource may not be a clone. * The resource must use an OCF style agent. * The resource must not be in a failed or degraded state. * The resource agent must support +migrate_to+ and +migrate_from+ actions, and advertise them in its metadata. * The resource must have the +allow-migrate+ meta-attribute set to +true+ (which is not the default). If an otherwise migratable resource depends on another resource via an ordering constraint, there are special situations in which it will be restarted rather than migrated. For example, if the resource depends on a clone, and at the time the resource needs to be moved, the clone has instances that are stopping and instances that are starting, then the resource will be restarted. The scheduler is not yet able to model this situation correctly and so takes the safer (if less optimal) path. Also, if a migratable resource depends on a non-migratable resource, and both need to be moved, the migratable resource will be restarted. + + +.. _node-health: + +Tracking Node Health +#################### - [[s-node-health]] - == Tracking Node Health == +.. Convert_to_RST_4: A node may be functioning adequately as far as cluster membership is concerned, and yet be "unhealthy" in some respect that makes it an undesirable location for resources. For example, a disk drive may be reporting SMART errors, or the CPU may be highly loaded. Pacemaker offers a way to automatically move resources off unhealthy nodes. === Node Health Attributes === Pacemaker will treat any node attribute whose name starts with +#health+ as an indicator of node health. Node health attributes may have one of the following values: .Allowed Values for Node Health Attributes [width="95%",cols="1,<3",options="header",align="center"] |========================================================= |Value |Intended significance |+red+ |This indicator is unhealthy indexterm:[Node health,red] |+yellow+ |This indicator is becoming unhealthy indexterm:[Node health,yellow] |+green+ |This indicator is healthy indexterm:[Node health,green] |'integer' |A numeric score to apply to all resources on this node (0 or positive is healthy, negative is unhealthy) indexterm:[Node health,score] |========================================================= === Node Health Strategy === Pacemaker assigns a node health score to each node, as the sum of the values of all its node health attributes. This score will be used as a location constraint applied to this node for all resources. The +node-health-strategy+ cluster option controls how Pacemaker responds to changes in node health attributes, and how it translates +red+, +yellow+, and +green+ to scores. Allowed values are: .Node Health Strategies [width="95%",cols="1m,<3",options="header",align="center"] |========================================================= |Value |Effect |none |Do not track node health attributes at all. indexterm:[Node health,none] |migrate-on-red |Assign the value of +-INFINITY+ to +red+, and 0 to +yellow+ and +green+. This will cause all resources to move off the node if any attribute is +red+. indexterm:[Node health,migrate-on-red] |only-green |Assign the value of +-INFINITY+ to +red+ and +yellow+, and 0 to +green+. This will cause all resources to move off the node if any attribute is +red+ or +yellow+. indexterm:[Node health,only-green] |progressive |Assign the value of the +node-health-red+ cluster option to +red+, the value of +node-health-yellow+ to +yellow+, and the value of +node-health-green+ to +green+. Each node is additionally assigned a score of +node-health-base+ (this allows resources to start even if some attributes are +yellow+). This strategy gives the administrator finer control over how important each value is. indexterm:[Node health,progressive] |custom |Track node health attributes using the same values as +progressive+ for +red+, +yellow+, and +green+, but do not take them into account. The administrator is expected to implement a policy by defining rules (see <>) referencing node health attributes. indexterm:[Node health,custom] |========================================================= === Measuring Node Health === Since Pacemaker calculates node health based on node attributes, any method that sets node attributes may be used to measure node health. The most common ways are resource agents or separate daemons. Pacemaker provides examples that can be used directly or as a basis for custom code. The +ocf:pacemaker:HealthCPU+ and +ocf:pacemaker:HealthSMART+ resource agents set node health attributes based on CPU and disk parameters. The +ipmiservicelogd+ daemon sets node health attributes based on IPMI values (the +ocf:pacemaker:SystemHealth+ resource agent can be used to manage the daemon as a cluster resource). In order to take advantage of this feature - firstly add the resource to your cluster, preferably as a cloned resource to constantly measure health on all nodes: ===== [source,XML] ------------ ------------ ===== This way attrd_updater will set proper status for each node running this resource. Any attribute matching "#health-[a-zA-z]+" will force cluster to migrate all resources from unhealthy node and place it on other nodes according to all constraints defined in your cluster. When the node is no longer faulty you can force the cluster to restart the cloned resource on faulty node and make it available to take resources, in this case since we are using HealthIOWait provider: ---- # attrd_updater -n "#health-iowait" -U "green" --node="" -d "60s" ---- == Reloading Services After a Definition Change == The cluster automatically detects changes to the definition of services it manages. The normal response is to stop the service (using the old definition) and start it again (with the new definition). This works well, but some services are smarter and can be told to use a new set of options without restarting. To take advantage of this capability, the resource agent must: . Accept the +reload+ operation and perform any required actions. _The actions here depend completely on your application!_ + .The DRBD agent's logic for supporting +reload+ ===== [source,Bash] ------- case $1 in start) drbd_start ;; stop) drbd_stop ;; reload) drbd_reload ;; monitor) drbd_monitor ;; *) drbd_usage exit $OCF_ERR_UNIMPLEMENTED ;; esac exit $? ------- ===== . Advertise the +reload+ operation in the +actions+ section of its metadata + .The DRBD Agent Advertising Support for the +reload+ Operation ===== [source,XML] ------- 1.1 Master/Slave OCF Resource Agent for DRBD ... ------- ===== . Advertise one or more parameters that can take effect using +reload+. + Any parameter with the +unique+ set to 0 is eligible to be used in this way. + .Parameter that can be changed using reload ===== [source,XML] ------- Full path to the drbd.conf file. Path to drbd.conf ------- ===== Once these requirements are satisfied, the cluster will automatically know to reload the resource (instead of restarting) when a non-unique field changes. [NOTE] ====== Metadata will not be re-read unless the resource needs to be started. This may mean that the resource will be restarted the first time, even though you changed a parameter with +unique=0+. ====== [NOTE] ====== If both a unique and non-unique field are changed simultaneously, the resource will still be restarted. ====== diff --git a/doc/sphinx/Pacemaker_Explained/constraints.rst b/doc/sphinx/Pacemaker_Explained/constraints.rst index 3bc55d756b..23647448c3 100644 --- a/doc/sphinx/Pacemaker_Explained/constraints.rst +++ b/doc/sphinx/Pacemaker_Explained/constraints.rst @@ -1,920 +1,927 @@ Resource Constraints -------------------- .. Convert_to_RST: anchor:ch-constraints[Chapter 7, Alerts] indexterm:[Resource,Constraint] == Scores == indexterm:[Resource,Score] indexterm:[Node,Score] Scores of all kinds are integral to how the cluster works. Practically everything from moving a resource to deciding which resource to stop in a degraded cluster is achieved by manipulating scores in some way. Scores are calculated per resource and node. Any node with a negative score for a resource can't run that resource. The cluster places a resource on the node with the highest score for it. === Infinity Math === Pacemaker implements +INFINITY+ (or equivalently, ++INFINITY+) internally as a score of 1,000,000. Addition and subtraction with it follow these three basic rules: * Any value + +INFINITY+ = +INFINITY+ * Any value - +INFINITY+ = +-INFINITY+ * +INFINITY+ - +INFINITY+ = +-INFINITY+ [NOTE] ====== What if you want to use a score higher than 1,000,000? Typically this possibility arises when someone wants to base the score on some external metric that might go above 1,000,000. The short answer is you can't. The long answer is it is sometimes possible work around this limitation creatively. You may be able to set the score to some computed value based on the external metric rather than use the metric directly. For nodes, you can store the metric as a node attribute, and query the attribute when computing the score (possibly as part of a custom resource agent). ====== - - == Deciding Which Nodes a Resource Can Run On == + + +.. _location-constraint: + +Deciding Which Nodes a Resource Can Run On +########################################## + + +.. Convert_to_RST_2: indexterm:[Constraint,Location Constraint] 'Location constraints' tell the cluster which nodes a resource can run on. There are two alternative strategies. One way is to say that, by default, resources can run anywhere, and then the location constraints specify nodes that are not allowed (an 'opt-out' cluster). The other way is to start with nothing able to run anywhere, and use location constraints to selectively enable allowed nodes (an 'opt-in' cluster). Whether you should choose opt-in or opt-out depends on your personal preference and the make-up of your cluster. If most of your resources can run on most of the nodes, then an opt-out arrangement is likely to result in a simpler configuration. On the other-hand, if most resources can only run on a small subset of nodes, an opt-in configuration might be simpler. === Location Properties === indexterm:[XML element,rsc_location element] indexterm:[Constraint,Location Constraint,rsc_location element] .Attributes of a rsc_location Element [width="95%",cols="2m,1,<5",options="header",align="center"] |========================================================= |Attribute |Default |Description |id | |A unique name for the constraint (required) indexterm:[XML attribute,id attribute,rsc_location element] indexterm:[XML element,rsc_location element,id attribute] |rsc | |The name of the resource to which this constraint applies. A location constraint must either have a +rsc+, have a +rsc-pattern+, or contain at least one resource set. indexterm:[XML attribute,rsc attribute,rsc_location element] indexterm:[XML element,rsc_location element,rsc attribute] |rsc-pattern | |A pattern matching the names of resources to which this constraint applies. The syntax is the same as http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap09.html#tag_09_04[POSIX] extended regular expressions, with the addition of an initial '!' indicating that resources 'not' matching the pattern are selected. If the regular expression contains submatches, and the constraint is governed by a <>, the submatches can be referenced as +%0+ through +%9+ in the rule's +score-attribute+ or a rule expression's +attribute+. A location constraint must either have a +rsc+, have a +rsc-pattern+, or contain at least one resource set. indexterm:[XML attribute,rsc-pattern attribute,rsc_location element] indexterm:[XML element,rsc_location element,rsc-pattern attribute] |node | |The name of the node to which this constraint applies. A location constraint must either have a +node+ and +score+, or contain at least one rule. indexterm:[XML attribute,node attribute,rsc_location element] indexterm:[XML element,rsc_location element,node attribute] |score | |Positive values indicate a preference for running the affected resource(s) on +node+ -- the higher the value, the stronger the preference. Negative values indicate the resource(s) should avoid this node (a value of +-INFINITY+ changes "should" to "must"). A location constraint must either have a +node+ and +score+, or contain at least one rule. indexterm:[XML attribute,score attribute,rsc_location element] indexterm:[XML element,rsc_location element,score attribute] |resource-discovery |always a|Whether Pacemaker should perform resource discovery (that is, check whether the resource is already running) for this resource on this node. This should normally be left as the default, so that rogue instances of a service can be stopped when they are running where they are not supposed to be. However, there are two situations where disabling resource discovery is a good idea: when a service is not installed on a node, discovery might return an error (properly written OCF agents will not, so this is usually only seen with other agent types); and when Pacemaker Remote is used to scale a cluster to hundreds of nodes, limiting resource discovery to allowed nodes can significantly boost performance. * +always:+ Always perform resource discovery for the specified resource on this node. * +never:+ Never perform resource discovery for the specified resource on this node. This option should generally be used with a -INFINITY score, although that is not strictly required. * +exclusive:+ Perform resource discovery for the specified resource only on this node (and other nodes similarly marked as +exclusive+). Multiple location constraints using +exclusive+ discovery for the same resource across different nodes creates a subset of nodes resource-discovery is exclusive to. If a resource is marked for +exclusive+ discovery on one or more nodes, that resource is only allowed to be placed within that subset of nodes. indexterm:[XML attribute,resource-discovery attribute,rsc_location element] indexterm:[XML element,rsc_location element,resource-discovery attribute] indexterm:[Constraint,Location Constraint,Resource Discovery] |========================================================= [WARNING] ========= Setting resource-discovery to +never+ or +exclusive+ removes Pacemaker's ability to detect and stop unwanted instances of a service running where it's not supposed to be. It is up to the system administrator (you!) to make sure that the service can 'never' be active on nodes without resource-discovery (such as by leaving the relevant software uninstalled). ========= === Asymmetrical "Opt-In" Clusters === indexterm:[Asymmetrical Clusters] indexterm:[Opt-In Clusters] To create an opt-in cluster, start by preventing resources from running anywhere by default: ---- # crm_attribute --name symmetric-cluster --update false ---- Then start enabling nodes. The following fragment says that the web server prefers *sles-1*, the database prefers *sles-2* and both can fail over to *sles-3* if their most preferred node fails. .Opt-in location constraints for two resources ====== [source,XML] ------- ------- ====== === Symmetrical "Opt-Out" Clusters === indexterm:[Symmetrical Clusters] indexterm:[Opt-Out Clusters] To create an opt-out cluster, start by allowing resources to run anywhere by default: ---- # crm_attribute --name symmetric-cluster --update true ---- Then start disabling nodes. The following fragment is the equivalent of the above opt-in configuration. .Opt-out location constraints for two resources ====== [source,XML] ------- ------- ====== [[node-score-equal]] === What if Two Nodes Have the Same Score === If two nodes have the same score, then the cluster will choose one. This choice may seem random and may not be what was intended, however the cluster was not given enough information to know any better. .Constraints where a resource prefers two nodes equally ====== [source,XML] ------- ------- ====== In the example above, assuming no other constraints and an inactive cluster, +Webserver+ would probably be placed on +sles-1+ and +Database+ on +sles-2+. It would likely have placed +Webserver+ based on the node's uname and +Database+ based on the desire to spread the resource load evenly across the cluster. However other factors can also be involved in more complex configurations. [[s-resource-ordering]] == Specifying the Order in which Resources Should Start/Stop == indexterm:[Constraint,Ordering Constraint] indexterm:[Resource,Start Order] 'Ordering constraints' tell the cluster the order in which certain resource actions should occur. [IMPORTANT] ==== Ordering constraints affect 'only' the ordering of resource actions; they do 'not' require that the resources be placed on the same node. If you want resources to be started on the same node 'and' in a specific order, you need both an ordering constraint 'and' a colocation constraint (see <>), or alternatively, a group (see <>). ==== === Ordering Properties === indexterm:[XML element,rsc_order element] indexterm:[Constraint,Ordering Constraint,rsc_order element] .Attributes of a rsc_order Element [width="95%",cols="1m,1,<4",options="header",align="center"] |========================================================= |Field |Default |Description |id | |A unique name for the constraint indexterm:[XML attribute,id attribute,rsc_order element] indexterm:[XML element,rsc_order element,id attribute] |first | |Name of the resource that the +then+ resource depends on indexterm:[XML attribute,first attribute,rsc_order element] indexterm:[XML element,rsc_order element,first attribute] |then | |Name of the dependent resource indexterm:[XML attribute,then attribute,rsc_order element] indexterm:[XML element,rsc_order element,then attribute] |first-action |start |The action that the +first+ resource must complete before +then-action+ can be initiated for the +then+ resource. Allowed values: +start+, +stop+, +promote+, +demote+. indexterm:[XML attribute,first-action attribute,rsc_order element] indexterm:[XML element,rsc_order element,first-action attribute] |then-action |value of +first-action+ |The action that the +then+ resource can execute only after the +first-action+ on the +first+ resource has completed. Allowed values: +start+, +stop+, +promote+, +demote+. indexterm:[XML attribute,then-action attribute,rsc_order element] indexterm:[XML element,rsc_order element,then-action attribute] |kind |Mandatory a|How to enforce the constraint. Allowed values: * +Mandatory:+ +then-action+ will never be initiated for the +then+ resource unless and until +first-action+ successfully completes for the +first+ resource. * +Optional:+ The constraint applies only if both specified resource actions are scheduled in the same transition (that is, in response to the same cluster state). This means that +then-action+ is allowed on the +then+ resource regardless of the state of the +first+ resource, but if both actions happen to be scheduled at the same time, they will be ordered. * +Serialize:+ Ensure that the specified actions are never performed concurrently for the specified resources. +First-action+ and +then-action+ can be executed in either order, but one must complete before the other can be initiated. An example use case is when resource start-up puts a high load on the host. indexterm:[XML attribute,kind attribute,rsc_order element] indexterm:[XML element,rsc_order element,kind attribute] |symmetrical |TRUE for +Mandatory+ and +Optional+ kinds. FALSE for +Serialize+ kind. |If true, the reverse of the constraint applies for the opposite action (for example, if B starts after A starts, then B stops before A stops). +Serialize+ orders cannot be symmetrical. indexterm:[XML attribute,symmetrical attribute,rsc_order element] indexterm:[XML element,rsc_order element,symmetrical attribute] |========================================================= +Promote+ and +demote+ apply to the master role of <> resources. === Optional and mandatory ordering === Here is an example of ordering constraints where +Database+ 'must' start before +Webserver+, and +IP+ 'should' start before +Webserver+ if they both need to be started: .Optional and mandatory ordering constraints ====== [source,XML] ------- ------- ====== Because the above example lets +symmetrical+ default to TRUE, +Webserver+ must be stopped before +Database+ can be stopped, and +Webserver+ should be stopped before +IP+ if they both need to be stopped. [[s-resource-colocation]] == Placing Resources Relative to other Resources == indexterm:[Constraint,Colocation Constraint] indexterm:[Resource,Location Relative to Other Resources] 'Colocation constraints' tell the cluster that the location of one resource depends on the location of another one. Colocation has an important side-effect: it affects the order in which resources are assigned to a node. Think about it: You can't place A relative to B unless you know where B is. footnote:[ While the human brain is sophisticated enough to read the constraint in any order and choose the correct one depending on the situation, the cluster is not quite so smart. Yet. ] So when you are creating colocation constraints, it is important to consider whether you should colocate A with B, or B with A. Another thing to keep in mind is that, assuming A is colocated with B, the cluster will take into account A's preferences when deciding which node to choose for B. For a detailed look at exactly how this occurs, see http://clusterlabs.org/doc/Colocation_Explained.pdf[Colocation Explained]. [IMPORTANT] ==== Colocation constraints affect 'only' the placement of resources; they do 'not' require that the resources be started in a particular order. If you want resources to be started on the same node 'and' in a specific order, you need both an ordering constraint (see <>) 'and' a colocation constraint, or alternatively, a group (see <>). ==== === Colocation Properties === indexterm:[XML element,rsc_colocation element] indexterm:[Constraint,Colocation Constraint,rsc_colocation element] .Attributes of a rsc_colocation Constraint [width="95%",cols="1m,1,<4",options="header",align="center"] |========================================================= |Field |Default |Description |id | |A unique name for the constraint (required). indexterm:[XML attribute,id attribute,rsc_colocation element] indexterm:[XML element,rsc_colocation element,id attribute] |rsc | |The name of a resource that should be located relative to +with-rsc+ (required). indexterm:[XML attribute,rsc attribute,rsc_colocation element] indexterm:[XML element,rsc_colocation element,rsc attribute] |with-rsc | |The name of the resource used as the colocation target. The cluster will decide where to put this resource first and then decide where to put +rsc+ (required). indexterm:[XML attribute,with-rsc attribute,rsc_colocation element] indexterm:[XML element,rsc_colocation element,with-rsc attribute] |node-attribute |#uname |The node attribute that must be the same on the node running +rsc+ and the node running +with-rsc+ for the constraint to be satisfied. (For details, see <>.) indexterm:[XML attribute,node-attribute attribute,rsc_colocation element] indexterm:[XML element,rsc_colocation element,node-attribute attribute] |score | |Positive values indicate the resources should run on the same node. Negative values indicate the resources should run on different nodes. Values of \+/- +INFINITY+ change "should" to "must". indexterm:[XML attribute,score attribute,rsc_colocation element] indexterm:[XML element,rsc_colocation element,score attribute] |========================================================= === Mandatory Placement === Mandatory placement occurs when the constraint's score is ++INFINITY+ or +-INFINITY+. In such cases, if the constraint can't be satisfied, then the +rsc+ resource is not permitted to run. For +score=INFINITY+, this includes cases where the +with-rsc+ resource is not active. If you need resource +A+ to always run on the same machine as resource +B+, you would add the following constraint: .Mandatory colocation constraint for two resources ==== [source,XML] ==== Remember, because +INFINITY+ was used, if +B+ can't run on any of the cluster nodes (for whatever reason) then +A+ will not be allowed to run. Whether +A+ is running or not has no effect on +B+. Alternatively, you may want the opposite -- that +A+ 'cannot' run on the same machine as +B+. In this case, use +score="-INFINITY"+. .Mandatory anti-colocation constraint for two resources ==== [source,XML] ==== Again, by specifying +-INFINITY+, the constraint is binding. So if the only place left to run is where +B+ already is, then +A+ may not run anywhere. As with +INFINITY+, +B+ can run even if +A+ is stopped. However, in this case +A+ also can run if +B+ is stopped, because it still meets the constraint of +A+ and +B+ not running on the same node. === Advisory Placement === If mandatory placement is about "must" and "must not", then advisory placement is the "I'd prefer if" alternative. For constraints with scores greater than +-INFINITY+ and less than +INFINITY+, the cluster will try to accommodate your wishes but may ignore them if the alternative is to stop some of the cluster resources. As in life, where if enough people prefer something it effectively becomes mandatory, advisory colocation constraints can combine with other elements of the configuration to behave as if they were mandatory. .Advisory colocation constraint for two resources ==== [source,XML] ==== [[s-coloc-attribute]] === Colocation by Node Attribute === The +node-attribute+ property of a colocation constraints allows you to express the requirement, "these resources must be on similar nodes". As an example, imagine that you have two Storage Area Networks (SANs) that are not controlled by the cluster, and each node is connected to one or the other. You may have two resources +r1+ and +r2+ such that +r2+ needs to use the same SAN as +r1+, but doesn't necessarily have to be on the same exact node. In such a case, you could define a <> named +san+, with the value +san1+ or +san2+ on each node as appropriate. Then, you could colocate +r2+ with +r1+ using +node-attribute+ set to +san+. [[s-resource-sets]] == Resource Sets == 'Resource sets' allow multiple resources to be affected by a single constraint. indexterm:[Constraint,Resource Set] indexterm:[Resource,Resource Set] .A set of 3 resources ==== [source,XML] ---- ---- ==== Resource sets are valid inside +rsc_location+, +rsc_order+ (see <>), +rsc_colocation+ (see <>), and +rsc_ticket+ (see <>) constraints. A resource set has a number of properties that can be set, though not all have an effect in all contexts. .Attributes of a resource_set Element [width="95%",cols="2m,1,<5",options="header",align="center"] |========================================================= |Field |Default |Description |id | |A unique name for the set indexterm:[XML attribute,id attribute,resource_set element] indexterm:[XML element,resource_set element,id attribute] |sequential |true |Whether the members of the set must be acted on in order. Meaningful within +rsc_order+ and +rsc_colocation+. indexterm:[XML attribute,sequential attribute,resource_set element] indexterm:[XML element,resource_set element,sequential attribute] |require-all |true |Whether all members of the set must be active before continuing. With the current implementation, the cluster may continue even if only one member of the set is started, but if more than one member of the set is starting at the same time, the cluster will still wait until all of those have started before continuing (this may change in future versions). Meaningful within +rsc_order+. indexterm:[XML attribute,require-all attribute,resource_set element] indexterm:[XML element,resource_set element,require-all attribute] |role | |Limit the effect of the constraint to the specified role. Meaningful within +rsc_location+, +rsc_colocation+ and +rsc_ticket+. indexterm:[XML attribute,role attribute,resource_set element] indexterm:[XML element,resource_set element,role attribute] |action | |Limit the effect of the constraint to the specified action. Meaningful within +rsc_order+. indexterm:[XML attribute,action attribute,resource_set element] indexterm:[XML element,resource_set element,action attribute] |score | |'Advanced use only.' Use a specific score for this set within the constraint. indexterm:[XML attribute,score attribute,resource_set element] indexterm:[XML element,resource_set element,score attribute] |========================================================= [[s-resource-sets-ordering]] == Ordering Sets of Resources == A common situation is for an administrator to create a chain of ordered resources, such as: .A chain of ordered resources ====== [source,XML] ------- ------- ====== .Visual representation of the four resources' start order for the above constraints image::images/resource-set.png["Ordered set",width="16cm",height="2.5cm",align="center"] === Ordered Set === To simplify this situation, resource sets (see <>) can be used within ordering constraints: .A chain of ordered resources expressed as a set ====== [source,XML] ------- ------- ====== While the set-based format is not less verbose, it is significantly easier to get right and maintain. [IMPORTANT] ========= If you use a higher-level tool, pay attention to how it exposes this functionality. Depending on the tool, creating a set +A B+ may be equivalent to +A then B+, or +B then A+. ========= === Ordering Multiple Sets === The syntax can be expanded to allow sets of resources to be ordered relative to each other, where the members of each individual set may be ordered or unordered (controlled by the +sequential+ property). In the example below, +A+ and +B+ can both start in parallel, as can +C+ and +D+, however +C+ and +D+ can only start once _both_ +A+ _and_ +B+ are active. .Ordered sets of unordered resources ====== [source,XML] ------- ------- ====== .Visual representation of the start order for two ordered sets of unordered resources image::images/two-sets.png["Two ordered sets",width="13cm",height="7.5cm",align="center"] Of course either set -- or both sets -- of resources can also be internally ordered (by setting +sequential="true"+) and there is no limit to the number of sets that can be specified. .Advanced use of set ordering - Three ordered sets, two of which are internally unordered ====== [source,XML] ------- ------- ====== .Visual representation of the start order for the three sets defined above image::images/three-sets.png["Three ordered sets",width="16cm",height="7.5cm",align="center"] [IMPORTANT] ==== An ordered set with +sequential=false+ makes sense only if there is another set in the constraint. Otherwise, the constraint has no effect. ==== === Resource Set OR Logic === The unordered set logic discussed so far has all been "AND" logic. To illustrate this take the 3 resource set figure in the previous section. Those sets can be expressed, +(A and B) then \(C) then (D) then (E and F)+. Say for example we want to change the first set, +(A and B)+, to use "OR" logic so the sets look like this: +(A or B) then \(C) then (D) then (E and F)+. This functionality can be achieved through the use of the +require-all+ option. This option defaults to TRUE which is why the "AND" logic is used by default. Setting +require-all=false+ means only one resource in the set needs to be started before continuing on to the next set. .Resource Set "OR" logic: Three ordered sets, where the first set is internally unordered with "OR" logic ====== [source,XML] ------- ------- ====== [IMPORTANT] ==== An ordered set with +require-all=false+ makes sense only in conjunction with +sequential=false+. Think of it like this: +sequential=false+ modifies the set to be an unordered set using "AND" logic by default, and adding +require-all=false+ flips the unordered set's "AND" logic to "OR" logic. ==== [[s-resource-sets-colocation]] == Colocating Sets of Resources == Another common situation is for an administrator to create a set of colocated resources. The simplest way to do this is to define a resource group (see <>), but that cannot always accurately express the desired relationships. For example, maybe the resources do not need to be ordered. Another way would be to define each relationship as an individual constraint, but that causes a difficult-to-follow constraint explosion as the number of resources and combinations grow. .Colocation chain as individual constraints, where A is placed first, then B, then C, then D ====== [source,XML] ------- ------- ====== To express complicated relationships with a simplified syntax footnote:[which is not the same as saying easy to follow], <> can be used within colocation constraints. .Equivalent colocation chain expressed using +resource_set+ ====== [source,XML] ------- ------- ====== [NOTE] ==== Within a +resource_set+, the resources are listed in the order they are _placed_, which is the reverse of the order in which they are _colocated_. In the above example, resource +A+ is placed before resource +B+, which is the same as saying resource +B+ is colocated with resource +A+. ==== As with individual constraints, a resource that can't be active prevents any resource that must be colocated with it from being active. In both of the two previous examples, if +B+ is unable to run, then both +C+ and by inference +D+ must remain stopped. [IMPORTANT] ========= If you use a higher-level tool, pay attention to how it exposes this functionality. Depending on the tool, creating a set +A B+ may be equivalent to +A with B+, or +B with A+. ========= Resource sets can also be used to tell the cluster that entire _sets_ of resources must be colocated relative to each other, while the individual members within any one set may or may not be colocated relative to each other (determined by the set's +sequential+ property). In the following example, resources +B+, +C+, and +D+ will each be colocated with +A+ (which will be placed first). +A+ must be able to run in order for any of the resources to run, but any of +B+, +C+, or +D+ may be stopped without affecting any of the others. .Using colocated sets to specify a shared dependency ====== [source,XML] ------- ------- ====== [NOTE] ==== Pay close attention to the order in which resources and sets are listed. While the members of any one sequential set are placed first to last (i.e., the colocation dependency is last with first), multiple sets are placed last to first (i.e. the colocation dependency is first with last). ==== [IMPORTANT] ==== A colocated set with +sequential="false"+ makes sense only if there is another set in the constraint. Otherwise, the constraint has no effect. ==== There is no inherent limit to the number and size of the sets used. The only thing that matters is that in order for any member of one set in the constraint to be active, all members of sets listed after it must also be active (and naturally on the same node); and if a set has +sequential="true"+, then in order for one member of that set to be active, all members listed before it must also be active. If desired, you can restrict the dependency to instances of promotable clone resources that are in a specific role, using the set's +role+ property. .Colocation in which the members of the middle set have no interdependencies, and the last set listed applies only to instances in the master role ====== [source,XML] ------- ------- ====== .Visual representation of the above example (resources are placed from left to right) image::images/pcmk-colocated-sets.png["Colocation chain",width="960px",height="431px",align="center"] [NOTE] ==== Unlike ordered sets, colocated sets do not use the +require-all+ option. ==== diff --git a/doc/sphinx/Pacemaker_Explained/options.rst b/doc/sphinx/Pacemaker_Explained/options.rst index 2261024423..e78172a356 100644 --- a/doc/sphinx/Pacemaker_Explained/options.rst +++ b/doc/sphinx/Pacemaker_Explained/options.rst @@ -1,504 +1,612 @@ Cluster-Wide Configuration -------------------------- -.. Convert_to_RST: - - == Configuration Layout == - - The cluster is defined by the Cluster Information Base (CIB), - which uses XML notation. The simplest CIB, an empty one, looks like this: - - .An empty configuration - ====== - [source,XML] - ------- - - - - - - - - - - ------- - ====== - - The empty configuration above contains the major sections that make up a CIB: - - * +cib+: The entire CIB is enclosed with a +cib+ tag. Certain fundamental settings - are defined as attributes of this tag. - - ** +configuration+: This section -- the primary focus of this document -- - contains traditional configuration information such as what resources the - cluster serves and the relationships among them. - - *** +crm_config+: cluster-wide configuration options - *** +nodes+: the machines that host the cluster - *** +resources+: the services run by the cluster - *** +constraints+: indications of how resources should be placed - - ** +status+: This section contains the history of each resource on each node. - Based on this data, the cluster can construct the complete current - state of the cluster. The authoritative source for this section - is the local executor (pacemaker-execd process) on each cluster node, and - the cluster will occasionally repopulate the entire section. For this - reason, it is never written to disk, and administrators are advised - against modifying it in any way. - - In this document, configuration settings will be described as 'properties' or 'options' - based on how they are defined in the CIB: - - * Properties are XML attributes of an XML element. - * Options are name-value pairs expressed as +nvpair+ child elements of an XML element. - - Normally, you will use command-line tools that abstract the XML, so the - distinction will be unimportant; both properties and options are - cluster settings you can tweak. - - == CIB Properties == - - Certain settings are defined by CIB properties (that is, attributes of the - +cib+ tag) rather than with the rest of the cluster configuration in the - +configuration+ section. - - The reason is simply a matter of parsing. These options are used by the - configuration database which is, by design, mostly ignorant of the content it - holds. So the decision was made to place them in an easy-to-find location. - - .CIB Properties - [width="95%",cols="2m,<5",options="header",align="center"] - |========================================================= - |Field |Description - - | admin_epoch | - indexterm:[Configuration Version,Cluster] - indexterm:[Cluster,Option,Configuration Version] - indexterm:[admin_epoch,Cluster Option] - indexterm:[Cluster,Option,admin_epoch] - When a node joins the cluster, the cluster performs a check to see - which node has the best configuration. It asks the node with the highest - (+admin_epoch+, +epoch+, +num_updates+) tuple to replace the configuration on - all the nodes -- which makes setting them, and setting them correctly, very - important. +admin_epoch+ is never modified by the cluster; you can use this - to make the configurations on any inactive nodes obsolete. _Never set this - value to zero_. In such cases, the cluster cannot tell the difference between - your configuration and the "empty" one used when nothing is found on disk. - - | epoch | - indexterm:[epoch,Cluster Option] - indexterm:[Cluster,Option,epoch] - The cluster increments this every time the configuration is updated (usually by - the administrator). - - | num_updates | - indexterm:[num_updates,Cluster Option] - indexterm:[Cluster,Option,num_updates] - The cluster increments this every time the configuration or status is updated - (usually by the cluster) and resets it to 0 when epoch changes. - - | validate-with | - indexterm:[validate-with,Cluster Option] - indexterm:[Cluster,Option,validate-with] - Determines the type of XML validation that will be done on the configuration. - If set to +none+, the cluster will not verify that updates conform to the - DTD (nor reject ones that don't). This option can be useful when - operating a mixed-version cluster during an upgrade. - - |cib-last-written | - indexterm:[cib-last-written,Cluster Property] - indexterm:[Cluster,Property,cib-last-written] - Indicates when the configuration was last written to disk. Maintained by the - cluster; for informational purposes only. - - |have-quorum | - indexterm:[have-quorum,Cluster Property] - indexterm:[Cluster,Property,have-quorum] - Indicates if the cluster has quorum. If false, this may mean that the - cluster cannot start resources or fence other nodes (see - +no-quorum-policy+ below). Maintained by the cluster. - - |dc-uuid | - indexterm:[dc-uuid,Cluster Property] - indexterm:[Cluster,Property,dc-uuid] - Indicates which cluster node is the current leader. Used by the - cluster when placing resources and determining the order of some - events. Maintained by the cluster. - - |========================================================= +.. index:: + pair: XML element; cib + pair: XML element; configuration + +Configuration Layout +#################### + +The cluster is defined by the Cluster Information Base (CIB), which uses XML +notation. The simplest CIB, an empty one, looks like this: + +.. topic:: An empty configuration + + .. code-block:: xml + + + + + + + + + + + +The empty configuration above contains the major sections that make up a CIB: + +* ``cib``: The entire CIB is enclosed with a ``cib`` element. Certain + fundamental settings are defined as attributes of this element. + + * ``configuration``: This section -- the primary focus of this document -- + contains traditional configuration information such as what resources the + cluster serves and the relationships among them. + + * ``crm_config``: cluster-wide configuration options + + * ``nodes``: the machines that host the cluster + + * ``resources``: the services run by the cluster + + * ``constraints``: indications of how resources should be placed + + * ``status``: This section contains the history of each resource on each + node. Based on this data, the cluster can construct the complete current + state of the cluster. The authoritative source for this section is the + local executor (pacemaker-execd process) on each cluster node, and the + cluster will occasionally repopulate the entire section. For this reason, + it is never written to disk, and administrators are advised against + modifying it in any way. + +In this document, configuration settings will be described as properties or +options based on how they are defined in the CIB: + +* Properties are XML attributes of an XML element. + +* Options are name-value pairs expressed as ``nvpair`` child elements of an XML + element. + +Normally, you will use command-line tools that abstract the XML, so the +distinction will be unimportant; both properties and options are cluster +settings you can tweak. + +CIB Properties +############## + +Certain settings are defined by CIB properties (that is, attributes of the +``cib`` tag) rather than with the rest of the cluster configuration in the +``configuration`` section. + +The reason is simply a matter of parsing. These options are used by the +configuration database which is, by design, mostly ignorant of the content it +holds. So the decision was made to place them in an easy-to-find location. + +.. table:: **CIB Properties** + + +------------------+-----------------------------------------------------------+ + | Attribute | Description | + +==================+===========================================================+ + | admin_epoch | .. index:: | + | | pair: admin_epoch; cib | + | | | + | | When a node joins the cluster, the cluster performs a | + | | check to see which node has the best configuration. It | + | | asks the node with the highest (``admin_epoch``, | + | | ``epoch``, ``num_updates``) tuple to replace the | + | | configuration on all the nodes -- which makes setting | + | | them, and setting them correctly, very important. | + | | ``admin_epoch`` is never modified by the cluster; you can | + | | use this to make the configurations on any inactive nodes | + | | obsolete. | + | | | + | | .. warning:: | + | | Never set this value to zero. In such cases, the | + | | cluster cannot tell the difference between your | + | | configuration and the "empty" one used when nothing is | + | | found on disk. | + +------------------+-----------------------------------------------------------+ + | epoch | .. index:: | + | | pair: epoch; cib | + | | | + | | The cluster increments this every time the configuration | + | | is updated (usually by the administrator). | + +------------------+-----------------------------------------------------------+ + | num_updates | .. index:: | + | | pair: num_updates; cib | + | | | + | | The cluster increments this every time the configuration | + | | or status is updated (usually by the cluster) and resets | + | | it to 0 when epoch changes. | + +------------------+-----------------------------------------------------------+ + | validate-with | .. index:: | + | | pair: validate-with; cib | + | | | + | | Determines the type of XML validation that will be done | + | | on the configuration. If set to ``none``, the cluster | + | | will not verify that updates conform to the DTD (nor | + | | reject ones that don't). | + +------------------+-----------------------------------------------------------+ + | cib-last-written | .. index:: | + | | pair: cib-last-written; cib | + | | | + | | Indicates when the configuration was last written to | + | | disk. Maintained by the cluster; for informational | + | | purposes only. | + +------------------+-----------------------------------------------------------+ + | have-quorum | .. index:: | + | | pair: have-quorum; cib | + | | | + | | Indicates if the cluster has quorum. If false, this may | + | | mean that the cluster cannot start resources or fence | + | | other nodes (see ``no-quorum-policy`` below). Maintained | + | | by the cluster. | + +------------------+-----------------------------------------------------------+ + | dc-uuid | .. index:: | + | | pair: dc-uuid; cib | + | | | + | | Indicates which cluster node is the current leader. Used | + | | by the cluster when placing resources and determining the | + | | order of some events. Maintained by the cluster. | + +------------------+-----------------------------------------------------------+ .. _cluster_options: Cluster Options ############### - -.. Convert_to_RST_2: - Cluster options, as you might expect, control how the cluster behaves - when confronted with certain situations. - - They are grouped into sets within the +crm_config+ section, and, in advanced - configurations, there may be more than one set. (This will be described later - in the section on <> where we will show how to have the cluster use - different sets of options during working hours than during weekends.) For now, - we will describe the simple case where each option is present at most once. - - You can obtain an up-to-date list of cluster options, including - their default values, by running the `man pacemaker-schedulerd` and - `man pacemaker-controld` commands. - - .Cluster Options - [width="95%",cols="5m,2,<11",options="header",align="center"] - |========================================================= - |Option |Default |Description - - | cluster-name | | - indexterm:[cluster-name,Cluster Property] - indexterm:[Cluster,Property,cluster-name] - An (optional) name for the cluster as a whole. This is mostly for users' - convenience for use as desired in administration, but this can be used - in the Pacemaker configuration in <> (as the - +#cluster-name+ <>). It may - also be used by higher-level tools when displaying cluster information, and by - certain resource agents (for example, the +ocf:heartbeat:GFS2+ agent stores the - cluster name in filesystem meta-data). - - | dc-version | | - indexterm:[dc-version,Cluster Property] - indexterm:[Cluster,Property,dc-version] - Version of Pacemaker on the cluster's DC. - Determined automatically by the cluster. - Often includes the hash which identifies the exact Git changeset it was built - from. Used for diagnostic purposes. - - | cluster-infrastructure | | - indexterm:[cluster-infrastructure,Cluster Property] - indexterm:[Cluster,Property,cluster-infrastructure] - The messaging stack on which Pacemaker is currently running. - Determined automatically by the cluster. - Used for informational and diagnostic purposes. - - | no-quorum-policy | stop - a| - indexterm:[no-quorum-policy,Cluster Option] - indexterm:[Cluster,Option,no-quorum-policy] - What to do when the cluster does not have quorum. Allowed values: - - * +ignore:+ continue all resource management - * +freeze:+ continue resource management, but don't recover resources from nodes not in the affected partition - * +stop:+ stop all resources in the affected cluster partition - * +demote:+ demote promotable resources and stop all other resources in the - affected cluster partition - * +suicide:+ fence all nodes in the affected cluster partition - - | batch-limit | 0 | - indexterm:[batch-limit,Cluster Option] - indexterm:[Cluster,Option,batch-limit] - The maximum number of actions that the cluster may execute in parallel across - all nodes. The "correct" value will depend on the speed and load of your - network and cluster nodes. If zero, the cluster will impose a dynamically - calculated limit only when any node has high load. - - | migration-limit | -1 | - indexterm:[migration-limit,Cluster Option] - indexterm:[Cluster,Option,migration-limit] - The number of <> actions that the cluster - is allowed to execute in parallel on a node. A value of -1 means unlimited. - - | symmetric-cluster | TRUE | - indexterm:[symmetric-cluster,Cluster Option] - indexterm:[Cluster,Option,symmetric-cluster] - Can all resources run on any node by default? - - | stop-all-resources | FALSE | - indexterm:[stop-all-resources,Cluster Option] - indexterm:[Cluster,Option,stop-all-resources] - Should the cluster stop all resources? - - | stop-orphan-resources | TRUE | - indexterm:[stop-orphan-resources,Cluster Option] - indexterm:[Cluster,Option,stop-orphan-resources] - Should deleted resources be stopped? This value takes precedence over - +is-managed+ (i.e. even unmanaged resources will be stopped if deleted from - the configuration when this value is TRUE). - - | stop-orphan-actions | TRUE | - indexterm:[stop-orphan-actions,Cluster Option] - indexterm:[Cluster,Option,stop-orphan-actions] - Should deleted actions be cancelled? - - | start-failure-is-fatal | TRUE | - indexterm:[start-failure-is-fatal,Cluster Option] - indexterm:[Cluster,Option,start-failure-is-fatal] - Should a failure to start a resource on a particular node prevent further start - attempts on that node? If FALSE, the cluster will decide whether the same - node is still eligible based on the resource's current failure count - and +migration-threshold+ (see <>). - - | enable-startup-probes | TRUE | - indexterm:[enable-startup-probes,Cluster Option] - indexterm:[Cluster,Option,enable-startup-probes] - Should the cluster check for active resources during startup? - - | maintenance-mode | FALSE | - indexterm:[maintenance-mode,Cluster Option] - indexterm:[Cluster,Option,maintenance-mode] - Should the cluster refrain from monitoring, starting and stopping resources? - - | stonith-enabled | TRUE | - indexterm:[stonith-enabled,Cluster Option] - indexterm:[Cluster,Option,stonith-enabled] - Should failed nodes and nodes with resources that can't be stopped be - shot? If you value your data, set up a STONITH device and enable this. - - If true, or unset, the cluster will refuse to start resources unless - one or more STONITH resources have been configured. - If false, unresponsive nodes are immediately assumed to be running no - resources, and resource takeover to online nodes starts without any - further protection (which means _data loss_ if the unresponsive node - still accesses shared storage, for example). See also the +requires+ - meta-attribute in <>. - - | stonith-action | reboot | - indexterm:[stonith-action,Cluster Option] - indexterm:[Cluster,Option,stonith-action] - Action to send to STONITH device. Allowed values are +reboot+ and +off+. - The value +poweroff+ is also allowed, but is only used for - legacy devices. - - | stonith-timeout | 60s | - indexterm:[stonith-timeout,Cluster Option] - indexterm:[Cluster,Option,stonith-timeout] - How long to wait for STONITH actions (reboot, on, off) to complete - - | stonith-max-attempts | 10 | - indexterm:[stonith-max-attempts,Cluster Option] - indexterm:[Cluster,Option,stonith-max-attempts] - How many times fencing can fail for a target before the cluster will no longer - immediately re-attempt it. - - | stonith-watchdog-timeout | 0 | - indexterm:[stonith-watchdog-timeout,Cluster Option] - indexterm:[Cluster,Option,stonith-watchdog-timeout] - If nonzero, along with `have-watchdog=true` automatically set by the - cluster, when fencing is required, watchdog-based self-fencing - will be performed via SBD without requiring a fencing resource - explicitly configured. - If `stonith-watchdog-timeout` is set to a positive value, unseen - nodes are assumed to self-fence within this much time. +WARNING:+ - It must be ensured that this value is larger than the - `SBD_WATCHDOG_TIMEOUT` environment variable on all nodes. - Pacemaker verifies the settings individually on all nodes and - prevents startup or shuts down if configured wrongly on the fly. - It's strongly recommended that `SBD_WATCHDOG_TIMEOUT` is set to - the same value on all nodes. - If `stonith-watchdog-timeout` is set to a negative value, and - `SBD_WATCHDOG_TIMEOUT` is set, twice that value will be used. - +WARNING:+ In this case, it's essential (currently not verified by - pacemaker) that `SBD_WATCHDOG_TIMEOUT` is set to the same value on - all nodes. +Cluster options, as you might expect, control how the cluster behaves when +confronted with various situations. + +They are grouped into sets within the ``crm_config`` section. In advanced +configurations, there may be more than one set. (This will be described later +in the chapter on :ref:`rules` where we will show how to have the cluster use +different sets of options during working hours than during weekends.) For now, +we will describe the simple case where each option is present at most once. + +You can obtain an up-to-date list of cluster options, including their default +values, by running the ``man pacemaker-schedulerd`` and +``man pacemaker-controld`` commands. + +.. table:: **Cluster Options** - | concurrent-fencing | FALSE | - indexterm:[concurrent-fencing,Cluster Option] - indexterm:[Cluster,Option,concurrent-fencing] - Is the cluster allowed to initiate multiple fence actions concurrently? - - | fence-reaction | stop | - indexterm:[fence-reaction,Cluster Option] - indexterm:[Cluster,Option,fence-reaction] - How should a cluster node react if notified of its own fencing? A cluster node - may receive notification of its own fencing if fencing is misconfigured, or if - fabric fencing is in use that doesn't cut cluster communication. Allowed values - are +stop+ to attempt to immediately stop pacemaker and stay stopped, or - +panic+ to attempt to immediately reboot the local node, falling back to stop - on failure. The default is likely to be changed to +panic+ in a future release. - '(since 2.0.3)' - - | priority-fencing-delay | 0 | - indexterm:[priority-fencing-delay,Cluster Option] - indexterm:[Cluster,Option,priority-fencing-delay] - Apply specified delay for the fencings that are targeting the lost - nodes with the highest total resource priority in case we don't - have the majority of the nodes in our cluster partition, so that - the more significant nodes potentially win any fencing match, - which is especially meaningful under split-brain of 2-node - cluster. A promoted resource instance takes the base priority + 1 - on calculation if the base priority is not 0. Any static/random - delays that are introduced by `pcmk_delay_base/max` configured - for the corresponding fencing resources will be added to this - delay. This delay should be significantly greater than, safely - twice, the maximum `pcmk_delay_base/max`. By default, priority - fencing delay is disabled. '(since 2.0.4)' - - | cluster-delay | 60s | - indexterm:[cluster-delay,Cluster Option] - indexterm:[Cluster,Option,cluster-delay] - Estimated maximum round-trip delay over the network (excluding action - execution). If the DC requires an action to be executed on another - node, it will consider the action failed if it does not get a response - from the other node in this time (after considering the action's - own timeout). The "correct" value will depend on the speed and load of your - network and cluster nodes. - - | dc-deadtime | 20s | - indexterm:[dc-deadtime,Cluster Option] - indexterm:[Cluster,Option,dc-deadtime] - How long to wait for a response from other nodes during startup. - - The "correct" value will depend on the speed/load of your network and the type of switches used. - - | cluster-ipc-limit | 500 | - indexterm:[cluster-ipc-limit,Cluster Option] - indexterm:[Cluster,Option,cluster-ipc-limit] - The maximum IPC message backlog before one cluster daemon will disconnect - another. This is of use in large clusters, for which a good value is the number - of resources in the cluster multiplied by the number of nodes. The default of - 500 is also the minimum. Raise this if you see "Evicting client" messages for - cluster daemon PIDs in the logs. - - | pe-error-series-max | -1 | - indexterm:[pe-error-series-max,Cluster Option] - indexterm:[Cluster,Option,pe-error-series-max] - The number of PE inputs resulting in ERRORs to save. Used when reporting problems. - A value of -1 means unlimited (report all). - - | pe-warn-series-max | -1 | - indexterm:[pe-warn-series-max,Cluster Option] - indexterm:[Cluster,Option,pe-warn-series-max] - The number of PE inputs resulting in WARNINGs to save. Used when reporting problems. - A value of -1 means unlimited (report all). - - | pe-input-series-max | -1 | - indexterm:[pe-input-series-max,Cluster Option] - indexterm:[Cluster,Option,pe-input-series-max] - The number of "normal" PE inputs to save. Used when reporting problems. - A value of -1 means unlimited (report all). - - | placement-strategy | default | - indexterm:[placement-strategy,Cluster Option] - indexterm:[Cluster,Option,placement-strategy] - How the cluster should allocate resources to nodes (see <>). - Allowed values are +default+, +utilization+, +balanced+, and +minimal+. - - | node-health-strategy | none | - indexterm:[node-health-strategy,Cluster Option] - indexterm:[Cluster,Option,node-health-strategy] - How the cluster should react to node health attributes (see <>). - Allowed values are +none+, +migrate-on-red+, +only-green+, +progressive+, and - +custom+. - - | enable-acl | FALSE | - indexterm:[enable-acl,Cluster Option] - indexterm:[Cluster,Option,enable-acl] - Whether access control lists (ACLs) (see <>) can be used to authorize - modifications to the CIB. - - | node-health-base | 0 | - indexterm:[node-health-base,Cluster Option] - indexterm:[Cluster,Option,node-health-base] - The base health score assigned to a node. Only used when - +node-health-strategy+ is +progressive+. - - | node-health-green | 0 | - indexterm:[node-health-green,Cluster Option] - indexterm:[Cluster,Option,node-health-green] - The score to use for a node health attribute whose value is +green+. - Only used when +node-health-strategy+ is +progressive+ or +custom+. - - | node-health-yellow | 0 | - indexterm:[node-health-yellow,Cluster Option] - indexterm:[Cluster,Option,node-health-yellow] - The score to use for a node health attribute whose value is +yellow+. - Only used when +node-health-strategy+ is +progressive+ or +custom+. - - | node-health-red | 0 | - indexterm:[node-health-red,Cluster Option] - indexterm:[Cluster,Option,node-health-red] - The score to use for a node health attribute whose value is +red+. - Only used when +node-health-strategy+ is +progressive+ or +custom+. - - | cluster-recheck-interval | 15min | - indexterm:[cluster-recheck-interval,Cluster Option] - indexterm:[Cluster,Option,cluster-recheck-interval] - Pacemaker is primarily event-driven, and looks ahead to know when to recheck - the cluster for failure timeouts and most time-based rules. However, it will - also recheck the cluster after this amount of inactivity. This has two goals: - rules with +date_spec+ are only guaranteed to be checked this often, and it - also serves as a fail-safe for certain classes of scheduler bugs. A value of 0 - disables this polling; positive values are a time interval. - - | shutdown-lock | false | - The default of false allows active resources to be recovered elsewhere when - their node is cleanly shut down, which is what the vast majority of users will - want. However, some users prefer to make resources highly available only for - failures, with no recovery for clean shutdowns. If this option is true, - resources active on a node when it is cleanly shut down are kept "locked" to - that node (not allowed to run elsewhere) until they start again on that node - after it rejoins (or for at most shutdown-lock-limit, if set). Stonith - resources and Pacemaker Remote connections are never locked. Clone and bundle - instances and the master role of promotable clones are currently never locked, - though support could be added in a future release. Locks may be manually - cleared using the `--refresh` option of `crm_resource` (both the resource and - node must be specified; this works with remote nodes if their connection - resource's target-role is set to Stopped, but not if Pacemaker Remote is - stopped on the remote node without disabling the connection resource). - '(since 2.0.4)' - indexterm:[shutdown-lock,Cluster Option] - indexterm:[Cluster,Option,shutdown-lock] - - | shutdown-lock-limit | 0 | - If shutdown-lock is true, and this is set to a nonzero time duration, locked - resources will be allowed to start after this much time has passed since the - node shutdown was initiated, even if the node has not rejoined. (This works - with remote nodes only if their connection resource's target-role is set to - Stopped.) '(since 2.0.4)' - indexterm:[shutdown-lock-limit,Cluster Option] - indexterm:[Cluster,Option,shutdown-lock-limit] - - | remove-after-stop | FALSE | - indexterm:[remove-after-stop,Cluster Option] - indexterm:[Cluster,Option,remove-after-stop] - _Advanced Use Only:_ Should the cluster remove resources from the LRM after - they are stopped? Values other than the default are, at best, poorly tested and - potentially dangerous. - - | startup-fencing | TRUE | - indexterm:[startup-fencing,Cluster Option] - indexterm:[Cluster,Option,startup-fencing] - _Advanced Use Only:_ Should the cluster shoot unseen nodes? - Not using the default is very unsafe! - - | election-timeout | 2min | - indexterm:[election-timeout,Cluster Option] - indexterm:[Cluster,Option,election-timeout] - _Advanced Use Only:_ If you need to adjust this value, it probably indicates - the presence of a bug. - - | shutdown-escalation | 20min | - indexterm:[shutdown-escalation,Cluster Option] - indexterm:[Cluster,Option,shutdown-escalation] - _Advanced Use Only:_ If you need to adjust this value, it probably indicates - the presence of a bug. - - | join-integration-timeout | 3min | - indexterm:[join-integration-timeout,Cluster Option] - indexterm:[Cluster,Option,join-integration-timeout] - _Advanced Use Only:_ If you need to adjust this value, it probably indicates - the presence of a bug. - - | join-finalization-timeout | 30min | - indexterm:[join-finalization-timeout,Cluster Option] - indexterm:[Cluster,Option,join-finalization-timeout] - _Advanced Use Only:_ If you need to adjust this value, it probably indicates - the presence of a bug. - - | transition-delay | 0s | - indexterm:[transition-delay,Cluster Option] - indexterm:[Cluster,Option,transition-delay] - _Advanced Use Only:_ Delay cluster recovery for the configured interval to - allow for additional/related events to occur. Useful if your configuration is - sensitive to the order in which ping updates arrive. - Enabling this option will slow down cluster recovery under - all conditions. - - |========================================================= + +---------------------------+---------+----------------------------------------------------+ + | Option | Default | Description | + +===========================+=========+====================================================+ + | cluster-name | | .. index:: | + | | | pair: cluster option; cluster-name | + | | | | + | | | An (optional) name for the cluster as a whole. | + | | | This is mostly for users' convenience for use | + | | | as desired in administration, but this can be | + | | | used in the Pacemaker configuration in | + | | | :ref:`rules` (as the ``#cluster-name`` | + | | | :ref:`node attribute | + | | | `. It may | + | | | also be used by higher-level tools when | + | | | displaying cluster information, and by | + | | | certain resource agents (for example, the | + | | | ``ocf:heartbeat:GFS2`` agent stores the | + | | | cluster name in filesystem meta-data). | + +---------------------------+---------+----------------------------------------------------+ + | dc-version | | .. index:: | + | | | pair: cluster option; dc-version | + | | | | + | | | Version of Pacemaker on the cluster's DC. | + | | | Determined automatically by the cluster. Often | + | | | includes the hash which identifies the exact | + | | | Git changeset it was built from. Used for | + | | | diagnostic purposes. | + +---------------------------+---------+----------------------------------------------------+ + | cluster-infrastructure | | .. index:: | + | | | pair: cluster option; cluster-infrastructure | + | | | | + | | | The messaging stack on which Pacemaker is | + | | | currently running. Determined automatically by | + | | | the cluster. Used for informational and | + | | | diagnostic purposes. | + +---------------------------+---------+----------------------------------------------------+ + | no-quorum-policy | stop | .. index:: | + | | | pair: cluster option; no-quorum-policy | + | | | | + | | | What to do when the cluster does not have | + | | | quorum. Allowed values: | + | | | | + | | | * ``ignore:`` continue all resource management | + | | | * ``freeze:`` continue resource management, but | + | | | don't recover resources from nodes not in the | + | | | affected partition | + | | | * ``stop:`` stop all resources in the affected | + | | | cluster partition | + | | | * ``demote:`` demote promotable resources and | + | | | stop all other resources in the affected | + | | | cluster partition | + | | | * ``suicide:`` fence all nodes in the affected | + | | | cluster partition | + +---------------------------+---------+----------------------------------------------------+ + | batch-limit | 0 | .. index:: | + | | | pair: cluster option; batch-limit | + | | | | + | | | The maximum number of actions that the cluster | + | | | may execute in parallel across all nodes. The | + | | | "correct" value will depend on the speed and | + | | | load of your network and cluster nodes. If zero, | + | | | the cluster will impose a dynamically calculated | + | | | limit only when any node has high load. | + +---------------------------+---------+----------------------------------------------------+ + | migration-limit | -1 | .. index:: | + | | | pair: cluster option; migration-limit | + | | | | + | | | The number of | + | | | :ref:`live migration ` actions | + | | | that the cluster is allowed to execute in | + | | | parallel on a node. A value of -1 means | + | | | unlimited. | + +---------------------------+---------+----------------------------------------------------+ + | symmetric-cluster | true | .. index:: | + | | | pair: cluster option; symmetric-cluster | + | | | | + | | | Whether resources can run on any node by default | + | | | (if false, a resource is allowed to run on a | + | | | node only if a | + | | | :ref:`location constraint ` | + | | | enables it) | + +---------------------------+---------+----------------------------------------------------+ + | stop-all-resources | false | .. index:: | + | | | pair: cluster option; stop-all-resources | + | | | | + | | | Whether all resources should be disallowed from | + | | | running (can be useful during maintenance) | + +---------------------------+---------+----------------------------------------------------+ + | stop-orphan-resources | true | .. index:: | + | | | pair: cluster option; stop-orphan-resources | + | | | | + | | | Whether resources that have been deleted from | + | | | the configuration should be stopped. This value | + | | | takes precedence over ``is-managed`` (that is, | + | | | even unmanaged resources will be stopped when | + | | | orphaned if this value is ``true`` | + +---------------------------+---------+----------------------------------------------------+ + | stop-orphan-actions | true | .. index:: | + | | | pair: cluster option; stop-orphan-actions | + | | | | + | | | Whether recurring :ref:`operations ` | + | | | that have been deleted from the configuration | + | | | should be cancelled | + +---------------------------+---------+----------------------------------------------------+ + | start-failure-is-fatal | true | .. index:: | + | | | pair: cluster option; start-failure-is-fatal | + | | | | + | | | Whether a failure to start a resource on a | + | | | particular node prevents further start attempts | + | | | on that node? If ``false``, the cluster will | + | | | decide whether the node is still eligible based | + | | | on the resource's current failure count and | + | | | :ref:`migration-threshold `. | + +---------------------------+---------+----------------------------------------------------+ + | enable-startup-probes | true | .. index:: | + | | | pair: cluster option; enable-startup-probes | + | | | | + | | | Whether the cluster should check the | + | | | pre-existing state of resources when the cluster | + | | | starts | + +---------------------------+---------+----------------------------------------------------+ + | maintenance-mode | false | .. index:: | + | | | pair: cluster option; maintenance-mode | + | | | | + | | | Whether the cluster should refrain from | + | | | monitoring, starting and stopping resources | + +---------------------------+---------+----------------------------------------------------+ + | stonith-enabled | true | .. index:: | + | | | pair: cluster option; stonith-enabled | + | | | | + | | | Whether the cluster is allowed to fence nodes | + | | | (for example, failed nodes and nodes with | + | | | resources that can't be stopped. | + | | | | + | | | If true, at least one fence device must be | + | | | configured before resources are allowed to run. | + | | | | + | | | If false, unresponsive nodes are immediately | + | | | assumed to be running no resources, and resource | + | | | recovery on online nodes starts without any | + | | | further protection (which can mean *data loss* | + | | | if the unresponsive node still accesses shared | + | | | storage, for example). See also the | + | | | :ref:`requires ` resource | + | | | meta-attribute. | + +---------------------------+---------+----------------------------------------------------+ + | stonith-action | reboot | .. index:: | + | | | pair: cluster option; stonith-action | + | | | | + | | | Action the cluster should send to the fence agent | + | | | when a node must be fenced. Allowed values are | + | | | ``reboot``, ``off``, and (for legacy agents only) | + | | | ``poweroff``. | + +---------------------------+---------+----------------------------------------------------+ + | stonith-timeout | 60s | .. index:: | + | | | pair: cluster option; stonith-timeout | + | | | | + | | | How long to wait for ``on``, ``off``, and | + | | | ``reboot`` fence actions to complete by default. | + +---------------------------+---------+----------------------------------------------------+ + | stonith-max-attempts | 10 | .. index:: | + | | | pair: cluster option; stonith-max-attempts | + | | | | + | | | How many times fencing can fail for a target | + | | | before the cluster will no longer immediately | + | | | re-attempt it. | + +---------------------------+---------+----------------------------------------------------+ + | stonith-watchdog-timeout | 0 | .. index:: | + | | | pair: cluster option; stonith-watchdog-timeout | + | | | | + | | | If nonzero, and the cluster detects | + | | | ``have-watchdog`` as ``true``, then watchdog-based | + | | | self-fencing will be performed via SBD when | + | | | fencing is required, without requiring a fencing | + | | | resource explicitly configured. | + | | | | + | | | If this is set to a positive value, unseen nodes | + | | | are assumed to self-fence within this much time. | + | | | | + | | | .. warning:: | + | | | It must be ensured that this value is larger | + | | | than the ``SBD_WATCHDOG_TIMEOUT`` environment | + | | | variable on all nodes. Pacemaker verifies the | + | | | settings individually on all nodes and prevents | + | | | startup or shuts down if configured wrongly on | + | | | the fly. It is strongly recommended that | + | | | ``SBD_WATCHDOG_TIMEOUT`` be set to the same | + | | | value on all nodes. | + | | | | + | | | If this is set to a negative value, and | + | | | ``SBD_WATCHDOG_TIMEOUT`` is set, twice that value | + | | | will be used. | + | | | | + | | | .. warning:: | + | | | In this case, it is essential (and currently | + | | | not verified by pacemaker) that | + | | | ``SBD_WATCHDOG_TIMEOUT`` is set to the same | + | | | value on all nodes. | + +---------------------------+---------+----------------------------------------------------+ + | concurrent-fencing | false | .. index:: | + | | | pair: cluster option; concurrent-fencing | + | | | | + | | | Whether the cluster is allowed to initiate multiple| + | | | fence actions concurrently | + +---------------------------+---------+----------------------------------------------------+ + | fence-reaction | stop | .. index:: | + | | | pair: cluster option; fence-reaction | + | | | | + | | | How should a cluster node react if notified of its | + | | | own fencing? A cluster node may receive | + | | | notification of its own fencing if fencing is | + | | | misconfigured, or if fabric fencing is in use that | + | | | doesn't cut cluster communication. Allowed values | + | | | are ``stop`` to attempt to immediately stop | + | | | pacemaker and stay stopped, or ``panic`` to | + | | | attempt to immediately reboot the local node, | + | | | falling back to stop on failure. The default is | + | | | likely to be changed to ``panic`` in a future | + | | | release. *(since 2.0.3)* | + +---------------------------+---------+----------------------------------------------------+ + | priority-fencing-delay | 0 | .. index:: | + | | | pair: cluster option; priority-fencing-delay | + | | | | + | | | Apply this delay to any fencing targeting the lost | + | | | nodes with the highest total resource priority in | + | | | case we don't have the majority of the nodes in | + | | | our cluster partition, so that the more | + | | | significant nodes potentially win any fencing | + | | | match (especially meaningful in a split-brain of a | + | | | 2-node cluster). A promoted resource instance | + | | | takes the resource's priority plus 1 if the | + | | | resource's priority is not 0. Any static or random | + | | | delays introduced by ``pcmk_delay_base`` and | + | | | ``pcmk_delay_max`` configured for the | + | | | corresponding fencing resources will be added to | + | | | this delay. This delay should be significantly | + | | | greater than (safely twice) the maximum delay from | + | | | those parameters. *(since 2.0.4)* | + +---------------------------+---------+----------------------------------------------------+ + | cluster-delay | 60s | .. index:: | + | | | pair: cluster option; cluster-delay | + | | | | + | | | Estimated maximum round-trip delay over the | + | | | network (excluding action execution). If the DC | + | | | requires an action to be executed on another node, | + | | | it will consider the action failed if it does not | + | | | get a response from the other node in this time | + | | | (after considering the action's own timeout). The | + | | | "correct" value will depend on the speed and load | + | | | of your network and cluster nodes. | + +---------------------------+---------+----------------------------------------------------+ + | dc-deadtime | 20s | .. index:: | + | | | pair: cluster option; dc-deadtime | + | | | | + | | | How long to wait for a response from other nodes | + | | | during startup. The "correct" value will depend on | + | | | the speed/load of your network and the type of | + | | | switches used. | + +---------------------------+---------+----------------------------------------------------+ + | cluster-ipc-limit | 500 | .. index:: | + | | | pair: cluster option; cluster-ipc-limit | + | | | | + | | | The maximum IPC message backlog before one cluster | + | | | daemon will disconnect another. This is of use in | + | | | large clusters, for which a good value is the | + | | | number of resources in the cluster multiplied by | + | | | the number of nodes. The default of 500 is also | + | | | the minimum. Raise this if you see | + | | | "Evicting client" messages for cluster daemon PIDs | + | | | in the logs. | + +---------------------------+---------+----------------------------------------------------+ + | pe-error-series-max | -1 | .. index:: | + | | | pair: cluster option; pe-error-series-max | + | | | | + | | | The number of scheduler inputs resulting in errors | + | | | to save. Used when reporting problems. A value of | + | | | -1 means unlimited (report all). | + +---------------------------+---------+----------------------------------------------------+ + | pe-warn-series-max | -1 | .. index:: | + | | | pair: cluster option; pe-warn-series-max | + | | | | + | | | The number of scheduler inputs resulting in | + | | | warnings to save. Used when reporting problems. A | + | | | value of -1 means unlimited (report all). | + +---------------------------+---------+----------------------------------------------------+ + | pe-input-series-max | -1 | .. index:: | + | | | pair: cluster option; pe-input-series-max | + | | | | + | | | The number of "normal" scheduler inputs to save. | + | | | Used when reporting problems. A value of -1 means | + | | | unlimited (report all). | + +---------------------------+---------+----------------------------------------------------+ + | enable-acl | false | .. index:: | + | | | pair: cluster option; enable-acl | + | | | | + | | | Whether :ref:`acl` should be used to authorize | + | | | modifications to the CIB | + +---------------------------+---------+----------------------------------------------------+ + | placement-strategy | default | .. index:: | + | | | pair: cluster option; placement-strategy | + | | | | + | | | How the cluster should allocate resources to nodes | + | | | (see :ref:`utilization`). Allowed values are | + | | | ``default``, ``utilization``, ``balanced``, and | + | | | ``minimal``. | + +---------------------------+---------+----------------------------------------------------+ + | node-health-strategy | none | .. index:: | + | | | pair: cluster option; node-health-strategy | + | | | | + | | | How the cluster should react to node health | + | | | attributes (see :ref:`node-health`). Allowed values| + | | | are ``none``, ``migrate-on-red``, ``only-green``, | + | | | ``progressive``, and ``custom``. | + +---------------------------+---------+----------------------------------------------------+ + | node-health-base | 0 | .. index:: | + | | | pair: cluster option; node-health-base | + | | | | + | | | The base health score assigned to a node. Only | + | | | used when ``node-health-strategy`` is | + | | | ``progressive``. | + +---------------------------+---------+----------------------------------------------------+ + | node-health-green | 0 | .. index:: | + | | | pair: cluster option; node-health-green | + | | | | + | | | The score to use for a node health attribute whose | + | | | value is ``green``. Only used when | + | | | ``node-health-strategy`` is ``progressive`` or | + | | | ``custom``. | + +---------------------------+---------+----------------------------------------------------+ + | node-health-yellow | 0 | .. index:: | + | | | pair: cluster option; node-health-yellow | + | | | | + | | | The score to use for a node health attribute whose | + | | | value is ``yellow``. Only used when | + | | | ``node-health-strategy`` is ``progressive`` or | + | | | ``custom``. | + +---------------------------+---------+----------------------------------------------------+ + | node-health-red | 0 | .. index:: | + | | | pair: cluster option; node-health-red | + | | | | + | | | The score to use for a node health attribute whose | + | | | value is ``red``. Only used when | + | | | ``node-health-strategy`` is ``progressive`` or | + | | | ``custom``. | + +---------------------------+---------+----------------------------------------------------+ + | cluster-recheck-interval | 15min | .. index:: | + | | | pair: cluster option; cluster-recheck-interval | + | | | | + | | | Pacemaker is primarily event-driven, and looks | + | | | ahead to know when to recheck the cluster for | + | | | failure timeouts and most time-based rules. | + | | | However, it will also recheck the cluster after | + | | | this amount of inactivity. This has two goals: | + | | | rules with ``date_spec`` are only guaranteed to be | + | | | checked this often, and it also serves as a | + | | | fail-safe for certain classes of scheduler bugs. A | + | | | value of 0 disables this polling; positive values | + | | | are a time interval. | + +---------------------------+---------+----------------------------------------------------+ + | shutdown-lock | false | .. index:: | + | | | pair: cluster option; shutdown-lock | + | | | | + | | | The default of false allows active resources to be | + | | | recovered elsewhere when their node is cleanly | + | | | shut down, which is what the vast majority of | + | | | users will want. However, some users prefer to | + | | | make resources highly available only for failures, | + | | | with no recovery for clean shutdowns. If this | + | | | option is true, resources active on a node when it | + | | | is cleanly shut down are kept "locked" to that | + | | | node (not allowed to run elsewhere) until they | + | | | start again on that node after it rejoins (or for | + | | | at most ``shutdown-lock-limit``, if set). Stonith | + | | | resources and Pacemaker Remote connections are | + | | | never locked. Clone and bundle instances and the | + | | | master role of promotable clones are currently | + | | | never locked, though support could be added in a | + | | | future release. Locks may be manually cleared | + | | | using the ``--refresh`` option of ``crm_resource`` | + | | | (both the resource and node must be specified; | + | | | this works with remote nodes if their connection | + | | | resource's ``target-role`` is set to ``Stopped``, | + | | | but not if Pacemaker Remote is stopped on the | + | | | remote node without disabling the connection | + | | | resource). *(since 2.0.4)* | + +---------------------------+---------+----------------------------------------------------+ + | shutdown-lock-limit | 0 | .. index:: | + | | | pair: cluster option; shutdown-lock-limit | + | | | | + | | | If ``shutdown-lock`` is true, and this is set to a | + | | | nonzero time duration, locked resources will be | + | | | allowed to start after this much time has passed | + | | | since the node shutdown was initiated, even if the | + | | | node has not rejoined. (This works with remote | + | | | nodes only if their connection resource's | + | | | ``target-role`` is set to ``Stopped``.) | + | | | *(since 2.0.4)* | + +---------------------------+---------+----------------------------------------------------+ + | remove-after-stop | false | .. index:: | + | | | pair: cluster option; remove-after-stop | + | | | | + | | | *Advanced Use Only:* Should the cluster remove | + | | | resources from Pacemaker's executor after they are | + | | | stopped? Values other than the default are, at | + | | | best, poorly tested and potentially dangerous. | + +---------------------------+---------+----------------------------------------------------+ + | startup-fencing | true | .. index:: | + | | | pair: cluster option; startup-fencing | + | | | | + | | | *Advanced Use Only:* Should the cluster fence | + | | | unseen nodes at start-up? Setting this to false is | + | | | unsafe, because the unseen nodes could be active | + | | | and running resources but unreachable. | + +---------------------------+---------+----------------------------------------------------+ + | election-timeout | 2min | .. index:: | + | | | pair: cluster option; election-timeout | + | | | | + | | | *Advanced Use Only:* If you need to adjust this | + | | | value, it probably indicates the presence of a bug.| + +---------------------------+---------+----------------------------------------------------+ + | shutdown-escalation | 20min | .. index:: | + | | | pair: cluster option; shutdown-escalation | + | | | | + | | | *Advanced Use Only:* If you need to adjust this | + | | | value, it probably indicates the presence of a bug.| + +---------------------------+---------+----------------------------------------------------+ + | join-integration-timeout | 3min | .. index:: | + | | | pair: cluster option; join-integration-timeout | + | | | | + | | | *Advanced Use Only:* If you need to adjust this | + | | | value, it probably indicates the presence of a bug.| + +---------------------------+---------+----------------------------------------------------+ + | join-finalization-timeout | 30min | .. index:: | + | | | pair: cluster option; join-finalization-timeout | + | | | | + | | | *Advanced Use Only:* If you need to adjust this | + | | | value, it probably indicates the presence of a bug.| + +---------------------------+---------+----------------------------------------------------+ + | transition-delay | 0s | .. index:: | + | | | pair: cluster option; transition-delay | + | | | | + | | | *Advanced Use Only:* Delay cluster recovery for | + | | | the configured interval to allow for additional or | + | | | related events to occur. This can be useful if | + | | | your configuration is sensitive to the order in | + | | | which ping updates arrive. Enabling this option | + | | | will slow down cluster recovery under all | + | | | conditions. | + +---------------------------+---------+----------------------------------------------------+ diff --git a/doc/sphinx/Pacemaker_Explained/resources.rst b/doc/sphinx/Pacemaker_Explained/resources.rst index 6e24844550..592e299121 100644 --- a/doc/sphinx/Pacemaker_Explained/resources.rst +++ b/doc/sphinx/Pacemaker_Explained/resources.rst @@ -1,964 +1,980 @@ +.. _resource: + Cluster Resources ----------------- .. Convert_to_RST: [[s-resource-primitive]] == What is a Cluster Resource? == indexterm:[Resource] A resource is a service made highly available by a cluster. The simplest type of resource, a 'primitive' resource, is described in this chapter. More complex forms, such as groups and clones, are described in later chapters. Every primitive resource has a 'resource agent'. A resource agent is an external program that abstracts the service it provides and present a consistent view to the cluster. This allows the cluster to be agnostic about the resources it manages. The cluster doesn't need to understand how the resource works because it relies on the resource agent to do the right thing when given a `start`, `stop` or `monitor` command. For this reason, it is crucial that resource agents are well-tested. Typically, resource agents come in the form of shell scripts. However, they can be written using any technology (such as C, Python or Perl) that the author is comfortable with. [[s-resource-supported]] == Resource Classes == indexterm:[Resource,class] Pacemaker supports several classes of agents: * OCF * LSB * Upstart * Systemd * Service * Fencing * Nagios Plugins === Open Cluster Framework === indexterm:[Resource,OCF] indexterm:[OCF,Resources] indexterm:[Open Cluster Framework,Resources] The OCF standard footnote:[See https://github.com/ClusterLabs/OCF-spec/tree/master/ra . The Pacemaker implementation has been somewhat extended from the OCF specs.] is basically an extension of the Linux Standard Base conventions for init scripts to: * support parameters, * make them self-describing, and * make them extensible OCF specs have strict definitions of the exit codes that actions must return. footnote:[ The resource-agents source code includes the `ocf-tester` script, which can be useful in this regard. ] The cluster follows these specifications exactly, and giving the wrong exit code will cause the cluster to behave in ways you will likely find puzzling and annoying. In particular, the cluster needs to distinguish a completely stopped resource from one which is in some erroneous and indeterminate state. Parameters are passed to the resource agent as environment variables, with the special prefix +OCF_RESKEY_+. So, a parameter which the user thinks of as +ip+ will be passed to the resource agent as +OCF_RESKEY_ip+. The number and purpose of the parameters is left to the resource agent; however, the resource agent should use the `meta-data` command to advertise any that it supports. The OCF class is the most preferred as it is an industry standard, highly flexible (allowing parameters to be passed to agents in a non-positional manner) and self-describing. For more information, see the http://www.linux-ha.org/wiki/OCF_Resource_Agents[reference] and the 'Resource Agents' chapter of 'Pacemaker Administration'. === Linux Standard Base === indexterm:[Resource,LSB] indexterm:[LSB,Resources] indexterm:[Linux Standard Base,Resources] 'LSB' resource agents are more commonly known as 'init scripts'. If a full path is not given, they are assumed to be located in +/etc/init.d+. Commonly, they are provided by the OS distribution. In order to be used with a Pacemaker cluster, they must conform to the LSB specification. footnote:[ See http://refspecs.linux-foundation.org/LSB_3.0.0/LSB-Core-generic/LSB-Core-generic/iniscrptact.html for the LSB Spec as it relates to init scripts. ] [WARNING] ==== Many distributions or particular software packages claim LSB compliance but ship with broken init scripts. For details on how to check whether your init script is LSB-compatible, see the 'Resource Agents' chapter of 'Pacemaker Administration'. Common problematic violations of the LSB standard include: * Not implementing the +status+ operation at all * Not observing the correct exit status codes for +start+/+stop+/+status+ actions * Starting a started resource returns an error * Stopping a stopped resource returns an error ==== [IMPORTANT] ==== Remember to make sure the computer is _not_ configured to start any services at boot time -- that should be controlled by the cluster. ==== [[s-resource-supported-systemd]] === Systemd === indexterm:[Resource,Systemd] indexterm:[Systemd,Resources] Some newer distributions have replaced the old http://en.wikipedia.org/wiki/Init#SysV-style["SysV"] style of initialization daemons and scripts with an alternative called http://www.freedesktop.org/wiki/Software/systemd[Systemd]. Pacemaker is able to manage these services _if they are present_. Instead of init scripts, systemd has 'unit files'. Generally, the services (unit files) are provided by the OS distribution, but there are online guides for converting from init scripts. footnote:[For example, http://0pointer.de/blog/projects/systemd-for-admins-3.html] [IMPORTANT] ==== Remember to make sure the computer is _not_ configured to start any services at boot time -- that should be controlled by the cluster. ==== === Upstart === indexterm:[Resource,Upstart] indexterm:[Upstart,Resources] Some newer distributions have replaced the old http://en.wikipedia.org/wiki/Init#SysV-style["SysV"] style of initialization daemons (and scripts) with an alternative called http://upstart.ubuntu.com/[Upstart]. Pacemaker is able to manage these services _if they are present_. Instead of init scripts, upstart has 'jobs'. Generally, the services (jobs) are provided by the OS distribution. [IMPORTANT] ==== Remember to make sure the computer is _not_ configured to start any services at boot time -- that should be controlled by the cluster. ==== === System Services === indexterm:[Resource,System Services] indexterm:[System Service,Resources] Since there are various types of system services (+systemd+, +upstart+, and +lsb+), Pacemaker supports a special +service+ alias which intelligently figures out which one applies to a given cluster node. This is particularly useful when the cluster contains a mix of +systemd+, +upstart+, and +lsb+. In order, Pacemaker will try to find the named service as: . an LSB init script . a Systemd unit file . an Upstart job === STONITH === indexterm:[Resource,STONITH] indexterm:[STONITH,Resources] The STONITH class is used exclusively for fencing-related resources. This is discussed later in <>. === Nagios Plugins === indexterm:[Resource,Nagios Plugins] indexterm:[Nagios Plugins,Resources] Nagios Plugins footnote:[The project has two independent forks, hosted at https://www.nagios-plugins.org/ and https://www.monitoring-plugins.org/. Output from both projects' plugins is similar, so plugins from either project can be used with pacemaker.] allow us to monitor services on remote hosts. Pacemaker is able to do remote monitoring with the plugins _if they are present_. A common use case is to configure them as resources belonging to a resource container (usually a virtual machine), and the container will be restarted if any of them has failed. Another use is to configure them as ordinary resources to be used for monitoring hosts or services via the network. The supported parameters are same as the long options of the plugin. [[primitive-resource]] == Resource Properties == These values tell the cluster which resource agent to use for the resource, where to find that resource agent and what standards it conforms to. .Properties of a Primitive Resource [width="95%",cols="1m,<6",options="header",align="center"] |========================================================= |Field |Description |id |Your name for the resource indexterm:[id,Resource] indexterm:[Resource,Property,id] |class |The standard the resource agent conforms to. Allowed values: +lsb+, +nagios+, +ocf+, +service+, +stonith+, +systemd+, +upstart+ indexterm:[class,Resource] indexterm:[Resource,Property,class] |type |The name of the Resource Agent you wish to use. E.g. +IPaddr+ or +Filesystem+ indexterm:[type,Resource] indexterm:[Resource,Property,type] |provider |The OCF spec allows multiple vendors to supply the same resource agent. To use the OCF resource agents supplied by the Heartbeat project, you would specify +heartbeat+ here. indexterm:[provider,Resource] indexterm:[Resource,Property,provider] |========================================================= The XML definition of a resource can be queried with the `crm_resource` tool. For example: ---- # crm_resource --resource Email --query-xml ---- might produce: .A system resource definition ===== [source,XML] ===== [NOTE] ===== One of the main drawbacks to system services (LSB, systemd or Upstart) resources is that they do not allow any parameters! ===== //// See https://tools.ietf.org/html/rfc5737 for choice of example IP address //// .An OCF resource definition ===== [source,XML] ------- ------- ===== .. _resource_options: Resource Options ################ .. Convert_to_RST_2: Resources have two types of options: 'meta-attributes' and 'instance attributes'. Meta-attributes apply to any type of resource, while instance attributes are specific to each resource agent. === Resource Meta-Attributes === Meta-attributes are used by the cluster to decide how a resource should behave and can be easily set using the `--meta` option of the `crm_resource` command. .Meta-attributes of a Primitive Resource [width="95%",cols="2m,2,<5",options="header",align="center"] |========================================================= |Field |Default |Description |priority |0 |If not all resources can be active, the cluster will stop lower priority resources in order to keep higher priority ones active. indexterm:[priority,Resource Option] indexterm:[Resource,Option,priority] |target-role |Started a|What state should the cluster attempt to keep this resource in? Allowed values: * +Stopped:+ Force the resource to be stopped * +Started:+ Allow the resource to be started (and in the case of <>, promoted to master if appropriate) * +Slave:+ Allow the resource to be started, but only in Slave mode if the resource is <> * +Master:+ Equivalent to +Started+ indexterm:[target-role,Resource Option] indexterm:[Resource,Option,target-role] |is-managed |TRUE |Is the cluster allowed to start and stop the resource? Allowed values: +true+, +false+ indexterm:[is-managed,Resource Option] indexterm:[Resource,Option,is-managed] |maintenance |FALSE |Similar to the +maintenance-mode+ <>, but for a single resource. If true, the resource will not be started, stopped, or monitored on any node. This differs from +is-managed+ in that monitors will not be run. Allowed values: +true+, +false+ indexterm:[maintenance,Resource Option] indexterm:[Resource,Option,maintenance] .. _resource-stickiness: placeholder .. Convert_to_RST_3: |resource-stickiness |1 for individual clone instances, 0 for all other resources |A score that will be added to the current node when a resource is already active. This allows running resources to stay where they are, even if they would be placed elsewhere if they were being started from a stopped state. indexterm:[resource-stickiness,Resource Option] indexterm:[Resource,Option,resource-stickiness] - + + +.. _requires: + + placeholder + +.. Convert_to_RST_4: + |requires |+quorum+ for resources with a +class+ of +stonith+, otherwise +unfencing+ if unfencing is active in the cluster, otherwise +fencing+ if +stonith-enabled+ is true, otherwise +quorum+ a|Conditions under which the resource can be started Allowed values: * +nothing:+ can always be started * +quorum:+ The cluster can only start this resource if a majority of the configured nodes are active * +fencing:+ The cluster can only start this resource if a majority of the configured nodes are active _and_ any failed or unknown nodes have been <> * +unfencing:+ The cluster can only start this resource if a majority of the configured nodes are active _and_ any failed or unknown nodes have been fenced _and_ only on nodes that have been <> indexterm:[requires,Resource Option] indexterm:[Resource,Option,requires] |migration-threshold |INFINITY |How many failures may occur for this resource on a node, before this node is marked ineligible to host this resource. A value of 0 indicates that this feature is disabled (the node will never be marked ineligible); by constrast, the cluster treats INFINITY (the default) as a very large but finite number. This option has an effect only if the failed operation specifies +on-fail+ as +restart+ (the default), and additionally for failed +start+ operations, if the cluster property +start-failure-is-fatal+ is +false+. indexterm:[migration-threshold,Resource Option] indexterm:[Resource,Option,migration-threshold] |failure-timeout |0 |How many seconds to wait before acting as if the failure had not occurred, and potentially allowing the resource back to the node on which it failed. A value of 0 indicates that this feature is disabled. indexterm:[failure-timeout,Resource Option] indexterm:[Resource,Option,failure-timeout] |multiple-active |stop_start a|What should the cluster do if it ever finds the resource active on more than one node? Allowed values: * +block:+ mark the resource as unmanaged * +stop_only:+ stop all active instances and leave them that way * +stop_start:+ stop all active instances and start the resource in one location only indexterm:[multiple-active,Resource Option] indexterm:[Resource,Option,multiple-active] |allow-migrate |TRUE for ocf:pacemaker:remote resources, FALSE otherwise |Whether the cluster should try to "live migrate" this resource when it needs to be moved (see <>) |container-attribute-target | |Specific to bundle resources; see <> |remote-node | |The name of the Pacemaker Remote guest node this resource is associated with, if any. If specified, this both enables the resource as a guest node and defines the unique name used to identify the guest node. The guest must be configured to run the Pacemaker Remote daemon when it is started. +WARNING:+ This value cannot overlap with any resource or node IDs. |remote-port |3121 |If +remote-node+ is specified, the port on the guest used for its Pacemaker Remote connection. The Pacemaker Remote daemon on the guest must be configured to listen on this port. |remote-addr |value of +remote-node+ |If +remote-node+ is specified, the IP address or hostname used to connect to the guest via Pacemaker Remote. The Pacemaker Remote daemon on the guest must be configured to accept connections on this address. |remote-connect-timeout |60s |If +remote-node+ is specified, how long before a pending guest connection will time out. |========================================================= As an example of setting resource options, if you performed the following commands on an LSB Email resource: ------- # crm_resource --meta --resource Email --set-parameter priority --parameter-value 100 # crm_resource -m -r Email -p multiple-active -v block ------- the resulting resource definition might be: .An LSB resource with cluster options ===== [source,XML] ------- ------- ===== In addition to the cluster-defined meta-attributes described above, you may also configure arbitrary meta-attributes of your own choosing. Most commonly, this would be done for use in <>. For example, an IT department might define a custom meta-attribute to indicate which company department each resource is intended for. To reduce the chance of name collisions with cluster-defined meta-attributes added in the future, it is recommended to use a unique, organization-specific prefix for such attributes. [[s-resource-defaults]] === Setting Global Defaults for Resource Meta-Attributes === To set a default value for a resource option, add it to the +rsc_defaults+ section with `crm_attribute`. For example, ---- # crm_attribute --type rsc_defaults --name is-managed --update false ---- would prevent the cluster from starting or stopping any of the resources in the configuration (unless of course the individual resources were specifically enabled by having their +is-managed+ set to +true+). === Resource Instance Attributes === The resource agents of some resource classes (lsb, systemd and upstart 'not' among them) can be given parameters which determine how they behave and which instance of a service they control. If your resource agent supports parameters, you can add them with the `crm_resource` command. For example, ---- # crm_resource --resource Public-IP --set-parameter ip --parameter-value 192.0.2.2 ---- would create an entry in the resource like this: .An example OCF resource with instance attributes ===== [source,XML] ------- ------- ===== For an OCF resource, the result would be an environment variable called +OCF_RESKEY_ip+ with a value of +192.0.2.2+. The list of instance attributes supported by an OCF resource agent can be found by calling the resource agent with the `meta-data` command. The output contains an XML description of all the supported attributes, their purpose and default values. .Displaying the metadata for the Dummy resource agent template ===== ---- # export OCF_ROOT=/usr/lib/ocf # $OCF_ROOT/resource.d/pacemaker/Dummy meta-data ---- [source,XML] ------- 1.0 This is a Dummy Resource Agent. It does absolutely nothing except keep track of whether its running or not. Its purpose in life is for testing and to serve as a template for RA writers. NB: Please pay attention to the timeouts specified in the actions section below. They should be meaningful for the kind of resource the agent manages. They should be the minimum advised timeouts, but they shouldn't/cannot cover _all_ possible resource instances. So, try to be neither overly generous nor too stingy, but moderate. The minimum timeouts should never be below 10 seconds. Example stateless resource agent Location to store the resource state in. State file Fake attribute that can be changed to cause a reload Fake attribute that can be changed to cause a reload Number of seconds to sleep during operations. This can be used to test how the cluster reacts to operation timeouts. Operation sleep duration in seconds. ------- ===== - - == Resource Operations == + + +.. _operation: + +Resource Operations +################### + + +.. Convert_to_RST_5: indexterm:[Resource,Action] 'Operations' are actions the cluster can perform on a resource by calling the resource agent. Resource agents must support certain common operations such as start, stop, and monitor, and may implement any others. Operations may be explicitly configured for two purposes: to override defaults for options (such as timeout) that the cluster will use whenever it initiates the operation, and to run an operation on a recurring basis (for example, to monitor the resource for failure). .An OCF resource with a non-default start timeout ===== [source,XML] ------- ------- ===== Pacemaker identifies operations by a combination of name and interval, so this combination must be unique for each resource. That is, you should not configure two operations for the same resource with the same name and interval. .. _operation_properties: Operation Properties ____________________ -.. Convert_to_RST_4: +.. Convert_to_RST_6: Operation properties may be specified directly in the +op+ element as XML attributes, or in a separate +meta_attributes+ block as +nvpair+ elements. XML attributes take precedence over +nvpair+ elements if both are specified. .Properties of an Operation [width="95%",cols="2m,3,<6",options="header",align="center"] |========================================================= |Field |Default |Description |id | |A unique name for the operation. indexterm:[id,Action Property] indexterm:[Action,Property,id] |name | |The action to perform. This can be any action supported by the agent; common values include +monitor+, +start+, and +stop+. indexterm:[name,Action Property] indexterm:[Action,Property,name] |interval |0 |How frequently (in seconds) to perform the operation. A value of 0 means "when needed". A positive value defines a 'recurring action', which is typically used with <>. indexterm:[interval,Action Property] indexterm:[Action,Property,interval] |timeout | |How long to wait before declaring the action has failed indexterm:[timeout,Action Property] indexterm:[Action,Property,timeout] |on-fail a|Varies by action: * +stop+: +fence+ if +stonith-enabled+ is true or +block+ otherwise * +demote+: +on-fail+ of the +monitor+ action with +role+ set to +Master+, if present, enabled, and configured to a value other than +demote+, or +restart+ otherwise * all other actions: +restart+ a|The action to take if this action ever fails. Allowed values: * +ignore:+ Pretend the resource did not fail. * +block:+ Don't perform any further operations on the resource. * +stop:+ Stop the resource and do not start it elsewhere. * +demote:+ Demote the resource, without a full restart. This is valid only for +promote+ actions, and for +monitor+ actions with both a nonzero +interval+ and +role+ set to +Master+; for any other action, a configuration error will be logged, and the default behavior will be used. * +restart:+ Stop the resource and start it again (possibly on a different node). * +fence:+ STONITH the node on which the resource failed. * +standby:+ Move _all_ resources away from the node on which the resource failed. indexterm:[on-fail,Action Property] indexterm:[Action,Property,on-fail] |enabled |TRUE |If +false+, ignore this operation definition. This is typically used to pause a particular recurring +monitor+ operation; for instance, it can complement the respective resource being unmanaged (+is-managed=false+), as this alone will <>. Disabling the operation does not suppress all actions of the given type. Allowed values: +true+, +false+. indexterm:[enabled,Action Property] indexterm:[Action,Property,enabled] |record-pending |TRUE |If +true+, the intention to perform the operation is recorded so that GUIs and CLI tools can indicate that an operation is in progress. This is best set as an _operation default_ (see <>). Allowed values: +true+, +false+. indexterm:[enabled,Action Property] indexterm:[Action,Property,enabled] |role | |Run the operation only on node(s) that the cluster thinks should be in the specified role. This only makes sense for recurring +monitor+ operations. Allowed (case-sensitive) values: +Stopped+, +Started+, and in the case of <>, +Slave+ and +Master+. indexterm:[role,Action Property] indexterm:[Action,Property,role] |========================================================= [NOTE] ==== When +on-fail+ is set to +demote+, recovery from failure by a successful demote causes the cluster to recalculate whether and where a new instance should be promoted. The node with the failure is eligible, so if master scores have not changed, it will be promoted again. There is no direct equivalent of +migration-threshold+ for the master role, but the same effect can be achieved with a location constraint using a <> with a node attribute expression for the resource's fail count. For example, to immediately ban the master role from a node with any failed promote or master monitor: [source,XML] ---- ---- This example assumes that there is a promotable clone of the +my_primitive+ resource (note that the primitive name, not the clone name, is used in the rule), and that there is a recurring 10-second-interval monitor configured for the master role (fail count attributes specify the interval in milliseconds). ==== [[s-resource-monitoring]] === Monitoring Resources for Failure === When Pacemaker first starts a resource, it runs one-time +monitor+ operations (referred to as 'probes') to ensure the resource is running where it's supposed to be, and not running where it's not supposed to be. (This behavior can be affected by the +resource-discovery+ location constraint property.) Other than those initial probes, Pacemaker will 'not' (by default) check that the resource continues to stay healthy. footnote:[Currently, anyway. Automatic monitoring operations may be added in a future version of Pacemaker.] You must configure +monitor+ operations explicitly to perform these checks. .An OCF resource with a recurring health check ===== [source,XML] ------- ------- ===== By default, a +monitor+ operation will ensure that the resource is running where it is supposed to. The +target-role+ property can be used for further checking. For example, if a resource has one +monitor+ operation with +interval=10 role=Started+ and a second +monitor+ operation with +interval=11 role=Stopped+, the cluster will run the first monitor on any nodes it thinks 'should' be running the resource, and the second monitor on any nodes that it thinks 'should not' be running the resource (for the truly paranoid, who want to know when an administrator manually starts a service by mistake). [NOTE] ==== Currently, monitors with +role=Stopped+ are not implemented for <> resources. ==== [[s-monitoring-unmanaged]] === Monitoring Resources When Administration is Disabled === Recurring +monitor+ operations behave differently under various administrative settings: * When a resource is unmanaged (by setting +is-managed=false+): No monitors will be stopped. + If the unmanaged resource is stopped on a node where the cluster thinks it should be running, the cluster will detect and report that it is not, but it will not consider the monitor failed, and will not try to start the resource until it is managed again. + Starting the unmanaged resource on a different node is strongly discouraged and will at least cause the cluster to consider the resource failed, and may require the resource's +target-role+ to be set to +Stopped+ then +Started+ to be recovered. * When a node is put into standby: All resources will be moved away from the node, and all +monitor+ operations will be stopped on the node, except those specifying +role+ as +Stopped+ (which will be newly initiated if appropriate). * When the cluster is put into maintenance mode: All resources will be marked as unmanaged. All monitor operations will be stopped, except those specifying +role+ as +Stopped+ (which will be newly initiated if appropriate). As with single unmanaged resources, starting a resource on a node other than where the cluster expects it to be will cause problems. [[s-operation-defaults]] === Setting Global Defaults for Operations === You can change the global default values for operation properties in a given cluster. These are defined in an +op_defaults+ section of the CIB's +configuration+ section, and can be set with `crm_attribute`. For example, ---- # crm_attribute --type op_defaults --name timeout --update 20s ---- would default each operation's +timeout+ to 20 seconds. If an operation's definition also includes a value for +timeout+, then that value would be used for that operation instead. === When Implicit Operations Take a Long Time === The cluster will always perform a number of implicit operations: +start+, +stop+ and a non-recurring +monitor+ operation used at startup to check whether the resource is already active. If one of these is taking too long, then you can create an entry for them and specify a longer timeout. .An OCF resource with custom timeouts for its implicit actions ===== [source,XML] ------- ------- ===== === Multiple Monitor Operations === Provided no two operations (for a single resource) have the same name and interval, you can have as many +monitor+ operations as you like. In this way, you can do a superficial health check every minute and progressively more intense ones at higher intervals. To tell the resource agent what kind of check to perform, you need to provide each monitor with a different value for a common parameter. The OCF standard creates a special parameter called +OCF_CHECK_LEVEL+ for this purpose and dictates that it is "made available to the resource agent without the normal +OCF_RESKEY+ prefix". Whatever name you choose, you can specify it by adding an +instance_attributes+ block to the +op+ tag. It is up to each resource agent to look for the parameter and decide how to use it. .An OCF resource with two recurring health checks, performing different levels of checks specified via +OCF_CHECK_LEVEL+. ===== [source,XML] ------- ------- ===== === Disabling a Monitor Operation === The easiest way to stop a recurring monitor is to just delete it. However, there can be times when you only want to disable it temporarily. In such cases, simply add +enabled=false+ to the operation's definition. .Example of an OCF resource with a disabled health check ===== [source,XML] ------- ------- ===== This can be achieved from the command line by executing: ---- # cibadmin --modify --xml-text '' ---- Once you've done whatever you needed to do, you can then re-enable it with ---- # cibadmin --modify --xml-text '' ---- diff --git a/doc/sphinx/Pacemaker_Explained/utilization.rst b/doc/sphinx/Pacemaker_Explained/utilization.rst index 4bcd777d62..3aa67adcac 100644 --- a/doc/sphinx/Pacemaker_Explained/utilization.rst +++ b/doc/sphinx/Pacemaker_Explained/utilization.rst @@ -1,232 +1,232 @@ +.. _utilization: + Utilization and Placement Strategy ---------------------------------- .. Convert_to_RST: - [[s-utilization]] - Pacemaker decides where to place a resource according to the resource allocation scores on every node. The resource will be allocated to the node where the resource has the highest score. If the resource allocation scores on all the nodes are equal, by the default placement strategy, Pacemaker will choose a node with the least number of allocated resources for balancing the load. If the number of resources on each node is equal, the first eligible node listed in the CIB will be chosen to run the resource. Often, in real-world situations, different resources use significantly different proportions of a node's capacities (memory, I/O, etc.). We cannot balance the load ideally just according to the number of resources allocated to a node. Besides, if resources are placed such that their combined requirements exceed the provided capacity, they may fail to start completely or run with degraded performance. To take these factors into account, Pacemaker allows you to configure: . The capacity a certain node provides. . The capacity a certain resource requires. . An overall strategy for placement of resources. == Utilization attributes == To configure the capacity that a node provides or a resource requires, you can use 'utilization attributes' in +node+ and +resource+ objects. You can name utilization attributes according to your preferences and define as many name/value pairs as your configuration needs. However, the attributes' values must be integers. .Specifying CPU and RAM capacities of two nodes ==== [source,XML] ---- ---- ==== .Specifying CPU and RAM consumed by several resources ==== [source,XML] ---- ---- ==== A node is considered eligible for a resource if it has sufficient free capacity to satisfy the resource's requirements. The nature of the required or provided capacities is completely irrelevant to Pacemaker -- it just makes sure that all capacity requirements of a resource are satisfied before placing a resource to a node. == Placement Strategy == After you have configured the capacities your nodes provide and the capacities your resources require, you need to set the +placement-strategy+ in the global cluster options, otherwise the capacity configurations have 'no effect'. Four values are available for the +placement-strategy+: +default+:: Utilization values are not taken into account at all. Resources are allocated according to allocation scores. If scores are equal, resources are evenly distributed across nodes. +utilization+:: Utilization values are taken into account 'only' when deciding whether a node is considered eligible (i.e. whether it has sufficient free capacity to satisfy the resource's requirements). Load-balancing is still done based on the number of resources allocated to a node. +balanced+:: Utilization values are taken into account when deciding whether a node is eligible to serve a resource 'and' when load-balancing, so an attempt is made to spread the resources in a way that optimizes resource performance. +minimal+:: Utilization values are taken into account 'only' when deciding whether a node is eligible to serve a resource. For load-balancing, an attempt is made to concentrate the resources on as few nodes as possible, thereby enabling possible power savings on the remaining nodes. Set +placement-strategy+ with `crm_attribute`: ---- # crm_attribute --name placement-strategy --update balanced ---- Now Pacemaker will ensure the load from your resources will be distributed evenly throughout the cluster, without the need for convoluted sets of colocation constraints. == Allocation Details == === Which node is preferred to get consumed first when allocating resources? === - The node with the highest node weight gets consumed first. Node weight is a score maintained by the cluster to represent node health. - If multiple nodes have the same node weight: * If +placement-strategy+ is +default+ or +utilization+, the node that has the least number of allocated resources gets consumed first. ** If their numbers of allocated resources are equal, the first eligible node listed in the CIB gets consumed first. * If +placement-strategy+ is +balanced+, the node that has the most free capacity gets consumed first. ** If the free capacities of the nodes are equal, the node that has the least number of allocated resources gets consumed first. *** If their numbers of allocated resources are equal, the first eligible node listed in the CIB gets consumed first. * If +placement-strategy+ is +minimal+, the first eligible node listed in the CIB gets consumed first. === Which node has more free capacity? === If only one type of utilization attribute has been defined, free capacity is a simple numeric comparison. If multiple types of utilization attributes have been defined, then the node that is numerically highest in the the most attribute types has the most free capacity. For example: - If +nodeA+ has more free +cpus+, and +nodeB+ has more free +memory+, then their free capacities are equal. - If +nodeA+ has more free +cpus+, while +nodeB+ has more free +memory+ and +storage+, then +nodeB+ has more free capacity. === Which resource is preferred to be assigned first? === - The resource that has the highest +priority+ (see <>) gets allocated first. - If their priorities are equal, check whether they are already running. The resource that has the highest score on the node where it's running gets allocated first, to prevent resource shuffling. - If the scores above are equal or the resources are not running, the resource has the highest score on the preferred node gets allocated first. - If the scores above are equal, the first runnable resource listed in the CIB gets allocated first. == Limitations and Workarounds == The type of problem Pacemaker is dealing with here is known as the http://en.wikipedia.org/wiki/Knapsack_problem[knapsack problem] and falls into the http://en.wikipedia.org/wiki/NP-complete[NP-complete] category of computer science problems -- a fancy way of saying "it takes a really long time to solve". Clearly in a HA cluster, it's not acceptable to spend minutes, let alone hours or days, finding an optimal solution while services remain unavailable. So instead of trying to solve the problem completely, Pacemaker uses a 'best effort' algorithm for determining which node should host a particular service. This means it arrives at a solution much faster than traditional linear programming algorithms, but by doing so at the price of leaving some services stopped. In the contrived example at the start of this chapter: - +rsc-small+ would be allocated to +node1+ - +rsc-medium+ would be allocated to +node2+ - +rsc-large+ would remain inactive Which is not ideal. There are various approaches to dealing with the limitations of pacemaker's placement strategy: Ensure you have sufficient physical capacity.:: It might sound obvious, but if the physical capacity of your nodes is (close to) maxed out by the cluster under normal conditions, then failover isn't going to go well. Even without the utilization feature, you'll start hitting timeouts and getting secondary failures. Build some buffer into the capabilities advertised by the nodes.:: Advertise slightly more resources than we physically have, on the (usually valid) assumption that a resource will not use 100% of the configured amount of CPU, memory and so forth 'all' the time. This practice is sometimes called 'overcommit'. Specify resource priorities.:: If the cluster is going to sacrifice services, it should be the ones you care about (comparatively) the least. Ensure that resource priorities are properly set so that your most important resources are scheduled first.