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           (optional, boolean, default yes)
83
84       force_clones
85           The use of a clone setup for local filesystems is forbidden by
86           default. For special setups like glusterfs, cloning a mount of a
87           local device with a filesystem like ext4 or xfs independently on
88           several nodes is a valid use case.
89
90           Only set this to "true" if you know what you are doing!
91
92           (optional, boolean, default false)
93
94       force_unmount
95           This option allows specifying how to handle processes that are
96           currently accessing the mount directory.
97
98           "true" : Default value, kill processes accessing mount point "safe"
99           : Kill processes accessing mount point using methods that avoid
100           functions that could potentially block during process detection
101           "false" : Do not kill any processes.
102
103           The 'safe' option uses shell logic to walk the /procs/ directory
104           for pids using the mount point while the default option uses the
105           fuser cli tool. fuser is known to perform operations that can
106           potentially block if unresponsive nfs mounts are in use on the
107           system.
108
109           (optional, boolean, default true)
110

SUPPORTED ACTIONS

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

EXAMPLE CRM SHELL

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

EXAMPLE PCS

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

AUTHOR

157       ClusterLabs contributors (see the resource agent source for information
158       about individual authors)
159
160
161
162resource-agents UNKNOWN           03/09/2020           OCF_HEARTBEAT_FILESY(7)