ocf_heartbeat_LVM-activate(7)

1OCF_HEARTBEAT_LVM-A(7)        OCF resource agents       OCF_HEARTBEAT_LVM-A(7)
2
3
4

NAME

6       ocf_heartbeat_LVM-activate - This agent activates/deactivates logical
7       volumes.
8

SYNOPSIS

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

DESCRIPTION

13       This agent manages LVM activation/deactivation work for a given volume
14       group.
15
16       It supports the following modes, controlled by the vg_access_mode
17       parameter:
18
19       * lvmlockd * system_id * clvmd * tagging
20
21       Notes:
22
23       1. There are two possible configuration combinations:
24       lvmlockd+LVM-activate and clvm+LVM-activate. However, it is not
25       possible to use both at the same time!
26
27       2. Put all "lvmlockd"/"clvmd" volume groups into auto management by the
28       agent if using the cluster to manage at least one of them. If you
29       manage some manually, the stop action of the lvmlockd agent may fail
30       and the node may get fenced, because some DLM lockspaces might be in
31       use and cannot be closed automatically.
32
33       3. The autoactivation property of volume group will be disabled when
34       vg_access_mode is set to system_id.
35
36       Option: OCF_CHECK_LEVEL
37
38       The standard monitor operation of depth 0 checks if the VG or LV is
39       valid. If you want deeper tests, set OCF_CHECK_LEVEL to 10:
40
41       10: read first 1 byte of the underlying device (raw read)
42
43       If there are many underlying devs in VG, it will only read one of the
44       devs. This is not perfect solution for detecting underlying devices
45       livable. e.g. iscsi SAN IO timeout will return EIO, and it makes
46       monitor failed.
47

SUPPORTED PARAMETERS

49       vgname
50           The volume group name.
51
52           (required, string, no default)
53
54       lvname
55           If set, only the specified LV will be activated.
56
57           (optional, string, no default)
58
59       vg_access_mode
60           This option decides which solution will be used to protect the
61           volume group in cluster environment. Optional solutions are:
62           lvmlockd, clvmd, system_id and tagging.
63
64           (required, string, no default)
65
66       activation_mode
67           The activation mode decides the visibility of logical volumes in
68           the cluster. There are two different modes: "shared" for cluster
69           filesystem and "exclusive" for local filesystem. With "shared", an
70           LV can be activated concurrently from multiple nodes. With
71           "exclusive", an LV can be activated by one node at a time.
72
73           This option only has effect on "lvmlockd"/"clvmd" vg_access_mode.
74           For "system_id" and "tagging", they always mean exclusive
75           activation.
76
77           (optional, string, default "exclusive")
78
79       tag
80           The tag used for tagging activation mode.
81
82           (optional, string, default "pacemaker")
83
84       partial_activation
85           If set, the volume group will be activated partially even with some
86           physical volumes missing. It helps to set to true when using
87           mirrored logical volumes.
88
89           (optional, string, default "false")
90

SUPPORTED ACTIONS

92       This resource agent supports the following actions (operations):
93
94       start
95           Starts the resource. Suggested minimum timeout: 90s.
96
97       stop
98           Stops the resource. Suggested minimum timeout: 90s.
99
100       monitor
101           Performs a detailed status check. Suggested minimum timeout: 90s.
102           Suggested interval: 30s.
103
104       meta-data
105           Retrieves resource agent metadata (internal use only). Suggested
106           minimum timeout: 10s.
107
108       validate-all
109           Performs a validation of the resource configuration. Suggested
110           minimum timeout: 20s.
111

EXAMPLE CRM SHELL

113       The following is an example configuration for a LVM-activate resource
114       using the crm(8) shell:
115
116           primitive p_LVM-activate ocf:heartbeat:LVM-activate \
117             params \
118               vgname=string \
119               vg_access_mode=string \
120             op monitor timeout="90s" interval="30s" depth="0"
121

EXAMPLE PCS

123       The following is an example configuration for a LVM-activate resource
124       using pcs(8)
125
126           pcs resource create p_LVM-activate ocf:heartbeat:LVM-activate \
127             vgname=string \
128             vg_access_mode=string \
129             op monitor timeout="90s" interval="30s" OCF_CHECK_LEVEL="0"
130

AUTHOR

135       ClusterLabs contributors (see the resource agent source for information
136       about individual authors)
137
138
139
140resource-agents UNKNOWN           01/25/2023            OCF_HEARTBEAT_LVM-A(7)