tomcat
No OneTemporary
Actions

Size

18 KB

Referenced Files

None

Subscribers

None

tomcat
View Options

	#!/bin/sh
	#
	# Description: Manages a Tomcat Server as an OCF High-Availability
	# resource under Heartbeat/LinuxHA control
	#
	# 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., 51 Franklin Street, Fifth Floor, Boston, MA
	# 02110-1301, USA.
	#
	# Copyright (c) 2007 NIPPON TELEGRAPH AND TELEPHONE CORPORATION
	#
	#######################################################################
	# OCF parameters:
	# OCF_RESKEY_tomcat_name - The name of the resource. Default is tomcat
	# OCF_RESKEY_script_log - A destination of the log of this script. Default /var/log/OCF_RESKEY_tomcat_name.log
	# OCF_RESKEY_tomcat_stop_timeout - Time-out at the time of the stop. Default is 5. DEPRECATED
	# OCF_RESKEY_tomcat_suspend_trialcount - The re-try number of times awaiting a stop. Default is 10. DEPRECATED
	# OCF_RESKEY_tomcat_user - A user name to start a resource.
	# OCF_RESKEY_statusurl - URL for state confirmation. Default is http://127.0.0.1:8080
	# OCF_RESKEY_max_stop_time - The max time it should take for proper shutdown. Restrictions, only Tomcat6.
	# OCF_RESKEY_java_home - Home directory of Java. Default is none
	# OCF_RESKEY_java_opts - Options to pass to Java JVM for start and stop. Default is none
	# OCF_RESKEY_catalina_home - Home directory of Tomcat. Default is none
	# OCF_RESKEY_catalina_base - Base directory of Tomcat. Default is OCF_RESKEY_catalina_home
	# OCF_RESKEY_catalina_out - Log file name of Tomcat. Default is OCF_RESKEY_catalina_base/logs/catalina.out
	# OCF_RESKEY_catalina_pid - A PID file name of Tomcat. Default is OCF_RESKEY_catalina_base/logs/catalina.pid
	# OCF_RESKEY_tomcat_start_opts - Start options of Tomcat. Default is none.
	# OCF_RESKEY_catalina_opts - CATALINA_OPTS environment variable. Default is none.
	# OCF_RESKEY_catalina_tmpdir - CATALINA_TMPDIR environment variable. Default is none.
	# OCF_RESKEY_catalina_rotate_log - Control catalina.out logrotation flag. Default is NO.
	# OCF_RESKEY_catalina_rotatetime - catalina.out logrotation time span(seconds). Default is 86400.
	# OCF_RESKEY_java_endorsed_dirs - JAVA_ENDORSED_DIRS environment variable. Default is none.
	# OCF_RESKEY_logging_config - LOGGING_CONFIG environment variable. Default is none.
	# OCF_RESKEY_logging_manager - LOGGING_MANAGER environment variable. Default is none.
	###############################################################################


	: ${OCF_FUNCTIONS_DIR=${OCF_ROOT}/lib/heartbeat}
	. ${OCF_FUNCTIONS_DIR}/ocf-shellfuncs

	############################################################################
	# Usage
	usage()
	{
	cat <<-!
	usage: $0 action

	action:
	start start Tomcat

	stop stop Tomcat

	status return the status of Tomcat, up or down

	monitor return TRUE if Tomcat appears to be working.
	You have to have installed $WGETNAME for this to work.

	meta-data show meta data message

	validate-all validate the instance parameters
	!
	}

	############################################################################
	# Check tomcat service availability
	isrunning_tomcat()
	{
	$WGET --tries=20 -O /dev/null $RESOURCE_STATUSURL >/dev/null 2>&1
	}

	############################################################################
	#
	isalive_tomcat()
	{
	# As the server stops, the PID file disappears. To avoid race conditions,
	# we will have remembered the PID of a running instance on script entry.
	local pid=$rememberedPID
	# If there is a PID file, use that
	if [ -f $CATALINA_PID ]; then
	ocf_log debug "Reading pid from $CATALINA_PID"
	# race conditions on PID file being removed by stopping tomcat...
	pid=`head -n 1 $CATALINA_PID`
	fi
	if [ -n "$pid" ] && [ "$pid" -gt 0 ]; then
	# Retry message for restraint
	ocf_log debug "Sending noop signal to $pid"
	kill -s 0 $pid >/dev/null 2>&1
	return $?
	fi
	# No PID file
	false
	}

	############################################################################
	# Check tomcat process and service availability
	monitor_tomcat()
	{
	isalive_tomcat \|\|
	return $OCF_NOT_RUNNING
	isrunning_tomcat \|\|
	return $OCF_ERR_GENERIC
	return $OCF_SUCCESS
	}

	############################################################################
	# Execute catalina.out log rotation
	rotate_catalina_out()
	{
	# Look for rotatelogs/rotatelogs2
	if [ -x /usr/sbin/rotatelogs ]; then
	ROTATELOGS=/usr/sbin/rotatelogs
	elif [ -x /usr/sbin/rotatelogs2 ]; then
	ROTATELOGS=/usr/sbin/rotatelogs2
	else
	ocf_log warn "rotatelogs command not found."
	return 1
	fi

	# Clean up and set permissions on required files
	rm -rf "$CATALINA_BASE"/temp/* "$CATALINA_OUT"
	mkfifo -m700 "$CATALINA_OUT"
	chown --dereference "$RESOURCE_TOMCAT_USER" "$CATALINA_OUT" \|\| true

	# -s is required because tomcat5.5's login shell is /bin/false
	su - -s /bin/sh $RESOURCE_TOMCAT_USER \
	-c "$ROTATELOGS -l \"$CATALINA_BASE/logs/catalina_%F.log\" $CATALINA_ROTATETIME" \
	< "$CATALINA_OUT" > /dev/null 2>&1 &
	}

	############################################################################
	# Tomcat Command
	tomcatCommand()
	{
	cat<<-END_TOMCAT_COMMAND
	export JAVA_HOME=${JAVA_HOME}
	export JAVA_OPTS="${JAVA_OPTS}"
	export CATALINA_HOME=${CATALINA_HOME}
	export CATALINA_BASE=${CATALINA_BASE}
	export CATALINA_OUT=${CATALINA_OUT}
	export CATALINA_PID=${CATALINA_PID}
	export CATALINA_OPTS="${CATALINA_OPTS}"
	export CATALINA_TMPDIR="${CATALINA_TMPDIR}"
	export JAVA_ENDORSED_DIRS="${JAVA_ENDORSED_DIRS}"
	export LOGGING_CONFIG="${LOGGING_CONFIG}"
	export LOGGING_MANAGER="${LOGGING_MANAGER}"
	$CATALINA_HOME/bin/catalina.sh $@
	END_TOMCAT_COMMAND
	}
	attemptTomcatCommand()
	{
	if [ "$RESOURCE_TOMCAT_USER" = root ]; then
	"$CATALINA_HOME/bin/catalina.sh" $@ >> "$TOMCAT_CONSOLE" 2>&1
	else
	tomcatCommand $@ \| su - -s /bin/sh "$RESOURCE_TOMCAT_USER" >> "$TOMCAT_CONSOLE" 2>&1
	fi
	}

	############################################################################
	# Start Tomcat
	start_tomcat()
	{
	cd "$CATALINA_HOME/bin"

	validate_all_tomcat \|\| exit $?

	monitor_tomcat
	if [ $? = $OCF_SUCCESS ]; then
	return $OCF_SUCCESS
	fi

	# Remove $CATALINA_PID if it exists
	rm -f $CATALINA_PID

	#ocf_log debug "catalina.out rotation FLG = ${CATALINA_ROTATE_LOG}"
	if ocf_is_true ${CATALINA_ROTATE_LOG}; then
	rotate_catalina_out
	if [ $? = 0 ]; then
	ocf_log debug "Rotate catalina.out succeeded."
	else
	ocf_log warn "Rotate catalina.out failed. Starting tomcat without catalina.out rotation."
	fi
	fi

	echo "`date "+%Y/%m/%d %T"`: start ===========================" >> "$TOMCAT_CONSOLE"

	ocf_log debug "CATALINA_OPTS value = ${CATALINA_OPTS}"
	attemptTomcatCommand start ${TOMCAT_START_OPTS} &

	while true; do
	monitor_tomcat
	if [ $? = $OCF_SUCCESS ]; then
	break
	fi
	ocf_log debug "start_tomcat[$TOMCAT_NAME]: retry monitor_tomcat"
	sleep 3
	done

	return $OCF_SUCCESS
	}

	############################################################################
	# Stop Tomcat
	stop_tomcat()
	{
	RA_TIMEOUT=$((OCF_RESKEY_CRM_meta_timeout/1000))
	STOP_TIMEOUT=$((RA_TIMEOUT-5))
	if [ -n "$MAX_STOP_TIME" ]; then
	if [ $MAX_STOP_TIME -gt $RA_TIMEOUT ]; then
	ocf_log warn "max_stop_timeout must be shorter than the timeout of stop operation."
	fi
	if [ $MAX_STOP_TIME -eq 0 ]; then
	STOP_TIMEOUT=$RA_TIMEOUT
	else
	STOP_TIMEOUT=$MAX_STOP_TIME
	fi
	fi

	cd "$CATALINA_HOME/bin"

	memorize_pid # This lets monitoring continue to work reliably

	echo "`date "+%Y/%m/%d %T"`: stop ###########################" >> "$TOMCAT_CONSOLE"

	attemptTomcatCommand stop $STOP_TIMEOUT -force

	lapse_sec=0
	while isalive_tomcat; do
	sleep 1
	lapse_sec=`expr $lapse_sec + 1`
	ocf_log debug "stop_tomcat[$TOMCAT_NAME]: stop failed, killing with SIGKILL ($lapse_sec)"
	kill -s KILL $rememberedPID
	done

	if ocf_is_true ${CATALINA_ROTATE_LOG}; then
	rm -f "$CATALINA_PID" "${CATALINA_OUT}"
	else
	rm -f "$CATALINA_PID"
	fi
	return $OCF_SUCCESS
	}

	metadata_tomcat()
	{
	cat <<END
	<?xml version="1.0"?>
	<!DOCTYPE resource-agent SYSTEM "ra-api-1.dtd">
	<resource-agent name="tomcat">
	<version>1.0</version>

	<longdesc lang="en">
	Resource script for Tomcat. It manages a Tomcat instance as a cluster resource.
	</longdesc>
	<shortdesc lang="en">Manages a Tomcat servlet environment instance</shortdesc>

	<parameters>

	<parameter name="tomcat_name" unique="1" >
	<longdesc lang="en"><![CDATA[
	The name of the resource, added as a Java parameter in JAVA_OPTS:
	-Dname=<tomcat_name> to Tomcat process on start. Used to ensure
	process is still running and must be unique.
	]]></longdesc>
	<shortdesc>The name of the resource</shortdesc>
	<content type="string" default="" />
	</parameter>

	<parameter name="script_log" unique="1">
	<longdesc lang="en">
	Log file, used during start and stop operations.
	</longdesc>
	<shortdesc>Log file</shortdesc>
	<content type="string" default="" />
	</parameter>

	<parameter name="tomcat_stop_timeout" unique="0">
	<longdesc lang="en">
	Time-out for stop operation. DEPRECATED
	</longdesc>
	<shortdesc>Time-out for the stop operation. DEPRECATED</shortdesc>
	<content type="integer" default="" />
	</parameter>

	<parameter name="tomcat_suspend_trialcount" unique="0">
	<longdesc lang="en">
	Maximum number of times to retry stop operation before suspending
	and killing Tomcat. DEPRECATED. Does not retry.
	</longdesc>
	<shortdesc>Max retry count for stop operation. DEPRECATED</shortdesc>
	<content type="integer" default="" />
	</parameter>

	<parameter name="tomcat_user" unique="0">
	<longdesc lang="en">
	The user who starts Tomcat.
	</longdesc>
	<shortdesc>The user who starts Tomcat</shortdesc>
	<content type="string" default="root" />
	</parameter>

	<parameter name="statusurl" unique="0">
	<longdesc lang="en">
	URL for state confirmation.
	</longdesc>
	<shortdesc>URL for state confirmation</shortdesc>
	<content type="string" default="" />
	</parameter>

	<parameter name="max_stop_time" unique="0">
	<longdesc lang="en">
	Number of seconds to wait during a stop before drastic measures
	(force kill) are used on the tomcat process.
	This number MUST be less than your cluster stop timeout for the resource.
	The default value is five seconds before the timeout value of stop operation.
	When it is over this value, it stops a process in kill commands.
	This parameter is only effective on Tomcat 6 or later.
	</longdesc>
	<shortdesc>The max time it should take for proper shutdown.</shortdesc>
	<content type="integer" default="" />
	</parameter>

	<parameter name="java_home" unique="0" required="1">
	<longdesc lang="en">
	Home directory of Java.
	</longdesc>
	<shortdesc>Home directory of Java</shortdesc>
	<content type="string" default="" />
	</parameter>

	<parameter name="java_opts" unique="0">
	<longdesc lang="en">
	Java JVM options used on start and stop.
	</longdesc>
	<shortdesc>Java options parsed to JVM, used on start and stop.</shortdesc>
	<content type="string" default="" />
	</parameter>

	<parameter name="catalina_home" unique="0" required="1">
	<longdesc lang="en">
	Home directory of Tomcat.
	</longdesc>
	<shortdesc>Home directory of Tomcat</shortdesc>
	<content type="string" default="" />
	</parameter>

	<parameter name="catalina_base" unique="1">
	<longdesc lang="en">
	Instance directory of Tomcat
	</longdesc>
	<shortdesc>Instance directory of Tomcat, defaults to catalina_home</shortdesc>
	<content type="string" default="" />
	</parameter>

	<parameter name="catalina_out" unique="1">
	<longdesc lang="en">
	Log file name of Tomcat
	</longdesc>
	<shortdesc>Log file name of Tomcat, defaults to catalina_base/logs/catalina.out</shortdesc>
	<content type="string" default="" />
	</parameter>

	<parameter name="catalina_pid" unique="1">
	<longdesc lang="en">
	A PID file name for Tomcat.
	</longdesc>
	<shortdesc>A PID file name for Tomcat</shortdesc>
	<content type="string" default="" />
	</parameter>

	<parameter name="tomcat_start_opts" unique="0">
	<longdesc lang="en">
	Tomcat start options.
	</longdesc>
	<shortdesc>Tomcat start options</shortdesc>
	<content type="string" default="" />
	</parameter>

	<parameter name="catalina_opts" unique="0">
	<longdesc lang="en">
	Catalina options, for the start operation only.
	</longdesc>
	<shortdesc>Catalina options</shortdesc>
	<content type="string" default="" />
	</parameter>

	<parameter name="catalina_tmpdir" unique="1">
	<longdesc lang="en">
	Temporary directory of Tomcat
	</longdesc>
	<shortdesc>Temporary directory of Tomcat, defaults to none</shortdesc>
	<content type="string" default="" />
	</parameter>

	<parameter name="catalina_rotate_log" unique="0">
	<longdesc lang="en">
	Rotate catalina.out flag.
	</longdesc>
	<shortdesc>Rotate catalina.out flag</shortdesc>
	<content type="boolean" default="NO" />
	</parameter>

	<parameter name="catalina_rotatetime" unique="0">
	<longdesc lang="en">
	catalina.out rotation interval (seconds).
	</longdesc>
	<shortdesc>catalina.out rotation interval (seconds)</shortdesc>
	<content type="integer" default="" />
	</parameter>

	<parameter name="java_endorsed_dirs" unique="1">
	<longdesc lang="en">
	Java_endorsed_dirs of tomcat
	</longdesc>
	<shortdesc>Java_endorsed_dirs of Tomcat, defaults to none</shortdesc>
	<content type="string" default="" />
	</parameter>

	<parameter name="logging_config" unique="1">
	<longdesc lang="en">
	Logging_config of tomcat
	</longdesc>
	<shortdesc>Logging_config of Tomcat, defaults to none</shortdesc>
	<content type="string" default="" />
	</parameter>

	<parameter name="logging_manager" unique="1">
	<longdesc lang="en">
	Logging_manager of tomcat
	</longdesc>
	<shortdesc>Logging_manager of Tomcat, defaults to none.</shortdesc>
	<content type="string" default="" />
	</parameter>

	</parameters>

	<actions>
	<action name="start" timeout="60s" />
	<action name="stop" timeout="120s" />
	<action name="status" timeout="60" />
	<action name="monitor" depth="0" timeout="30s" interval="10s" />
	<action name="meta-data" timeout="5s" />
	<action name="validate-all" timeout="5"/>
	</actions>
	</resource-agent>
	END
	return $OCF_SUCCESS
	}

	validate_all_tomcat()
	{
	local port
	local rc=$OCF_SUCCESS
	ocf_log info "validate_all_tomcat[$TOMCAT_NAME]"

	check_binary $WGET

	if [ -n "$MAX_STOP_TIME" ] && [ "$MAX_STOP_TIME" -lt 0 ]; then
	ocf_log err "max_stop_time must be set to a value greater than 0."
	rc=$OCF_ERR_CONFIGURED
	fi

	if echo "$RESOURCE_STATUSURL" \| grep -q ":[0-9][0-9]*" ; then
	port=${RESOURCE_STATUSURL##*:}
	port=${port%%/*}
	ocf_log debug "Tomcat port is $port"
	ocf_log debug "grep port=\"$port\" $CATALINA_BASE/conf/server.xml"
	grep "port=\"$port\"" $CATALINA_BASE/conf/server.xml > /dev/null 2>&1
	if [ $? -ne 0 ]; then
	ocf_log err "Your configured status URL specifies a port ($port), but the server does not have a connector listening to that port in $CATALINA_BASE/conf/server.xml"
	rc=$OCF_ERR_INSTALLED
	fi
	fi

	return $rc
	}

	# As we stop tomcat, it removes it's own pid file...we still want to know what it was
	memorize_pid()
	{
	if [ -f $CATALINA_PID ]; then
	rememberedPID=$(cat $CATALINA_PID)
	fi
	}

	#
	### tomcat RA environment variables
	#

	COMMAND=$1
	TOMCAT_NAME="${OCF_RESKEY_tomcat_name-tomcat}"
	TOMCAT_CONSOLE="${OCF_RESKEY_script_log-/var/log/$TOMCAT_NAME.log}"
	RESOURCE_TOMCAT_USER="${OCF_RESKEY_tomcat_user-root}"
	RESOURCE_STATUSURL="${OCF_RESKEY_statusurl-http://127.0.0.1:8080}"

	JAVA_HOME="${OCF_RESKEY_java_home}"
	JAVA_OPTS="${OCF_RESKEY_java_opts}"
	CATALINA_HOME="${OCF_RESKEY_catalina_home}"
	CATALINA_BASE="${OCF_RESKEY_catalina_base-${OCF_RESKEY_catalina_home}}"
	CATALINA_OUT="${OCF_RESKEY_catalina_out-$CATALINA_BASE/logs/catalina.out}"
	CATALINA_PID="${OCF_RESKEY_catalina_pid-$CATALINA_BASE/logs/catalina.pid}"
	MAX_STOP_TIME="${OCF_RESKEY_max_stop_time}"

	TOMCAT_START_OPTS="${OCF_RESKEY_tomcat_start_opts}"
	CATALINA_OPTS="-Dname=$TOMCAT_NAME ${OCF_RESKEY_catalina_opts}"
	CATALINA_TMPDIR="${OCF_RESKEY_catalina_tmpdir}"
	CATALINA_ROTATE_LOG="${OCF_RESKEY_catalina_rotate_log-NO}"
	CATALINA_ROTATETIME="${OCF_RESKEY_catalina_rotatetime-86400}"
	JAVA_ENDORSED_DIRS="${OCF_RESKEY_java_endorsed_dirs}"
	LOGGING_CONFIG="${OCF_RESKEY_logging_config}"
	LOGGING_MANAGER="${OCF_RESKEY_logging_manager}"

	LSB_STATUS_STOPPED=3
	if [ $# -ne 1 ]; then
	usage
	exit $OCF_ERR_ARGS
	fi
	case "$COMMAND" in
	meta-data) metadata_tomcat; exit $OCF_SUCCESS;;
	help\|usage) usage; exit $OCF_SUCCESS;;
	esac

	if [ ! -d "$JAVA_HOME" -o ! -d "$CATALINA_HOME" -o ! -d "$CATALINA_BASE" ]; then
	case $COMMAND in
	stop) exit $OCF_SUCCESS;;
	monitor) exit $OCF_NOT_RUNNING;;
	status) exit $LSB_STATUS_STOPPED;;
	esac
	ocf_log err "JAVA_HOME or CATALINA_HOME or CATALINA_BASE does not exist."
	exit $OCF_ERR_INSTALLED
	fi

	export JAVA_HOME JAVA_OPTS CATALINA_HOME CATALINA_BASE CATALINA_OUT CATALINA_PID CATALINA_OPTS CATALINA_TMPDIR JAVA_ENDORSED_DIRS LOGGING_CONFIG LOGGING_MANAGER

	JAVA=${JAVA_HOME}/bin/java

	if [ ! -x "$JAVA" ]; then
	case $COMMAND in
	stop) exit $OCF_SUCCESS;;
	monitor) exit $OCF_NOT_RUNNING;;
	status) exit $LSB_STATUS_STOPPED;;
	esac
	ocf_log err "java command does not exist."
	exit $OCF_ERR_INSTALLED
	fi

	#
	# ------------------
	# the main script
	# ------------------
	#
	case "$COMMAND" in
	start)
	ocf_log debug "[$TOMCAT_NAME] Enter tomcat start"
	start_tomcat
	func_status=$?
	ocf_log debug "[$TOMCAT_NAME] Leave tomcat start $func_status"
	exit $func_status
	;;
	stop)
	ocf_log debug "[$TOMCAT_NAME] Enter tomcat stop"
	stop_tomcat
	func_status=$?
	ocf_log debug "[$TOMCAT_NAME] Leave tomcat stop $func_status"
	exit $func_status
	;;
	status)
	if monitor_tomcat; then
	echo tomcat instance $TOMCAT_NAME is running
	exit $OCF_SUCCESS
	else
	echo tomcat instance $TOMCAT_NAME is stopped
	exit $OCF_NOT_RUNNING
	fi
	exit $?
	;;
	monitor)
	#ocf_log debug "[$TOMCAT_NAME] Enter tomcat monitor"
	monitor_tomcat
	func_status=$?
	#ocf_log debug "[$TOMCAT_NAME] Leave tomcat monitor $func_status"
	exit $func_status
	;;
	meta-data)
	metadata_tomcat
	exit $?
	;;
	validate-all)
	validate_all_tomcat
	exit $?
	;;
	usage\|help)
	usage
	exit $OCF_SUCCESS
	;;
	*)
	usage
	exit $OCF_ERR_UNIMPLEMENTED
	;;
	esac

File Metadata

Mime Type: text/x-shellscript
Expires: Sun, Jul 20, 9:14 PM (16 h, 55 m)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 2063011
Default Alt Text: tomcat (18 KB)

tomcatNo OneTemporaryActions

tomcatView Options

File Metadata

Event Timeline

tomcat
No OneTemporary
Actions

tomcat
View Options