:compat-mode: legacy
= Advanced Resource Types =

[[group-resources]]
== Groups - A Syntactic Shortcut ==
indexterm:[Group Resources]
indexterm:[Resource,Groups]


One of the most common elements of a cluster is a set of resources
that need to be located together, start sequentially, and stop in the
reverse order.  To simplify this configuration, we support the concept
of groups.

.A group of two primitive resources
======
[source,XML]
-------
<group id="shortcut">
   <primitive id="Public-IP" class="ocf" type="IPaddr" provider="heartbeat">
    <instance_attributes id="params-public-ip">
       <nvpair id="public-ip-addr" name="ip" value="192.0.2.2"/>
    </instance_attributes>
   </primitive>
   <primitive id="Email" class="lsb" type="exim"/>
</group> 
-------
======


Although the example above contains only two resources, there is no
limit to the number of resources a group can contain.  The example is
also sufficient to explain the fundamental properties of a group:

* Resources are started in the order they appear in (+Public-IP+
  first, then +Email+)
* Resources are stopped in the reverse order to which they appear in
  (+Email+ first, then +Public-IP+)

If a resource in the group can't run anywhere, then nothing after that
is allowed to run, too.

* If +Public-IP+ can't run anywhere, neither can +Email+;
* but if +Email+ can't run anywhere, this does not affect +Public-IP+
  in any way

The group above is logically equivalent to writing:

.How the cluster sees a group resource
======
[source,XML]
-------
<configuration>
   <resources>
    <primitive id="Public-IP" class="ocf" type="IPaddr" provider="heartbeat">
     <instance_attributes id="params-public-ip">
        <nvpair id="public-ip-addr" name="ip" value="192.0.2.2"/>
     </instance_attributes>
    </primitive>
    <primitive id="Email" class="lsb" type="exim"/>
   </resources>
   <constraints>
      <rsc_colocation id="xxx" rsc="Email" with-rsc="Public-IP" score="INFINITY"/>
      <rsc_order id="yyy" first="Public-IP" then="Email"/>
   </constraints>
</configuration> 
-------
======

Obviously as the group grows bigger, the reduced configuration effort
can become significant.

Another (typical) example of a group is a DRBD volume, the filesystem
mount, an IP address, and an application that uses them.

=== Group Properties ===
.Properties of a Group Resource
[width="95%",cols="3m,<5",options="header",align="center"]
|=========================================================

|Field
|Description

|id
|A unique name for the group
 indexterm:[id,Group Resource Property]
 indexterm:[Resource,Group Property,id]

|=========================================================

=== Group Options ===

Groups inherit the +priority+, +target-role+, and +is-managed+ properties
from primitive resources. See <<s-resource-options>> for information about
those properties.

=== Group Instance Attributes ===

Groups have no instance attributes. However, any that are set for the group
object will be inherited by the group's children.

=== Group Contents ===

Groups may only contain a collection of cluster resources (see
<<primitive-resource>>).  To refer to a child of a group resource, just use
the child's +id+ instead of the group's.

=== Group Constraints ===

Although it is possible to reference a group's children in
constraints, it is usually preferable to reference the group itself.

.Some constraints involving groups
======
[source,XML]
-------
<constraints>
    <rsc_location id="group-prefers-node1" rsc="shortcut" node="node1" score="500"/>
    <rsc_colocation id="webserver-with-group" rsc="Webserver" with-rsc="shortcut"/>
    <rsc_order id="start-group-then-webserver" first="Webserver" then="shortcut"/>
</constraints> 
-------
======

=== Group Stickiness ===
indexterm:[resource-stickiness,Groups]

Stickiness, the measure of how much a resource wants to stay where it
is, is additive in groups.  Every active resource of the group will
contribute its stickiness value to the group's total.  So if the
default +resource-stickiness+ is 100, and a group has seven members,
five of which are active, then the group as a whole will prefer its
current location with a score of 500.

[[s-resource-clone]]
== Clones - Resources That Can Have Multiple Active Instances ==
indexterm:[Clone Resources]
indexterm:[Resource,Clones]

'Clone' resources are resources that can have more than one copy active at the
same time. This allows you, for example, to run a copy of a daemon on every
node. You can clone any primitive or group resource.
footnote:[
Of course, the service must support running multiple instances.
]

=== Anonymous versus Unique Clones ===

A clone resource is configured to be either 'anonymous' or 'globally unique'.

Anonymous clones are the simplest. These behave completely identically
everywhere they are running. Because of this, there can be only one instance of
an anonymous clone active per node.
      
The instances of globally unique clones are distinct entities. All instances
are launched identically, but one instance of the clone is not identical to any
other instance, whether running on the same node or a different node. As an
example, a cloned IP address can use special kernel functionality such that
each instance handles a subset of requests for the same IP address.

[[s-resource-promotable]]
=== Promotable clones ===

indexterm:[Promotable Clone Resources]
indexterm:[Resource,Promotable]

If a clone is 'promotable', its instances can perform a special role that
Pacemaker will manage via the +promote+ and +demote+ actions of the resource
agent.

Services that support such a special role have various terms for the special
role and the default role: primary and secondary, master and replica,
controller and worker, etc. Pacemaker uses the terms 'master' and 'slave',
footnote:[
These are historical terms that will eventually be replaced, but the extensive
use of them and the need for backward compatibility makes it a long process.
You may see examples using a +master+ tag instead of a +clone+ tag with the
+promotable+ meta-attribute set to +true+; the +master+ tag is supported, but
deprecated, and will be removed in a future version. You may also see such
services referred to as 'multi-state' or 'stateful'; these means the same thing
as 'promotable'.
]
but is agnostic to what the service calls them or what they do.

All that Pacemaker cares about is that an instance comes up in the default role
when started, and the resource agent supports the +promote+ and +demote+ actions
to manage entering and exiting the special role.

=== Clone Properties ===

.Properties of a Clone Resource
[width="95%",cols="3m,<5",options="header",align="center"]
|=========================================================

|Field
|Description

|id
|A unique name for the clone
 indexterm:[id,Clone Property]
 indexterm:[Clone,Property,id]

|=========================================================

=== Clone Options ===

<<s-resource-options,Options>> inherited from primitive resources:
+priority, target-role, is-managed+

.Clone-specific configuration options
[width="95%",cols="1m,1,<3",options="header",align="center"]
|=========================================================

|Field
|Default
|Description

|globally-unique
|false
|If +true+, each clone instance performs a distinct function
 indexterm:[globally-unique,Clone Option]
 indexterm:[Clone,Option,globally-unique]
  
|clone-max
|number of nodes in cluster
|The maximum number of clone instances that can be started across the entire
 cluster
 indexterm:[clone-max,Clone Option]
 indexterm:[Clone,Option,clone-max]

|clone-node-max
|1
|If +globally-unique+ is +true+, the maximum number of clone instances that can
 be started on a single node
 indexterm:[clone-node-max,Clone Option]
 indexterm:[Clone,Option,clone-node-max]
  
|clone-min
|0
|Require at least this number of clone instances to be runnable before allowing
 resources depending on the clone to be runnable. A value of 0 means require
 all clone instances to be runnable.
 indexterm:[clone-min,Clone Option]
 indexterm:[Clone,Option,clone-min]

|notify
|false
|Call the resource agent's +notify+ action for all active instances, before and
 after starting or stopping any clone instance. The resource agent must support
 this action. Allowed values: +false+, +true+
 indexterm:[notify,Clone Option]
 indexterm:[Clone,Option,notify]

|ordered
|false
|If +true+, clone instances must be started sequentially instead of in parallel
 Allowed values: +false+, +true+
 indexterm:[ordered,Clone Option]
 indexterm:[Clone,Option,ordered]

|interleave
|false
|When this clone is ordered relative to another clone, if this option is
 +false+ (the default), the ordering is relative to 'all' instances of the
 other clone, whereas if this option is +true+, the ordering is relative only
 to instances on the same node.
 Allowed values: +false+, +true+
 indexterm:[interleave,Clone Option]
 indexterm:[Clone,Option,interleave]

|promotable
|false
|If +true+, clone instances can perform a special role that Pacemaker will
 manage via the resource agent's +promote+ and +demote+ actions. The resource
 agent must support these actions.
 Allowed values: +false+, +true+
 indexterm:[promotable,Clone Option]
 indexterm:[Clone,Option,promotable]

|promoted-max
|1
|If +promotable+ is +true+, the number of instances that can be promoted at one
 time across the entire cluster
 indexterm:[promoted-max,Clone Option]
 indexterm:[Clone,Option,promoted-max]

|promoted-node-max
|1
|If +promotable+ is +true+ and +globally-unique+ is +false+, the number of
 clone instances can be promoted at one time on a single node
 indexterm:[promoted-node-max,Clone Option]
 indexterm:[Clone,Option,promoted-node-max]

|=========================================================

For backward compatibility, +master-max+ and +master-node-max+ are accepted as
aliases for +promoted-max+ and +promoted-node-max+, but are deprecated since
2.0.0, and support for them will be removed in a future version.

=== Clone Contents ===

Clones must contain exactly one primitive or group resource.

.A clone that runs a web server on all nodes
====
[source,XML]
----
<clone id="apache-clone">
    <primitive id="apache" class="lsb" type="apache">
        <operations>
           <op id="apache-monitor" name="monitor" interval="30"/>
        </operations>
    </primitive>
</clone> 
----
====

[WARNING]
You should never reference the name of a clone's child (the primitive or group
resource being cloned). If you think you need to do this, you probably need to
re-evaluate your design.

=== Clone Instance Attributes ===

Clones have no instance attributes; however, any that are set here will be
inherited by the clone's child.

=== Clone Constraints ===

In most cases, a clone will have a single instance on each active cluster
node.  If this is not the case, you can indicate which nodes the
cluster should preferentially assign copies to with resource location
constraints.  These constraints are written no differently from those
for primitive resources except that the clone's +id+ is used.

.Some constraints involving clones
======
[source,XML]
-------
<constraints>
    <rsc_location id="clone-prefers-node1" rsc="apache-clone" node="node1" score="500"/>
    <rsc_colocation id="stats-with-clone" rsc="apache-stats" with="apache-clone"/>
    <rsc_order id="start-clone-then-stats" first="apache-clone" then="apache-stats"/>
</constraints> 
-------
======

Ordering constraints behave slightly differently for clones.  In the
example above, +apache-stats+ will wait until all copies of +apache-clone+
that need to be started have done so before being started itself.
Only if _no_ copies can be started will +apache-stats+ be prevented
from being active.  Additionally, the clone will wait for
+apache-stats+ to be stopped before stopping itself.

Colocation of a primitive or group resource with a clone means that
the resource can run on any node with an active instance of the clone.
The cluster will choose an instance based on where the clone is running and
the resource's own location preferences.

Colocation between clones is also possible.  If one clone +A+ is colocated
with another clone +B+, the set of allowed locations for +A+ is limited to
nodes on which +B+ is (or will be) active.  Placement is then performed
normally.

==== Promotable Clone Constraints ====

For promotable clone resources, the +first-action+ and/or +then-action+ fields
for ordering constraints may be set to +promote+ or +demote+ to constrain the
master role, and colocation constraints may contain +rsc-role+ and/or
+with-rsc-role+ fields.
          
.Additional colocation constraint options for promotable clone resources
[width="95%",cols="1m,1,<3",options="header",align="center"]
|=========================================================

|Field
|Default
|Description

|rsc-role
|Started
|An additional attribute of colocation constraints that specifies the
 role that +rsc+ must be in.  Allowed values: +Started+, +Master+,
 +Slave+.
 indexterm:[rsc-role,Ordering Constraints]
 indexterm:[Constraints,Ordering,rsc-role]

|with-rsc-role
|Started
|An additional attribute of colocation constraints that specifies the
 role that +with-rsc+ must be in.  Allowed values: +Started+,
 +Master+, +Slave+.
 indexterm:[with-rsc-role,Ordering Constraints]
 indexterm:[Constraints,Ordering,with-rsc-role]

|=========================================================

.Constraints involving promotable clone resources       
======
[source,XML]
-------
<constraints>
   <rsc_location id="db-prefers-node1" rsc="database" node="node1" score="500"/>
   <rsc_colocation id="backup-with-db-slave" rsc="backup"
     with-rsc="database" with-rsc-role="Slave"/>
   <rsc_colocation id="myapp-with-db-master" rsc="myApp"
     with-rsc="database" with-rsc-role="Master"/>
   <rsc_order id="start-db-before-backup" first="database" then="backup"/>
   <rsc_order id="promote-db-then-app" first="database" first-action="promote"
     then="myApp" then-action="start"/>
</constraints> 
-------
======

In the example above, +myApp+ will wait until one of the database
copies has been started and promoted to master before being started
itself on the same node.  Only if no copies can be promoted will +myApp+ be
prevented from being active.  Additionally, the cluster will wait for
+myApp+ to be stopped before demoting the database.

Colocation of a primitive or group resource with a promotable clone
resource means that it can run on any node with an active instance of
the promotable clone resource that has the specified role (+master+ or
+slave+).  In the example above, the cluster will choose a location based on
where database is running as a +master+, and if there are multiple
+master+ instances it will also factor in +myApp+'s own location
preferences when deciding which location to choose.

Colocation with regular clones and other promotable clone resources is also
possible.  In such cases, the set of allowed locations for the +rsc+
clone is (after role filtering) limited to nodes on which the
+with-rsc+ promotable clone resource is (or will be) in the specified role.
Placement is then performed as normal.

==== Using Promotable Clone Resources in Colocation Sets ====

.Additional colocation set options relevant to promotable clone resources
[width="95%",cols="1m,1,<6",options="header",align="center"]
|=========================================================

|Field
|Default
|Description

|role
|Started
|The role that 'all members' of the set must be in.  Allowed values: +Started+, +Master+,
 +Slave+.
 indexterm:[role,Ordering Constraints]
 indexterm:[Constraints,Ordering,role]

|=========================================================

In the following example +B+'s master must be located on the same node as +A+'s master.
Additionally resources +C+ and +D+ must be located on the same node as +A+'s
and +B+'s masters.

.Colocate C and D with A's and B's master instances
======
[source,XML]
-------
<constraints>
    <rsc_colocation id="coloc-1" score="INFINITY" >
      <resource_set id="colocated-set-example-1" sequential="true" role="Master">
        <resource_ref id="A"/>
        <resource_ref id="B"/>
      </resource_set>
      <resource_set id="colocated-set-example-2" sequential="true">
        <resource_ref id="C"/>
        <resource_ref id="D"/>
      </resource_set>
    </rsc_colocation>
</constraints>
-------
======

==== Using Promotable Clone Resources in Ordered Sets ====

.Additional ordered set options relevant to promotable clone resources
[width="95%",cols="1m,1,<3",options="header",align="center"]
|=========================================================

|Field
|Default
|Description

|action
|value of +first-action+
|An additional attribute of ordering constraint sets that specifies the
 action that applies to 'all members' of the set.  Allowed
 values: +start+, +stop+, +promote+, +demote+.
 indexterm:[action,Ordering Constraints]
 indexterm:[Constraints,Ordering,action]

|=========================================================

.Start C and D after first promoting A and B
======
[source,XML]
-------
<constraints>
    <rsc_order id="order-1" score="INFINITY" >
      <resource_set id="ordered-set-1" sequential="true" action="promote">
        <resource_ref id="A"/>
        <resource_ref id="B"/>
      </resource_set>
      <resource_set id="ordered-set-2" sequential="true" action="start">
        <resource_ref id="C"/>
        <resource_ref id="D"/>
      </resource_set>
    </rsc_order>
</constraints>
-------
======

In the above example, +B+ cannot be promoted to a master role until +A+ has
been promoted. Additionally, resources +C+ and +D+ must wait until +A+ and +B+
have been promoted before they can start.


[[s-clone-stickiness]]
=== Clone Stickiness ===

indexterm:[resource-stickiness,Clones]

To achieve a stable allocation pattern, clones are slightly sticky by
default.  If no value for +resource-stickiness+ is provided, the clone
will use a value of 1.  Being a small value, it causes minimal
disturbance to the score calculations of other resources but is enough
to prevent Pacemaker from needlessly moving copies around the cluster.

[NOTE]
====
For globally unique clones, this may result in multiple instances of the
clone staying on a single node, even after another eligible node becomes
active (for example, after being put into standby mode then made active again).
If you do not want this behavior, specify a +resource-stickiness+ of 0
for the clone temporarily and let the cluster adjust, then set it back
to 1 if you want the default behavior to apply again.
====

[IMPORTANT]
====
If +resource-stickiness+ is set in the +rsc_defaults+ section, it will
apply to clone instances as well. This means an explicit +resource-stickiness+
of 0 in +rsc_defaults+ works differently from the implicit default used when
+resource-stickiness+ is not specified.
====

=== Clone Resource Agent Requirements ===

Any resource can be used as an anonymous clone, as it requires no
additional support from the resource agent.  Whether it makes sense to
do so depends on your resource and its resource agent.

==== Resource Agent Requirements for Globally Unique Clones ====

Globally unique clones require additional support in the resource agent. In
particular, it must only respond with +$\{OCF_SUCCESS}+ if the node has that
exact instance active. All other probes for instances of the clone should
result in +$\{OCF_NOT_RUNNING}+ (or one of the other OCF error codes if
they are failed).

Individual instances of a clone are identified by appending a colon and a
numerical offset, e.g. +apache:2+.

Resource agents can find out how many copies there are by examining
the +OCF_RESKEY_CRM_meta_clone_max+ environment variable and which
instance it is by examining +OCF_RESKEY_CRM_meta_clone+.

The resource agent must not make any assumptions (based on
+OCF_RESKEY_CRM_meta_clone+) about which numerical instances are active.  In
particular, the list of active copies will not always be an unbroken
sequence, nor always start at 0.

==== Resource Agent Requirements for Promotable Clones ====

Promotable clone resources require two extra actions, +demote+ and +promote+,
which are responsible for changing the state of the resource. Like +start+ and
+stop+, they should return +$\{OCF_SUCCESS}+ if they completed successfully or
a relevant error code if they did not.

The states can mean whatever you wish, but when the resource is
started, it must come up in the mode called +slave+.  From there the
cluster will decide which instances to promote to +master+.

In addition to the clone requirements for monitor actions, agents must
also _accurately_ report which state they are in.  The cluster relies
on the agent to report its status (including role) accurately and does
not indicate to the agent what role it currently believes it to be in.

.Role implications of OCF return codes
[width="95%",cols="1,<1",options="header",align="center"]
|=========================================================

|Monitor Return Code
|Description

|OCF_NOT_RUNNING
|Stopped
 indexterm:[Return Code,OCF_NOT_RUNNING]
 
|OCF_SUCCESS
|Running (Slave)
 indexterm:[Return Code,OCF_SUCCESS]
 
|OCF_RUNNING_MASTER
|Running (Master)
 indexterm:[Return Code,OCF_RUNNING_MASTER]

|OCF_FAILED_MASTER
|Failed (Master)
 indexterm:[Return Code,OCF_FAILED_MASTER]
 
|Other
|Failed (Slave)

|=========================================================

==== Clone Notifications ====

If the clone has the +notify+ meta-attribute set to +true+, and the resource
agent supports the +notify+ action, Pacemaker will call the action when
appropriate, passing a number of extra variables which, when combined with
additional context, can be used to calculate the current state of the cluster
and what is about to happen to it.

.Environment variables supplied with Clone notify actions
[width="95%",cols="5,<3",options="header",align="center"]
|=========================================================

|Variable
|Description

|OCF_RESKEY_CRM_meta_notify_type
|Allowed values: +pre+, +post+
 indexterm:[Environment Variable,OCF_RESKEY_CRM_meta_notify_,type]
 indexterm:[type,Notification Environment Variable]

|OCF_RESKEY_CRM_meta_notify_operation
|Allowed values: +start+, +stop+
 indexterm:[Environment Variable,OCF_RESKEY_CRM_meta_notify_,operation]
 indexterm:[operation,Notification Environment Variable]

|OCF_RESKEY_CRM_meta_notify_start_resource
|Resources to be started
 indexterm:[Environment Variable,OCF_RESKEY_CRM_meta_notify_,start_resource]
 indexterm:[start_resource,Notification Environment Variable]

|OCF_RESKEY_CRM_meta_notify_stop_resource
|Resources to be stopped
 indexterm:[Environment Variable,OCF_RESKEY_CRM_meta_notify_,stop_resource]
 indexterm:[stop_resource,Notification Environment Variable]

|OCF_RESKEY_CRM_meta_notify_active_resource
|Resources that are running
 indexterm:[Environment Variable,OCF_RESKEY_CRM_meta_notify_,active_resource]
 indexterm:[active_resource,Notification Environment Variable]

|OCF_RESKEY_CRM_meta_notify_inactive_resource
|Resources that are not running
 indexterm:[Environment Variable,OCF_RESKEY_CRM_meta_notify_,inactive_resource]
 indexterm:[inactive_resource,Notification Environment Variable]

|OCF_RESKEY_CRM_meta_notify_start_uname
|Nodes on which resources will be started
 indexterm:[Environment Variable,OCF_RESKEY_CRM_meta_notify_,start_uname]
 indexterm:[start_uname,Notification Environment Variable]

|OCF_RESKEY_CRM_meta_notify_stop_uname
|Nodes on which resources will be stopped
 indexterm:[Environment Variable,OCF_RESKEY_CRM_meta_notify_,stop_uname]
 indexterm:[stop_uname,Notification Environment Variable]

|OCF_RESKEY_CRM_meta_notify_active_uname
|Nodes on which resources are running
 indexterm:[Environment Variable,OCF_RESKEY_CRM_meta_notify_,active_uname]
 indexterm:[active_uname,Notification Environment Variable]

|=========================================================

The variables come in pairs, such as
+OCF_RESKEY_CRM_meta_notify_start_resource+ and
+OCF_RESKEY_CRM_meta_notify_start_uname+, and should be treated as an
array of whitespace-separated elements.

+OCF_RESKEY_CRM_meta_notify_inactive_resource+ is an exception, as the
matching +uname+ variable does not exist since inactive resources
are not running on any node.

Thus, in order to indicate that +clone:0+ will be started on +sles-1+,
+clone:2+ will be started on +sles-3+, and +clone:3+ will be started
on +sles-2+, the cluster would set:

.Notification variables
======
[source,Bash]
-------
OCF_RESKEY_CRM_meta_notify_start_resource="clone:0 clone:2 clone:3"
OCF_RESKEY_CRM_meta_notify_start_uname="sles-1 sles-3 sles-2"
-------
======

[NOTE]
====
Pacemaker will log but otherwise ignore failures of notify actions.
====

==== Interpretation of Notification Variables ====

.Pre-notification (stop):

* Active resources: +$OCF_RESKEY_CRM_meta_notify_active_resource+
* Inactive resources: +$OCF_RESKEY_CRM_meta_notify_inactive_resource+
* Resources to be started: +$OCF_RESKEY_CRM_meta_notify_start_resource+
* Resources to be stopped: +$OCF_RESKEY_CRM_meta_notify_stop_resource+


.Post-notification (stop) / Pre-notification (start):

* Active resources
** +$OCF_RESKEY_CRM_meta_notify_active_resource+
** minus +$OCF_RESKEY_CRM_meta_notify_stop_resource+
* Inactive resources
** +$OCF_RESKEY_CRM_meta_notify_inactive_resource+
** plus +$OCF_RESKEY_CRM_meta_notify_stop_resource+ 
* Resources that were started: +$OCF_RESKEY_CRM_meta_notify_start_resource+
* Resources that were stopped: +$OCF_RESKEY_CRM_meta_notify_stop_resource+


.Post-notification (start):

* Active resources:
** +$OCF_RESKEY_CRM_meta_notify_active_resource+
** minus +$OCF_RESKEY_CRM_meta_notify_stop_resource+
** plus +$OCF_RESKEY_CRM_meta_notify_start_resource+
* Inactive resources:
** +$OCF_RESKEY_CRM_meta_notify_inactive_resource+
** plus +$OCF_RESKEY_CRM_meta_notify_stop_resource+
** minus +$OCF_RESKEY_CRM_meta_notify_start_resource+
* Resources that were started: +$OCF_RESKEY_CRM_meta_notify_start_resource+
* Resources that were stopped: +$OCF_RESKEY_CRM_meta_notify_stop_resource+

==== Extra Notifications for Promotable Clones ====

.Extra environment variables supplied for promotable clones
[width="95%",cols="5,<3",options="header",align="center"]
|=========================================================

|Variable
|Description

|OCF_RESKEY_CRM_meta_notify_master_resource
|Resources that are running in +Master+ mode
 indexterm:[Environment Variable,OCF_RESKEY_CRM_meta_notify_,master_resource]
 indexterm:[master_resource,Notification Environment Variable]

|OCF_RESKEY_CRM_meta_notify_slave_resource
|Resources that are running in +Slave+ mode
 indexterm:[Environment Variable,OCF_RESKEY_CRM_meta_notify_,slave_resource]
 indexterm:[slave_resource,Notification Environment Variable]
   
|OCF_RESKEY_CRM_meta_notify_promote_resource
|Resources to be promoted
 indexterm:[Environment Variable,OCF_RESKEY_CRM_meta_notify_,promote_resource]
 indexterm:[promote_resource,Notification Environment Variable]
   
|OCF_RESKEY_CRM_meta_notify_demote_resource
|Resources to be demoted
 indexterm:[Environment Variable,OCF_RESKEY_CRM_meta_notify_,demote_resource]
 indexterm:[demote_resource,Notification Environment Variable]

|OCF_RESKEY_CRM_meta_notify_promote_uname
|Nodes on which resources will be promoted
 indexterm:[Environment Variable,OCF_RESKEY_CRM_meta_notify_,promote_uname]
 indexterm:[promote_uname,Notification Environment Variable]

|OCF_RESKEY_CRM_meta_notify_demote_uname
|Nodes on which resources will be demoted
 indexterm:[Environment Variable,OCF_RESKEY_CRM_meta_notify_,demote_uname]
 indexterm:[demote_uname,Notification Environment Variable]

|OCF_RESKEY_CRM_meta_notify_master_uname
|Nodes on which resources are running in +Master+ mode
 indexterm:[Environment Variable,OCF_RESKEY_CRM_meta_notify_,master_uname]
 indexterm:[master_uname,Notification Environment Variable]

|OCF_RESKEY_CRM_meta_notify_slave_uname
|Nodes on which resources are running in +Slave+ mode
 indexterm:[Environment Variable,OCF_RESKEY_CRM_meta_notify_,slave_uname]
 indexterm:[slave_uname,Notification Environment Variable]

|=========================================================

==== Interpretation of Promotable Notification Variables ====

.Pre-notification (demote):

* +Active+ resources: +$OCF_RESKEY_CRM_meta_notify_active_resource+
* +Master+ resources: +$OCF_RESKEY_CRM_meta_notify_master_resource+
* +Slave+ resources: +$OCF_RESKEY_CRM_meta_notify_slave_resource+
* Inactive resources: +$OCF_RESKEY_CRM_meta_notify_inactive_resource+
* Resources to be started: +$OCF_RESKEY_CRM_meta_notify_start_resource+
* Resources to be promoted: +$OCF_RESKEY_CRM_meta_notify_promote_resource+
* Resources to be demoted: +$OCF_RESKEY_CRM_meta_notify_demote_resource+
* Resources to be stopped: +$OCF_RESKEY_CRM_meta_notify_stop_resource+


.Post-notification (demote) / Pre-notification (stop):

* +Active+ resources: +$OCF_RESKEY_CRM_meta_notify_active_resource+
* +Master+ resources:
** +$OCF_RESKEY_CRM_meta_notify_master_resource+
** minus +$OCF_RESKEY_CRM_meta_notify_demote_resource+ 
* +Slave+ resources: +$OCF_RESKEY_CRM_meta_notify_slave_resource+
* Inactive resources: +$OCF_RESKEY_CRM_meta_notify_inactive_resource+
* Resources to be started: +$OCF_RESKEY_CRM_meta_notify_start_resource+
* Resources to be promoted: +$OCF_RESKEY_CRM_meta_notify_promote_resource+
* Resources to be demoted: +$OCF_RESKEY_CRM_meta_notify_demote_resource+
* Resources to be stopped: +$OCF_RESKEY_CRM_meta_notify_stop_resource+
* Resources that were demoted: +$OCF_RESKEY_CRM_meta_notify_demote_resource+


.Post-notification (stop) / Pre-notification (start)

* +Active+ resources:
** +$OCF_RESKEY_CRM_meta_notify_active_resource+
** minus +$OCF_RESKEY_CRM_meta_notify_stop_resource+ 
* +Master+ resources:
** +$OCF_RESKEY_CRM_meta_notify_master_resource+
** minus +$OCF_RESKEY_CRM_meta_notify_demote_resource+ 
* +Slave+ resources:
** +$OCF_RESKEY_CRM_meta_notify_slave_resource+
** minus +$OCF_RESKEY_CRM_meta_notify_stop_resource+ 
* Inactive resources:
** +$OCF_RESKEY_CRM_meta_notify_inactive_resource+
** plus +$OCF_RESKEY_CRM_meta_notify_stop_resource+ 
* Resources to be started: +$OCF_RESKEY_CRM_meta_notify_start_resource+
* Resources to be promoted: +$OCF_RESKEY_CRM_meta_notify_promote_resource+
* Resources to be demoted: +$OCF_RESKEY_CRM_meta_notify_demote_resource+
* Resources to be stopped: +$OCF_RESKEY_CRM_meta_notify_stop_resource+
* Resources that were demoted: +$OCF_RESKEY_CRM_meta_notify_demote_resource+
* Resources that were stopped: +$OCF_RESKEY_CRM_meta_notify_stop_resource+


.Post-notification (start) / Pre-notification (promote)

* +Active+ resources:
** +$OCF_RESKEY_CRM_meta_notify_active_resource+
** minus +$OCF_RESKEY_CRM_meta_notify_stop_resource+
** plus +$OCF_RESKEY_CRM_meta_notify_start_resource+ 
* +Master+ resources:
** +$OCF_RESKEY_CRM_meta_notify_master_resource+
** minus +$OCF_RESKEY_CRM_meta_notify_demote_resource+ 
* +Slave+ resources:
** +$OCF_RESKEY_CRM_meta_notify_slave_resource+
** minus +$OCF_RESKEY_CRM_meta_notify_stop_resource+
** plus +$OCF_RESKEY_CRM_meta_notify_start_resource+ 
* Inactive resources:
** +$OCF_RESKEY_CRM_meta_notify_inactive_resource+
** plus +$OCF_RESKEY_CRM_meta_notify_stop_resource+
** minus +$OCF_RESKEY_CRM_meta_notify_start_resource+           
* Resources to be started: +$OCF_RESKEY_CRM_meta_notify_start_resource+
* Resources to be promoted: +$OCF_RESKEY_CRM_meta_notify_promote_resource+
* Resources to be demoted: +$OCF_RESKEY_CRM_meta_notify_demote_resource+
* Resources to be stopped: +$OCF_RESKEY_CRM_meta_notify_stop_resource+
* Resources that were started: +$OCF_RESKEY_CRM_meta_notify_start_resource+
* Resources that were demoted: +$OCF_RESKEY_CRM_meta_notify_demote_resource+
* Resources that were stopped: +$OCF_RESKEY_CRM_meta_notify_stop_resource+

.Post-notification (promote)

* +Active+ resources:
** +$OCF_RESKEY_CRM_meta_notify_active_resource+
** minus +$OCF_RESKEY_CRM_meta_notify_stop_resource+
** plus +$OCF_RESKEY_CRM_meta_notify_start_resource+ 
* +Master+ resources:
** +$OCF_RESKEY_CRM_meta_notify_master_resource+
** minus +$OCF_RESKEY_CRM_meta_notify_demote_resource+
** plus +$OCF_RESKEY_CRM_meta_notify_promote_resource+
* +Slave+ resources:
** +$OCF_RESKEY_CRM_meta_notify_slave_resource+
** minus +$OCF_RESKEY_CRM_meta_notify_stop_resource+
** plus +$OCF_RESKEY_CRM_meta_notify_start_resource+
** minus +$OCF_RESKEY_CRM_meta_notify_promote_resource+ 
* Inactive resources:
** +$OCF_RESKEY_CRM_meta_notify_inactive_resource+
** plus +$OCF_RESKEY_CRM_meta_notify_stop_resource+
** minus +$OCF_RESKEY_CRM_meta_notify_start_resource+ 
* Resources to be started: +$OCF_RESKEY_CRM_meta_notify_start_resource+
* Resources to be promoted: +$OCF_RESKEY_CRM_meta_notify_promote_resource+
* Resources to be demoted: +$OCF_RESKEY_CRM_meta_notify_demote_resource+
* Resources to be stopped: +$OCF_RESKEY_CRM_meta_notify_stop_resource+
* Resources that were started: +$OCF_RESKEY_CRM_meta_notify_start_resource+
* Resources that were promoted: +$OCF_RESKEY_CRM_meta_notify_promote_resource+
* Resources that were demoted: +$OCF_RESKEY_CRM_meta_notify_demote_resource+
* Resources that were stopped: +$OCF_RESKEY_CRM_meta_notify_stop_resource+

=== Monitoring Promotable Clone Resources ===

The usual monitor actions are insufficient to monitor a promotable clone
resource, because Pacemaker needs to verify not only that the resource is
active, but also that its actual role matches its intended one.

Define two monitoring actions: the usual one will cover the slave role,
and an additional one with +role="master"+ will cover the master role.

.Monitoring both states of a promotable clone resource
======
[source,XML]
-------
<clone id="myMasterRsc">
   <meta_attributes id="myMasterRsc-meta">
       <nvpair name="promotable" value="true"/>
   </meta_attributes>
   <primitive id="myRsc" class="ocf" type="myApp" provider="myCorp">
    <operations>
     <op id="public-ip-slave-check" name="monitor" interval="60"/>
     <op id="public-ip-master-check" name="monitor" interval="61" role="Master"/>
    </operations>
   </primitive>
</clone> 
-------
======

[IMPORTANT]
===========
It is crucial that _every_ monitor operation has a different interval!
Pacemaker currently differentiates between operations
only by resource and interval; so if (for example) a promotable clone resource
had the same monitor interval for both roles, Pacemaker would ignore the
role when checking the status -- which would cause unexpected return
codes, and therefore unnecessary complications.
===========

[[s-promotion-scores]]
=== Determining Which Instance is Promoted ===

Pacemaker can choose a promotable clone instance to be promoted in one of two
ways:

* Promotion scores: These are node attributes set via the `crm_master` utility,
  which generally would be called by the resource agent's start action if it
  supports promotable clones. This tool automatically detects both the resource
  and host, and should be used to set a preference for being promoted. Based on
  this, +promoted-max+, and +promoted-node-max+, the instance(s) with the
  highest preference will be promoted.

* Constraints: Location constraints can indicate which nodes are most preferred
  as masters.

.Explicitly preferring node1 to be promoted to master
======
[source,XML]
-------
<rsc_location id="master-location" rsc="myMasterRsc">
    <rule id="master-rule" score="100" role="Master">
      <expression id="master-exp" attribute="#uname" operation="eq" value="node1"/>
    </rule>
</rsc_location> 
-------
======

[[s-resource-bundle]]
== Bundles - Isolated Environments ==
indexterm:[Resource,Bundle]
indexterm:[Container,Docker,Bundle]
indexterm:[Container,podman,Bundle]
indexterm:[Container,rkt,Bundle]

Pacemaker supports a special syntax for launching a
https://en.wikipedia.org/wiki/Operating-system-level_virtualization[container]
with any infrastructure it requires: the 'bundle'.

Pacemaker bundles support https://www.docker.com/[Docker],
https://podman.io/[podman], and https://coreos.com/rkt/[rkt]
container technologies.
footnote:[Docker is a trademark of Docker, Inc. No endorsement by or
association with Docker, Inc. is implied.]

.A bundle for a containerized web server
====
[source,XML]
----
<bundle id="httpd-bundle">
   <podman image="pcmk:http" replicas="3"/>
   <network ip-range-start="192.168.122.131"
            host-netmask="24"
            host-interface="eth0">
      <port-mapping id="httpd-port" port="80"/>
   </network>
   <storage>
      <storage-mapping id="httpd-syslog"
                       source-dir="/dev/log"
                       target-dir="/dev/log"
                       options="rw"/>
      <storage-mapping id="httpd-root"
                       source-dir="/srv/html"
                       target-dir="/var/www/html"
                       options="rw,Z"/>
      <storage-mapping id="httpd-logs"
                       source-dir-root="/var/log/pacemaker/bundles"
                       target-dir="/etc/httpd/logs"
                       options="rw,Z"/>
   </storage>
   <primitive class="ocf" id="httpd" provider="heartbeat" type="apache"/>
</bundle>
----
====

=== Bundle Prerequisites ===
indexterm:[Resource,Bundle,Prerequisites]

Before configuring a bundle in Pacemaker, the user must install the appropriate
container launch technology (Docker, podman, or rkt), and supply a fully
configured container image, on every node allowed to run the bundle.

Pacemaker will create an implicit resource of type +ocf:heartbeat:docker+,
+ocf:heartbeat:podman+, or +ocf:heartbeat:rkt+ to manage a bundle's
container. The user must ensure that the appropriate resource agent is
installed on every node allowed to run the bundle.

=== Bundle Properties ===

indexterm:[XML element,bundle element]

.XML Attributes of a bundle Element
[width="95%",cols="3m,<5",options="header",align="center"]
|=========================================================

|Attribute
|Description

|id
|A unique name for the bundle (required)
 indexterm:[XML attribute,id attribute,bundle element]
 indexterm:[XML element,bundle element,id attribute]

|description
|Arbitrary text (not used by Pacemaker)
 indexterm:[XML attribute,description attribute,bundle element]
 indexterm:[XML element,bundle element,description attribute]

|=========================================================

A bundle must contain exactly one +docker+, +podman+, or +rkt+ element.

=== Bundle Container Properties ===
indexterm:[XML element,docker element]
indexterm:[XML element,podman element]
indexterm:[XML element,rkt element]
indexterm:[Resource,Bundle,Container]

.XML attributes of a docker, podman, or rkt Element
[width="95%",cols="3m,4,<5",options="header",align="center"]
|====

|Attribute
|Default
|Description

|image
|
|Container image tag (required)
 indexterm:[XML attribute,image attribute,docker element]
 indexterm:[XML element,docker element,image attribute]
 indexterm:[XML attribute,image attribute,podman element]
 indexterm:[XML element,podman element,image attribute]
 indexterm:[XML attribute,image attribute,rkt element]
 indexterm:[XML element,rkt element,image attribute]

|replicas
|Value of +promoted-max+ if that is positive, else 1
|A positive integer specifying the number of container instances to launch
 indexterm:[XML attribute,replicas attribute,docker element]
 indexterm:[XML element,docker element,replicas attribute]
 indexterm:[XML attribute,replicas attribute,podman element]
 indexterm:[XML element,podman element,replicas attribute]
 indexterm:[XML attribute,replicas attribute,rkt element]
 indexterm:[XML element,rkt element,replicas attribute]

|replicas-per-host
|1
|A positive integer specifying the number of container instances allowed to run
 on a single node
 indexterm:[XML attribute,replicas-per-host attribute,docker element]
 indexterm:[XML element,docker element,replicas-per-host attribute]
 indexterm:[XML attribute,replicas-per-host attribute,podman element]
 indexterm:[XML element,podman element,replicas-per-host attribute]
 indexterm:[XML attribute,replicas-per-host attribute,rkt element]
 indexterm:[XML element,rkt element,replicas-per-host attribute]

|promoted-max
|0
|A non-negative integer that, if positive, indicates that the containerized
 service should be treated as a promotable service, with this many replicas
 allowed to run the service in the master role
 indexterm:[XML attribute,promoted-max attribute,docker element]
 indexterm:[XML element,docker element,promoted-max attribute]
 indexterm:[XML attribute,promoted-max attribute,podman element]
 indexterm:[XML element,podman element,promoted-max attribute]
 indexterm:[XML attribute,promoted-max attribute,rkt element]
 indexterm:[XML element,rkt element,promoted-max attribute]

|network
|
|If specified, this will be passed to the `docker run`, `podman run`, or
 `rkt run` command as the network setting for the container.
 indexterm:[XML attribute,network attribute,docker element]
 indexterm:[XML element,docker element,network attribute]
 indexterm:[XML attribute,network attribute,podman element]
 indexterm:[XML element,podman element,network attribute]
 indexterm:[XML attribute,network attribute,rkt element]
 indexterm:[XML element,rkt element,network attribute]

|run-command
|`/usr/sbin/pacemaker-remoted` if bundle contains a +primitive+, otherwise none
|This command will be run inside the container when launching it ("PID 1"). If
 the bundle contains a +primitive+, this command 'must' start pacemaker-remoted
 (but could, for example, be a script that does other stuff, too).
 indexterm:[XML attribute,run-command attribute,docker element]
 indexterm:[XML element,docker element,run-command attribute]
 indexterm:[XML attribute,run-command attribute,podman element]
 indexterm:[XML element,podman element,run-command attribute]
 indexterm:[XML attribute,run-command attribute,rkt element]
 indexterm:[XML element,rkt element,run-command attribute]

|options
|
|Extra command-line options to pass to the `docker run`, `podman run`, or
 `rkt run` command
 indexterm:[XML attribute,options attribute,docker element]
 indexterm:[XML element,docker element,options attribute]
 indexterm:[XML attribute,options attribute,podman element]
 indexterm:[XML element,podman element,options attribute]
 indexterm:[XML attribute,options attribute,rkt element]
 indexterm:[XML element,rkt element,options attribute]

|====

[NOTE]
====
Considerations when using cluster configurations or container images from
Pacemaker 1.1:

- If the container image has a pre-2.0.0 version of Pacemaker, set +run-command+
to +/usr/sbin/pacemaker_remoted+ (note the underbar instead of dash).

- +masters+ is accepted as an alias for +promoted-max+, but is deprecated since
2.0.0, and support for it will be removed in a future version.
====

=== Bundle Network Properties ===

A bundle may optionally contain one +<network>+ element.
indexterm:[XML element,network element]
indexterm:[Resource,Bundle,Networking]

.XML attributes of a network Element
[width="95%",cols="2m,1,<4",options="header",align="center"]
|=========================================================

|Attribute
|Default
|Description

|add-host
|TRUE
|If TRUE, and +ip-range-start+ is used, Pacemaker will automatically ensure
 that +/etc/hosts+ inside the containers has entries for each
 <<s-resource-bundle-note-replica-names,replica name>> and its assigned IP.
 indexterm:[XML element,add-host attribute,network element]
 indexterm:[XML attribute,network element,add-host attribute]

|ip-range-start
|
|If specified, Pacemaker will create an implicit +ocf:heartbeat:IPaddr2+
 resource for each container instance, starting with this IP address,
 using up to +replicas+ sequential addresses. These addresses can be used
 from the host's network to reach the service inside the container, though
 it is not visible within the container itself. Only IPv4 addresses are
 currently supported.
 indexterm:[XML element,ip-range-start attribute,network element]
 indexterm:[XML attribute,network element,ip-range-start attribute]

|host-netmask
|32
|If +ip-range-start+ is specified, the IP addresses are created with this
 CIDR netmask (as a number of bits).
 indexterm:[XML element,host-netmask attribute,network element]
 indexterm:[XML attribute,network element,host-netmask attribute]

|host-interface
|
|If +ip-range-start+ is specified, the IP addresses are created on this
 host interface (by default, it will be determined from the IP address).
 indexterm:[XML element,host-interface attribute,network element]
 indexterm:[XML attribute,network element,host-interface attribute]

|control-port
|3121
|If the bundle contains a +primitive+, the cluster will use this integer TCP
 port for communication with Pacemaker Remote inside the container. Changing
 this is useful when the container is unable to listen on the default port,
 for example, when the container uses the host's network rather than
 +ip-range-start+ (in which case +replicas-per-host+ must be 1), or when the
 bundle may run on a Pacemaker Remote node that is already listening on the
 default port. Any PCMK_remote_port environment variable set on the host or in
 the container is ignored for bundle connections.
 indexterm:[XML element,control-port attribute,network element]
 indexterm:[XML attribute,network element,control-port attribute]

|=========================================================

[[s-resource-bundle-note-replica-names]]
[NOTE]
====
Replicas are named by the bundle id plus a dash and an integer counter starting
with zero. For example, if a bundle named +httpd-bundle+ has +replicas=2+, its
containers will be named +httpd-bundle-0+ and +httpd-bundle-1+.
====

Additionally, a +network+ element may optionally contain one or more
+port-mapping+ elements.
indexterm:[XML element,port-mapping]

.Attributes of a port-mapping Element
[width="95%",cols="2m,1,<4",options="header",align="center"]
|=========================================================

|Attribute
|Default
|Description

|id
|
|A unique name for the port mapping (required)
 indexterm:[XML attribute,id attribute,port-mapping element]
 indexterm:[XML element,port-mapping element,id attribute]

|port
|
|If this is specified, connections to this TCP port number on the host network
 (on the container's assigned IP address, if +ip-range-start+ is specified)
 will be forwarded to the container network. Exactly one of +port+ or +range+
 must be specified in a +port-mapping+.
 indexterm:[XML attribute,port attribute,port-mapping element]
 indexterm:[XML element,port-mapping element,port attribute]

|internal-port
|value of +port+
|If +port+ and this are specified, connections to +port+ on the host's network
 will be forwarded to this port on the container network.
 indexterm:[XML attribute,internal-port attribute,port-mapping element]
 indexterm:[XML element,port-mapping element,internal-port attribute]

|range
|
|If this is specified, connections to these TCP port numbers (expressed as
 'first_port'-'last_port') on the host network (on the container's assigned IP
 address, if +ip-range-start+ is specified) will be forwarded to the same ports
 in the container network. Exactly one of +port+ or +range+ must be specified
 in a +port-mapping+.
 indexterm:[XML attribute,range attribute,port-mapping element]
 indexterm:[XML element,port-mapping element,range attribute]

|=========================================================

[NOTE]
====
If the bundle contains a +primitive+, Pacemaker will automatically map the
+control-port+, so it is not necessary to specify that port in a
+port-mapping+.
====

[[s-bundle-storage]]
=== Bundle Storage Properties ===

A bundle may optionally contain one +storage+ element. A +storage+ element
has no properties of its own, but may contain one or more +storage-mapping+
elements.
indexterm:[XML element,storage element]
indexterm:[XML element,storage-mapping element]
indexterm:[Resource,Bundle,Storage]

.Attributes of a storage-mapping Element
[width="95%",cols="2m,1,<4",options="header",align="center"]
|=========================================================

|Attribute
|Default
|Description

|id
|
|A unique name for the storage mapping (required)
 indexterm:[XML attribute,id attribute,storage-mapping element]
 indexterm:[XML element,storage-mapping element,id attribute]

|source-dir
|
|The absolute path on the host's filesystem that will be mapped into the
 container. Exactly one of +source-dir+ and +source-dir-root+ must be specified
 in a +storage-mapping+.
 indexterm:[XML attribute,source-dir attribute,storage-mapping element]
 indexterm:[XML element,storage-mapping element,source-dir attribute]

|source-dir-root
|
|The start of a path on the host's filesystem that will be mapped into the
 container, using a different subdirectory on the host for each container
 instance. The subdirectory will be named the same as the
 <<s-resource-bundle-note-replica-names,replica name>>.
 Exactly one of +source-dir+ and +source-dir-root+ must be specified in a
 +storage-mapping+.
 indexterm:[XML attribute,source-dir-root attribute,storage-mapping element]
 indexterm:[XML element,storage-mapping element,source-dir-root attribute]

|target-dir
|
|The path name within the container where the host storage will be mapped
 (required)
 indexterm:[XML attribute,target-dir attribute,storage-mapping element]
 indexterm:[XML element,storage-mapping element,target-dir attribute]

|options
|
|A comma-separated list of file system mount options to use when mapping the
 storage
 indexterm:[XML attribute,options attribute,storage-mapping element]
 indexterm:[XML element,storage-mapping element,options attribute]

|=========================================================

[NOTE]
====
Pacemaker does not define the behavior if the source directory does not already
exist on the host. However, it is expected that the container technology and/or
its resource agent will create the source directory in that case.
====

[NOTE]
====
If the bundle contains a +primitive+,
Pacemaker will automatically map the equivalent of
+source-dir=/etc/pacemaker/authkey target-dir=/etc/pacemaker/authkey+
and +source-dir-root=/var/log/pacemaker/bundles target-dir=/var/log+ into the
container, so it is not necessary to specify those paths in a
+storage-mapping+.
====

[IMPORTANT]
====
The +PCMK_authkey_location+ environment variable must not be set to anything
other than the default of `/etc/pacemaker/authkey` on any node in the cluster.
====

[IMPORTANT]
====
If SELinux is used in enforcing mode on the host, you must ensure the container
is allowed to use any storage you mount into it. For Docker and podman bundles,
adding "Z" to the mount options will create a container-specific label for the
mount that allows the container access.
====

=== Bundle Primitive ===

indexterm:[Resource,Bundle,Primitive]

A bundle may optionally contain one <<s-resource-primitive,primitive>>
resource. The primitive may have operations, instance attributes, and
meta-attributes defined, as usual.

If a bundle contains a primitive resource, the container image must include
the Pacemaker Remote daemon, and at least one of +ip-range-start+ or
+control-port+ must be configured in the bundle. Pacemaker will create an
implicit +ocf:pacemaker:remote+ resource for the connection, launch
Pacemaker Remote within the container, and monitor and manage the primitive
resource via Pacemaker Remote.

If the bundle has more than one container instance (replica), the primitive
resource will function as an implicit <<s-resource-clone,clone>> -- a
<<s-resource-promotable,promotable clone>> if the bundle has +masters+ greater
than zero.
 
[NOTE]
====
If you want to pass environment variables to a bundle's Pacemaker Remote
connection or primitive, you have two options:

* Environment variables whose value is the same regardless of the underlying host
  may be set using the container element's +options+ attribute.
* If you want variables to have host-specific values, you can use the
  <<s-bundle-storage,+storage-mapping+>> element to map a file on the host as
  +/etc/pacemaker/pcmk-init.env+ in the container. Pacemaker Remote will parse
  this file as a shell-like format, with variables set as NAME=VALUE, ignoring
  blank lines and comments starting with "#".
====

[IMPORTANT]
====
When a bundle has a +primitive+, Pacemaker on all cluster nodes must be able to
contact Pacemaker Remote inside the bundle's containers.

* The containers must have an accessible network (for example, +network+ should
  not be set to "none" with a +primitive+).
* The default, using a distinct network space inside the container, works in
  combination with +ip-range-start+. Any firewall must allow access from all
  cluster nodes to the +control-port+ on the container IPs.
* If the container shares the host's network space (for example, by setting
  +network+ to "host"), a unique +control-port+ should be specified for each
  bundle. Any firewall must allow access from all cluster nodes to the
  +control-port+ on all cluster and remote node IPs.
====

[[s-bundle-attributes]]
=== Bundle Node Attributes ===

indexterm:[Resource,Bundle,Node Attributes]

If the bundle has a +primitive+, the primitive's resource agent may want to set
node attributes such as <<s-promotion-scores,promotion scores>>. However, with
containers, it is not apparent which node should get the attribute.

If the container uses shared storage that is the same no matter which node the
container is hosted on, then it is appropriate to use the promotion score on the
bundle node itself.

On the other hand, if the container uses storage exported from the underlying host,
then it may be more appropriate to use the promotion score on the underlying host.

Since this depends on the particular situation, the
+container-attribute-target+ resource meta-attribute allows the user to specify
which approach to use. If it is set to +host+, then user-defined node attributes
will be checked on the underlying host. If it is anything else, the local node
(in this case the bundle node) is used as usual.

This only applies to user-defined attributes; the cluster will always check the
local node for cluster-defined attributes such as +#uname+.

If +container-attribute-target+ is +host+, the cluster will pass additional
environment variables to the primitive's resource agent that allow it to set
node attributes appropriately: +CRM_meta_container_attribute_target+ (identical
to the meta-attribute value) and +CRM_meta_physical_host+ (the name of the
underlying host).

[NOTE]
====
When called by a resource agent, the `attrd_updater` and `crm_attribute`
commands will automatically check those environment variables and set
attributes appropriately.
====

=== Bundle Meta-Attributes ===

indexterm:[Resource,Bundle,Meta-attributes]

Any meta-attribute set on a bundle will be inherited by the bundle's
primitive and any resources implicitly created by Pacemaker for the bundle.

This includes options such as +priority+, +target-role+, and +is-managed+. See
<<s-resource-options>> for more information.

=== Limitations of Bundles ===

Restarting pacemaker while a bundle is unmanaged or the cluster is in
maintenance mode may cause the bundle to fail.

Bundles may not be explicitly cloned or included in groups. This includes the
bundle's primitive and any resources implicitly created by Pacemaker for the
bundle. (If +replicas+ is greater than 1, the bundle will behave like a clone
implicitly.)

Bundles do not have instance attributes, utilization attributes, or operations,
though a bundle's primitive may have them.

A bundle with a primitive can run on a Pacemaker Remote node only if the bundle
uses a distinct +control-port+.
