neochrome/parameter-store-executor

Parameter Store Executor

概述和主要用途

Parameter Store Executor是一款工具，用于从AWS SSM Parameter Store递归获取指定PARAMETER_PATHs下的参数，并将这些参数转换为环境变量后执行命令。它解决了在执行命令前从AWS参数存储注入配置参数的需求，特别适用于需要动态获取配置的应用场景。

核心功能和特性

• 参数递归获取：支持从指定PARAMETER_PATHs递归获取所有参数
• 参数名转换规则：
  • 相对于对应PARAMETER_PATH的相对路径
  • 将所有'/'和'-'字符替换为'_'
  • 转换为大写字母
• 环境变量优先级：已存在的环境变量（除非指定--clean-env）会被传递并优先于同名参数，支持参数覆盖（如开发环境中覆盖特定参数）
• 冲突解决：冲突参数的值以最后找到的为准

参数转换示例

gherkin
假设存在以下参数：
| name      | value |
| /one/test | 1     |
| /two/test | 2     |

当请求路径为: [/, /one, /two]

则会生成以下环境变量：
| name     | value |
| ONE_TEST | 1     |
| TWO_TEST | 2     |
| TEST     | 2     |

核心功能和特性

• 自动检测AWS凭证，支持多种凭证来源
• 支持参数名转换，确保符合环境变量命名规范
• 允许现有环境变量覆盖参数值，便于开发环境调试
• 可作为Docker镜像的ENTRYPOINT，方便容器化应用集成

安装

从源码构建

1. 克隆仓库
2. 运行 shards build
3. 将 ./bin/pse 可执行文件复制到 $PATH 中的某个目录

发布的二进制文件

从https://github.com/neochrome/parameter-store-executor/releases%E4%B8%8B%E8%BD%BD%E6%89%80%E9%9C%80%E7%89%88%E6%9C%AC%E3%80%82

使用方法

AWS凭证检测顺序

启动工具时，会按以下顺序检测当前AWS凭证：

1. 来自环境变量
2. 来自~/.aws/credentials文件
3. 来自实例元数据服务（在EC2实例上使用时特别有用）

基本命令行使用

sh
pse /path/to/parameters -- env

使用 --help 选项可获取更多调用信息。

Docker使用

从GitHub安装二进制发布版

Dockerfile
FROM alpine

# 安装特定版本的二进制文件
ARG pse_version=latest
ADD https://github.com/neochrome/parameter-store-executor/releases/download/${pse_version}/pse /
# -- 或者 --
# 使用最新发布版本
ADD https://github.com/neochrome/parameter-store-executor/releases/latest/download/pse /

从Docker Hub安装二进制发布版

二进制发布版也已推送到Docker Hub，可通过多阶段构建安装：

Dockerfile
# 安装特定版本的二进制发布版
FROM neochrome/parameter-store-executor:0.2.0 as release
# -- 或者 --
# 使用最新版本
FROM neochrome/parameter-store-executor:latest as release

COPY --from=release /pse /

Entrypoint配置

可将该工具指定为Docker镜像的ENTRYPOINT，以便在容器中轻松使用AWS SSM Parameter Store参数运行应用：

Dockerfile
FROM alpine

# 使用上述任一方法安装二进制发布版

# 使二进制文件可执行
RUN chmod +x /pse

# 除非从容器外部传入，否则指定AWS_REGION
ENV AWS_REGION=eu-west-1

# 使用环境变量指定要使用的参数
ENV PARAMETER_PATH=/some/path
ENTRYPOINT /pse "$PARAMETER_PATH" -- env
# -- 或者 --
# 直接在ENTRYPOINT中指定参数，并可选使用CMD
ENTRYPOINT [ "/pse", "/some/path", "--" ]
CMD ["env"]

适用场景

• 容器化应用需要从AWS参数存储动态获取配置参数时
• 在EC2实例或EKS集群中运行的应用，需要安全注入敏感配置
• 开发环境中需要覆盖特定参数进行调试时
• 需统一管理应用配置，避免硬编码环境变量的场景

贡献

1. Fork仓库（https://github.com/neochrome/parameter-store-executor/fork）
2. 创建功能分支（git checkout -b my-new-feature）
3. 提交更改（git commit -am 'Add some feature'）
4. 推送到分支（git push origin my-new-feature）
5. 创建新的Pull Request

发布

要创建新版本，推送带有新版本号（遵循语义化版本）的标签，例如：v1.2.3。该标签需指向已更新shard.yml版本和./src/version.cr的提交。脚本./scripts/version可同步版本并执行以下检查：

1. 检测未提交的更改
2. 检查代码格式
3. 测试通过情况
4. 新版本号的合理性检查