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
91       degraded_activation
92           Activate RAID LVs using the "degraded" activation mode. This allows
93           RAID LVs to be activated with missing PVs if all data can be
94           provided with RAID redundancy. The RAID level determines the number
95           of PVs that are required for degraded activation to succeed. If
96           fewer PVs are available, then degraded activation will fail. Also
97           enable majority_pvs.
98
99           (optional, string, default "false")
100
101       majority_pvs
102           If set, the VG system ID can be reassigned to a new host if a
103           majority of PVs in the VG are present. Otherwise, VG failover with
104           system ID will fail when the VG is missing PVs. Also enable
105           degraded_activation when RAID LVs are used.
106
107           (optional, string, default "false")
108

SUPPORTED ACTIONS

110       This resource agent supports the following actions (operations):
111
112       start
113           Starts the resource. Suggested minimum timeout: 90s.
114
115       stop
116           Stops the resource. Suggested minimum timeout: 90s.
117
118       monitor
119           Performs a detailed status check. Suggested minimum timeout: 90s.
120           Suggested interval: 30s.
121
122       meta-data
123           Retrieves resource agent metadata (internal use only). Suggested
124           minimum timeout: 10s.
125
126       validate-all
127           Performs a validation of the resource configuration. Suggested
128           minimum timeout: 20s.
129

EXAMPLE CRM SHELL

131       The following is an example configuration for a LVM-activate resource
132       using the crm(8) shell:
133
134           primitive p_LVM-activate ocf:heartbeat:LVM-activate \
135             params \
136               vgname=string \
137               vg_access_mode=string \
138             op monitor timeout="90s" interval="30s" depth="0"
139

EXAMPLE PCS

141       The following is an example configuration for a LVM-activate resource
142       using pcs(8)
143
144           pcs resource create p_LVM-activate ocf:heartbeat:LVM-activate \
145             vgname=string \
146             vg_access_mode=string \
147             op monitor timeout="90s" interval="30s" OCF_CHECK_LEVEL="0"
148

AUTHOR

153       ClusterLabs contributors (see the resource agent source for information
154       about individual authors)
155
156
157
158resource-agents UNKNOWN           10/11/2023            OCF_HEARTBEAT_LVM-A(7)