ocf_heartbeat_sfex(7)

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

NAME

6       ocf_heartbeat_sfex - Manages exclusive access to shared storage using
7       Shared Disk File EXclusiveness (SF-EX)
8

SYNOPSIS

10       sfex [start | stop | monitor | meta-data | validate-all]
11

DESCRIPTION

13       Resource script for SF-EX. It manages a shared storage medium
14       exclusively .
15

SUPPORTED PARAMETERS

17       device
18           Block device path that stores exclusive control data.
19
20           (required, string, no default)
21
22       index
23           Location in block device where exclusive control data is stored. 1
24           or more is specified. Default is 1.
25
26           (optional, integer, default 1)
27
28       collision_timeout
29           Waiting time when a collision of lock acquisition is detected.
30           Default is 1 second.
31
32           (optional, integer, default 1)
33
34       monitor_interval
35           Monitor interval(sec). Default is 10 seconds
36
37           (optional, integer, default 10)
38
39       lock_timeout
40           Valid term of lock(sec). Default is 100 seconds. The lock_timeout
41           is calculated by the following formula.
42
43           lock_timeout = monitor_interval + "The expiration time of the lock"
44
45           We suggest 90 seconds as a default value of the "The expiration
46           time of the lock", but you should change it in consideration of
47           access delay to the shared disk and the switch time of the
48           multipath driver.
49
50           The lock timeout have an impact on start action timeout because
51           start action timeout value is calculated by the following formula.
52
53           start timeout = collision_timeout + lock_timeout + "safety margin"
54
55           The "safety margin" is decided within the range of about 10-20
56           seconds(It depends on your system requirement).
57
58           (optional, integer, default 100)
59

SUPPORTED ACTIONS

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

EXAMPLE CRM SHELL

82       The following is an example configuration for a sfex resource using the
83       crm(8) shell:
84
85           primitive p_sfex ocf:heartbeat:sfex \
86             params \
87               device=string \
88             op monitor depth="0" timeout="10s" interval="10s"
89

EXAMPLE PCS

91       The following is an example configuration for a sfex resource using
92       pcs(8)
93
94           pcs resource create p_sfex ocf:heartbeat:sfex \
95             device=string \
96             op monitor OCF_CHECK_LEVEL="0" timeout="10s" interval="10s"
97

AUTHOR

102       ClusterLabs contributors (see the resource agent source for information
103       about individual authors)
104
105
106
107resource-agents UNKNOWN           01/25/2023             OCF_HEARTBEAT_SFEX(7)