xenial (7) ocf_heartbeat_Filesystem.7.gz

NAME

       ocf_heartbeat_Filesystem - Manages filesystem mounts

SYNOPSIS

       Filesystem [start | stop | monitor | meta-data | validate-all]

DESCRIPTION

       Resource script for Filesystem. It manages a Filesystem on a shared storage medium.

       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:

       10: read first 16 blocks of the device (raw read)

       This doesn't 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.

       20: test if a status file can be written and read

       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.

SUPPORTED PARAMETERS

       device
           The name of block device for the filesystem, or -U, -L options for mount, or NFS mount specification.

           (required, string, no default)

       directory
           The mount point for the filesystem.

           (required, string, no default)

       fstype
           The type of filesystem to be mounted.

           (required, string, no default)

       options
           Any extra options to be given as -o options to mount.

           For bind mounts, add "bind" here and set fstype to "none". We will do the right thing for options
           such as "bind,ro".

           (optional, string, no default)

       statusfile_prefix
           The prefix to be used for a status file for resource monitoring with depth 20. If you don't specify
           this parameter, all status files will be created in a separate directory.

           (optional, string, default ".Filesystem_status/")

       run_fsck
           Specify how to decide whether to run fsck or not.

           "auto" : decide to run fsck depending on the fstype(default) "force" : always run fsck regardless of
           the fstype "no" : do not run fsck ever.

           (optional, string, default "auto")

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

           (optional, boolean, default yes)

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

           Only set this to "true" if you know what you are doing!

           (optional, boolean, default false)

       force_unmount
           This option allows specifying how to handle processes that are currently accessing the mount
           directory.

           "true" : Default value, 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.

           The 'safe' 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.

           (optional, boolean, default true)

SUPPORTED ACTIONS

       This resource agent supports the following actions (operations):

       start
           Starts the resource. Suggested minimum timeout: 60.

       stop
           Stops the resource. Suggested minimum timeout: 60.

       notify
           Suggested minimum timeout: 60.

       monitor
           Performs a detailed status check. Suggested minimum timeout: 40. Suggested interval: 20.

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

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

EXAMPLE CRM SHELL

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

           primitive p_Filesystem ocf:heartbeat:Filesystem \
             params \
               device=string \
               directory=string \
               fstype=string \
             op monitor depth="0" timeout="40" interval="20"

EXAMPLE PCS

       The following is an example configuration for a Filesystem resource using pcs(8)

           pcs resource create p_Filesystem ocf:heartbeat:Filesystem \
             device=string \
             directory=string \
             fstype=string \
             op monitor depth="0" timeout="40" interval="20"

SEE ALSO

       http://www.linux-ha.org/wiki/Filesystem_(resource_agent)

AUTHOR

       Linux-HA contributors (see the resource agent source for information about individual authors)