SSM参数存储模板

使用SSM参数存储数据渲染模板的命令行应用程序

安装

ssm-ps-template应用程序可通过Python包索引获取，并可以使用pip进行安装

pip install ssm-ps-template

模板化

应用程序使用Jinja2作为模板引擎。应用程序默认公开了Jinja2模板的所有可用功能。

使用前缀

应用程序默认前缀为/，会添加到不以斜杠开头（/）的参数名称之前。

此功能允许您在路径前缀下分组变量，例如/my-application/settings，然后仅引用单个键值，如password，而不是引用完整的路径/my-application/settings/password。

如果您以斜杠开头引用参数名称，则不会将前缀添加到参数名称中。

获取参数存储值

应用程序在模板中公开get_parameter(name: str, default: typing.Optional[str] = None)以访问SSM参数存储中的值。

以下示例中，我们假设存在用于键 /my-application/foo 和 /my-application/bar 的参数存储值，并且应用程序使用前缀 /my-appliction 调用。

foo: {{ get_parameter('/my-application/foo') }}
bar: {{ get_parameter('/my-application/bar') }}

将呈现为：

foo: bar
baz: qux

此外，还有一个公开的函数 get_parameters_by_path(path: str, default: typing.Optional[dict] = None)，它将返回指定路径的字典。

以下示例将遍历结果

{% for key, value in get_parameters_by_path('settings/', {}).items() %}
  {{ key }}: {{ value }}
{% endfor %}

或者，您可以使用 Jinja 过滤器将它们转换为 YAML

{{ get_parameters_by_path('settings/') | path_to_dict | toyaml | indent(2, first=True) }}

对于存储为 StringList 的参数存储中的值，它们将被自动转换为字符串列表。以下是一个值示例

以下模板

Connections:
{% for connection in get_parameter('/my-application/connections', []) %}
  - {{ connection }}

以下将呈现为

Connections:
  - amqp://server1
  - amqp://server2

性能考虑因素

参数名称在预处理步骤中收集，以最小化对 SSM 参数存储的调用。

配置

配置文件提供指定多个模板、覆盖 AWS 配置和更改日志级别的功能。

顶级配置指令

模板配置指令

配置中的 templates 指令是对象数组。

如果 destination 路径中存在父目录且不存在，则将创建它们。

扩展模板功能

除了 Jinja2 公开的基功能外，还添加了以下 Python 函数。

以下过滤器已添加：

以下变量被公开

配置文件格式

应用程序支持 JSON、TOML 或 YAML 作为配置文件格式。以下示例使用 YAML 格式

示例配置文件

templates:
  - source: /etc/ssm-templates/nginx-example
    destination: /etc/nginx/sites-available/example
    prefix: /namespaced/application/nginx/
  - source: /etc/ssm-templates/postgres-example
    destination: /etc/postgresql/14/main/postgresql.conf
    prefix: /namespaced/application/postgres/
    user: postgres
    group: postgres
    mode: 0600
profile: default
region: us-east-1
verbose: false

命令行用法

usage: ssm-ps-template [-h] [--aws-profile AWS_PROFILE] [--aws-region AWS_REGION] [--endpoint-url ENDPOINT_URL] [--prefix PREFIX] [--replace-underscores]
                       [--verbose] [--version]
                       config

Command line application to render templates with data from SSM Parameter Store

positional arguments:
  config

optional arguments:
  -h, --help            show this help message and exit
  --aws-profile AWS_PROFILE
                        AWS Profile (default: None)
  --aws-region AWS_REGION
                        AWS Region (default: None)
  --endpoint-url ENDPOINT_URL
                        Specify an endpoint URL to use when contacting SSM Parameter Store. (default: None)
  --prefix PREFIX       Default SSM Key Prefix (default: /)
  --replace-underscores
                        Replace underscores in variable names to dashes when looking for values in SSM (default: False)
  --verbose
  --version             show program's version number and exit

注意，默认的 SSM 前缀也可以通过 PARAMS_PREFIX 环境变量设置，端点 URL 可以通过 SSM_ENDPOINT_URL 环境变量设置。