AWS SSM 参数存储机密后端¶

要启用 SSM 参数存储，请在 airflow.cfg 的 [secrets] 部分中将 SystemsManagerParameterStoreBackend 指定为 backend。

以下是示例配置

[secrets]
backend = airflow.providers.amazon.aws.secrets.systems_manager.SystemsManagerParameterStoreBackend
backend_kwargs = {
  "connections_prefix": "airflow/connections",
  "connections_lookup_pattern": null,
  "variables_prefix": "airflow/variables",
  "variables_lookup_pattern": null,
  "config_prefix": "airflow/config",
  "config_lookup_pattern": null,
  "profile_name": "default"
}

进行身份验证时，您可以提供 Amazon Webservices Connection Extra 配置中列出的参数，或设置环境变量。

[secrets]
backend = airflow.providers.amazon.aws.secrets.systems_manager.SystemsManagerParameterStoreBackend
backend_kwargs = {
  "connections_prefix": "airflow/connections",
  "variables_prefix": "airflow/variables",
  "config_prefix": "airflow/config",
  "role_arn": "arn:aws:iam::123456789098:role/role-name"
}

可选查找¶

可选地，连接、变量或配置可以相互排除地查找，或以任意组合方式查找。这将阻止向 AWS SSM 参数存储发送针对被排除类型的请求。

如果您想在 AWS SSM 参数存储中查找某些项而不查找其他项，可以通过将要排除项的相应 *_prefix 参数设置为 null 来实现。

例如，如果您想将参数 connections_prefix 设置为 "airflow/connections"，并且不查找变量和配置，则您的配置文件应如下所示

[secrets]
backend = airflow.providers.amazon.aws.secrets.systems_manager.SystemsManagerParameterStoreBackend
backend_kwargs = {
  "connections_prefix": "airflow/connections",
  "variables_prefix": null,
  "config_prefix": null,
  "profile_name": "default"
}

如果您只想在 AWS Secrets Manager 中查找特定子集的连接、变量或配置，可通过设置相应的 *_lookup_pattern 参数来实现。该参数的取值为字符串形式的正则表达式。

例如，如果您只想在 AWS Secrets Manager 中查找以 “m” 开头的连接，则您的配置文件应如下所示

[secrets]
backend = airflow.providers.amazon.aws.secrets.secrets_manager.SecretsManagerBackend
backend_kwargs = {
  "connections_prefix": "airflow/connections",
  "connections_lookup_pattern": "^m",
  "profile_name": "default"
}

存储和检索连接¶

如果您已将 connections_prefix 设置为 /airflow/connections，则对于连接 ID 为 smtp_default，应将该连接存储在 /airflow/connections/smtp_default。

您也可以提供一个配置文件名称以引用 AWS 配置文件，例如在 ~/.aws/config 中定义的配置文件。

SSM 参数的值必须是连接 URI 表示，或连接对象的 JSON 格式。

在某些情况下，您需要存储在 AWS SSM 参数存储中的 URI 可能不直观，例如使用 HTTP / HTTPS 或 SPARK 时，可能需要如下形式的 URI：

http://https%3A%2F%2Fexample.com

spark://spark%3A%2F%2Fspark-main-0.spark-main.spark:7077

这是一种已知情况，即 URI 的模式和协议部分是独立的，在某些情况下，需要显式指定。

请参阅 GitHub issue #10256 和 #10913，了解导致此文档更新的更详细讨论。此问题可能在未来得到解决。

相同的连接也可以在 AWS SSM 参数存储中以 JSON 对象的形式表示

{"conn_type": "http", "host": "https://example.com"}

{"conn_type": "spark", "host": "spark://spark-main-0.spark-main.spark", "port": 7077}

存储和检索变量¶

如果您已将 variables_prefix 设置为 /airflow/variables，则对于变量键 hello，应将其存储在 /airflow/variables/hello。

您也可以提供一个配置文件名称以引用 AWS 配置文件，例如在 ~/.aws/config 中定义的配置文件。