jwilder/dockerize

dockerize

镜像概述和主要用途

dockerize是一个简化Docker容器中应用运行的工具，旨在解决容器化应用部署中的常见问题，如配置文件动态生成、日志集中管理以及服务依赖启动顺序协调，使应用在Docker环境中更易于配置和维护。

核心功能和特性

• 动态配置生成：基于模板文件和容器环境变量，在容器启动时动态生成应用配置文件
• 日志标准化输出：将应用输出到文件系统的多个日志文件重定向至stdout/stderr，便于docker logs命令统一查看
• 服务依赖等待：支持在启动主进程前，等待其他服务通过TCP、HTTP(S)、unix、file等协议可用，解决服务启动顺序问题

使用场景和适用范围

• 配置依赖环境变量：当应用无法直接读取环境变量，需从配置文件获取参数时（如Python应用的设置文件需配置数据库URL）
• 日志文件系统输出：应用默认将日志输出到文件系统而非标准流，导致容器日志难以查看时（如Nginx默认日志输出到/var/log/nginx目录）
• 多服务协同启动：使用Docker Compose等工具时，需等待关联容器服务就绪后再启动当前应用（如等待数据库服务启动后再启动Web应用）

安装

Docker基础镜像

jwilder/dockerize是基于Alpine Linux的基础镜像，已预装dockerize并添加至$PATH，可直接使用：

dockerfile
FROM jwilder/dockerize
...
ENTRYPOINT dockerize ...

Ubuntu镜像

在Ubuntu基础镜像中安装：

dockerfile
RUN apt-get update && apt-get install -y wget

ENV DOCKERIZE_VERSION v0.5.0
RUN wget https://github.com/jwilder/dockerize/releases/download/$DOCKERIZE_VERSION/dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz \
    && tar -C /usr/local/bin -xzvf dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz \
    && rm dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz

Alpine镜像

在Alpine基础镜像中安装：

dockerfile
RUN apk add --no-cache openssl

ENV DOCKERIZE_VERSION v0.5.0
RUN wget https://github.com/jwilder/dockerize/releases/download/$DOCKERIZE_VERSION/dockerize-alpine-linux-amd64-$DOCKERIZE_VERSION.tar.gz \
    && tar -C /usr/local/bin -xzvf dockerize-alpine-linux-amd64-$DOCKERIZE_VERSION.tar.gz \
    && rm dockerize-alpine-linux-amd64-$DOCKERIZE_VERSION.tar.gz

使用方法

dockerize通过包装应用启动命令（使用ENTRYPOINT或CMD指令）工作。以下示例展示生成Nginx配置、日志重定向及服务依赖等待的完整用法：

dockerfile
CMD dockerize -template /etc/nginx/nginx.tmpl:/etc/nginx/nginx.conf -stdout /var/log/nginx/access.log -stderr /var/log/nginx/error.log -wait tcp://web:8000 nginx

命令行选项

模板生成

• 多模板支持：多次使用-template指定多个模板文件：

  bash
  $ dockerize -template template1.tmpl:file1.cfg -template template2.tmpl:file3
  

• 模板输出到STDOUT：不指定目标路径时，模板内容输出至STDOUT：

  bash
  $ dockerize -template template1.tmpl
  

• 目录模板处理：模板为目录时，递归处理目录内所有文件并输出至目标目录（目标目录省略时输出至STDOUT）：

  bash
  $ dockerize -template src_dir:dest_dir
  

• 禁止覆盖文件：使用-no-overwrite选项避免覆盖已存在的目标文件：

  bash
  $ dockerize -no-overwrite -template template1.tmpl:file
  

日志处理

• 多日志文件重定向：多次使用-stdout或-stderr指定多个日志文件：

  bash
  $ dockerize -stdout info.log -stdout perf.log
  

• 日志轮询模式：当inotify机制不可用时，使用-poll选项轮询文件变化：

  bash
  $ dockerize -stdout info.log -stdout perf.log -poll
  

模板语法自定义

使用-delims修改模板变量分隔符（默认{{和}}）：

bash
$ dockerize -delims "<%:%>"

HTTP请求头配置

为HTTP/HTTPS协议的等待检查添加自定义请求头：

bash
$ dockerize -wait http://web:80 -wait-http-header "Authorization:Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=="

等待其他服务依赖

dockerize支持在启动主进程前等待其他服务就绪，支持协议包括file、tcp、tcp4、tcp6、http、https和unix，解决容器启动顺序导致的服务不可用问题。

基础用法

bash
$ dockerize -wait tcp://db:5432 -wait http://web:80 -wait file:///tmp/generated-file

超时设置

使用-timeout指定等待超时时间（默认10秒），超时未就绪则进程退出（状态码1）：

bash
$ dockerize -wait tcp://db:5432 -wait http://web:80 -timeout 10s

模板使用详解

模板基于Golang text/template语法，通过.Env访问环境变量：

{{ .Env.PATH }}  # 输出环境变量PATH的值

内置模板函数

• default：为不存在的变量提供默认值
  {{ default .Env.VERSION "0.1.2" }}

• contains：检查字符串是否包含子串
  {{ contains .Env.PATH "/usr/local/bin" }}

• exists：检查文件路径是否存在
  {{ exists "/etc/default/myapp" }}

• split：按分隔符拆分字符串为数组（strings.Split别名）
  {{ split .Env.PATH ":" }}

• replace：替换字符串中的子串（strings.Replace别名）
  {{ replace .Env.PATH ":" ";" -1 }}

• parseUrl：解析URL为URL对象（url.Parse别名）
  {{ parseUrl .Env.URL }}

• atoi：字符串转整数
  {{ if (gt (atoi .Env.NUM_THREADS) 1) }}

• add：整数加法运算
  {{ add (atoi .Env.SHARD_NUM) -1 }}

• isTrue：字符串转布尔值（支持"true"、"1"、"yes"等）
  {{ if isTrue .Env.ENABLED }}

• lower/upper：字符串大小写转换
  {{ lower .Env.NAME }} / {{ upper .Env.NAME }}

• jsonQuery：JSON文档查询

• loop：循环生成

jsonQuery函数

支持通过名称访问对象字段、索引访问数组元素（[index]），嵌套元素用点（.）分隔。示例：
若环境变量SERVICES值为：

json
{
  "services": [
    { "name": "service1", "port": 8000 },
    { "name": "service2", "port": 9000 }
  ]
}

则jsonQuery .Env.SERVICES "services.[1].port"返回9000。

loop函数

生成循环序列，支持1-3个参数：

• loop n：生成0到n-1的序列
• loop start end：生成start到end-1的序列
• loop start end step：生成start到end-1、步长为step的序列

示例：

# 循环0-9
{{ range loop 10 }}
i = {{ . }}
{{ end }}

# 循环5-9
{{ range $i := loop 5 10 }}
i = {{ $i }}
{{ end }}

# 循环5、7、9（步长2）
{{ range $i := loop 5 10 2 }}
i = {{ $i }}
{{ end }}

许可证

MIT