springload/ssm-parent

SSM Parent Docker镜像

镜像概述

SSM Parent是一个Docker入口点工具，核心作用是从AWS SSM参数存储获取参数（包括秘密数据），并将其暴露为环境变量或生成.env文件，供应用程序使用。使用时需确保存在合适的init进程（如通过docker run --init启用Docker内置init）。

核心功能

1. 参数读取：支持从SSM参数存储读取路径（-p）、名称（-n）、普通路径（--plain-path）、普通名称（--plain-name）类型的参数；
2. 参数合并：多个JSON格式参数会被合并，右侧参数覆盖左侧同名键；
3. 输出方式：可将参数转为环境变量（run命令）或生成.env文件（dotenv命令）；
4. 变量转换：通过配置文件支持变量的重命名、删除、模板化（使用Go模板，含自定义函数如url_host、trim_prefix等）；
5. 命令行工具：提供print（打印参数）、run（运行应用）、dotenv（生成.env）等命令。

使用场景

• 应用需要从SSM参数存储动态获取配置或秘密，避免硬编码敏感信息；
• 生成.env文件供不支持直接读取环境变量的应用使用；
• 对SSM获取的参数进行转换（如从数据库URL中提取服务器、用户名等信息）。

配置说明

命令行参数示例

bash
# 打印从指定路径读取的参数
ssm-parent print -r -p /myproject/production/backend/

# 运行应用并注入环境变量
ssm-parent run -e -p /myproject/production/backend/ -- myapp

# 生成.env文件
ssm-parent dotenv -r -p /myproject/production/backend/ .env

配置文件示例（YAML）

yaml
recursive: true
expand: true
debug: true
paths: ["/$PROJECT/common/", "/$PROJECT/$ENVIRONMENT"]

transformations:
  - action: template
    rule:
      SS_DATABASE_SERVER: "{{ url_host .DATABASE_URL }}"
      SS_DATABASE_USERNAME: "{{ url_user .DATABASE_URL }}"
      SS_DATABASE_PASSWORD: "{{ url_password .DATABASE_URL }}"
      SS_DATABASE_NAME: "{{ with $x := url_path .DATABASE_URL }}{{ trim_prefix $x \"/\" }}{{end}}"
  - action: rename
    rule:
      AWS_BUCKET: AWS_S3_BUCKET
  - action: delete
    rule:
      - DATABASE_URL

Docker部署示例

Dockerfile片段

dockerfile
ENV PROJECT myproject
ENV ENVIRONMENT production

RUN wget -O /tmp/ssm-parent.tar.gz https://github.com/springload/ssm-parent/releases/download/v1.4.1/ssm-parent_1.4.1_linux_amd64.tar.gz && \
    tar xvf /tmp/ssm-parent.tar.gz && mv ssm-parent /usr/bin/ssm-parent && rm /tmp/ssm-parent.tar.gz

ENTRYPOINT ["/usr/bin/ssm-parent", "run", "-e", "-p", "/$PROJECT/$ENVIRONMENT/backend/", "-r", "--"]
CMD ["caddy", "--conf", "/etc/Caddyfile", "--log", "stdout"]

作为Docker阶段使用

dockerfile
# 获取SSM Parent
FROM springload/ssm-parent:1.4.1 as ssm-parent

# 主镜像
FROM alpine
ENV PROJECT myproject
ENV ENVIRONMENT production

COPY --from=ssm-parent /usr/bin/ssm-parent /usr/bin/ssm-parent

ENTRYPOINT ["/usr/bin/ssm-parent", "run", "-e", "-p", "/$PROJECT/$ENVIRONMENT/backend/", "-r", "--"]
CMD ["caddy", "--conf", "/etc/Caddyfile", "--log", "stdout"]