openstack-resource-agents/manila-api
Clinton Knight 17c4e1f17c Add Linux-HA resource agent for Manila
The OpenStack HA guide [1][2] describes how to configure the Linux
clustering components Corosync and Pacemaker to run OpenStack services
as active/passive HA processes.

The Manila resource agent was modeled after the one for Cinder, plus
a few fixes needed to make it work with Devstack.  A separate commit
to the OpenStack HA Guide will add a section covering Manila.

[1] http://docs.openstack.org/high-availability-guide/content/ch_preface.html
[2] https://github.com/openstack/ha-guide

Change-Id: I14f9598cf682ec3c43c2163a3dfabf18a59d7baa
2015-10-21 09:55:28 -07:00

380 lines
12 KiB
Bash

#!/bin/sh
#
#
# OpenStack Manila API (manila-api)
#
# Description: Manages an OpenStack Manila API (manila-api) process as an HA resource
#
# Authors: Emilian Macchi, Clinton Knight
# Mainly inspired by the Nova API written by Sebastien Han
#
# Support: openstack@lists.launchpad.net
# License: Apache Software License (ASL) 2.0
#
#
# See usage() function below for more details ...
#
# OCF instance parameters:
# OCF_RESKEY_binary
# OCF_RESKEY_config
# OCF_RESKEY_user
# OCF_RESKEY_pid
# OCF_RESKEY_os_username
# OCF_RESKEY_os_password
# OCF_RESKEY_os_tenant_name
# OCF_RESKEY_keystone_get_token_url
# OCF_RESKEY_additional_parameters
#######################################################################
# Initialization:
: ${OCF_ROOT=/usr/lib/ocf}
: ${OCF_FUNCTIONS_DIR=${OCF_ROOT}/lib/heartbeat}
. ${OCF_FUNCTIONS_DIR}/ocf-shellfuncs
#######################################################################
# Fill in some defaults if no values are specified
OCF_RESKEY_binary_default="manila-api"
OCF_RESKEY_config_default="/etc/manila/manila.conf"
OCF_RESKEY_user_default="manila"
OCF_RESKEY_pid_default="$HA_RSCTMP/manila.pid"
OCF_RESKEY_url_default="http://127.0.0.1:8786/v2/"
OCF_RESKEY_keystone_get_token_url_default="http://127.0.0.1:5000/v2.0/tokens"
: ${OCF_RESKEY_binary=${OCF_RESKEY_binary_default}}
: ${OCF_RESKEY_config=${OCF_RESKEY_config_default}}
: ${OCF_RESKEY_user=${OCF_RESKEY_user_default}}
: ${OCF_RESKEY_pid=${OCF_RESKEY_pid_default}}
: ${OCF_RESKEY_url=${OCF_RESKEY_url_default}}
: ${OCF_RESKEY_keystone_get_token_url=${OCF_RESKEY_keystone_get_token_url_default}}
#######################################################################
usage() {
cat <<UEND
usage: $0 (start|stop|validate-all|meta-data|status|monitor)
$0 manages an OpenStack Manila API (manila-api) process as an HA resource
The 'start' operation starts the manila-api service.
The 'stop' operation stops the manila-api service.
The 'validate-all' operation reports whether the parameters are valid
The 'meta-data' operation reports this RA's meta-data information
The 'status' operation reports whether the manila-api service is running
The 'monitor' operation reports whether the manila-api service seems to be working
UEND
}
meta_data() {
cat <<END
<?xml version="1.0"?>
<!DOCTYPE resource-agent SYSTEM "ra-api-1.dtd">
<resource-agent name="manila-api">
<version>1.0</version>
<longdesc lang="en">
Resource agent for the OpenStack Manila API Service (manila-api)
May manage a manila-api instance or a clone set that
creates a distributed manila-api cluster.
</longdesc>
<shortdesc lang="en">Manages the OpenStack Manila API (manila-api)</shortdesc>
<parameters>
<parameter name="binary" unique="0" required="0">
<longdesc lang="en">
Location of the OpenStack Manila API server binary (manila-api)
</longdesc>
<shortdesc lang="en">OpenStack Manila API server binary (manila-api)</shortdesc>
<content type="string" default="${OCF_RESKEY_binary_default}" />
</parameter>
<parameter name="config" unique="0" required="0">
<longdesc lang="en">
Location of the OpenStack Manila API (manila-api) configuration file
</longdesc>
<shortdesc lang="en">OpenStack Manila API (manila-api registry) config file</shortdesc>
<content type="string" default="${OCF_RESKEY_config_default}" />
</parameter>
<parameter name="user" unique="0" required="0">
<longdesc lang="en">
User running OpenStack Manila API (manila-api)
</longdesc>
<shortdesc lang="en">OpenStack Manila API (manila-api) user</shortdesc>
<content type="string" default="${OCF_RESKEY_user_default}" />
</parameter>
<parameter name="pid" unique="0" required="0">
<longdesc lang="en">
The pid file to use for this OpenStack Manila API (manila-api) instance
</longdesc>
<shortdesc lang="en">OpenStack Manila API (manila-api) pid file</shortdesc>
<content type="string" default="${OCF_RESKEY_pid_default}" />
</parameter>
<parameter name="url" unique="0" required="0">
<longdesc lang="en">
The default URL to use for monitoring this instance (manila-api) via curl. Important note: the monitor function doesn't accept http return code different than 200, for instance redirection code will generate an error. Don't forget the '/' at the end of your url endpoint. For example http://127.0.0.1:8786/v2 won't work and http://127.0.0.1:8786/v2/ will.
</longdesc>
<shortdesc lang="en">OpenStack Manila API (manila-api) monitor url</shortdesc>
<content type="string" default="${OCF_RESKEY_url_default}" />
</parameter>
<parameter name="keystone_get_token_url" unique="0" required="0">
<longdesc lang="en">
The default URL to use to acquire a Manila API (manila-api) token for monitoring this instance
of OpenStack Manila API (manila-api)
</longdesc>
<shortdesc lang="en">OpenStack Manila API (manila-api) url</shortdesc>
<content type="string" default="${OCF_RESKEY_keystone_get_token_url_default}" />
</parameter>
<parameter name="os_username" unique="0" required="0">
<longdesc lang="en">
The username to use when connecting with Manila API (manila-api) for monitoring purposes
</longdesc>
<shortdesc lang="en">Manila API (manila-api) monitoring login</shortdesc>
<content type="string" />
</parameter>
<parameter name="os_password" unique="0" required="0">
<longdesc lang="en">
The password to use when connecting Manila API (manila-api) for monitoring purposes
</longdesc>
<shortdesc lang="en">Manila API (manila-api) monitoring password</shortdesc>
<content type="string" />
</parameter>
<parameter name="os_tenant_name" unique="0" required="0">
<longdesc lang="en">
The tenant to use when connecting Manila API (manila-api) for monitoring purposes
</longdesc>
<shortdesc lang="en">Manila API (manila-api) monitoring tenant</shortdesc>
<content type="string" />
</parameter>
<parameter name="additional_parameters" unique="0" required="0">
<longdesc lang="en">
Additional parameters to pass on to the OpenStack Manila API (manila-api)
</longdesc>
<shortdesc lang="en">Additional parameters for manila-api</shortdesc>
<content type="string" />
</parameter>
</parameters>
<actions>
<action name="start" timeout="20" />
<action name="stop" timeout="20" />
<action name="status" timeout="20" />
<action name="monitor" timeout="10" interval="5" />
<action name="validate-all" timeout="5" />
<action name="meta-data" timeout="5" />
</actions>
</resource-agent>
END
}
#######################################################################
# Functions invoked by resource manager actions
manila_api_validate() {
local rc
# Note that the check for OCF_RESKEY_binary may fail if using Devstack,
# because this script normally runs as root, and the root user does not
# usually have /usr/local/bin in its PATH so it cannot find the binaries
# installed by Devstack. Possible workarounds are to place symlinks
# in /usr/sbin or to perform the 'which' check as the OCF_RESKEY_user
# that will be running the Manila API service.
check_binary $OCF_RESKEY_binary
check_binary curl
check_binary tr
check_binary grep
check_binary cut
check_binary head
# A config file on shared storage that is not available
# during probes is OK.
if [ ! -f $OCF_RESKEY_config ]; then
if ! ocf_is_probe; then
ocf_log err "Config $OCF_RESKEY_config doesn't exist"
return $OCF_ERR_INSTALLED
fi
ocf_log_warn "Config $OCF_RESKEY_config not available during a probe"
fi
getent passwd $OCF_RESKEY_user >/dev/null 2>&1
rc=$?
if [ $rc -ne 0 ]; then
ocf_log err "User $OCF_RESKEY_user doesn't exist"
return $OCF_ERR_INSTALLED
fi
true
}
manila_api_status() {
local pid
local rc
if [ ! -f $OCF_RESKEY_pid ]; then
ocf_log info "OpenStack Manila API (manila-api) is not running"
return $OCF_NOT_RUNNING
else
pid=`cat $OCF_RESKEY_pid`
fi
ocf_run -warn kill -s 0 $pid
rc=$?
if [ $rc -eq 0 ]; then
return $OCF_SUCCESS
else
ocf_log info "Old PID file found, but OpenStack Manila API (manila-api) is not running"
return $OCF_NOT_RUNNING
fi
}
manila_api_monitor() {
local rc
local token
local http_code
manila_api_status
rc=$?
# If status returned anything but success, return that immediately
if [ $rc -ne $OCF_SUCCESS ]; then
return $rc
fi
# Check detailed information about this specific version of the API.
if [ -n "$OCF_RESKEY_os_username" ] && [ -n "$OCF_RESKEY_os_password" ] \
&& [ -n "$OCF_RESKEY_os_tenant_name" ] && [ -n "$OCF_RESKEY_keystone_get_token_url" ]; then
token=`curl -s -d "{\"auth\":{\"passwordCredentials\": {\"username\": \"$OCF_RESKEY_os_username\", \
\"password\": \"$OCF_RESKEY_os_password\"}, \"tenantName\": \"$OCF_RESKEY_os_tenant_name\"}}" \
-H "Content-type: application/json" $OCF_RESKEY_keystone_get_token_url | tr ',' '\n' | grep '"id":' \
| cut -d'"' -f4 | head --lines 1`
http_code=`curl --write-out %{http_code} --output /dev/null -sH "X-Auth-Token: $token" $OCF_RESKEY_url`
rc=$?
if [ $rc -ne 0 ] || [ $http_code -ne 200 ]; then
ocf_log err "Failed to connect to the OpenStack Manila API (manila-api): $rc and $http_code"
return $OCF_NOT_RUNNING
fi
fi
ocf_log debug "OpenStack Manila API (manila-api) monitor succeeded"
return $OCF_SUCCESS
}
manila_api_start() {
local rc
manila_api_status
rc=$?
if [ $rc -eq $OCF_SUCCESS ]; then
ocf_log info "OpenStack Manila API (manila-api) already running"
return $OCF_SUCCESS
fi
# run the actual manila-api daemon. Don't use ocf_run as we're sending the tool's output
# straight to /dev/null anyway and using ocf_run would break stdout-redirection here.
su ${OCF_RESKEY_user} -s /bin/sh -c "${OCF_RESKEY_binary} --config-file=$OCF_RESKEY_config \
$OCF_RESKEY_additional_parameters"' >> /dev/null 2>&1 & echo $!' > $OCF_RESKEY_pid
# Spin waiting for the server to come up.
# Let the CRM/LRM time us out if required
while true; do
manila_api_monitor
rc=$?
[ $rc -eq $OCF_SUCCESS ] && break
if [ $rc -ne $OCF_NOT_RUNNING ]; then
ocf_log err "OpenStack Manila API (manila-api) start failed"
exit $OCF_ERR_GENERIC
fi
sleep 1
done
ocf_log info "OpenStack Manila API (manila-api) started"
return $OCF_SUCCESS
}
manila_api_stop() {
local rc
local pid
manila_api_status
rc=$?
if [ $rc -eq $OCF_NOT_RUNNING ]; then
ocf_log info "OpenStack Manila API (manila-api) already stopped"
return $OCF_SUCCESS
fi
# Try SIGTERM
pid=`cat $OCF_RESKEY_pid`
ocf_run kill -s TERM $pid
rc=$?
if [ $rc -ne 0 ]; then
ocf_log err "OpenStack Manila API (manila-api) couldn't be stopped"
exit $OCF_ERR_GENERIC
fi
# stop waiting
shutdown_timeout=15
if [ -n "$OCF_RESKEY_CRM_meta_timeout" ]; then
shutdown_timeout=$((($OCF_RESKEY_CRM_meta_timeout/1000)-5))
fi
count=0
while [ $count -lt $shutdown_timeout ]; do
manila_api_status
rc=$?
if [ $rc -eq $OCF_NOT_RUNNING ]; then
break
fi
count=`expr $count + 1`
sleep 1
ocf_log debug "OpenStack Manila API (manila-api) still hasn't stopped yet. Waiting ..."
done
manila_api_status
rc=$?
if [ $rc -ne $OCF_NOT_RUNNING ]; then
# SIGTERM didn't help either, try SIGKILL
ocf_log info "OpenStack Manila API (manila-api) failed to stop after ${shutdown_timeout}s \
using SIGTERM. Trying SIGKILL ..."
ocf_run kill -s KILL $pid
fi
ocf_log info "OpenStack Manila API (manila-api) stopped"
rm -f $OCF_RESKEY_pid
return $OCF_SUCCESS
}
#######################################################################
case "$1" in
meta-data) meta_data
exit $OCF_SUCCESS;;
usage|help) usage
exit $OCF_SUCCESS;;
esac
# Anything except meta-data and help must pass validation
manila_api_validate || exit $?
# What kind of method was invoked?
case "$1" in
start) manila_api_start;;
stop) manila_api_stop;;
status) manila_api_status;;
monitor) manila_api_monitor;;
validate-all) ;;
*) usage
exit $OCF_ERR_UNIMPLEMENTED;;
esac