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

SUPPORTED ACTIONS

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

EXAMPLE CRM SHELL

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

EXAMPLE PCS

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

AUTHOR

161       ClusterLabs contributors (see the resource agent source for information
162       about individual authors)
163
164
165
166resource-agents UNKNOWN           01/25/2023           OCF_HEARTBEAT_FILESY(7)