c03b99a800da8a7068d6da0e178b57e28175bb8e
[sfrench/samba-autobuild/.git] / ctdb / doc / examples / nfs-ganesha-callout
1 #!/bin/sh
2
3 # This is an example CTDB NFS callout script for Ganesha.  It is based
4 # on the last version of 60.ganesha shipped with CTDB.  As such, it
5 # does not try to monitor RPC services that were not monitored by
6 # 60.ganesha - this might be a useful improvement.  It has also not
7 # been properly tested.
8
9 # You should check your version of NFS Ganesha to see if it ships with
10 # a newer callout.
11
12 # To use this:
13 #
14 # * Set CTDB_NFS_CALLOUT in your CTDB configuration to point to this
15 #   script
16 #
17 # * Rename the following files in nfs-checks.d so that they no longer
18 #   have the ".check" suffix:
19 #     * 10.status.check
20 #     * 20.nfs.check
21 #     * 30.nlockmgr.check
22 #     * 40.mountd.check
23 #     * 50.rquotad.check
24 #
25 # * Install 20.nfs-ganesha.check to nfs-checks.d/20.nfs.check
26 #
27 # * It is recommended, but not required, to install the grace_period
28 #   script (usually shipped in a utils package for NFS-Ganesha) to
29 #   /usr/bin/grace_period
30
31 # I (Martin Schwenke) hereby relicense all of my contributions to this
32 # callout (and, previously, to 60.ganesha) to a license compatible
33 # with NFS Ganesha (right now this is LGPLv3, but I'm flexible).
34 # There may be other contributions to be considered for relicensing,
35 # particularly those in commit 28cbe527d47822f870e8252495ab2a1c8fddd12f.
36
37 ######################################################################
38
39 # Exit on 1st error
40 set -e
41
42 # Filesystem type and mount point for the (typically clustered)
43 # volume that will contain the NFS-Ganesha state.
44 state_fs="${CTDB_NFS_STATE_FS_TYPE:-gpfs}"
45 state_dir="${CTDB_NFS_STATE_MNT}" # No sane default.
46
47 # To change the following, edit the default values below.  Do not set
48 # these - they aren't configuration variables, just hooks for testing.
49 nfs_exports_file="${CTDB_NFS_EXPORTS_FILE:-/etc/ganesha/ganesha.conf}"
50 nfs_service="${CTDB_NFS_SERVICE:-nfs-ganesha}"
51 ganesha_rec_subdir=${CTDB_GANESHA_REC_SUBDIR:-.ganesha}
52 procfs=${PROCFS_PATH:-/proc}
53
54 case $state_fs in
55 gpfs)
56         GANRECDIR="/var/lib/nfs/ganesha"
57         ;;
58 glusterfs)
59         if [ -z "${state_dir}" ]; then
60                 echo "CTDB_NFS_STATE_MNT not defined for GlusterFS"
61                 exit 1
62         fi
63         host=`hostname`
64         NODESTATEDIR="$state_dir/nfs-ganesha/$host"
65         GANSTATEDIR="$state_dir/nfs-ganesha/.noderefs"
66         NODESTATELN="$GANSTATEDIR/$host"
67         ;;
68 esac
69
70
71 ##################################################
72
73 usage ()
74 {
75         _c=$(basename $0)
76         cat <<EOF
77 usage: $_c { shutdown | startup }
78        $_c { stop | start | check } nfs
79        $_c { releaseip | takeip }
80        $_c { monitor-list-shares }
81 EOF
82     exit 1
83 }
84
85
86 ##################################################
87 # Basic service stop and start
88
89 basic_stop ()
90 {
91         case "$1" in
92         nfs)
93                 service "$nfs_service" stop
94                 ;;
95         *)
96                 usage
97         esac
98 }
99
100 basic_start ()
101 {
102         case "$1" in
103         nfs)
104                 service "$nfs_service" start
105                 ;;
106         *)
107                 usage
108         esac
109 }
110
111 ##################################################
112 # "stop" and "start" options for restarting
113
114 service_stop ()
115 {
116     case "$1" in
117         nfs)
118             basic_stop "nfs"
119             ;;
120         nlockmgr)
121             # Do nothing - used by statd-callout
122             :
123             ;;
124         *)
125             usage
126     esac
127 }
128
129 service_start ()
130 {
131         case "$1" in
132         nfs)
133                 basic_start "nfs"
134                 ;;
135         nlockmgr)
136                 # Do nothing - used by statd-callout
137                 :
138                 ;;
139         *)
140                 usage
141         esac
142 }
143
144 ##################################################
145 # Nitty gritty - monitoring and IP handling
146
147 # Check that a symlink exists, create it otherwise.
148 # Usage: check_ln <TARGET> <LINK>
149 check_ln ()
150 {
151         if [ ! -L "${2}" ] ; then
152                 rm -vrf "${2}"
153         else
154                 _t=$(readlink "${2}")
155                 if [ "$_t" != "${1}" ] ; then
156                         rm -v "${2}"
157                 fi
158         fi
159         # This is not an "else".  It also re-creates the link if it was
160         # removed above!
161         if [ ! -e "${2}" ]; then
162                 ln -sfv "${1}" "${2}"
163         fi
164 }
165
166 # Return 'active' if the shared filesystem is accessible.
167 get_cluster_fs_state ()
168 {
169         case $state_fs in
170         gpfs)
171                 /usr/lpp/mmfs/bin/mmgetstate | awk 'NR == 4 { print $3 }'
172                 ;;
173         glusterfs)
174                 # Since we're past create_ganesha_recdirs(), we're active.
175                 echo "active"
176                 ;;
177         *)
178                 echo "File system $state_fs not supported"
179                 exit 1
180                 ;;
181         esac
182 }
183
184 create_ganesha_recdirs ()
185 {
186         if ! _mounts=$(mount | grep $state_fs); then
187                 echo "Failed to find mounts of type $state_fs"
188                 exit 1
189         fi
190         if [ -z "$_mounts" ]; then
191                 echo "startup $state_fs not ready"
192                 exit 0
193         fi
194
195         case $state_fs in
196         gpfs)
197                 _mntpt=$(echo "$_mounts" | sort | awk 'NR == 1 {print $3}')
198                 _link_dst="${_mntpt}/${ganesha_rec_subdir}"
199                 mkdir -vp "$_link_dst"
200                 check_ln "$_link_dst" "$GANRECDIR"
201                 ;;
202         glusterfs)
203                 [ -d /var/lib/nfs.backup ] || \
204                         mv /var/lib/nfs /var/lib/nfs.backup
205                 check_ln ${NODESTATEDIR} /var/lib/nfs
206
207                 mkdir -p ${NODESTATEDIR}/ganesha/v4recov
208                 mkdir -p ${NODESTATEDIR}/ganesha/v4old
209                 mkdir -p ${NODESTATEDIR}/statd/sm
210                 mkdir -p ${NODESTATEDIR}/statd/sm.bak
211                 touch ${NODESTATEDIR}/state
212                 touch ${NODESTATEDIR}/statd/state
213
214                 mkdir -p ${GANSTATEDIR}
215                 check_ln ${NODESTATEDIR} ${NODESTATELN}
216                 for node in `ls ${GANSTATEDIR}`; do
217                         if [ "${node}" != "${host}" ]; then
218                                 check_ln ${GANSTATEDIR}/${node}/ganesha \
219                                          ${NODESTATEDIR}/ganesha/${node}
220                                 check_ln ${GANSTATEDIR}/${node}/statd \
221                                          ${NODESTATEDIR}/statd/${node}
222                         fi
223                 done
224                 ;;
225         esac
226 }
227
228 service_check ()
229 {
230         create_ganesha_recdirs
231
232         # Always succeed if cluster filesystem is not active
233         _cluster_fs_state=$(get_cluster_fs_state)
234         if [ $_cluster_fs_state != "active" ] ; then
235                 return 0
236         fi
237
238         # Check that NFS Ganesha is running, according to PID file
239         _pidfile="/var/run/ganesha.pid"
240         _ganesha="/usr/bin/ganesha.nfsd"
241         if ! { read _pid < "$_pidfile" && \
242                 grep "$_ganesha" "${procfs}/${_pid}/cmdline" ; } >/dev/null 2>&1
243         then
244
245                 echo "ERROR: NFS Ganesha not running according to PID file"
246                 return 1
247         fi
248
249         return 0
250 }
251
252 #-------------------------------------------------
253
254 nfs_releaseip ()
255 {
256         if [ -x "/usr/bin/grace_period" ]; then
257                 /usr/bin/grace_period "2:${2}"
258         else
259                 dbus-send --print-reply --system --dest=org.ganesha.nfsd \
260                           /org/ganesha/nfsd/admin org.ganesha.nfsd.admin.grace \
261                           string:"2:${2}"
262         fi
263 }
264
265 nfs_takeip ()
266 {
267         case  $state_fs in
268         glusterfs)
269                 check_ln ${NODESTATEDIR} ${GANSTATEDIR}/${2}
270                 ;;
271         esac
272         if [ -x "/usr/bin/grace_period" ]; then
273                 /usr/bin/grace_period "5:${2}"
274         else
275                 dbus-send --print-reply --system --dest=org.ganesha.nfsd \
276                           /org/ganesha/nfsd/admin org.ganesha.nfsd.admin.grace \
277                           string:"5:${2}"
278         fi
279 }
280
281 ##################################################
282 # service init startup and final shutdown
283
284 nfs_shutdown ()
285 {
286         basic_stop "nfs"
287 }
288
289 nfs_startup ()
290 {
291         basic_stop "nfs" || true
292
293         create_ganesha_recdirs
294
295         basic_start "nfs"
296         _f="${procfs}/sys/net/ipv4/tcp_tw_recycle"
297         if [ "$_f" ] ; then
298                 echo 1 >"$_f"
299         fi
300 }
301
302 ##################################################
303 # list share directories
304
305 nfs_monitor_list_shares ()
306 {
307         grep Path $nfs_exports_file |
308                 cut -f2 -d\" |
309                 sort -u
310 }
311
312 ##################################################
313
314 nfs_register ()
315 {
316         cat <<EOF
317 shutdown
318 startup
319 stop
320 start
321 check
322 releaseip
323 takeip
324 monitor-list-shares
325 EOF
326 }
327
328 ##################################################
329
330 action="$1"
331 shift
332
333 case "$action" in
334 shutdown)            nfs_shutdown            ;;
335 startup)             nfs_startup             ;;
336 stop)                service_stop "$1"       ;;
337 start)               service_start "$1"      ;;
338 check)               service_check "$1"      ;;
339 releaseip)           nfs_releaseip "$@"      ;;
340 takeip)              nfs_takeip "$@"         ;;
341 monitor-list-shares) nfs_monitor_list_shares ;;
342 register)            nfs_register            ;;
343 monitor-pre|monitor-post|releaseip-pre|takeip-pre)
344         # Not required/implemented
345         :
346         ;;
347 *)
348         usage
349 esac