summaryrefslogtreecommitdiffstats
path: root/rgmanager/src/resources/nfsclient.sh.in
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 07:52:36 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 07:52:36 +0000
commit7de03e4e519705301265c0415b3c0af85263a7ac (patch)
tree29d819c5227e3619d18a67d2a5dde963b3229dbe /rgmanager/src/resources/nfsclient.sh.in
parentInitial commit. (diff)
downloadresource-agents-7de03e4e519705301265c0415b3c0af85263a7ac.tar.xz
resource-agents-7de03e4e519705301265c0415b3c0af85263a7ac.zip
Adding upstream version 1:4.13.0.upstream/1%4.13.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'rgmanager/src/resources/nfsclient.sh.in')
-rwxr-xr-xrgmanager/src/resources/nfsclient.sh.in479
1 files changed, 479 insertions, 0 deletions
diff --git a/rgmanager/src/resources/nfsclient.sh.in b/rgmanager/src/resources/nfsclient.sh.in
new file mode 100755
index 0000000..ef68dbe
--- /dev/null
+++ b/rgmanager/src/resources/nfsclient.sh.in
@@ -0,0 +1,479 @@
+#!@BASH_SHELL@
+
+#
+# NFS Export Client handler agent script
+#
+#
+# Copyright (C) 1997-2003 Sistina Software, Inc. All rights reserved.
+# Copyright (C) 2004-2011 Red Hat, Inc. All rights reserved.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+#
+
+LC_ALL=C
+LANG=C
+PATH=/bin:/sbin:/usr/bin:/usr/sbin
+export LC_ALL LANG PATH
+
+. $(dirname $0)/ocf-shellfuncs
+
+meta_data()
+{
+ cat <<EOT
+<?xml version="1.0" ?>
+<!DOCTYPE resource-agent SYSTEM "ra-api-1-modified.dtd">
+<resource-agent version="rgmanager 2.0" name="nfsclient">
+ <version>1.0</version>
+
+ <longdesc lang="en">
+ This defines how a machine or group of machines may access
+ an NFS export on the cluster. IP addresses, IP wildcards,
+ hostnames, hostname wildcards, and netgroups are supported.
+ </longdesc>
+ <shortdesc lang="en">
+ Defines an NFS client.
+ </shortdesc>
+
+ <parameters>
+ <parameter name="name" unique="1" primary="1">
+ <longdesc lang="en">
+ This is a symbolic name of a client used to reference
+ it in the resource tree. This is NOT the same thing
+ as the target option.
+ </longdesc>
+ <shortdesc lang="en">
+ Client Name
+ </shortdesc>
+ <content type="string"/>
+ </parameter>
+
+ <parameter name="target" required="1">
+ <longdesc lang="en">
+ This is either a hostname, a wildcard (IP address or
+ hostname based), or a netgroup to which defining a
+ host or hosts to export to.
+ </longdesc>
+ <shortdesc lang="en">
+ Target Hostname, Wildcard, or Netgroup
+ </shortdesc>
+ <content type="string"/>
+ </parameter>
+
+ <parameter name="path" inherit="path">
+ <longdesc lang="en">
+ This is the path to export to the target. This
+ field is generally left blank, as it inherits the
+ path from the parent export.
+ </longdesc>
+ <shortdesc lang="en">
+ Path to Export
+ </shortdesc>
+ <content type="string"/>
+ </parameter>
+
+ <parameter name="svcname" inherit="service%name">
+ <longdesc lang="en">
+ </longdesc>
+ <shortdesc lang="en">
+ </shortdesc>
+ <content type="string"/>
+ </parameter>
+
+
+ <parameter name="fsid" inherit="fsid">
+ <longdesc lang="en">
+ File system ID inherited from the parent nfsexport/
+ clusterfs/fs resource. Putting fsid in the options
+ field will override this.
+ </longdesc>
+ <shortdesc lang="en">
+ File system ID
+ </shortdesc>
+ <content type="string"/>
+ </parameter>
+
+ <parameter name="options">
+ <longdesc lang="en">Defines a list of options for this
+ particular client. See 'man 5 exports' for a list
+ of available options.
+ </longdesc>
+ <shortdesc lang="en">
+ Export Options
+ </shortdesc>
+ <content type="string"/>
+ </parameter>
+
+ <parameter name="allow_recover">
+ <longdesc lang="en">
+ Allows recovery of this NFS client (default = 1) if it
+ disappears from the export list. If set to 0, the service
+ will be restarted. This is useful to help preserve export
+ ordering.
+ </longdesc>
+ <shortdesc lang="en">
+ Allow recovery
+ </shortdesc>
+ <content type="boolean"/>
+ </parameter>
+
+ <parameter name="service_name" inherit="service%name">
+ <longdesc lang="en">
+ Service this NFS export belongs to. Used for caching
+ exports on a per-service basis.
+ </longdesc>
+ <shortdesc lang="en">
+ Service Name
+ </shortdesc>
+ <content type="string"/>
+ </parameter>
+
+ <parameter name="use_cache" inherit="service%nfs_client_cache">
+ <longdesc lang="en">
+ On systems with large numbers of exports, a performance
+ problem in the exportfs command can cause inordinately long
+ status check times for services with lots of mounted
+ NFS clients. This occurs because exportfs does DNS queries
+ on all clients in the export list.
+
+ Setting this option to '1' will enable caching of the export
+ list returned from the exportfs command on a per-service
+ basis. The cache will last for 30 seconds before expiring
+ instead of being generated each time an nfsclient resource
+ is called.
+ </longdesc>
+ <shortdesc lang="en">
+ Enable exportfs list caching
+ </shortdesc>
+ <content type="integer"/>
+ </parameter>
+
+
+ </parameters>
+
+ <actions>
+ <action name="start" timeout="90"/>
+ <action name="stop" timeout="5"/>
+ <action name="recover" timeout="90"/>
+
+ <!-- Checks to see if the export exists in /var/lib/nfs/etab -->
+ <action name="status" timeout="5" interval="1m"/>
+ <action name="monitor" timeout="5" interval="1m"/>
+
+ <action name="meta-data" timeout="5"/>
+ <action name="validate-all" timeout="30"/>
+ </actions>
+
+</resource-agent>
+EOT
+}
+
+
+verify_options()
+{
+ declare o
+ declare -i ret=0
+
+ [ -z "$OCF_RESKEY_options" ] && return 0
+
+ #
+ # From exports(5)
+ #
+ for o in `echo $OCF_RESKEY_options | sed -e s/,/\ /g`; do
+ case $o in
+ fsid=*)
+ ocf_log debug "Using designated $o instead of fsid=$OCF_RESKEY_fsid"
+ unset OCF_RESKEY_fsid
+ ;;
+ secure)
+ ;;
+ insecure)
+ ;;
+ sec=*)
+ ;;
+ rw)
+ ;;
+ ro)
+ ;;
+ async)
+ ;;
+ sync)
+ ;;
+ wdelay)
+ ;;
+ no_wdelay)
+ ;;
+ hide)
+ ;;
+ nohide)
+ ;;
+ subtree_check)
+ ;;
+ no_subtree_check)
+ ;;
+ secure_locks)
+ ;;
+ insecure_locks)
+ ;;
+ auth_nlm)
+ ;;
+ no_auth_nlm)
+ ;;
+ mountpoint=*)
+ ;;
+ mp=*)
+ ;;
+ root_squash)
+ ;;
+ no_root_squash)
+ ;;
+ all_squash)
+ ;;
+ no_all_squash)
+ ;;
+ anonuid=*)
+ ;;
+ anongid=*)
+ ;;
+ *)
+ ocf_log err "Export Option $o invalid"
+ ret=$OCF_ERR_ARGS
+ ;;
+ esac
+ done
+
+ return $ret
+}
+
+
+verify_target()
+{
+ # XXX need to add wildcards, hostname, ip, etc.
+ [ -n "$OCF_RESKEY_target" ] && return 0
+
+ return $OCF_ERR_ARGS
+}
+
+
+verify_path()
+{
+ if [ -z "$OCF_RESKEY_path" ]; then
+ ocf_log err "No export path specified."
+ return $OCF_ERR_ARGS
+ fi
+
+ OCF_RESKEY_path="${OCF_RESKEY_path%/}"
+
+ [ -d "$OCF_RESKEY_path" ] && return 0
+
+ ocf_log err "$OCF_RESKEY_path is not a directory"
+
+ return $OCF_ERR_ARGS
+}
+
+
+verify_type()
+{
+ [ -z "$OCF_RESKEY_type" ] && return 0
+ [ "$OCF_RESKEY_type" = "nfs" ] && return 0
+
+ ocf_log err "Export type $OCF_RESKEY_type not supported yet"
+ return $OCF_ERR_ARGS
+}
+
+
+verify_all()
+{
+ declare -i ret=0
+
+ verify_type || ret=$OCF_ERR_ARGS
+ verify_options || ret=$OCF_ERR_ARGS
+ verify_target || ret=$OCF_ERR_ARGS
+ verify_path || ret=$OCF_ERR_ARGS
+
+ return $ret
+}
+
+
+case $1 in
+start)
+ declare option_str
+
+ verify_all || exit $OCF_ERR_ARGS
+
+ #
+ # XXX
+ # Bad: Side-effect of verify_options: unset OCF_RESKEY_fsid if
+ # fsid is specified in the options string.
+ #
+ if [ -z "$OCF_RESKEY_options" ] && [ -n "$OCF_RESKEY_fsid" ]; then
+ option_str="fsid=$OCF_RESKEY_fsid"
+ elif [ -n "$OCF_RESKEY_options" ] && [ -z "$OCF_RESKEY_fsid" ]; then
+ option_str="$OCF_RESKEY_options"
+ elif [ -n "$OCF_RESKEY_fsid" ] && [ -n "$OCF_RESKEY_options" ]; then
+ option_str="fsid=$OCF_RESKEY_fsid,$OCF_RESKEY_options"
+ fi
+
+ if [ -z "$option_str" ]; then
+ ocf_log info "Adding export: ${OCF_RESKEY_target}:${OCF_RESKEY_path}"
+ exportfs -i "${OCF_RESKEY_target}:${OCF_RESKEY_path}"
+ rv=$?
+ else
+ ocf_log info "Adding export: ${OCF_RESKEY_target}:${OCF_RESKEY_path} ($option_str)"
+ exportfs -i -o $option_str "${OCF_RESKEY_target}:${OCF_RESKEY_path}"
+ rv=$?
+ fi
+ ;;
+
+stop)
+ verify_all || exit $OCF_ERR_ARGS
+
+ $0 status
+ rv=$?
+ if [ $rv -eq 0 ]; then
+ ocf_log info "Removing export: ${OCF_RESKEY_target}:${OCF_RESKEY_path}"
+ exportfs -u "${OCF_RESKEY_target}:${OCF_RESKEY_path}"
+ rv=$?
+ else
+ # If status check fails then there is no matching nfs export for
+ # this resource.
+ rv=0
+ fi
+ ;;
+
+status|monitor)
+ verify_all || exit $OCF_ERR_ARGS
+
+ if [ "${OCF_RESKEY_target}" = "*" ]; then
+ export OCF_RESKEY_target="\<world\>"
+ fi
+
+ #
+ # Status check fix from Birger Wathne:
+ # * Exports longer than 14 chars have line breaks inserted, which
+ # broke the way the status check worked.
+ #
+ # Status check fix from Craig Lewis:
+ # * Exports with RegExp metacharacters need to be escaped.
+ # These metacharacters are: * ? .
+ #
+ export OCF_RESKEY_target_regexp=$(echo $OCF_RESKEY_target | \
+ sed -e 's/*/[*]/g' -e 's/?/[?]/g' -e 's/\./\\./g')
+
+ declare tmpfn
+ declare time_created time_now
+ declare -i delta=0
+
+ #
+ # Don't let anyone read the cache files.
+ #
+ umask 066
+
+ mkdir -p /var/cache/cluster
+
+ if [ -n "$OCF_RESKEY_service_name" ] && [ "$OCF_RESKEY_use_cache" = "1" ]; then
+
+ #
+ # For large #s of exports, we need to cache the information
+ #
+ tmpfn=/var/cache/cluster/nfsclient-status-cache-$OCF_RESKEY_service_name
+
+ if [ -f "$tmpfn" ]; then
+ time_created=$(stat -c "%Y" $tmpfn)
+ time_now=$(date +"%s")
+ delta=$((time_now-time_created))
+ fi
+ #echo "Cache age = $delta seconds"
+ else
+ delta=100
+ #
+ # Create a different file if this is a separate instance
+ #
+ tmpfn=/var/cache/cluster/nfsclient-status-cache-$$
+ fi
+
+ if ! [ -f "$tmpfn" ] || [ $delta -gt 30 ]; then
+ #echo "Create $tmpfn. Nonexistent / expired / no service name"
+ exportfs -v > $tmpfn
+ fi
+
+ cat $tmpfn | tr -d "\n" | sed -e 's/([^)]*)/\n/g' | grep -Piq \
+ "^${OCF_RESKEY_path}[\t ]+${OCF_RESKEY_target_regexp}"
+ rv=$?
+
+ if [ $rv -eq 0 ]; then
+ [ "$OCF_RESKEY_use_cache" = "1" ] || rm -f $tmpfn
+ exit 0
+ fi
+
+ declare OCF_RESKEY_target_tmp
+ OCF_RESKEY_target_tmp=$(clufindhostname -i "$OCF_RESKEY_target")
+ if [ $? -ne 0 ]; then
+ OCF_RESKEY_target_tmp=$(clufindhostname -n "$OCF_RESKEY_target")
+ if [ $? -ne 0 ]; then
+ [ "$OCF_RESKEY_use_cache" = "1" ] || rm -f $tmpfn
+ ocf_log err "nfsclient:$OCF_RESKEY_name is missing!"
+ exit 1
+ fi
+ fi
+
+ cat $tmpfn | tr -d "\n" | sed -e 's/([^)]*)/\n/g' | grep -Pq \
+ "^${OCF_RESKEY_path}[\t ]+${OCF_RESKEY_target_tmp}"
+ rv=$?
+
+ [ "$OCF_RESKEY_use_cache" = "1" ] || rm -f $tmpfn
+ if [ $rv -eq 0 ]; then
+ exit 0
+ fi
+
+ ocf_log err "nfsclient:$OCF_RESKEY_name is missing!"
+ exit $OCF_NOT_RUNNING
+ ;;
+
+recover)
+ if [ "$OCF_RESKEY_allow_recover" = "0" ] || \
+ [ "$OCF_RESKEY_allow_recover" = "no" ] || \
+ [ "$OCF_RESKEY_allow_recover" = "false" ]; then
+ exit 1
+ fi
+
+ $0 stop || exit 1
+ $0 start || exit 1
+ ;;
+
+restart)
+ #
+ # Recover might better be "exportfs -r" - reexport
+ #
+ $0 stop || exit 1
+ $0 start || exit 1
+ ;;
+
+meta-data)
+ meta_data
+ exit 0
+ ;;
+
+validate-all)
+ verify_all
+ rv=$?
+ ;;
+
+*)
+ echo "usage: $0 {start|stop|status|monitor|restart|meta-data|validate-all}"
+ rv=$OCF_ERR_UNIMPLEMENTED
+ ;;
+esac
+
+exit $rv