ocf_heartbeat_anything(7)

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

NAME

6       ocf_heartbeat_anything - Manages an arbitrary service
7

SYNOPSIS

9       anything [start | stop | monitor | meta-data | validate-all]
10

DESCRIPTION

12       This is a generic OCF RA to manage almost anything.
13

SUPPORTED PARAMETERS

15       binfile
16           The full name of the binary to be executed. This is expected to
17           keep running with the same pid and not just do something and exit.
18
19           (required, string, no default)
20
21       cmdline_options
22           Command line options to pass to the binary
23
24           (optional, string, no default)
25
26       workdir
27           The path from where the binfile will be executed.
28
29           (optional, string, no default)
30
31       pidfile
32           File to read/write the PID from/to.
33
34           (optional, string, default "/var/run/anything_RESOURCE_ID.pid")
35
36       logfile
37           File to write STDOUT to
38
39           (optional, string, default "/dev/null")
40
41       errlogfile
42           File to write STDERR to
43
44           (optional, string, no default)
45
46       user
47           User to run the command as
48
49           (optional, string, default "root")
50
51       monitor_hook
52           Command to run in monitor operation
53
54           (optional, string, no default)
55
56       stop_timeout
57           In the stop operation: Seconds to wait for kill -TERM to succeed
58           before sending kill -SIGKILL. Defaults to 2/3 of the stop operation
59           timeout.
60
61           (optional, string, no default)
62

SUPPORTED ACTIONS

64       This resource agent supports the following actions (operations):
65
66       start
67           Starts the resource. Suggested minimum timeout: 20s.
68
69       stop
70           Stops the resource. Suggested minimum timeout: 20s.
71
72       monitor
73           Performs a detailed status check. Suggested minimum timeout: 20s.
74           Suggested interval: 10s.
75
76       meta-data
77           Retrieves resource agent metadata (internal use only). Suggested
78           minimum timeout: 5s.
79
80       validate-all
81           Performs a validation of the resource configuration. Suggested
82           minimum timeout: 5s.
83

EXAMPLE CRM SHELL

85       The following is an example configuration for a anything resource using
86       the crm(8) shell:
87
88           primitive p_anything ocf:heartbeat:anything \
89             params \
90               binfile=string \
91             op monitor depth="0" timeout="20s" interval="10s"
92

EXAMPLE PCS

94       The following is an example configuration for a anything resource using
95       pcs(8)
96
97           pcs resource create p_anything ocf:heartbeat:anything \
98             binfile=string \
99             op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="10s"
100

AUTHOR

105       ClusterLabs contributors (see the resource agent source for information
106       about individual authors)
107
108
109
110resource-agents UNKNOWN           11/03/2021           OCF_HEARTBEAT_ANYTHI(7)