NAME

       ocf_heartbeat_LVM-activate - This agent activates/deactivates logical volumes.

SYNOPSIS

       LVM-activate [start | stop | monitor | meta-data | validate-all]

DESCRIPTION

       This agent manages LVM activation/deactivation work for a given volume group.

       It supports the following modes, controlled by the vg_access_mode parameter:

       * lvmlockd * system_id * clvmd * tagging

       Notes:

       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!

       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.

       3. The autoactivation property of volume group will be disabled when vg_access_mode is set to system_id.

       Option: OCF_CHECK_LEVEL

       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:

       10: read first 1 byte of the underlying device (raw read)

       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.

SUPPORTED PARAMETERS

       vgname
           The volume group name.

           (required, string, no default)

       lvname
           If set, only the specified LV will be activated.

           (optional, string, no default)

       vg_access_mode
           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.

           (required, string, no default)

       activation_mode
           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.

           This option only has effect on "lvmlockd"/"clvmd" vg_access_mode. For "system_id" and "tagging", they
           always mean exclusive activation.

           (optional, string, default "exclusive")

       tag
           The tag used for tagging activation mode.

           (optional, string, default "pacemaker")

       partial_activation
           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.

           (optional, string, default "false")

       degraded_activation
           Activate RAID LVs using the "degraded" activation mode. This allows RAID LVs to be activated with
           missing PVs if all data can be provided with RAID redundancy. The RAID level determines the number of
           PVs that are required for degraded activation to succeed. If fewer PVs are available, then degraded
           activation will fail. Also enable majority_pvs.

           (optional, string, default "false")

       majority_pvs
           If set, the VG system ID can be reassigned to a new host if a majority of PVs in the VG are present.
           Otherwise, VG failover with system ID will fail when the VG is missing PVs. Also enable
           degraded_activation when RAID LVs are used.

           (optional, string, default "false")

SUPPORTED ACTIONS

       This resource agent supports the following actions (operations):

       start
           Starts the resource. Suggested minimum timeout: 90s.

       stop
           Stops the resource. Suggested minimum timeout: 90s.

       monitor
           Performs a detailed status check. Suggested minimum timeout: 90s. Suggested interval: 30s.

       meta-data
           Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 10s.

       validate-all
           Performs a validation of the resource configuration. Suggested minimum timeout: 20s.

EXAMPLE CRM SHELL

       The following is an example configuration for a LVM-activate resource using the crm(8) shell:

           primitive p_LVM-activate ocf:heartbeat:LVM-activate \
             params \
               vgname=string \
               vg_access_mode=string \
             op monitor timeout="90s" interval="30s" depth="0"

EXAMPLE PCS

       The following is an example configuration for a LVM-activate resource using pcs(8)

           pcs resource create p_LVM-activate ocf:heartbeat:LVM-activate \
             vgname=string \
             vg_access_mode=string \
             op monitor timeout="90s" interval="30s" OCF_CHECK_LEVEL="0"

SEE ALSO

       http://clusterlabs.org/

AUTHOR

       ClusterLabs contributors (see the resource agent source for information about individual authors)

resource-agents 4.15.1-1ubuntu                     08/29/2024                             OCF_HEARTBEAT_LVM-A(7)