Last active
July 24, 2022 01:41
-
-
Save lambdalisue/f01c5a65e81100356379 to your computer and use it in GitHub Desktop.
A service (init.d) script for jupyterhub
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| #! /bin/sh | |
| ### BEGIN INIT INFO | |
| # Provides: jupyterhub | |
| # Required-Start: $remote_fs $syslog | |
| # Required-Stop: $remote_fs $syslog | |
| # Default-Start: 2 3 4 5 | |
| # Default-Stop: 0 1 6 | |
| # Short-Description: Start jupyterhub | |
| # Description: This file should be used to construct scripts to be | |
| # placed in /etc/init.d. | |
| ### END INIT INFO | |
| # Author: Alisue <[email protected]> | |
| # | |
| # Please remove the "Author" lines above and replace them | |
| # with your own name if you copy and modify this script. | |
| # Do NOT "set -e" | |
| # PATH should only include /usr/* if it runs after the mountnfs.sh script | |
| PATH=/sbin:/usr/sbin:/bin:/usr/bin:/usr/local/bin | |
| DESC="Multi-user server for Jupyter notebooks" | |
| NAME=jupyterhub | |
| DAEMON=/usr/local/bin/jupyterhub | |
| DAEMON_ARGS="--config=/etc/jupyterhub/jupyterhub_config.py" | |
| PIDFILE=/var/run/$NAME.pid | |
| SCRIPTNAME=/etc/init.d/$NAME | |
| # Exit if the package is not installed | |
| [ -x "$DAEMON" ] || exit 0 | |
| # Read configuration variable file if it is present | |
| [ -r /etc/default/$NAME ] && . /etc/default/$NAME | |
| # Load the VERBOSE setting and other rcS variables | |
| . /lib/init/vars.sh | |
| # Define LSB log_* functions. | |
| # Depend on lsb-base (>= 3.2-14) to ensure that this file is present | |
| # and status_of_proc is working. | |
| . /lib/lsb/init-functions | |
| # | |
| # Function that starts the daemon/service | |
| # | |
| do_start() | |
| { | |
| # Return | |
| # 0 if daemon has been started | |
| # 1 if daemon was already running | |
| # 2 if daemon could not be started | |
| start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON --test > /dev/null \ | |
| || return 1 | |
| start-stop-daemon --start --background --make-pidfile --quiet --pidfile $PIDFILE --exec $DAEMON -- \ | |
| $DAEMON_ARGS \ | |
| || return 2 | |
| # Add code here, if necessary, that waits for the process to be ready | |
| # to handle requests from services started subsequently which depend | |
| # on this one. As a last resort, sleep for some time. | |
| } | |
| # | |
| # Function that stops the daemon/service | |
| # | |
| do_stop() | |
| { | |
| # Return | |
| # 0 if daemon has been stopped | |
| # 1 if daemon was already stopped | |
| # 2 if daemon could not be stopped | |
| # other if a failure occurred | |
| start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --pidfile $PIDFILE --name $NAME | |
| RETVAL="$?" | |
| [ "$RETVAL" = 2 ] && return 2 | |
| # Wait for children to finish too if this is a daemon that forks | |
| # and if the daemon is only ever run from this initscript. | |
| # If the above conditions are not satisfied then add some other code | |
| # that waits for the process to drop all resources that could be | |
| # needed by services started subsequently. A last resort is to | |
| # sleep for some time. | |
| start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec $DAEMON | |
| [ "$?" = 2 ] && return 2 | |
| # Many daemons don't delete their pidfiles when they exit. | |
| rm -f $PIDFILE | |
| return "$RETVAL" | |
| } | |
| # | |
| # Function that sends a SIGHUP to the daemon/service | |
| # | |
| do_reload() { | |
| # | |
| # If the daemon can reload its configuration without | |
| # restarting (for example, when it is sent a SIGHUP), | |
| # then implement that here. | |
| # | |
| start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME | |
| return 0 | |
| } | |
| case "$1" in | |
| start) | |
| [ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME" | |
| do_start | |
| case "$?" in | |
| 0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;; | |
| 2) [ "$VERBOSE" != no ] && log_end_msg 1 ;; | |
| esac | |
| ;; | |
| stop) | |
| [ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME" | |
| do_stop | |
| case "$?" in | |
| 0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;; | |
| 2) [ "$VERBOSE" != no ] && log_end_msg 1 ;; | |
| esac | |
| ;; | |
| status) | |
| status_of_proc "$DAEMON" "$NAME" && exit 0 || exit $? | |
| ;; | |
| #reload|force-reload) | |
| # | |
| # If do_reload() is not implemented then leave this commented out | |
| # and leave 'force-reload' as an alias for 'restart'. | |
| # | |
| #log_daemon_msg "Reloading $DESC" "$NAME" | |
| #do_reload | |
| #log_end_msg $? | |
| #;; | |
| restart|force-reload) | |
| # | |
| # If the "reload" option is implemented then remove the | |
| # 'force-reload' alias | |
| # | |
| log_daemon_msg "Restarting $DESC" "$NAME" | |
| do_stop | |
| case "$?" in | |
| 0|1) | |
| do_start | |
| case "$?" in | |
| 0) log_end_msg 0 ;; | |
| 1) log_end_msg 1 ;; # Old process is still running | |
| *) log_end_msg 1 ;; # Failed to start | |
| esac | |
| ;; | |
| *) | |
| # Failed to stop | |
| log_end_msg 1 | |
| ;; | |
| esac | |
| ;; | |
| *) | |
| #echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2 | |
| echo "Usage: $SCRIPTNAME {start|stop|status|restart|force-reload}" >&2 | |
| exit 3 | |
| ;; | |
| esac | |
| : |
Thanks for the script!! In case you want to run Jupyterhub as another user instead of root, see https://gist.github.com/zonca/aaeaf3c4e7339127b482d759866e5f39#file-jupyterhub-L54
Can you please let me know # Load the VERBOSE setting and other rcS variables
. /lib/init/vars.sh and # and status_of_proc is working.
. /lib/lsb/init-functions
As i am not finding them on rhel7 . also if i remove those scripts i am getting errors as command not found for log_daemon_msg do_start do_stop .. Please help i want to run jupyterhub as non root user without any spawner class .. like the above as daemon
This errors with, using Amazon Linux:
[ec2-user@gpu ~]$ sudo service jupyterhub start
/etc/init.d/jupyterhub: line 36: /lib/init/vars.sh: No such file or directory
This one works much better:
https://gist.github.com/kose-y/d77d4d054c88e5c5edf03ce6adeab29e
Thank for this script!
A little suggestion, after I've run into some issues. On ubuntu 18.04 the daemon is started in /. I've updated the script a little to make it run in /var/lib/jupyterhub/ (which is created if necessary).
--- jupyterhub 2019-05-03 11:39:35.961611915 +0000
+++ /etc/init.d/jupyterhub 2019-05-03 11:41:35.916295030 +0000
@@ -23,6 +23,7 @@
NAME=jupyterhub
DAEMON=/usr/local/bin/jupyterhub
DAEMON_ARGS="--config=/etc/jupyterhub/jupyterhub_config.py"
+WORKING_DIR="/var/lib/jupyterhub"
PIDFILE=/var/run/$NAME.pid
SCRIPTNAME=/etc/init.d/$NAME
@@ -45,13 +46,14 @@
#
do_start()
{
+ mkdir -p "$WORKING_DIR"
# Return
# 0 if daemon has been started
# 1 if daemon was already running
# 2 if daemon could not be started
- start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON --test > /dev/null \
+ start-stop-daemon --start --quiet -d "$WORKING_DIR" --pidfile $PIDFILE --exec $DAEMON --test > /dev/null \
|| return 1
- start-stop-daemon --start --background --make-pidfile --quiet --pidfile $PIDFILE --exec $DAEMON -- \
+ start-stop-daemon --start --background --make-pidfile --quiet -d "$WORKING_DIR" --pidfile $PIDFILE --exec $DAEMON -- \
$DAEMON_ARGS \
|| return 2
# Add code here, if necessary, that waits for the process to be ready
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
This. Rocks. Thank you!