將Jupyter/JupyterHub/JupyterLab運行爲系統服務

Jupyter/JupyterHub/JupyterLab可以以多種方式運行，包括命令行、系統服務、Docker實例、Kubernetes應用等。這裏介紹將其做爲系統服務運行的方式，經過使用《IPython 6/Jupyter的magic操做符》、《 IPython的Magics魔法操做符》可提供更好的控制檯操做（誰用誰知道！若是在Notebook中須要輸入密碼，可使用sshpass參考《Ubuntu上使用sshpass遠程腳本免密安全交互》 ），也支持標準的遠程shell控制檯。

首先，在宿主機安裝Anaconda、Jupyter和JupyterLab。方法以下：

• JupyterLab的本地安裝和使用（Ubuntu 18.04）

一、Jupyter for Ubuntu/Debian Anaconda3 with systemd

建立服務描述文件：

#/etc/systemd/system/jupyter.service

編輯文件： 

sudo nano /etc/systemd/system/jupyter.service

把下面的內容複製進去：

[Unit]
Description=Jupyter
After=syslog.target network.target

[Service]
User=supermap
Environment="PATH=/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/opt/anaconda3/bin"
WorkingDirectory=/home/supermap/
ExecStart=/home/supermap/anaconda3/bin/jupyter lab --ip=10.1.1.201

Restart=on-failure
RestartSec=10

[Install]
WantedBy=multi-user.target

從新載入服務：

sudo systemctl daemon-reload

啓動服務：

sudo systemctl start jupyter

查看狀態：

sudo systemctl status jupyter --no-pager

能夠看到相應的登陸地址和token等信息，將其輸入瀏覽器便可訪問。

設置爲系統啓動時自動啓動：

sudo systemctl enable jupyter

二、JupyterHub for Ubuntu/Debian Anaconda3 with systemd

若是使用JupyterHub，採用 /opt/anaconda3/jupyterhub 做爲配置目錄。保存下面內容爲文件 /etc/systemd/system/jupyterhub.service。

[Unit]
Description=Jupyterhub
After=syslog.target network.target

[Service]
User=root
Environment="PATH=/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/opt/anaconda3/bin"
ExecStart=/opt/anaconda3/bin/jupyterhub -f /etc/jupyterhub/jupyterhub_config.py

[Install]
WantedBy=multi-user.target

若是保存配置 c.JupyterHub.cleanup_servers = False 在 JupyterHub config，須要加入 KillMode=process 在 [Service] 段中。缺省狀況下，systemd將在退出時kill掉全部的子進程。

使用sudo systemctl daemon-reload 和 sudo systemctl <start|stop|status> jupyterhub來啓動服務。 sudo systemctl enable jupyterhub 將使 jupyterhub 開機自動啓動。

三、JupyterHub for Ubuntu/Debian 的非systemd配置

保存 https://gist.github.com/lambdalisue/f01c5a65e81100356379 爲 /etc/init.d/jupyterhub。以下：

#! /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 <lambdalisue@hashnote.net>
#
# 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

:

而後，執行配置過程：

$ sudo chmod +x /etc/init.d/jupyterhub
# Create a default config to /etc/jupyterhub/jupyterhub_config.py
$ sudo jupyterhub --generate-config -f /etc/jupyterhub/jupyterhub_config.py
# Reload systemctl daemon to notice the init.d script
$ sudo systemctl daemon-reload
# Start jupyterhub
$ sudo service jupyterhub start
# Stop jupyterhub
$ sudo service jupyterhub stop
# Start jupyterhub on boot
$ sudo update-rc.d jupyterhub defaults
# Or use rcconf to manage services http://manpages.ubuntu.com/manpages/natty/man8/rcconf.8.html
$ sudo rcconf

四、JupyterHub for CentOS/Fedora with Generic systemd

假設使用 /etc/jupyterhub 做爲 configs，保存下面內容到文件 /lib/systemd/system/jupyterhub.service:

[Unit]
Description=Jupyterhub

[Service]
User=jupyterhub
ExecStart=/usr/bin/jupyterhub --JupyterHub.spawner_class=sudospawner.SudoSpawner
WorkingDirectory=/etc/jupyterhub

[Install]
WantedBy=multi-user.target

• 注意:
  • 須要添加 After=network-online.target 到 [Unit] section，不然設置 service 開機啓動將失敗，由於網絡還不可用。
  • 設置正確的 User 和爭取的權限來運行 /usr/bin/jupyterhub。

運行: sudo systemctl daemon-reload. 而後 sudo systemctl <start|stop|status> jupyterhub來啓動服務。

• 注意:
  • 確保安裝 sudospawner.SudoSpawner ，運行 pip3 install git+https://github.com/jupyter/sudospawner。

五、JupyterHub for OSX

添加 jupyterhub_config.py 到 /etc/jupyterhub (若是沒有則建立之)。建立 /Library/LaunchDaemons/com.jupyterhub.plist 粘貼下面的內容並編輯路徑，指向jupyterhub。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
    <dict>
        <key>Label</key>
        <string>com.jupyterhub.app</string>
        <key>ProgramArguments</key>
        <array>
            <string>/opt/anaconda3/bin/jupyterhub</string>
            <string>-f</string>
            <string>/etc/jupyterhub/jupyterhub_config.py</string>
        </array>
        <key>KeepAlive</key>
        <true/>
        <key>StandardErrorPath</key>
        <string>/var/log/jupyterhuberr.log</string>
        <key>StandardOutPath</key>
        <string>/var/log/jupyterhubout.log</string>
        <key>EnvironmentVariables</key>
        <dict>
          <key>PATH</key>
            <string><![CDATA[/usr/local/bin:/usr/local/sbin:/usr/bin:/bin:/usr/sbin:/sbin:/opt/anaconda3/bin]]></string>
        </dict>

    </dict>
</plist>

載入和啓動service，以下：

sudo launchctl load -w /Library/LaunchDaemons/com.jupyterhub.plist
sudo launchctl start -w /Library/LaunchDaemons/com.jupyterhub.plist

你的jupyterhub 能夠經過localhost:8000 (缺省的config)來訪問（若是須要外部機器訪問，在啓動命令行加上--ip=x.x.x.x.參數）。若是訪問不了，經過 /var/log/system.log | grep jupyter 來查看狀態或者查看日誌文件 /var/log/jupyterhubout.log 來查看緣由。

六、其餘

查看 https://github.com/jupyter/jupyterhub/issues/317 並分享你的經驗。

更多參考：

• 本機運行Jupyter
  • JupyterLab的本地安裝和使用（Ubuntu 18.04）
  • BinderHub 安裝指南
• 容器運行Jupyter
  • 容器運行 Jupyter notebook server
  • 基於Docker+Jupyter+Python的科學計算環境
  • 整合GIS和Jupyter Notebook平臺
• Kubernetes運行Jupyter
  • 快速設置JupyterHub for K8s
  • 使用kubeadm部署高可用Kubernetes 1.17.0
  • Kubernetes 1.17.0管理界面Dashboard 2
  • 爲JupyterHub自定義Notebook Images