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       Option: OCF_CHECK_LEVEL
34
35       The standard monitor operation of depth 0 checks if the VG or LV is
36       valid. If you want deeper tests, set OCF_CHECK_LEVEL to 10:
37
38       10: read first 1 byte of the underlying device (raw read)
39
40       If there are many underlying devs in VG, it will only read one of the
41       devs. This is not perfect solution for detecting underlying devices
42       livable. e.g. iscsi SAN IO timeout will return EIO, and it makes
43       monitor failed.
44

SUPPORTED PARAMETERS

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

SUPPORTED ACTIONS

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

EXAMPLE CRM SHELL

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

EXAMPLE PCS

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

AUTHOR

132       ClusterLabs contributors (see the resource agent source for information
133       about individual authors)
134
135
136
137resource-agents UNKNOWN           03/25/2021            OCF_HEARTBEAT_LVM-A(7)