summaryrefslogtreecommitdiffstats
path: root/doc/sphinx/Pacemaker_Explained/resources.rst
blob: a971c44c26e88c7bf458ce135bc391bf4be83b59 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
.. _resource:

Cluster Resources
-----------------

.. _s-resource-primitive:

What is a Cluster Resource?
###########################

.. index::
   single: resource

A *resource* is a service managed by Pacemaker. The simplest type of resource,
a *primitive*, is described in this chapter. More complex forms, such as groups
and clones, are described in later chapters.

Every primitive has a *resource agent* that provides Pacemaker a standardized
interface for managing the service. This allows Pacemaker to be agnostic about
the services it manages. Pacemaker doesn't need to understand how the service
works because it relies on the resource agent to do the right thing when asked.

Every resource has a *class* specifying the standard that its resource agent
follows, and a *type* identifying the specific service being managed.


.. _s-resource-supported:

.. index::
   single: resource; class
 
Resource Classes
################

Pacemaker supports several classes, or standards, of resource agents:

* OCF
* LSB
* Systemd
* Service
* Fencing
* Nagios *(deprecated since 2.1.6)*
* Upstart *(deprecated since 2.1.0)*


.. index::
   single: resource; OCF
   single: OCF; resources
   single: Open Cluster Framework; resources

Open Cluster Framework
______________________

The Open Cluster Framework (OCF) Resource Agent API is a ClusterLabs
standard for managing services. It is the most preferred since it is
specifically designed for use in a Pacemaker cluster.

OCF agents are scripts that support a variety of actions including ``start``,
``stop``, and ``monitor``. They may accept parameters, making them more
flexible than other classes. The number and purpose of parameters is left to
the agent, which advertises them via the ``meta-data`` action.

Unlike other classes, OCF agents have a *provider* as well as a class and type.

For more information, see the "Resource Agents" chapter of *Pacemaker
Administration* and the `OCF standard
<https://github.com/ClusterLabs/OCF-spec/tree/main/ra>`_.


.. _s-resource-supported-systemd:

.. index::
   single: Resource; Systemd
   single: Systemd; resources

Systemd
_______

Most Linux distributions use `Systemd
<http://www.freedesktop.org/wiki/Software/systemd>`_ for system initialization
and service management. *Unit files* specify how to manage services and are
usually provided by the distribution.

Pacemaker can manage systemd services. Simply create a resource with
``systemd`` as the resource class and the unit file name as the resource type.
Do *not* run ``systemctl enable`` on the unit.

.. important::

   Make sure that any systemd services to be controlled by the cluster are
   *not* enabled to start at boot.


.. index::
   single: resource; LSB
   single: LSB; resources
   single: Linux Standard Base; resources

Linux Standard Base
___________________

*LSB* resource agents, also known as `SysV-style
<https://en.wikipedia.org/wiki/Init#SysV-style init scripts>`_, are scripts that
provide start, stop, and status actions for a service.

They are provided by some operating system distributions. If a full path is not
given, they are assumed to be located in a directory specified when your
Pacemaker software was built (usually ``/etc/init.d``).

In order to be used with Pacemaker, they must conform to the `LSB specification
<http://refspecs.linux-foundation.org/LSB_5.0.0/LSB-Core-generic/LSB-Core-generic/iniscrptact.html>`_
as it relates to init scripts.

.. warning::

   Some LSB scripts do not fully comply with the standard. For details on how
   to check whether your script is LSB-compatible, see the "Resource Agents"
   chapter of `Pacemaker Administration`. Common problems include:

   * Not implementing the ``status`` action
   * Not observing the correct exit status codes
   * Starting a started resource returns an error
   * Stopping a stopped resource returns an error

.. important::

   Make sure the host is *not* configured to start any LSB services at boot
   that will be controlled by the cluster.


.. index::
   single: Resource; System Services
   single: System Service; resources

System Services
_______________

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


.. index::
   single: Resource; STONITH
   single: STONITH; resources

STONITH
_______

The ``stonith`` class is used for managing fencing devices, discussed later in
:ref:`fencing`.


.. index::
   single: Resource; Nagios Plugins
   single: Nagios Plugins; resources

Nagios Plugins
______________

Nagios Plugins are a way to monitor services. Pacemaker can use these as
resources, to react to a change in the service's status.

To use plugins as resources, Pacemaker must have been built with support, and
OCF-style meta-data for the plugins must be installed on nodes that can run
them. Meta-data for several common plugins is provided by the
`nagios-agents-metadata <https://github.com/ClusterLabs/nagios-agents-metadata>`_
project.

The supported parameters for such a resource are same as the long options of
the plugin.

Start and monitor actions for plugin resources are implemented as invoking the
plugin. A plugin result of "OK" (0) is treated as success, a result of "WARN"
(1) is treated as a successful but degraded service, and any other result is
considered a failure.

A plugin resource is not going to change its status after recovery by
restarting the plugin, so using them alone does not make sense with ``on-fail``
set (or left to default) to ``restart``. Another value could make sense, for
example, if you want to fence or standby nodes that cannot reach some external
service.

A more common use case for plugin resources is to configure them with a
``container`` meta-attribute set to the name of another resource that actually
makes the service available, such as a virtual machine or container.

With ``container`` set, the plugin resource will automatically be colocated
with the containing resource and ordered after it, and the containing resource
will be considered failed if the plugin resource fails. This allows monitoring
of a service inside a virtual machine or container, with recovery of the
virtual machine or container if the service fails.

.. warning::

   Nagios support is deprecated in Pacemaker. Support will be dropped entirely
   at the next major release of Pacemaker.

   For monitoring a service inside a virtual machine or container, the
   recommended alternative is to configure the virtual machine as a guest node
   or the container as a :ref:`bundle <s-resource-bundle>`. For other use
   cases, or when the virtual machine or container image cannot be modified,
   the recommended alternative is to write a custom OCF agent for the service
   (which may even call the Nagios plugin as part of its status action).


.. index::
   single: Resource; Upstart
   single: Upstart; resources

Upstart
_______

Some Linux distributions previously used `Upstart
<https://upstart.ubuntu.com/>`_ for system initialization and service
management. Pacemaker is able to manage services using Upstart if the local
system supports them and support was enabled when your Pacemaker software was
built.

The *jobs* that specify how services are managed are usually provided by the
operating system distribution.

.. important::

   Make sure the host is *not* configured to start any Upstart services at boot
   that will be controlled by the cluster.

.. warning::

   Upstart support is deprecated in Pacemaker. Upstart is no longer actively
   maintained, and test platforms for it are no longer readily usable. Support
   will be dropped entirely at the next major release of Pacemaker.


.. _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.

.. table:: **Properties of a Primitive Resource**
   :widths: 1 4

   +-------------+------------------------------------------------------------------+
   | Field       | Description                                                      |
   +=============+==================================================================+
   | id          | .. index::                                                       |
   |             |    single: id; resource                                          |
   |             |    single: resource; property, id                                |
   |             |                                                                  |
   |             | Your name for the resource                                       |
   +-------------+------------------------------------------------------------------+
   | class       | .. index::                                                       |
   |             |    single: class; resource                                       |
   |             |    single: resource; property, class                             |
   |             |                                                                  |
   |             | The standard the resource agent conforms to. Allowed values:     |
   |             | ``lsb``, ``ocf``, ``service``, ``stonith``, ``systemd``,         |
   |             | ``nagios`` *(deprecated since 2.1.6)*, and ``upstart``           |
   |             | *(deprecated since 2.1.0)*                                       |
   +-------------+------------------------------------------------------------------+
   | description | .. index::                                                       |
   |             |    single: description; resource                                 |
   |             |    single: resource; property, description                       |
   |             |                                                                  |
   |             | A description of the Resource Agent, intended for local use.     |
   |             | E.g. ``IP address for website``                                  |
   +-------------+------------------------------------------------------------------+
   | type        | .. index::                                                       |
   |             |    single: type; resource                                        |
   |             |    single: resource; property, type                              |
   |             |                                                                  |
   |             | The name of the Resource Agent you wish to use. E.g.             |
   |             | ``IPaddr`` or ``Filesystem``                                     |
   +-------------+------------------------------------------------------------------+
   | provider    | .. index::                                                       |
   |             |    single: provider; resource                                    |
   |             |    single: resource; property, 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.                   |
   +-------------+------------------------------------------------------------------+

The XML definition of a resource can be queried with the **crm_resource** tool.
For example:

.. code-block:: none

   # crm_resource --resource Email --query-xml

might produce:

.. topic:: A system resource definition

   .. code-block:: xml

      <primitive id="Email" class="service" type="exim"/>

.. note::

   One of the main drawbacks to system services (LSB, systemd or
   Upstart) resources is that they do not allow any parameters!

.. topic:: An OCF resource definition

   .. code-block:: xml

      <primitive id="Public-IP" class="ocf" type="IPaddr" provider="heartbeat">
         <instance_attributes id="Public-IP-params">
            <nvpair id="Public-IP-ip" name="ip" value="192.0.2.2"/>
         </instance_attributes>
      </primitive>

.. _resource_options:

Resource Options
################

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.

.. table:: **Meta-attributes of a Primitive Resource**
   :class: longtable
   :widths: 2 2 3

   +----------------------------+----------------------------------+------------------------------------------------------+
   | Field                      | Default                          | Description                                          |
   +============================+==================================+======================================================+
   | priority                   | 0                                | .. index::                                           |
   |                            |                                  |    single: priority; resource option                 |
   |                            |                                  |    single: resource; option, priority                |
   |                            |                                  |                                                      |
   |                            |                                  | If not all resources can be active, the cluster      |
   |                            |                                  | will stop lower priority resources in order to       |
   |                            |                                  | keep higher priority ones active.                    |
   +----------------------------+----------------------------------+------------------------------------------------------+
   | critical                   | true                             | .. index::                                           |
   |                            |                                  |    single: critical; resource option                 |
   |                            |                                  |    single: resource; option, critical                |
   |                            |                                  |                                                      |
   |                            |                                  | Use this value as the default for ``influence`` in   |
   |                            |                                  | all :ref:`colocation constraints                     |
   |                            |                                  | <s-resource-colocation>` involving this resource,    |
   |                            |                                  | as well as the implicit colocation constraints       |
   |                            |                                  | created if this resource is in a                     |
   |                            |                                  | :ref:`group <group-resources>`. For details, see     |
   |                            |                                  | :ref:`s-coloc-influence`. *(since 2.1.0)*            |
   +----------------------------+----------------------------------+------------------------------------------------------+
   | target-role                | Started                          | .. index::                                           |
   |                            |                                  |    single: target-role; resource option              |
   |                            |                                  |    single: resource; option, target-role             |
   |                            |                                  |                                                      |
   |                            |                                  | 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                                |
   |                            |                                  |   :ref:`promotable <s-resource-promotable>` clone    |
   |                            |                                  |   resources, promoted if appropriate)                |
   |                            |                                  | * ``Unpromoted:`` Allow the resource to be started,  |
   |                            |                                  |   but only in the unpromoted role if the resource is |
   |                            |                                  |   :ref:`promotable <s-resource-promotable>`          |
   |                            |                                  | * ``Promoted:`` Equivalent to ``Started``            |
   +----------------------------+----------------------------------+------------------------------------------------------+
   | is-managed                 | TRUE                             | .. _is_managed:                                      |
   |                            |                                  |                                                      |
   |                            |                                  | .. index::                                           |
   |                            |                                  |    single: is-managed; resource option               |
   |                            |                                  |    single: resource; option, is-managed              |
   |                            |                                  |                                                      |
   |                            |                                  | If false, the cluster will not start or stop the     |
   |                            |                                  | resource on any node. Recurring actions for the      |
   |                            |                                  | resource are unaffected. Maintenance mode overrides  |
   |                            |                                  | this setting. Allowed values: ``true``, ``false``    |
   +----------------------------+----------------------------------+------------------------------------------------------+
   | maintenance                | FALSE                            | .. _rsc_maintenance:                                 |
   |                            |                                  |                                                      |
   |                            |                                  | .. index::                                           |
   |                            |                                  |    single: maintenance; resource option              |
   |                            |                                  |    single: resource; option, maintenance             |
   |                            |                                  |                                                      |
   |                            |                                  | If true, the cluster will not start or stop the      |
   |                            |                                  | resource on any node, and will pause any recurring   |
   |                            |                                  | monitors (except those specifying ``role`` as        |
   |                            |                                  | ``Stopped``). If true, the                           |
   |                            |                                  | :ref:`maintenance-mode <maintenance_mode>` cluster   |
   |                            |                                  | option or :ref:`maintenance <node_maintenance>`      |
   |                            |                                  | node attribute override this. Allowed values:        |
   |                            |                                  | ``true``, ``false``                                  |
   +----------------------------+----------------------------------+------------------------------------------------------+
   | resource-stickiness        | 1 for individual clone           | .. _resource-stickiness:                             |
   |                            | instances, 0 for all             |                                                      |
   |                            | other resources                  | .. index::                                           |
   |                            |                                  |    single: resource-stickiness; resource option      |
   |                            |                                  |    single: resource; option, resource-stickiness     |
   |                            |                                  |                                                      |
   |                            |                                  | 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.                        |
   +----------------------------+----------------------------------+------------------------------------------------------+
   | requires                   | ``quorum`` for resources         | .. _requires:                                        |
   |                            | with a ``class`` of ``stonith``, |                                                      |
   |                            | otherwise ``unfencing`` if       | .. index::                                           |
   |                            | unfencing is active in the       |    single: requires; resource option                 |
   |                            | cluster, otherwise ``fencing``   |    single: resource; option, requires                |
   |                            | if ``stonith-enabled`` is true,  |                                                      |
   |                            | otherwise ``quorum``             | 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 :ref:`fenced <fencing>`                  |
   |                            |                                  | * ``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     |
   |                            |                                  |   :ref:`unfenced <unfencing>`                        |
   +----------------------------+----------------------------------+------------------------------------------------------+
   | migration-threshold        | INFINITY                         | .. index::                                           |
   |                            |                                  |    single: migration-threshold; resource option      |
   |                            |                                  |    single: resource; option, migration-threshold     |
   |                            |                                  |                                                      |
   |                            |                                  | 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``.    |
   +----------------------------+----------------------------------+------------------------------------------------------+
   | failure-timeout            | 0                                | .. index::                                           |
   |                            |                                  |    single: failure-timeout; resource option          |
   |                            |                                  |    single: resource; option, failure-timeout         |
   |                            |                                  |                                                      |
   |                            |                                  | 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.                                            |
   +----------------------------+----------------------------------+------------------------------------------------------+
   | multiple-active            | stop_start                       | .. index::                                           |
   |                            |                                  |    single: multiple-active; resource option          |
   |                            |                                  |    single: resource; option, multiple-active         |
   |                            |                                  |                                                      |
   |                            |                                  | 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            |
   |                            |                                  | * ``stop_unexpected``: stop all active instances     |
   |                            |                                  |   except where the resource should be active (this   |
   |                            |                                  |   should be used only when extra instances are not   |
   |                            |                                  |   expected to disrupt existing instances, and the    |
   |                            |                                  |   resource agent's monitor of an existing instance   |
   |                            |                                  |   is capable of detecting any problems that could be |
   |                            |                                  |   caused; note that any resources ordered after this |
   |                            |                                  |   will still need to be restarted) *(since 2.1.3)*   |
   +----------------------------+----------------------------------+------------------------------------------------------+
   | allow-migrate              | TRUE for ocf:pacemaker:remote    | Whether the cluster should try to "live migrate"     |
   |                            | resources, FALSE otherwise       | this resource when it needs to be moved (see         |
   |                            |                                  | :ref:`live-migration`)                               |
   +----------------------------+----------------------------------+------------------------------------------------------+
   | allow-unhealthy-nodes      | FALSE                            | Whether the resource should be able to run on a node |
   |                            |                                  | even if the node's health score would otherwise      |
   |                            |                                  | prevent it (see :ref:`node-health`) *(since 2.1.3)*  |
   +----------------------------+----------------------------------+------------------------------------------------------+
   | container-attribute-target |                                  | Specific to bundle resources; see                    |
   |                            |                                  | :ref:`s-bundle-attributes`                           |
   +----------------------------+----------------------------------+------------------------------------------------------+
   | 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:

.. code-block:: none

   # 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:

.. topic:: An LSB resource with cluster options

   .. code-block:: xml

      <primitive id="Email" class="lsb" type="exim">
        <meta_attributes id="Email-meta_attributes">
          <nvpair id="Email-meta_attributes-priority" name="priority" value="100"/>
          <nvpair id="Email-meta_attributes-multiple-active" name="multiple-active" value="block"/>
        </meta_attributes>
      </primitive>

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 :ref:`rules <rules>`. 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,

.. code-block:: none

   # 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,

.. code-block:: none

   # crm_resource --resource Public-IP --set-parameter ip --parameter-value 192.0.2.2

would create an entry in the resource like this:

.. topic:: An example OCF resource with instance attributes

   .. code-block:: xml

      <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>

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.

.. topic:: Displaying the metadata for the Dummy resource agent template

   .. code-block:: none

      # export OCF_ROOT=/usr/lib/ocf
      # $OCF_ROOT/resource.d/pacemaker/Dummy meta-data

   .. code-block:: xml

      <?xml version="1.0"?>
      <!DOCTYPE resource-agent SYSTEM "ra-api-1.dtd">
      <resource-agent name="Dummy" version="2.0">
      <version>1.1</version>

      <longdesc lang="en">
      This is a dummy OCF resource agent. It does absolutely nothing except keep track
      of whether it is running or not, and can be configured so that actions fail or
      take a long time. Its purpose is primarily for testing, and to serve as a
      template for resource agent writers.
      </longdesc>
      <shortdesc lang="en">Example stateless resource agent</shortdesc>

      <parameters>
      <parameter name="state" unique-group="state">
      <longdesc lang="en">
      Location to store the resource state in.
      </longdesc>
      <shortdesc lang="en">State file</shortdesc>
      <content type="string" default="/var/run/Dummy-RESOURCE_ID.state" />
      </parameter>

      <parameter name="passwd" reloadable="1">
      <longdesc lang="en">
      Fake password field
      </longdesc>
      <shortdesc lang="en">Password</shortdesc>
      <content type="string" default="" />
      </parameter>

      <parameter name="fake" reloadable="1">
      <longdesc lang="en">
      Fake attribute that can be changed to cause a reload
      </longdesc>
      <shortdesc lang="en">Fake attribute that can be changed to cause a reload</shortdesc>
      <content type="string" default="dummy" />
      </parameter>

      <parameter name="op_sleep" reloadable="1">
      <longdesc lang="en">
      Number of seconds to sleep during operations.  This can be used to test how
      the cluster reacts to operation timeouts.
      </longdesc>
      <shortdesc lang="en">Operation sleep duration in seconds.</shortdesc>
      <content type="string" default="0" />
      </parameter>

      <parameter name="fail_start_on" reloadable="1">
      <longdesc lang="en">
      Start, migrate_from, and reload-agent actions will return failure if running on
      the host specified here, but the resource will run successfully anyway (future
      monitor calls will find it running). This can be used to test on-fail=ignore.
      </longdesc>
      <shortdesc lang="en">Report bogus start failure on specified host</shortdesc>
      <content type="string" default="" />
      </parameter>
      <parameter name="envfile" reloadable="1">
      <longdesc lang="en">
      If this is set, the environment will be dumped to this file for every call.
      </longdesc>
      <shortdesc lang="en">Environment dump file</shortdesc>
      <content type="string" default="" />
      </parameter>

      </parameters>

      <actions>
      <action name="start"        timeout="20s" />
      <action name="stop"         timeout="20s" />
      <action name="monitor"      timeout="20s" interval="10s" depth="0"/>
      <action name="reload"       timeout="20s" />
      <action name="reload-agent" timeout="20s" />
      <action name="migrate_to"   timeout="20s" />
      <action name="migrate_from" timeout="20s" />
      <action name="validate-all" timeout="20s" />
      <action name="meta-data"    timeout="5s" />
      </actions>
      </resource-agent>