'\" t
.\"     Title: ocf_heartbeat_LVM-activate
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 12/17/2020
.\"    Manual: OCF resource agents
.\"    Source: resource-agents UNKNOWN
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_LVM\-A" "7" "12/17/2020" "resource-agents UNKNOWN" "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_LVM-activate \- This agent activates/deactivates logical volumes\&.
.SH "SYNOPSIS"
.HP \w'\fBLVM\-activate\fR\ 'u
\fBLVM\-activate\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
This agent manages LVM activation/deactivation work for a given volume group\&.
.PP
It supports the following modes, controlled by the vg_access_mode parameter:
.PP
* lvmlockd * system_id * clvmd * tagging
.PP
Notes:
.PP
1\&. There are two possible configuration combinations: lvmlockd+LVM\-activate and clvm+LVM\-activate\&. However, it is not possible to use both at the same time!
.PP
2\&. Put all "lvmlockd"/"clvmd" volume groups into auto management by the agent if using the cluster to manage at least one of them\&. If you manage some manually, the stop action of the lvmlockd agent may fail and the node may get fenced, because some DLM lockspaces might be in use and cannot be closed automatically\&.
.PP
Option: OCF_CHECK_LEVEL
.PP
The standard monitor operation of depth 0 checks if the VG or LV is valid\&. If you want deeper tests, set OCF_CHECK_LEVEL to 10:
.PP
10: read first 1 byte of the underlying device (raw read)
.PP
If there are many underlying devs in VG, it will only read one of the devs\&. This is not perfect solution for detecting underlying devices livable\&. e\&.g\&. iscsi SAN IO timeout will return EIO, and it makes monitor failed\&.
.PP
.SH "SUPPORTED PARAMETERS"
.PP
\fBvgname\fR
.RS 4
The volume group name\&.
.sp
(required, string, no default)
.RE
.PP
\fBlvname\fR
.RS 4
If set, only the specified LV will be activated\&.
.sp
(optional, string, no default)
.RE
.PP
\fBvg_access_mode\fR
.RS 4
This option decides which solution will be used to protect the volume group in cluster environment\&. Optional solutions are: lvmlockd, clvmd, system_id and tagging\&.
.sp
(required, string, no default)
.RE
.PP
\fBactivation_mode\fR
.RS 4
The activation mode decides the visibility of logical volumes in the cluster\&. There are two different modes: "shared" for cluster filesystem and "exclusive" for local filesystem\&. With "shared", an LV can be activated concurrently from multiple nodes\&. With "exclusive", an LV can be activated by one node at a time\&.
.sp
This option only has effect on "lvmlockd"/"clvmd" vg_access_mode\&. For "system_id" and "tagging", they always mean exclusive activation\&.
.sp
(optional, string, default "exclusive")
.RE
.PP
\fBtag\fR
.RS 4
The tag used for tagging activation mode\&.
.sp
(optional, string, default "pacemaker")
.RE
.PP
\fBpartial_activation\fR
.RS 4
If set, the volume group will be activated partially even with some physical volumes missing\&. It helps to set to true when using mirrored logical volumes\&.
.sp
(optional, string, 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: 90s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 90s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 90s\&. Suggested interval: 30s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 10s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 20s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a LVM\-activate resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_LVM\-activate ocf:heartbeat:LVM\-activate \e
  params \e
    vgname=\fIstring\fR \e
    vg_access_mode=\fIstring\fR \e
  op monitor timeout="90s" interval="30s" depth="0" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a LVM\-activate resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_LVM\-activate ocf:heartbeat:LVM\-activate \e
  vgname=\fIstring\fR \e
  vg_access_mode=\fIstring\fR \e
  op monitor timeout="90s" interval="30s" OCF_CHECK_LEVEL="0" 
.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