ezintz/dockerize

dockerize

概述

dockerize是一个用于简化Docker容器中应用运行的工具，主要功能包括：

• 从模板和容器环境变量生成应用配置文件
• 将多个日志文件输出到stdout和/或stderr
• 在启动主进程前等待其他服务（通过TCP、HTTP(S)、unix等协议）可用

典型使用场景包括：当应用需要通过环境变量控制配置文件值，或应用日志输出到文件系统而非标准输出时，dockerize可帮助解决配置管理和日志收集问题。此外，它还能解决容器间服务依赖的启动顺序问题，确保依赖服务就绪后再启动应用。

安装

dockerize是静态编译的二进制文件，可与任何基础镜像配合使用。

基础系统安装

Alpine:

sh
apk add curl
# 安装最新版本
curl -sfL $(curl -s https://api.github.com/repos/powerman/dockerize/releases/latest | grep -i /dockerize-$(uname -s)-$(uname -m)\" | cut -d\" -f4) | install /dev/stdin /usr/local/bin/dockerize
# 安装特定版本（如v0.11.5）
curl -sfL https://github.com/powerman/dockerize/releases/download/v0.11.5/dockerize-`uname -s`-`uname -m` | install /dev/stdin /usr/local/bin/dockerize

Debian/Ubuntu:

sh
apt update && apt install -y curl
# 安装最新版本
curl -sfL $(curl -s https://api.github.com/repos/powerman/dockerize/releases/latest | grep -i /dockerize-$(uname -s)-$(uname -m)\" | cut -d\" -f4) | install /dev/stdin /usr/local/bin/dockerize
# 安装特定版本（如v0.11.5）
curl -sfL https://github.com/powerman/dockerize/releases/download/v0.11.5/dockerize-`uname -s`-`uname -m` | install /dev/stdin /usr/local/bin/dockerize

Busybox（使用wget）:

sh
# 安装最新版本
wget -O - $(wget -O - https://api.github.com/repos/powerman/dockerize/releases/latest | grep -i /dockerize-$(uname -s)-$(uname -m)\" | cut -d\" -f4) | install /dev/stdin /usr/local/bin/dockerize
# 安装特定版本（如v0.11.5）
wget -O - https://github.com/powerman/dockerize/releases/download/v0.11.5/dockerize-`uname -s`-`uname -m` | install /dev/stdin /usr/local/bin/dockerize

验证签名（可选）:

sh
curl -sfL https://powerman.name/about/Powerman.asc | gpg --import
curl -sfL https://github.com/powerman/dockerize/releases/download/v0.11.5/dockerize-`uname -s`-`uname -m`.asc > dockerize.asc
gpg --verify dockerize.asc /usr/local/bin/dockerize

Docker基础镜像

ezintz/dockerize镜像基于Alpine Linux，已预装dockerize并添加到$PATH：

dockerfile
FROM ezintz/dockerize
...
ENTRYPOINT dockerize ...

Docker多阶段构建

dockerfile
FROM ezintz/dockerize AS dockerize
FROM alpine:3.16
COPY --from=dockerize /usr/local/bin/dockerize /usr/local/bin
...
ENTRYPOINT dockerize ...

使用

dockerize通过包装应用调用（使用ENTRYPOINT或CMD指令）工作。例如：

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

上述命令会：从模板生成/etc/nginx/nginx.conf，将/var/log/nginx/access.log输出到STDOUT，/var/log/nginx/error.log输出到STDERR，等待web:8000可用后启动nginx。

命令行选项

模板相关

• -template <src>:<dest>: 指定模板文件和目标文件，可多次使用

  sh
  dockerize -template template1.tmpl:file1.cfg -template template2.tmpl:file3
  

• -template <src>: 仅指定模板源，输出到STDOUT

  sh
  dockerize -template template1.tmpl
  

• -template <src_dir>:<dest_dir>: 处理目录下所有文件（递归），保持目录结构

  sh
  dockerize -template src_dir:dest_dir
  

• -no-overwrite: 不覆盖已存在的目标文件

  sh
  dockerize -no-overwrite -template template1.tmpl:file
  

• -delims <left:right>: 修改模板分隔符（默认{{:}}）

  sh
  dockerize -delims "<%:%>" -template template1.tmpl
  

• -template-strict: 要求模板中引用的所有环境变量必须存在

  sh
  dockerize -template-strict -template template1.tmpl
  

日志相关

• -stdout <file>: 将文件内容输出到STDOUT，可多次使用

  sh
  dockerize -stdout info.log -stdout perf.log
  

• -stderr <file>: 将文件内容输出到STDERR，可多次使用

等待依赖服务

• -wait <url>: 等待指定服务可用，支持协议：file、tcp、tcp4、tcp6、http、https、amqp、amqps、unix，可多次使用

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

• -wait-list "<url1> <url2> ...": 空格分隔的等待URL列表，与多次-wait等效

  sh
  dockerize -wait-list "tcp://db:5432 http://web:80 file:///tmp/generated-file"
  

• -wait-http-header <header>: 为HTTP/HTTPS请求指定头信息（支持文件路径，文件需包含Header: value格式内容）

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

• -wait-http-status-code <code>: 指定可接受的HTTP状态码（默认接受2xx），可多次使用

  sh
  dockerize -wait http://web:80 -wait-http-status-code 302 -wait-http-status-code 200
  

• -wait-http-skip-redirect: 忽略HTTP重定向

超时与重试

• -timeout <duration>: 等待服务超时时间（默认10秒），超时后退出状态码123

  sh
  dockerize -wait tcp://db:5432 -timeout 10s
  

• -wait-retry-interval <duration>: 等待失败后重试间隔（默认1秒）

  sh
  dockerize -wait tcp://db:5432 -wait-retry-interval 5s
  

SSL相关

• -cacert <path>: 指定自定义CA证书用于HTTPS/AMQPS连接验证

  sh
  dockerize -cacert /path/to/ca.pem -wait https://web:80
  

• -skip-tls-verify: 跳过HTTPS/AMQPS连接的SSL证书验证

  sh
  dockerize -skip-tls-verify -wait https://web:80
  

环境变量注入

• -env <path/url>: 从INI文件加载环境变量默认值
• -env-section <name>: 指定INI文件中的节名
• -multiline: 解析INI文件中的多行条目
• -env-header <header>: 为HTTP获取INI文件指定头信息

  sh
  dockerize -env /path/to/file.ini -env-section SectionName -multiline ...
  dockerize -env http://localhost:80/file.ini -env-header "Header: value" ...
  

使用模板

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

{{ .Env.PATH }} is my path

内置函数

除http://masterminds.github.io/sprig/%E5%A4%96%EF%BC%8C%E8%BF%98%E6%94%AF%E6%8C%81%E4%BB%A5%E4%B8%8B%E5%86%85%E7%BD%AE%E5%87%BD%E6%95%B0%EF%BC%9A

• exists $path: 检查文件路径是否存在

  {{ if exists "/etc/default/myapp" }}
  

• parseUrl $url: 解析URL为协议、主机等部分（等同于url.Parse）
• isTrue $value: 将字符串解析为布尔值

  {{ if isTrue .Env.ENABLED }}
  

• jsonQuery $json $query: 对JSON文档执行查询
• readFile $fileName: 读取文件内容（文件不存在返回空字符串）

注意：与原dockerize v0.6.1不兼容，以下函数行为变更：

• default：参数顺序变更
• contains：现在作用于字符串，检查map键使用hasKey
• split：现在返回map，返回列表使用splitList
• replace：参数顺序和数量变更
• loop：已移除，使用untilStep替代

jsonQuery

通过名称访问对象和字段，数组元素通过索引（如[1]）访问，嵌套元素用点（.）分隔。

示例：
若.Env.SERVICES包含以下JSON：

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

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