ocf_heartbeat_mdraid(7)

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

NAME

6       ocf_heartbeat_mdraid - Manages Linux software RAID (MD) devices on
7       shared storage
8

SYNOPSIS

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

DESCRIPTION

13       This resource agent manages Linux software RAID (MD) devices on a
14       shared storage medium ensuring that non-clustered MD arrays are
15       prohibited from starting cloned (which would cause data corruption
16       (e.g., on raid6 arrays) unless forced (see force_clones parameter).
17       Clustered MD RAID layouts (see below) will be discovered and allowed
18       cloning by default; no need to set force_clones.
19
20       It uses mdadm(8) to start, stop, and monitor the MD devices.
21
22       Supported clustered (i.e., clonable active-active) arrays are linear,
23       raid0, and clustered raid1/raid10 (i.e. mdadm(8) created with
24
25       --bitmap=clustered).
26
27       Option: OCF_CHECK_LEVEL
28
29       When OCF_CHECK_LEVEL is set to any number greater than 0, the standard
30       monitor operation (including probe) will check the array and attempt
31       recovery sequence to re-add devices if any failed device exists. By
32       default, OCF_CHECK_LEVEL is unset, and this is disabled.
33

SUPPORTED PARAMETERS

35       mdadm_conf
36           The MD RAID configuration file (e.g., /etc/mdadm.conf).
37
38           (required, string, no default)
39
40       md_dev
41           MD array block device to use (e.g., /dev/md0 or /dev/md/3). With
42           shared access to the array's storage, this should preferably be a
43           clustered raid1 or raid10 array created with --bitmap=clustered,
44           assuming its resource will be cloned (i.e., active-active access).
45
46           Be sure to disable auto-assembly for the resource-managed arrays!
47
48           (required, string, no default)
49
50       force_stop
51           If processes or kernel threads are using the array, it cannot be
52           stopped. We will try to stop processes, first by sending TERM and
53           then, if that doesn't help in seconds, using KILL. The lsof(8)
54           program is required to get the list of array users. Of course, the
55           kernel threads cannot be stopped this way. If the processes are
56           critical for data integrity, then set this parameter to false. Note
57           that in that case the stop operation will fail and the node will be
58           fenced.
59
60           (optional, boolean, default false)
61
62       wait_for_udev
63           Wait until udevd creates a device in the start operation. On a
64           normally loaded host this should happen quickly, but you may be
65           unlucky. If you are not using udev set this to "no".
66
67           (optional, boolean, default true)
68
69       force_clones
70           Activating the same, non-clustered MD RAID array (i.e. single-host
71           raid1/4/5/6/10) on multiple nodes at the same time will result in
72           data corruption and thus is forbidden by default.
73
74           A safe example could be an (exotic) array that is only named
75           identically across all nodes, but is in fact based on distinct
76           (non-shared) storage.
77
78           Only set this to "true" if you know what you are doing!
79
80           (optional, boolean, default false)
81

SUPPORTED ACTIONS

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

EXAMPLE CRM SHELL

104       The following is an example configuration for a mdraid resource using
105       the crm(8) shell:
106
107           primitive p_mdraid ocf:heartbeat:mdraid \
108             params \
109               mdadm_conf=string \
110               md_dev=string \
111             op monitor depth="0" timeout="20s" interval="10s"
112

EXAMPLE PCS

114       The following is an example configuration for a mdraid resource using
115       pcs(8)
116
117           pcs resource create p_mdraid ocf:heartbeat:mdraid \
118             mdadm_conf=string \
119             md_dev=string \
120             op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="10s"
121

AUTHOR

126       ClusterLabs contributors (see the resource agent source for information
127       about individual authors)
128
129
130
131resource-agents UNKNOWN           10/11/2023           OCF_HEARTBEAT_MDRAID(7)