rancher/s6-builder

s6 Runtime 镜像文档

镜像概述和主要用途

本镜像是基于 jprjr/s6-builder 的固定版本构建，提供 s6 运行时环境。s6 是一套轻量级的 Unix 进程管理工具集，核心功能包括进程 supervision（监控与重启）、服务生命周期管理、信号处理及日志聚合，适用于 Docker 容器场景下的服务进程管理，确保服务可靠启动、运行及故障恢复。

核心功能和特性

核心功能

• 进程 Supervision：监控服务进程状态，异常退出时自动重启，保障服务可用性。
• 轻量级设计：组件体积小，资源占用低，适合容器化环境。
• 快速启动：优化进程启动流程，减少服务初始化延迟。
• 可靠信号处理：支持自定义进程信号（如 SIGTERM、SIGINT）处理逻辑，确保服务优雅停止。
• 日志管理：提供统一日志收集能力，支持将服务日志重定向至标准输出或文件。

关键特性

• 兼容标准 Unix 信号机制，支持进程间通信与控制；
• 支持多进程管理，可在单容器中协调多个关联服务；
• 内置服务生命周期管理脚本，简化服务启动/停止/重启流程；
• 配置简洁，支持通过文件系统或环境变量自定义服务行为。

使用场景和适用范围

典型使用场景

1. Docker 容器多进程管理：需在单个容器中运行多个关联服务（如应用服务+日志收集器）时，通过 s6 实现进程协调与监控。
2. 服务进程可靠性保障：对关键服务（如 API 服务、数据库代理）提供故障自动恢复能力，避免进程意外退出导致服务中断。
3. 日志聚合与处理：通过 s6 的日志重定向功能，将服务日志统一输出至容器标准输出，便于 Docker 日志驱动收集与分析。
4. 微服务容器初始化：作为基础镜像，为微服务提供标准化的进程管理底座，简化服务部署流程。

适用范围

• 基于 Docker 的服务容器化部署；
• 需要轻量级进程 supervision 的场景（对比 systemd、supervisord 等工具，更适合资源受限环境）；
• 需自定义服务启动顺序或依赖关系的多服务容器。

使用方法和配置说明

基本使用：启动容器

通过 docker run 命令启动容器，基础用法如下：

bash
docker run -d --name s6-demo <镜像名称>

默认情况下，镜像会启动 s6 supervision 主进程，并运行预配置的服务（具体服务需参考镜像内置配置或自定义添加）。

配置说明

环境变量

镜像可能支持以下环境变量（具体以实际镜像实现为准）：

自定义服务配置

s6 通过服务目录管理进程，用户可通过挂载或构建时添加自定义服务配置：

1. 服务目录结构：每个服务需在 /etc/s6/services/ 目录下创建独立子目录（如 /etc/s6/services/my-service/），包含以下文件：

   • run：可执行脚本，定义服务启动命令（必须存在且可执行）；
   • finish：可选脚本，定义服务停止时的清理逻辑；
   • down：可选脚本，定义服务强制终止时的处理逻辑。

2. 示例：添加自定义服务
   创建 my-service 服务配置，启动 nginx 并输出日志：

   dockerfile
   # 自定义 Dockerfile 示例
   FROM <s6-runtime-image>
   RUN mkdir -p /etc/s6/services/my-service
   # 编写 run 脚本
   RUN echo '#!/bin/sh' > /etc/s6/services/my-service/run && \
       echo 'exec nginx -g "daemon off;"' >> /etc/s6/services/my-service/run && \
       chmod +x /etc/s6/services/my-service/run
   

3. 通过挂载自定义服务
   运行时挂载本地服务配置目录至容器：

   bash
   docker run -d -v $(pwd)/my-service:/etc/s6/services/my-service <镜像名称>
   

注意事项

• 本镜像基于 jprjr/s6-builder 固定版本构建，s6 工具版本及特性以基础构建版本为准；
• 自定义服务脚本需确保正确处理信号（如 SIGTERM），避免服务无法优雅停止；
• 日志输出建议重定向至标准输出（stdout/stderr），便于 Docker 日志驱动（如 json-file、journald）收集。