ocf_heartbeat_dummypy(7)

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

NAME

6       ocf_heartbeat_dummypy - Example stateless resource agent
7

SYNOPSIS

9       dummypy [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, no default)
33
34       fake
35           Fake attribute that can be changed to cause a reload
36
37           (optional, string, no default)
38

SUPPORTED ACTIONS

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

EXAMPLE CRM SHELL

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

EXAMPLE PCS

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

AUTHOR

90       ClusterLabs contributors (see the resource agent source for information
91       about individual authors)
92
93
94
95resource-agents UNKNOWN           10/11/2023           OCF_HEARTBEAT_DUMMYP(7)