ocf_heartbeat_Filesystem(7)

1OCF_HEARTBEAT_FILESY(7)       OCF resource agents      OCF_HEARTBEAT_FILESY(7)
2
3
4

NAME

6       ocf_heartbeat_Filesystem - Manages filesystem mounts
7

SYNOPSIS

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

DESCRIPTION

12       Resource script for Filesystem. It manages a Filesystem on a shared
13       storage medium.
14
15       The standard monitor operation of depth 0 (also known as probe) checks
16       if the filesystem is mounted. If you want deeper tests, set
17       OCF_CHECK_LEVEL to one of the following values:
18
19       10: read first 16 blocks of the device (raw read)
20
21       This doesn't exercise the filesystem at all, but the device on which
22       the filesystem lives. This is noop for non-block devices such as NFS,
23       SMBFS, or bind mounts.
24
25       20: test if a status file can be written and read
26
27       The status file must be writable by root. This is not always the case
28       with an NFS mount, as NFS exports usually have the "root_squash" option
29       set. In such a setup, you must either use read-only monitoring
30       (depth=10), export with "no_root_squash" on your NFS server, or grant
31       world write permissions on the directory where the status file is to be
32       placed.
33

SUPPORTED PARAMETERS

35       device
36           The name of block device for the filesystem, or -U, -L options for
37           mount, or NFS mount specification.
38
39           (required, string, no default)
40
41       directory
42           The mount point for the filesystem.
43
44           (required, string, no default)
45
46       fstype
47           The type of filesystem to be mounted.
48
49           (required, string, no default)
50
51       options
52           Any extra options to be given as -o options to mount.
53
54           For bind mounts, add "bind" here and set fstype to "none". We will
55           do the right thing for options such as "bind,ro".
56
57           (optional, string, no default)
58
59       statusfile_prefix
60           The prefix to be used for a status file for resource monitoring
61           with depth 20. If you don't specify this parameter, all status
62           files will be created in a separate directory.
63
64           (optional, string, default ".Filesystem_status/")
65
66       run_fsck
67           Specify how to decide whether to run fsck or not.
68
69           "auto" : decide to run fsck depending on the fstype(default)
70           "force" : always run fsck regardless of the fstype "no" : do not
71           run fsck ever.
72
73           (optional, string, default "auto")
74
75       fast_stop
76           Normally, we expect no users of the filesystem and the stop
77           operation to finish quickly. If you cannot control the filesystem
78           users easily and want to prevent the stop action from failing, then
79           set this parameter to "no" and add an appropriate timeout for the
80           stop operation.
81
82           This defaults to "no" for GFS2 filesystems.
83
84           (optional, boolean, default no)
85
86       force_clones
87           The use of a clone setup for local filesystems is forbidden by
88           default. For special setups like glusterfs, cloning a mount of a
89           local device with a filesystem like ext4 or xfs independently on
90           several nodes is a valid use case.
91
92           Only set this to "true" if you know what you are doing!
93
94           (optional, boolean, default false)
95
96       force_unmount
97           This option allows specifying how to handle processes that are
98           currently accessing the mount directory.
99
100           "true" : Kill processes accessing mount point "safe" : Kill
101           processes accessing mount point using methods that avoid functions
102           that could potentially block during process detection "false" : Do
103           not kill any processes.
104
105           The 'safe' option uses shell logic to walk the /procs/ directory
106           for pids using the mount point while the default option uses the
107           fuser cli tool. fuser is known to perform operations that can
108           potentially block if unresponsive nfs mounts are in use on the
109           system.
110
111           (optional, boolean, default safe)
112

SUPPORTED ACTIONS

114       This resource agent supports the following actions (operations):
115
116       start
117           Starts the resource. Suggested minimum timeout: 60s.
118
119       stop
120           Stops the resource. Suggested minimum timeout: 60s.
121
122       monitor
123           Performs a detailed status check. Suggested minimum timeout: 40s.
124           Suggested interval: 20s.
125
126       validate-all
127           Performs a validation of the resource configuration. Suggested
128           minimum timeout: 5s.
129
130       meta-data
131           Retrieves resource agent metadata (internal use only). Suggested
132           minimum timeout: 5s.
133

EXAMPLE CRM SHELL

135       The following is an example configuration for a Filesystem resource
136       using the crm(8) shell:
137
138           primitive p_Filesystem ocf:heartbeat:Filesystem \
139             params \
140               device=string \
141               directory=string \
142               fstype=string \
143             op monitor depth="0" timeout="40s" interval="20s"
144

EXAMPLE PCS

146       The following is an example configuration for a Filesystem resource
147       using pcs(8)
148
149           pcs resource create p_Filesystem ocf:heartbeat:Filesystem \
150             device=string \
151             directory=string \
152             fstype=string \
153             op monitor OCF_CHECK_LEVEL="0" timeout="40s" interval="20s"
154

AUTHOR

159       ClusterLabs contributors (see the resource agent source for information
160       about individual authors)
161
162
163
164resource-agents UNKNOWN           04/06/2022           OCF_HEARTBEAT_FILESY(7)