From a3f0b6fce07d6849d7b98353067c4c9f1e926751 Mon Sep 17 00:00:00 2001
From: Aravinda VK <avishwan@redhat.com>
Date: Wed, 31 Aug 2016 08:33:44 +0530
Subject: [PATCH 44/86] eventsapi: Add Init scripts for different distributions
Added init scripts for
- SysvInit(CentOS 6 or Red Hat 6)
- rc.d (FreeBSD)
Most of the latest distributions are using systemd. Support to be
added for other distributions which are not using systemd.
Removed systemctl wrapper functions(start/stop/status) from
gluster-eventsapi CLI(peer_eventsapi.py). Status and Reload
re-implemented using pid file check.
Added pid file support for glustereventsd.
Following dependencies removed
python-flask - Only used for example dashboard. User can install
if required.
python-fasteners - Not available for EPEL 6, added custom code using
fcntl as replacement.
> Reviewed-on: http://review.gluster.org/15367
> Smoke: Gluster Build System <jenkins@build.gluster.org>
> CentOS-regression: Gluster Build System <jenkins@build.gluster.org>
> Reviewed-by: Niels de Vos <ndevos@redhat.com>
> NetBSD-regression: NetBSD Build System <jenkins@build.gluster.org>
> Reviewed-by: Kaleb KEITHLEY <kkeithle@redhat.com>
BUG: 1351589
Change-Id: I26792eae9b11e93304f70b3997cd7d8d03b067f4
Signed-off-by: Aravinda VK <avishwan@redhat.com>
Reviewed-on: https://code.engineering.redhat.com/gerrit/84747
Reviewed-by: Milind Changire <mchangir@redhat.com>
Reviewed-by: Atin Mukherjee <amukherj@redhat.com>
---
configure.ac | 2 +
events/src/eventsapiconf.py.in | 1 +
events/src/glustereventsd.py | 21 ++++-
events/src/peer_eventsapi.py | 160 +++++++++---------------------
events/src/utils.py | 77 ++++++++++++++
extras/init.d/Makefile.am | 11 ++-
extras/init.d/glustereventsd-FreeBSD.in | 19 ++++
extras/init.d/glustereventsd-Redhat.in | 129 ++++++++++++++++++++++++
extras/systemd/glustereventsd.service.in | 3 +-
glusterfs.spec.in | 19 +++-
10 files changed, 322 insertions(+), 120 deletions(-)
create mode 100644 extras/init.d/glustereventsd-FreeBSD.in
create mode 100644 extras/init.d/glustereventsd-Redhat.in
diff --git a/configure.ac b/configure.ac
index d77f41f..d84398d 100644
--- a/configure.ac
+++ b/configure.ac
@@ -200,6 +200,8 @@ AC_CONFIG_FILES([Makefile
extras/init.d/glusterd-Redhat
extras/init.d/glusterd-FreeBSD
extras/init.d/glusterd-SuSE
+ extras/init.d/glustereventsd-Redhat
+ extras/init.d/glustereventsd-FreeBSD
extras/ganesha/Makefile
extras/ganesha/config/Makefile
extras/ganesha/scripts/Makefile
diff --git a/events/src/eventsapiconf.py.in b/events/src/eventsapiconf.py.in
index fad96ca..ecccd3d 100644
--- a/events/src/eventsapiconf.py.in
+++ b/events/src/eventsapiconf.py.in
@@ -23,3 +23,4 @@ INT_CONFIGS = ["port"]
RESTART_CONFIGS = ["port"]
EVENTS_ENABLED = @EVENTS_ENABLED@
UUID_FILE = "@GLUSTERD_WORKDIR@/glusterd.info"
+PID_FILE = "@localstatedir@/run/glustereventsd.pid"
diff --git a/events/src/glustereventsd.py b/events/src/glustereventsd.py
index 91a0743..d057e09 100644
--- a/events/src/glustereventsd.py
+++ b/events/src/glustereventsd.py
@@ -15,12 +15,13 @@ import sys
import signal
import SocketServer
import socket
+from argparse import ArgumentParser, RawDescriptionHelpFormatter
from eventtypes import all_events
import handlers
import utils
-from eventsapiconf import SERVER_ADDRESS
-from utils import logger
+from eventsapiconf import SERVER_ADDRESS, PID_FILE
+from utils import logger, PidFile, PidFileLockFailed
class GlusterEventsRequestHandler(SocketServer.BaseRequestHandler):
@@ -90,9 +91,23 @@ def init_event_server():
server.serve_forever()
+def get_args():
+ parser = ArgumentParser(formatter_class=RawDescriptionHelpFormatter,
+ description=__doc__)
+ parser.add_argument("-p", "--pid-file", help="PID File",
+ default=PID_FILE)
+
+ return parser.parse_args()
+
+
def main():
+ args = get_args()
try:
- init_event_server()
+ with PidFile(args.pid_file):
+ init_event_server()
+ except PidFileLockFailed as e:
+ sys.stderr.write("Failed to get lock for pid file({0}): {1}".format(
+ args.pid_file, e))
except KeyboardInterrupt:
sys.exit(1)
diff --git a/events/src/peer_eventsapi.py b/events/src/peer_eventsapi.py
index f444778..7f80f79 100644
--- a/events/src/peer_eventsapi.py
+++ b/events/src/peer_eventsapi.py
@@ -14,14 +14,17 @@ from __future__ import print_function
import os
import json
from errno import EEXIST
+import fcntl
+from errno import EACCES, EAGAIN
+import signal
import requests
-import fasteners
from prettytable import PrettyTable
from gluster.cliutils import (Cmd, execute, node_output_ok, node_output_notok,
sync_file_to_peers, GlusterCmdException,
output_error, execute_in_peers, runcli)
+from events.utils import LockedOpen
from events.eventsapiconf import (WEBHOOKS_FILE_TO_SYNC,
WEBHOOKS_FILE,
@@ -32,6 +35,7 @@ from events.eventsapiconf import (WEBHOOKS_FILE_TO_SYNC,
CONFIG_KEYS,
BOOL_CONFIGS,
INT_CONFIGS,
+ PID_FILE,
RESTART_CONFIGS)
@@ -78,67 +82,36 @@ def mkdirp(path, exit_on_err=False, logger=None):
output_error("Fail to create dir %s: %s" % (path, e))
-def is_enabled(service):
- rc, out, err = execute(["systemctl", "is-enabled", service])
- return rc == 0
-
-
-def is_active(service):
- rc, out, err = execute(["systemctl", "is-active", service])
- return rc == 0
-
-
-def enable_service(service):
- if not is_enabled(service):
- cmd = ["systemctl", "enable", service]
- return execute(cmd)
-
- return (0, "", "")
-
-
-def disable_service(service):
- if is_enabled(service):
- cmd = ["systemctl", "disable", service]
- return execute(cmd)
-
- return (0, "", "")
-
-
-def start_service(service):
- rc, out, err = enable_service(service)
- if rc != 0:
- return (rc, out, err)
-
- cmd = ["systemctl", "start", service]
- return execute(cmd)
-
-
-def stop_service(service):
- rc, out, err = disable_service(service)
- if rc != 0:
- return (rc, out, err)
-
- cmd = ["systemctl", "stop", service]
- return execute(cmd)
-
-
-def restart_service(service):
- rc, out, err = stop_service(service)
- if rc != 0:
- return (rc, out, err)
-
- return start_service(service)
+def is_active():
+ state = False
+ try:
+ with open(PID_FILE, "a+") as f:
+ fcntl.flock(f.fileno(), fcntl.LOCK_EX | fcntl.LOCK_NB)
+ state = False
+ except (IOError, OSError) as e:
+ if e.errno in (EACCES, EAGAIN):
+ # cannot grab. so, process still running..move on
+ state = True
+ else:
+ state = False
+ return state
-def reload_service(service):
- if is_active(service):
- cmd = ["systemctl", "reload", service]
- return execute(cmd)
+def reload_service():
+ pid = None
+ if is_active():
+ with open(PID_FILE) as f:
+ try:
+ pid = int(f.read().strip())
+ except ValueError:
+ pid = None
+ if pid is not None:
+ os.kill(pid, signal.SIGUSR2)
return (0, "", "")
-def sync_to_peers(restart=False):
+def sync_to_peers():
if os.path.exists(WEBHOOKS_FILE):
try:
sync_file_to_peers(WEBHOOKS_FILE_TO_SYNC)
@@ -153,11 +126,7 @@ def sync_to_peers(restart=False):
output_error("Failed to sync Config file: [Error: {0}]"
"{1}".format(e[0], e[2]))
- action = "node-reload"
- if restart:
- action = "node-restart"
-
- out = execute_in_peers(action)
+ out = execute_in_peers("node-reload")
table = PrettyTable(["NODE", "NODE STATUS", "SYNC STATUS"])
table.align["NODE STATUS"] = "r"
table.align["SYNC STATUS"] = "r"
@@ -204,53 +173,11 @@ def action_handle(action):
print (table)
-class NodeStart(Cmd):
- name = "node-start"
-
- def run(self, args):
- node_output_handle(start_service(EVENTSD))
-
-
-class StartCmd(Cmd):
- name = "start"
-
- def run(self, args):
- action_handle("start")
-
-
-class NodeStop(Cmd):
- name = "node-stop"
-
- def run(self, args):
- node_output_handle(stop_service(EVENTSD))
-
-
-class StopCmd(Cmd):
- name = "stop"
-
- def run(self, args):
- action_handle("stop")
-
-
-class NodeRestart(Cmd):
- name = "node-restart"
-
- def run(self, args):
- node_output_handle(restart_service(EVENTSD))
-
-
-class RestartCmd(Cmd):
- name = "restart"
-
- def run(self, args):
- action_handle("restart")
-
-
class NodeReload(Cmd):
name = "node-reload"
def run(self, args):
- node_output_handle(reload_service(EVENTSD))
+ node_output_handle(reload_service())
class ReloadCmd(Cmd):
@@ -264,7 +191,7 @@ class NodeStatus(Cmd):
name = "node-status"
def run(self, args):
- node_output_ok("UP" if is_active(EVENTSD) else "DOWN")
+ node_output_ok("UP" if is_active() else "DOWN")
class StatusCmd(Cmd):
@@ -294,7 +221,7 @@ class WebhookAddCmd(Cmd):
def run(self, args):
create_webhooks_file_if_not_exists()
- with fasteners.InterProcessLock(WEBHOOKS_FILE):
+ with LockedOpen(WEBHOOKS_FILE, 'r+'):
data = json.load(open(WEBHOOKS_FILE))
if data.get(args.url, None) is not None:
output_error("Webhook already exists")
@@ -316,7 +243,7 @@ class WebhookModCmd(Cmd):
def run(self, args):
create_webhooks_file_if_not_exists()
- with fasteners.InterProcessLock(WEBHOOKS_FILE):
+ with LockedOpen(WEBHOOKS_FILE, 'r+'):
data = json.load(open(WEBHOOKS_FILE))
if data.get(args.url, None) is None:
output_error("Webhook does not exists")
@@ -336,7 +263,7 @@ class WebhookDelCmd(Cmd):
def run(self, args):
create_webhooks_file_if_not_exists()
- with fasteners.InterProcessLock(WEBHOOKS_FILE):
+ with LockedOpen(WEBHOOKS_FILE, 'r+'):
data = json.load(open(WEBHOOKS_FILE))
if data.get(args.url, None) is None:
output_error("Webhook does not exists")
@@ -445,7 +372,9 @@ class ConfigSetCmd(Cmd):
if args.name not in CONFIG_KEYS:
output_error("Invalid Config item")
- with fasteners.InterProcessLock(CUSTOM_CONFIG_FILE):
+ create_custom_config_file_if_not_exists()
+
+ with LockedOpen(CUSTOM_CONFIG_FILE, 'r+'):
data = json.load(open(DEFAULT_CONFIG_FILE))
if os.path.exists(CUSTOM_CONFIG_FILE):
config_json = read_file_content_json(CUSTOM_CONFIG_FILE)
@@ -456,7 +385,6 @@ class ConfigSetCmd(Cmd):
return
# TODO: Validate Value
- create_custom_config_file_if_not_exists()
new_data = read_file_content_json(CUSTOM_CONFIG_FILE)
v = args.value
@@ -474,7 +402,9 @@ class ConfigSetCmd(Cmd):
if args.name in RESTART_CONFIGS:
restart = True
- sync_to_peers(restart=restart)
+ sync_to_peers()
+ if restart:
+ print ("\nRestart glustereventsd in all nodes")
class ConfigResetCmd(Cmd):
@@ -484,7 +414,9 @@ class ConfigResetCmd(Cmd):
parser.add_argument("name", help="Config Name or all")
def run(self, args):
- with fasteners.InterProcessLock(CUSTOM_CONFIG_FILE):
+ create_custom_config_file_if_not_exists()
+
+ with LockedOpen(CUSTOM_CONFIG_FILE, 'r+'):
changed_keys = []
data = {}
if os.path.exists(CUSTOM_CONFIG_FILE):
@@ -511,7 +443,9 @@ class ConfigResetCmd(Cmd):
restart = True
break
- sync_to_peers(restart=restart)
+ sync_to_peers()
+ if restart:
+ print ("\nRestart glustereventsd in all nodes")
class SyncCmd(Cmd):
diff --git a/events/src/utils.py b/events/src/utils.py
index 386e8f2..db8ebfe 100644
--- a/events/src/utils.py
+++ b/events/src/utils.py
@@ -12,6 +12,8 @@
import json
import os
import logging
+import fcntl
+from errno import ESRCH, EBADF
import requests
from eventsapiconf import (LOG_FILE,
@@ -168,3 +170,78 @@ def plugin_webhook(message):
url=url,
event=message_json,
status_code=resp.status_code))
+
+
+class LockedOpen(object):
+
+ def __init__(self, filename, *args, **kwargs):
+ self.filename = filename
+ self.open_args = args
+ self.open_kwargs = kwargs
+ self.fileobj = None
+
+ def __enter__(self):
+ """
+ If two processes compete to update a file, The first process
+ gets the lock and the second process is blocked in the fcntl.flock()
+ call. When first process replaces the file and releases the lock,
+ the already open file descriptor in the second process now points
+ to a "ghost" file(not reachable by any path name) with old contents.
+ To avoid that conflict, check the fd already opened is same or
+ not. Open new one if not same
+ """
+ f = open(self.filename, *self.open_args, **self.open_kwargs)
+ while True:
+ fcntl.flock(f, fcntl.LOCK_EX)
+ fnew = open(self.filename, *self.open_args, **self.open_kwargs)
+ if os.path.sameopenfile(f.fileno(), fnew.fileno()):
+ fnew.close()
+ break
+ else:
+ f.close()
+ f = fnew
+ self.fileobj = f
+ return f
+
+ def __exit__(self, _exc_type, _exc_value, _traceback):
+ self.fileobj.close()
+
+
+class PidFileLockFailed(Exception):
+ pass
+
+
+class PidFile(object):
+ def __init__(self, filename):
+ self.filename = filename
+ self.pid = os.getpid()
+ self.fh = None
+
+ def cleanup(self, remove_file=True):
+ try:
+ if self.fh is not None:
+ self.fh.close()
+ except IOError as exc:
+ if exc.errno != EBADF:
+ raise
+ finally:
+ if os.path.isfile(self.filename) and remove_file:
+ os.remove(self.filename)
+
+ def __enter__(self):
+ self.fh = open(self.filename, 'a+')
+ try:
+ fcntl.flock(self.fh.fileno(), fcntl.LOCK_EX | fcntl.LOCK_NB)
+ except IOError as exc:
+ self.cleanup(remove_file=False)
+ raise PidFileLockFailed(exc)
+
+ self.fh.seek(0)
+ self.fh.truncate()
+ self.fh.write("%d\n" % self.pid)
+ self.fh.flush()
+ self.fh.seek(0)
+ return self
+
+ def __exit__(self, _exc_type, _exc_value, _traceback):
+ self.cleanup()
diff --git a/extras/init.d/Makefile.am b/extras/init.d/Makefile.am
index 8c43e51..bd8837b 100644
--- a/extras/init.d/Makefile.am
+++ b/extras/init.d/Makefile.am
@@ -1,5 +1,7 @@
-EXTRA_DIST = glusterd-Debian glusterd-FreeBSD glusterd-Redhat glusterd-SuSE glusterd.plist rhel5-load-fuse.modules
+EXTRA_DIST = glusterd-Debian glusterd-FreeBSD glusterd-Redhat glusterd-SuSE \
+ glusterd.plist rhel5-load-fuse.modules \
+ glustereventsd-FreeBSD glustereventsd-Redhat
CLEANFILES =
@@ -13,6 +15,13 @@ $(GF_DISTRIBUTION):
$(INSTALL_PROGRAM) glusterd-$(GF_DISTRIBUTION) $(DESTDIR)$(INIT_DIR)/glusterd; \
fi
+if BUILD_EVENTS
+ @if [ ! -d $(SYSTEMD_DIR) ]; then \
+ $(mkdir_p) $(DESTDIR)$(INIT_DIR); \
+ $(INSTALL_PROGRAM) glustereventsd-$(GF_DISTRIBUTION) $(DESTDIR)$(INIT_DIR)/glustereventsd; \
+ fi
+endif
+
install-exec-local: $(GF_DISTRIBUTION)
install-data-local:
diff --git a/extras/init.d/glustereventsd-FreeBSD.in b/extras/init.d/glustereventsd-FreeBSD.in
new file mode 100644
index 0000000..2e8303e
--- /dev/null
+++ b/extras/init.d/glustereventsd-FreeBSD.in
@@ -0,0 +1,19 @@
+#!/bin/sh
+#
+# $FreeBSD$
+#
+
+# PROVIDE: glustereventsd
+
+. /etc/rc.subr
+
+name="glustereventsd"
+rcvar=`set_rcvar`
+command=@prefix@/sbin/${name}
+command_interpreter=/usr/local/bin/python
+pidfile="/var/run/${name}.pid"
+glustereventsd_flags="-p /var/run/${name}.pid"
+start_cmd="/usr/sbin/daemon $command ${glustereventsd_flags}"
+
+load_rc_config $name
+run_rc_command "$1"
diff --git a/extras/init.d/glustereventsd-Redhat.in b/extras/init.d/glustereventsd-Redhat.in
new file mode 100644
index 0000000..d23ce4c
--- /dev/null
+++ b/extras/init.d/glustereventsd-Redhat.in
@@ -0,0 +1,129 @@
+#!/bin/bash
+#
+# glustereventsd Startup script for the glusterfs Events server
+#
+# chkconfig: - 20 80
+# description: Gluster Events Server
+
+### BEGIN INIT INFO
+# Provides: glustereventsd
+# Required-Start: $local_fs $network
+# Required-Stop: $local_fs $network
+# Should-Start:
+# Should-Stop:
+# Default-Start: 2 3 4 5
+# Default-Stop: 0 1 6
+# Short-Description: glusterfs Events server
+# Description: GlusterFS Events Server
+### END INIT INFO
+#
+
+# Source function library.
+. /etc/rc.d/init.d/functions
+
+BASE=glustereventsd
+
+# Fedora File System Layout dictates /run
+[ -e /run ] && RUNDIR="/run"
+PIDFILE="${RUNDIR:-/var/run}/${BASE}.pid"
+
+PID=`test -f $PIDFILE && cat $PIDFILE`
+
+GLUSTEREVENTSD_BIN=@prefix@/sbin/$BASE
+GLUSTEREVENTSD_OPTS="--pid-file=$PIDFILE"
+GLUSTEREVENTSD="$GLUSTEREVENTSD_BIN $GLUSTEREVENTSD_OPTS"
+RETVAL=0
+
+LOCKFILE=/var/lock/subsys/${BASE}
+
+# Start the service $BASE
+start()
+{
+ if pidofproc -p $PIDFILE $GLUSTEREVENTSD_BIN &> /dev/null; then
+ echo "glustereventsd service is already running with pid $PID"
+ return 0
+ else
+ echo -n $"Starting $BASE:"
+ daemon $GLUSTEREVENTSD &
+ RETVAL=$?
+ echo
+ [ $RETVAL -eq 0 ] && touch $LOCKFILE
+ return $RETVAL
+ fi
+}
+
+# Stop the service $BASE
+stop()
+{
+ echo -n $"Stopping $BASE:"
+ if pidofproc -p $PIDFILE $GLUSTEREVENTSD_BIN &> /dev/null; then
+ killproc -p $PIDFILE $BASE
+ else
+ killproc $BASE
+ fi
+ RETVAL=$?
+ echo
+ [ $RETVAL -eq 0 ] && rm -f $LOCKFILE
+ return $RETVAL
+}
+
+restart()
+{
+ stop
+ start
+}
+
+reload()
+{
+ restart
+}
+
+force_reload()
+{
+ restart
+}
+
+rh_status()
+{
+ status $BASE
+}
+
+rh_status_q()
+{
+ rh_status &>/dev/null
+}
+
+
+### service arguments ###
+case $1 in
+ start)
+ rh_status_q && exit 0
+ $1
+ ;;
+ stop)
+ rh_status_q || exit 0
+ $1
+ ;;
+ restart)
+ $1
+ ;;
+ reload)
+ rh_status_q || exit 7
+ $1
+ ;;
+ force-reload)
+ force_reload
+ ;;
+ status)
+ rh_status
+ ;;
+ condrestart|try-restart)
+ rh_status_q || exit 0
+ restart
+ ;;
+ *)
+ echo $"Usage: $0 {start|stop|status|restart|condrestart|try-restart|reload|force-reload}"
+ exit 1
+esac
+
+exit $?
diff --git a/extras/systemd/glustereventsd.service.in b/extras/systemd/glustereventsd.service.in
index 75cca16..4bfcf42 100644
--- a/extras/systemd/glustereventsd.service.in
+++ b/extras/systemd/glustereventsd.service.in
@@ -5,9 +5,10 @@ After=syslog.target network.target
[Service]
Environment=PYTHONPATH=@BUILD_PYTHON_SITE_PACKAGES_EXPANDED@:$PYTHONPATH
Type=simple
-ExecStart=@SBIN_DIR@/glustereventsd
+ExecStart=@SBIN_DIR@/glustereventsd --pid-file @localstatedir@/run/glustereventsd.pid
ExecReload=/bin/kill -SIGUSR2 $MAINPID
KillMode=control-group
+PIDFile=@localstatedir@/run/glustereventsd.pid
[Install]
WantedBy=multi-user.target
diff --git a/glusterfs.spec.in b/glusterfs.spec.in
index cb90eef..27032f4 100644
--- a/glusterfs.spec.in
+++ b/glusterfs.spec.in
@@ -617,8 +617,7 @@ This package provides the translators needed on any GlusterFS client.
Summary: GlusterFS Events
Group: Applications/File
Requires: %{name}-server%{?_isa} = %{version}-%{release}
-Requires: python python-fasteners python-requests python-flask
-Requires: python-prettytable
+Requires: python python-requests python-prettytable
Requires: python-gluster = %{version}-%{release}
%if ( 0%{?rhel} && 0%{?rhel} <= 6 )
Requires: python-argparse
@@ -942,6 +941,15 @@ fi
%postun api
/sbin/ldconfig
+%if 0%{?_build_server}
+%postun events
+%if ( 0%{!?_without_events:1} )
+%if ( 0%{?fedora} ) || ( 0%{?rhel} && 0%{?rhel} >= 6 )
+%_init_restart glustereventsd
+%endif
+%endif
+%endif
+
%postun libs
/sbin/ldconfig
@@ -1000,6 +1008,8 @@ exit 0
%exclude %{_datadir}/glusterfs/scripts/eventsdash.py*
%if ( 0%{?_with_systemd:1} )
%exclude %{_unitdir}/glustereventsd.service
+%else
+%exclude %{_sysconfdir}/init.d/glustereventsd
%endif
# exclude server files
%exclude %{_sharedstatedir}/glusterd/*
@@ -1400,6 +1410,8 @@ exit 0
%{_datadir}/glusterfs/scripts/eventsdash.py*
%if ( 0%{?_with_systemd:1} )
%{_unitdir}/glustereventsd.service
+%else
+%{_sysconfdir}/init.d/glustereventsd
%endif
%endif
%endif
@@ -1994,6 +2006,9 @@ end
%endif
%changelog
+* Fri Sep 16 2016 Aravinda VK <avishwan@redhat.com>
+- Added init script for glustereventsd (#1365395)
+
* Thu Sep 15 2016 Aravinda VK <avishwan@redhat.com>
- Added new subpackage events(glusterfs-events) (#1334044)
--
1.7.1