'\" t
.\"     Title: ocf_heartbeat_Filesystem
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 04/13/2023
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.12.0-2
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_FILESY" "7" "04/13/2023" "resource-agents 4.12.0-2" "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_Filesystem \- Manages filesystem mounts
.SH "SYNOPSIS"
.HP \w'\fBFilesystem\fR\ 'u
\fBFilesystem\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Resource script for Filesystem\&. It manages a Filesystem on a shared storage medium\&.
.PP
The standard monitor operation of depth 0 (also known as probe) checks if the filesystem is mounted\&. If you want deeper tests, set OCF_CHECK_LEVEL to one of the following values:
.PP
10: read first 16 blocks of the device (raw read)
.PP
This doesn\*(Aqt exercise the filesystem at all, but the device on which the filesystem lives\&. This is noop for non\-block devices such as NFS, SMBFS, or bind mounts\&.
.PP
20: test if a status file can be written and read
.PP
The status file must be writable by root\&. This is not always the case with an NFS mount, as NFS exports usually have the "root_squash" option set\&. In such a setup, you must either use read\-only monitoring (depth=10), export with "no_root_squash" on your NFS server, or grant world write permissions on the directory where the status file is to be placed\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBdevice\fR
.RS 4
The name of block device for the filesystem, or \-U, \-L options for mount, or NFS mount specification\&.
.sp
NOTE: On Linux /dev/disk/by\-{uuid,label}/ are preferred to \-U/\-L\&.
.sp
(required, string, no default)
.RE
.PP
\fBdirectory\fR
.RS 4
The mount point for the filesystem\&.
.sp
(required, string, no default)
.RE
.PP
\fBfstype\fR
.RS 4
The type of filesystem to be mounted\&.
.sp
(required, string, no default)
.RE
.PP
\fBoptions\fR
.RS 4
Any extra options to be given as \-o options to mount\&.
.sp
For bind mounts, add "bind" here and set fstype to "none"\&. We will do the right thing for options such as "bind,ro"\&.
.sp
(optional, string, no default)
.RE
.PP
\fBstatusfile_prefix\fR
.RS 4
The prefix to be used for a status file for resource monitoring with depth 20\&. If you don\*(Aqt specify this parameter, all status files will be created in a separate directory\&.
.sp
(optional, string, default "\&.Filesystem_status/")
.RE
.PP
\fBrun_fsck\fR
.RS 4
Specify how to decide whether to run fsck or not\&.
.sp
"auto" : decide to run fsck depending on the fstype(default) "force" : always run fsck regardless of the fstype "no" : do not run fsck ever\&.
.sp
(optional, string, default "auto")
.RE
.PP
\fBfast_stop\fR
.RS 4
Normally, we expect no users of the filesystem and the stop operation to finish quickly\&. If you cannot control the filesystem users easily and want to prevent the stop action from failing, then set this parameter to "no" and add an appropriate timeout for the stop operation\&.
.sp
This defaults to "no" for GFS2 filesystems\&.
.sp
(optional, boolean, default
no)
.RE
.PP
\fBforce_clones\fR
.RS 4
The use of a clone setup for local filesystems is forbidden by default\&. For special setups like glusterfs, cloning a mount of a local device with a filesystem like ext4 or xfs independently on several nodes is a valid use case\&.
.sp
Only set this to "true" if you know what you are doing!
.sp
(optional, boolean, default
false)
.RE
.PP
\fBforce_unmount\fR
.RS 4
This option allows specifying how to handle processes that are currently accessing the mount directory\&.
.sp
"true" : Kill processes accessing mount point "safe" : Kill processes accessing mount point using methods that avoid functions that could potentially block during process detection "false" : Do not kill any processes\&.
.sp
The \*(Aqsafe\*(Aq option uses shell logic to walk the /procs/ directory for pids using the mount point while the default option uses the fuser cli tool\&. fuser is known to perform operations that can potentially block if unresponsive nfs mounts are in use on the system\&.
.sp
(optional, boolean, default
true)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 60s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 60s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 40s\&. Suggested interval: 20s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 5s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a Filesystem resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_Filesystem ocf:heartbeat:Filesystem \e
  params \e
    device=\fIstring\fR \e
    directory=\fIstring\fR \e
    fstype=\fIstring\fR \e
  op monitor depth="0" timeout="40s" interval="20s" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a Filesystem resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_Filesystem ocf:heartbeat:Filesystem \e
  device=\fIstring\fR \e
  directory=\fIstring\fR \e
  fstype=\fIstring\fR \e
  op monitor OCF_CHECK_LEVEL="0" timeout="40s" interval="20s" 
.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