ucsdets/k8s-support

k8s-support 镜像文档

镜像概述

k8s-support是一个在主notebook服务器容器启动前运行的初始化容器，主要用于为JupyterHub环境提供必要的工具支持和进程管理能力。该容器通过挂载指定目录、集成进程管理工具，确保主容器能够稳定运行并支持后台任务管理。

核心功能与特性

1. 目录挂载

将仓库中的bin目录挂载到容器内的/opt/k8s-support路径，为后续主容器提供工具支持。在Kubernetes环境中，通过KubeSpawner的volume_mounts和singleuser_init_containers配置实现（参考：https://github.com/ucsd-ets/dsmlp-helmfile/blob/master/releases/jupyterhub/extraConfig.py%EF%BC%89%E3%80%82

2. tini进程管理

集成https://github.com/krallin/tini%E5%B7%A5%E5%85%B7%E4%BD%9C%E4%B8%BAinit%E8%BF%9B%E7%A8%8B%EF%BC%8C%E8%B4%9F%E8%B4%A3%E5%88%9B%E5%BB%BA%E5%AD%90%E8%BF%9B%E7%A8%8B%EF%BC%88%E5%A6%82Jupyter Notebook）并处理孤儿进程。当应用创建子进程且子进程终止时，tini会执行wait操作清理进程表，解决Docker环境中孤儿进程残留问题。

3. screen命令支持

包含GNU Screen工具，用于管理后台运行的进程。支持创建、列出、连接和断开后台进程终端，适用于长期运行任务的管理。常见用法：

• screen：创建新的后台进程终端
• screen ls：列出所有后台运行的screen进程
• screen -r <pid>：连接到指定PID的后台进程
• screen -d <pid>：断开与指定PID进程的终端连接

4. pause命令支持

基于google/pause镜像构建，提供pause命令。该命令通过sleep运行进程，接收SIGTERM信号时终止，用于容器启动后等待用户连接的场景。

使用场景

• JupyterHub环境中作为初始化容器，为主notebook服务器提供前置工具准备
• 需要管理长期运行后台任务（如耗时一天的作业）的场景
• 需要处理子进程生命周期，避免孤儿进程残留的容器环境

使用方法与配置说明

Kubernetes环境配置

在JupyterHub的Kubernetes部署中，通过KubeSpawner配置将k8s-support作为初始化容器：

python
# 示例：extraConfig.py 中的配置
c.KubeSpawner.singleuser_init_containers = [
    {
        "name": "k8s-support",
        "image": "k8s-support:latest",
        "volumeMounts": [
            {
                "name": "k8s-support-bin",
                "mountPath": "/opt/k8s-support"
            }
        ]
    }
]

c.KubeSpawner.volume_mounts = [
    {
        "name": "k8s-support-bin",
        "mountPath": "/opt/k8s-support",
        "readOnly": True
    }
]

Docker运行示例

bash
# 基本运行命令
docker run -d --name k8s-support \
  -v /path/to/local/bin:/opt/k8s-support \
  k8s-support:latest

关键配置说明

• 挂载卷：必须将包含工具的bin目录挂载到/opt/k8s-support，确保主容器可访问所需工具
• tini进程：容器默认以tini作为init进程，无需额外配置
• screen使用：进入容器后可直接使用screen命令管理后台进程
• pause命令：通过运行pause命令使容器进入等待状态，直至接收SIGTERM信号