ocf_heartbeat_Dummy(7)

1OCF_HEARTBEAT_DUMMY(7)        OCF resource agents       OCF_HEARTBEAT_DUMMY(7)
2
3
4

NAME

6       ocf_heartbeat_Dummy - Example stateless resource agent
7

SYNOPSIS

9       Dummy [start | stop | monitor | migrate_to | migrate_from | meta-data |
10             validate-all]
11

DESCRIPTION

13       This is a Dummy Resource Agent. It does absolutely nothing except keep
14       track of whether its running or not. Its purpose in life is for testing
15       and to serve as a template for RA writers.
16
17       NB: Please pay attention to the timeouts specified in the actions
18       section below. They should be meaningful for the kind of resource the
19       agent manages. They should be the minimum advised timeouts, but they
20       shouldn't/cannot cover _all_ possible resource instances. So, try to be
21       neither overly generous nor too stingy, but moderate. The minimum
22       timeouts should never be below 10 seconds.
23
24       This resource agent may be configured for native migration if available
25       in the cluster manager. For Pacemaker, the allow-migrate="true" meta
26       attribute enables native migration.
27

SUPPORTED PARAMETERS

29       state
30           Location to store the resource state in.
31
32           (unique, optional, string, default
33           "/run/resource-agents/Dummy-RESOURCE_ID.state")
34
35       fake
36           Fake attribute that can be changed to cause a reload
37
38           (optional, string, default "dummy")
39

SUPPORTED ACTIONS

41       This resource agent supports the following actions (operations):
42
43       start
44           Starts the resource. Suggested minimum timeout: 20s.
45
46       stop
47           Stops the resource. Suggested minimum timeout: 20s.
48
49       monitor
50           Performs a detailed status check. Suggested minimum timeout: 20s.
51           Suggested interval: 10s.
52
53       reload
54           Suggested minimum timeout: 20s.
55
56       migrate_to
57           Executes steps necessary for migrating the resource to the node.
58           Suggested minimum timeout: 20s.
59
60       migrate_from
61           Executes steps necessary for migrating the resource away from the
62           node. Suggested minimum timeout: 20s.
63
64       meta-data
65           Retrieves resource agent metadata (internal use only). Suggested
66           minimum timeout: 5s.
67
68       validate-all
69           Performs a validation of the resource configuration. Suggested
70           minimum timeout: 20s.
71

EXAMPLE CRM SHELL

73       The following is an example configuration for a Dummy resource using
74       the crm(8) shell:
75
76           primitive p_Dummy ocf:heartbeat:Dummy \
77             meta allow-migrate="true" \
78             op monitor timeout="20s" interval="10s" depth="0"
79

EXAMPLE PCS

81       The following is an example configuration for a Dummy resource using
82       pcs(8)
83
84           pcs resource create p_Dummy ocf:heartbeat:Dummy \
85             op monitor timeout="20s" interval="10s" OCF_CHECK_LEVEL="0"
86

AUTHOR

91       ClusterLabs contributors (see the resource agent source for information
92       about individual authors)
93
94
95
96resource-agents UNKNOWN           01/25/2023            OCF_HEARTBEAT_DUMMY(7)