config/sysinv/sysinv/sysinv/scripts/sysinv-api

495 lines
14 KiB
Bash
Executable File

#!/bin/sh
#
# Copyright (c) 2013-2014, 2016, 2021 Wind River Systems, Inc.
#
# SPDX-License-Identifier: Apache-2.0
#
#
# Support: www.windriver.com
#
# Purpose: This resource agent manages
#
# .... the CGCS Platform Host System Inventory REST API Service
#
#
# OCF instance parameters:
# OCF_RESKEY_binary
# OCF_RESKEY_client_binary
# OCF_RESKEY_config
# OCF_RESKEY_os_username
# OCF_RESKEY_os_tenant_name
# OCF_RESKEY_os_auth_url
# OCF_RESKEY_os_password
# OCF_RESKEY_user
# OCF_RESKEY_pid
# OCF_RESKEY_additional_parameters
#
# RA Spec:
#
# http://www.opencf.org/cgi-bin/viewcvs.cgi/specs/ra/resource-agent-api.txt?rev=HEAD
#
#######################################################################
# Initialization:
: ${OCF_FUNCTIONS_DIR=${OCF_ROOT}/lib/heartbeat}
. ${OCF_FUNCTIONS_DIR}/ocf-shellfuncs
process="sysinv"
service="-api"
binname="${process}${service}"
readonly max_sysinv_api_request_attempts=15
readonly sysinv_api_request_sleep=1
#######################################################################
# Fill in some defaults if no values are specified
OCF_RESKEY_binary_default=${binname}
OCF_RESKEY_dbg_default="false"
OCF_RESKEY_user_default="sysinv"
OCF_RESKEY_pid_default="/var/run/${binname}.pid"
OCF_RESKEY_config_default="/etc/sysinv/sysinv.conf"
OCF_RESKEY_client_binary_default="system"
OCF_RESKEY_os_tenant_name_default="admin"
: ${OCF_RESKEY_binary=${OCF_RESKEY_binary_default}}
: ${OCF_RESKEY_dbg=${OCF_RESKEY_dbg_default}}
: ${OCF_RESKEY_user=${OCF_RESKEY_user_default}}
: ${OCF_RESKEY_pid=${OCF_RESKEY_pid_default}}
: ${OCF_RESKEY_config=${OCF_RESKEY_config_default}}
: ${OCF_RESKEY_client_binary=${OCF_RESKEY_client_binary_default}}
: ${OCF_RESKEY_os_tenant_name=${OCF_RESKEY_os_tenant_name_default}}
mydaemon="/usr/bin/${OCF_RESKEY_binary}"
TMP_DIR=/var/run/sysinv_tmp
#######################################################################
usage() {
cat <<UEND
usage: $0 (start|stop|status|reload|monitor|validate-all|meta-data)
$0 manages the Platform's System Inventory REST API (sysinv-api) process as an HA resource
The 'start' ..... operation starts the sysinv-api service in the active state.
The 'stop' ...... operation stops the sysinv-api service.
The 'reload' .... operation stops and then starts the sysinv-api service.
The 'status' .... operation checks the status of the sysinv-api service.
The 'monitor' .... operation indicates the in-service status of the sysinv-api service.
The 'validate-all' operation reports whether the parameters are valid.
The 'meta-data' .. operation reports the sysinv's meta-data information.
UEND
}
#######################################################################
meta_data() {
if [ ${OCF_RESKEY_dbg} = "true" ] ; then
ocf_log info "${binname}:meta_data"
fi
cat <<END
<?xml version="1.0"?>
<!DOCTYPE resource-agent SYSTEM "ra-api-1.dtd">
<resource-agent name="sysinv">
<version>1.0</version>
<longdesc lang="en">
This 'sysinv-api' is an OCF Compliant Resource Agent that manages start, stop
and in-service monitoring of the Inventory REST API Process in the Wind River
Systems High Availability (HA) Carrier Grade Communication Server (CGCS)
Platform.
</longdesc>
<shortdesc lang="en">
Manages the CGCS Inventory REST API (sysinv-api) process in the WRS HA CGCS Platform.
</shortdesc>
<parameters>
<parameter name="dbg" unique="0" required="0">
<longdesc lang="en">
dbg = false ... info, warn and err logs sent to output stream (default)
dbg = true ... Additional debug logs are also sent to the output stream
</longdesc>
<shortdesc lang="en">Service Debug Control Option</shortdesc>
<content type="boolean" default="${OCF_RESKEY_dbg_default}"/>
</parameter>
<parameter name="user" unique="0" required="0">
<longdesc lang="en">
User running SysInv API Service (sysinv-api)
</longdesc>
<shortdesc lang="en">SysInv API Service (sysinv-api) user</shortdesc>
<content type="string" default="${OCF_RESKEY_user_default}" />
</parameter>
</parameters>
<actions>
<action name="start" timeout="10s" />
<action name="stop" timeout="10s" />
<action name="monitor" timeout="10s" interval="10m" />
<action name="meta-data" timeout="10s" />
<action name="validate-all" timeout="10s" />
</actions>
</resource-agent>
END
return ${OCF_SUCCESS}
}
sysinv_api_tmpdir () {
local rc
if [ ! -d "$TMP_DIR" ]; then
mkdir -p "$TMP_DIR"
rc=$?
if [ $rc -ne 0 ]; then
ocf_log err "Inventory Service (${OCF_RESKEY_binary}) failed to create temp dir (rc=${rc})"
return ${OCF_NOT_RUNNING}
fi
chown sysinv:sysinv "$TMP_DIR"
fi
export TMPDIR="$TMP_DIR"
return ${OCF_SUCCESS}
}
sysinv_api_validate() {
local rc
proc="${binname}:validate"
if [ ${OCF_RESKEY_dbg} = "true" ] ; then
ocf_log info "${proc}"
fi
check_binary ${OCF_RESKEY_binary}
check_binary sysinv-conductor
check_binary pidof
if [ ! -f ${OCF_RESKEY_config} ] ; then
ocf_log err "${OCF_RESKEY_binary} ini file missing (${OCF_RESKEY_config})"
return ${OCF_ERR_CONFIGURED}
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_CONFIGURED}
fi
return ${OCF_SUCCESS}
}
sysinv_api_status() {
local pid
local rc
proc="${binname}:status"
if [ ${OCF_RESKEY_dbg} = "true" ] ; then
ocf_log info "${proc}"
fi
if [ ! -f $OCF_RESKEY_pid ]; then
ocf_log info "${binname}:Sysinv API (sysinv-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 "${binname}:Old PID file found, but Sysinv API (sysinv-api) is not running"
rm -f $OCF_RESKEY_pid
return $OCF_NOT_RUNNING
fi
}
sysinv_api_request () {
# Monitor the RA by retrieving the system show
if [ -n "$OCF_RESKEY_os_username" ] && [ -n "$OCF_RESKEY_os_tenant_name" ] && [ -n "$OCF_RESKEY_os_auth_url" ]; then
ocf_run -q $OCF_RESKEY_client_binary \
--os-username "$OCF_RESKEY_os_username" \
--os-project-name "$OCF_RESKEY_os_tenant_name" \
--os-auth-url "$OCF_RESKEY_os_auth_url" \
--os-region-name "$OCF_RESKEY_os_region_name" \
--system-url "$OCF_RESKEY_system_url" \
show > /dev/null 2>&1
rc=$?
if [ $rc -ne 0 ]; then
ocf_log err "Failed to connect to the System Inventory Service (sysinv-api): $rc"
return $OCF_ERR_GENERIC
else
return $OCF_SUCCESS
fi
else
ocf_log err "Unable to run system show, trying direct request on sysinv-api URL (sysinv-api)"
# Test request on "http://controller:6385/v1" if minimum variables are not available
# "controller" matches the mgmt ip on /etc/hosts
ocf_run curl http://controller:6385/v1 > /dev/null 2>&1
rc=$?
if [ $rc -eq 0 ]; then
return $OCF_SUCCESS
fi
ocf_log err "Unable to communicate with the System Inventory Service (sysinv-api)"
return $OCF_ERR_GENERIC
fi
}
sysinv_api_request_with_attempt() {
for (( i = 1; i <= $max_sysinv_api_request_attempts; i++ ))
do
sysinv_api_request
rc=$?
if [ $rc -ne ${OCF_SUCCESS} ]; then
ocf_log info "Retrying to connect to the System Inventory Service (sysinv-api), attempt #$i"
else
break
fi
sleep $sysinv_api_request_sleep
done
return ${rc}
}
sysinv_api_monitor () {
local rc
proc="${binname}:monitor"
if [ ${OCF_RESKEY_dbg} = "true" ] ; then
ocf_log info "${proc}"
fi
sysinv_api_status
rc=$?
# If status returned anything but success, return that immediately
if [ $rc -ne $OCF_SUCCESS ]; then
return $rc
fi
# Trigger a request over sysinv-api to determine if it is properly started
sysinv_api_request
rc=$?
if [ $rc -ne ${OCF_SUCCESS} ] ; then
ocf_log err "System Inventory Service (sysinv-api) monitor failed"
else
ocf_log debug "System Inventory Service (sysinv-api) monitor succeeded"
fi
return ${rc}
}
sysinv_api_start () {
local rc
proc="${binname}:start"
if [ ${OCF_RESKEY_dbg} = "true" ] ; then
ocf_log info "${proc}"
fi
# If running then issue a ping test and check sysinv-api availability
# Retry to connect to it in case of failure
if [ -f ${OCF_RESKEY_pid} ] ; then
sysinv_api_status
rc=$?
if [ $rc -ne ${OCF_SUCCESS} ] ; then
ocf_log err "${proc} ping test failed (rc=${rc})"
sysinv_api_stop
else
sysinv_api_request_with_attempt
rc=$?
return ${rc}
fi
fi
if [ ${OCF_RESKEY_dbg} = "true" ] ; then
RUN_OPT_DEBUG="--debug"
else
RUN_OPT_DEBUG=""
fi
# switch to non-root user before starting service
su ${OCF_RESKEY_user} -s /bin/sh -c "${OCF_RESKEY_binary} --config-file=${OCF_RESKEY_config} ${RUN_OPT_DEBUG}"' >> /dev/null 2>&1 & echo $!' > $OCF_RESKEY_pid
rc=$?
if [ ${rc} -ne ${OCF_SUCCESS} ] ; then
ocf_log err "${proc} failed ${mydaemon} daemon (rc=$rc)"
return ${OCF_ERR_GENERIC}
else
if [ -f ${OCF_RESKEY_pid} ] ; then
pid=`cat ${OCF_RESKEY_pid}`
ocf_log info "${proc} running with pid ${pid}"
else
ocf_log info "${proc} with no pid file"
fi
fi
# If running then issue a ping test and check sysinv-api availability
# Retry to connect to it in case of failure
if [ -f ${OCF_RESKEY_pid} ] ; then
sysinv_api_status
rc=$?
if [ $rc -ne ${OCF_SUCCESS} ] ; then
ocf_log info "${proc} ping test failed (rc=${rc})"
sysinv_api_stop
else
sysinv_api_request_with_attempt
rc=$?
fi
fi
# Record success or failure and return status
if [ ${rc} -eq $OCF_SUCCESS ] ; then
ocf_log info "Inventory Service (${OCF_RESKEY_binary}) started (pid=${pid})"
else
ocf_log err "Inventory Service (${OCF_RESKEY_binary}) failed to start (rc=${rc})"
rc=${OCF_ERR_GENERIC}
fi
return ${rc}
}
sysinv_api_confirm_stop() {
local my_bin
local my_processes
my_binary=`which ${OCF_RESKEY_binary}`
my_processes=`pgrep -l -f "^(python|/usr/bin/python|/usr/bin/python2) ${my_binary}([^\w-]|$)"`
if [ -n "${my_processes}" ]
then
ocf_log info "About to SIGKILL the following: ${my_processes}"
pkill -KILL -f "^(python|/usr/bin/python|/usr/bin/python2) ${my_binary}([^\w-]|$)"
fi
}
sysinv_api_stop () {
local rc
local pid
proc="${binname}:stop"
if [ ${OCF_RESKEY_dbg} = "true" ] ; then
ocf_log info "${proc}"
fi
sysinv_api_status
rc=$?
if [ $rc -eq $OCF_NOT_RUNNING ]; then
ocf_log info "${proc} Sysinv API (sysinv-api) already stopped"
sysinv_api_confirm_stop
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 "${proc} Sysinv API (sysinv-api) couldn't be stopped"
sysinv_api_confirm_stop
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
sysinv_api_status
rc=$?
if [ $rc -eq $OCF_NOT_RUNNING ]; then
break
fi
count=`expr $count + 1`
sleep 1
ocf_log info "${proc} Sysinv API (sysinv-api) still hasn't stopped yet. Waiting ..."
done
sysinv_api_status
rc=$?
if [ $rc -ne $OCF_NOT_RUNNING ]; then
# SIGTERM didn't help either, try SIGKILL
ocf_log info "${proc} Sysinv API (sysinv-api) failed to stop after ${shutdown_timeout}s using SIGTERM. Trying SIGKILL ..."
ocf_run kill -s KILL $pid
fi
sysinv_api_confirm_stop
ocf_log info "${proc} Sysinv API (sysinv-api) stopped."
rm -f $OCF_RESKEY_pid
return $OCF_SUCCESS
}
sysinv_api_reload () {
local rc
proc="${binname}:reload"
if [ ${OCF_RESKEY_dbg} = "true" ] ; then
ocf_log info "${proc}"
fi
sysinv_api_stop
rc=$?
if [ $rc -eq ${OCF_SUCCESS} ] ; then
#sleep 1
sysinv_api_start
rc=$?
if [ $rc -eq ${OCF_SUCCESS} ] ; then
ocf_log info "System Inventory (${OCF_RESKEY_binary}) process restarted"
fi
fi
if [ ${rc} -ne ${OCF_SUCCESS} ] ; then
ocf_log err "System Inventory (${OCF_RESKEY_binary}) process failed to restart (rc=${rc})"
fi
return ${rc}
}
case ${__OCF_ACTION} in
meta-data) meta_data
exit ${OCF_SUCCESS}
;;
usage|help) usage
exit ${OCF_SUCCESS}
;;
esac
# Anything except meta-data and help must pass validation
sysinv_api_validate || exit $?
# Set up tmpfiles directory to avoid temp files being
# cleaned up by systemd tmpfiles clean service.
sysinv_api_tmpdir || exit $?
if [ ${OCF_RESKEY_dbg} = "true" ] ; then
ocf_log info "${binname}:${__OCF_ACTION} action"
fi
case ${__OCF_ACTION} in
start) sysinv_api_start
;;
stop) sysinv_api_stop
;;
status) sysinv_api_status
;;
reload) sysinv_api_reload
;;
monitor) sysinv_api_monitor
;;
validate-all) sysinv_api_validate
;;
*) usage
exit ${OCF_ERR_UNIMPLEMENTED}
;;
esac