'\" t
.\"     Title: ocf_heartbeat_Raid1
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 06/07/2017
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.0.0~rc1-4~bpo8+1
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_RAID1" "7" "06/07/2017" "resource-agents 4.0.0~rc1-4~bp" "OCF resource agents"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ocf_heartbeat_Raid1 \- Manages Linux software RAID (MD) devices on shared storage
.SH "SYNOPSIS"
.HP \w'\fBRaid1\fR\ 'u
\fBRaid1\fR [start | stop | status | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
This resource agent manages Linux software RAID (MD) devices on a shared storage medium\&. It uses mdadm(8) to start, stop, and monitor the MD devices\&. Raidtools are supported, but deprecated\&. See https://raid\&.wiki\&.kernel\&.org/index\&.php/Linux_Raid for more information\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBraidconf\fR
.RS 4
The RAID configuration file, e\&.g\&. /etc/mdadm\&.conf\&.
.sp
(required, string, no default)
.RE
.PP
\fBraiddev\fR
.RS 4
One or more block devices to use, space separated\&. Alternatively, set to "auto" to manage all devices specified in raidconf\&.
.sp
(required, string, no default)
.RE
.PP
\fBhomehost\fR
.RS 4
The value for the homehost directive; this is an mdadm feature to protect RAIDs against being activated by accident\&. It is recommended to create RAIDs managed by the cluster with "homehost" set to a special value, so they are not accidentially auto\-assembled by nodes not supposed to own them\&.
.sp
(optional, string, no default)
.RE
.PP
\fBforce_stop\fR
.RS 4
If processes or kernel threads are using the array, it cannot be stopped\&. We will try to stop processes, first by sending TERM and then, if that doesn\*(Aqt help in 3 seconds, using KILL\&. The lsof(8) program is required to get the list of array users\&. Of course, the kernel threads cannot be stopped this way\&. If the processes are critical for data integrity, then set this parameter to false\&. Note that in that case the stop operation will fail and the node will be fenced\&.
.sp
(optional, boolean, default
true)
.RE
.PP
\fBudev\fR
.RS 4
Wait until udevd creates a device in the start operation\&. On a normally loaded host this should happen quickly, but you may be unlucky\&. If you are not using udev set this to "no"\&.
.sp
(optional, boolean, default
true)
.RE
.PP
\fBforce_clones\fR
.RS 4
Activating the same md RAID array on multiple nodes at the same time will result in data corruption and thus is forbidden by default\&.
.sp
A safe example could be an array that is only named identically across all nodes, but is in fact distinct\&.
.sp
Only set this to "true" if you know what you are doing!
.sp
(optional, boolean, default
false)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 20s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 20s\&.
.RE
.PP
\fBstatus\fR
.RS 4
Performs a status check\&. Suggested minimum timeout: 20s\&. Suggested interval: 10\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 20s\&. Suggested interval: 10\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 5\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a Raid1 resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_Raid1 ocf:heartbeat:Raid1 \e
  params \e
    raidconf=\fIstring\fR \e
    raiddev=\fIstring\fR \e
  op monitor depth="0" timeout="20s" interval="10" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a Raid1 resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_Raid1 ocf:heartbeat:Raid1 \e
  raidconf=\fIstring\fR \e
  raiddev=\fIstring\fR \e
  op monitor depth="0" timeout="20s" interval="10" 
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\m[blue]\fB\%http://clusterlabs.org/\fR\m[]
.SH "AUTHOR"
.PP
\fBClusterLabs contributors (see the resource agent source for information about individual authors)\fR