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

NAME

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

SYNOPSIS

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

DESCRIPTION

13       This resource agent manages Linux software RAID (MD) devices on a
14       shared storage medium. It uses mdadm(8) to start, stop, and monitor the
15       MD devices. Raidtools are supported, but deprecated. See
16       https://raid.wiki.kernel.org/index.php/Linux_Raid for more information.
17

SUPPORTED PARAMETERS

19       raidconf
20           The RAID configuration file, e.g. /etc/mdadm.conf.
21
22           (required, string, no default)
23
24       raiddev
25           One or more block devices to use, space separated. Alternatively,
26           set to "auto" to manage all devices specified in raidconf.
27
28           (required, string, no default)
29
30       homehost
31           The value for the homehost directive; this is an mdadm feature to
32           protect RAIDs against being activated by accident. It is
33           recommended to create RAIDs managed by the cluster with "homehost"
34           set to a special value, so they are not accidentally auto-assembled
35           by nodes not supposed to own them.
36
37           (optional, string, no default)
38
39       force_stop
40           If processes or kernel threads are using the array, it cannot be
41           stopped. We will try to stop processes, first by sending TERM and
42           then, if that doesn't help in 3 seconds, using KILL. The lsof(8)
43           program is required to get the list of array users. Of course, the
44           kernel threads cannot be stopped this way. If the processes are
45           critical for data integrity, then set this parameter to false. Note
46           that in that case the stop operation will fail and the node will be
47           fenced.
48
49           (optional, boolean, default true)
50
51       udev
52           Wait until udevd creates a device in the start operation. On a
53           normally loaded host this should happen quickly, but you may be
54           unlucky. If you are not using udev set this to "no".
55
56           (optional, boolean, default true)
57
58       force_clones
59           Activating the same md RAID array on multiple nodes at the same
60           time will result in data corruption and thus is forbidden by
61           default.
62
63           A safe example could be an array that is only named identically
64           across all nodes, but is in fact distinct.
65
66           Only set this to "true" if you know what you are doing!
67
68           (optional, boolean, default false)
69

SUPPORTED ACTIONS

71       This resource agent supports the following actions (operations):
72
73       start
74           Starts the resource. Suggested minimum timeout: 20s.
75
76       stop
77           Stops the resource. Suggested minimum timeout: 20s.
78
79       status
80           Performs a status check. Suggested minimum timeout: 20s. Suggested
81           interval: 10s.
82
83       monitor
84           Performs a detailed status check. Suggested minimum timeout: 20s.
85           Suggested interval: 10s.
86
87       validate-all
88           Performs a validation of the resource configuration. Suggested
89           minimum timeout: 5s.
90
91       meta-data
92           Retrieves resource agent metadata (internal use only). Suggested
93           minimum timeout: 5s.
94

EXAMPLE CRM SHELL

96       The following is an example configuration for a Raid1 resource using
97       the crm(8) shell:
98
99           primitive p_Raid1 ocf:heartbeat:Raid1 \
100             params \
101               raidconf=string \
102               raiddev=string \
103             op monitor depth="0" timeout="20s" interval="10s"
104

EXAMPLE PCS

106       The following is an example configuration for a Raid1 resource using
107       pcs(8)
108
109           pcs resource create p_Raid1 ocf:heartbeat:Raid1 \
110             raidconf=string \
111             raiddev=string \
112             op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="10s"
113

SEE ALSO

115       http://clusterlabs.org/
116

AUTHOR

118       ClusterLabs contributors (see the resource agent source for information
119       about individual authors)
120
121
122
123resource-agents UNKNOWN           04/06/2022            OCF_HEARTBEAT_RAID1(7)
Impressum