cloudkats/c7n-mailer

Cloud Custodian Mailer 镜像文档

镜像概述与主要用途

Cloud Custodian Mailer 是一个非官方的Docker镜像，实现了Cloud Custodian的邮件器功能。Cloud Custodian是一个云安全、成本优化和治理的规则引擎，通过YAML领域特定语言(DSL)定义策略，用于查询、筛选云资源并对其执行操作。本镜像专注于提供出站邮件传递能力，支持将策略执行结果通过邮件通知相关人员。

核心功能与特性

• 规则引擎集成：与Cloud Custodian规则引擎无缝集成，支持基于YAML策略文件执行资源查询与操作
• YAML策略DSL：使用简洁的YAML格式定义策略，实现对云资源的条件筛选和操作逻辑
• 资源操作能力：支持对云资源执行查询、筛选及各类操作（如标记、删除、通知等）
• 邮件通知功能：提供出站邮件传递机制，将策略执行结果、资源状态变更等信息通过邮件发送
• 开源实现：基于Cloud Custodian官方工具源码构建（https://github.com/cloud-custodian/cloud-custodian/tree/master/tools/c7n_mailer%EF%BC%89

使用场景与适用范围

• 云资源安全监控：监控云资源配置合规性，发送安全漏洞或不合规配置的邮件通知
• 成本优化管理：识别闲置或低利用率资源，通过邮件发送成本优化建议
• 云治理自动化：实现云资源治理策略的自动执行与结果通知
• 多云环境管理：适用于AWS、Azure、GCP等主流云平台的资源管理与通知

使用方法与配置说明

基本使用示例

使用docker run命令启动容器，需挂载策略文件目录并配置邮件相关环境变量：

bash
docker run -d \
  -v /path/to/policies:/policies \
  -e SMTP_SERVER=smtp.example.com \
  -e SMTP_PORT=587 \
  -e SMTP_USER=user@example.com \
  -e SMTP_PASSWORD=your_password \
  -e FROM_EMAIL=notifications@example.com \
  cloudcustodian/mailer:latest

关键配置参数

通过环境变量配置邮件服务：

• SMTP_SERVER：SMTP服务器地址（必填）
• SMTP_PORT：SMTP服务器端口（通常为587或465，必填）
• SMTP_USER：SMTP认证用户名（必填）
• SMTP_PASSWORD：SMTP认证密码（必填）
• FROM_EMAIL：发件人***地址（必填）
• SMTP_USE_TLS：是否启用TLS（可选，默认true）

策略文件挂载

将包含YAML策略文件的目录挂载到容器内/policies路径，Custodian将自动加载并执行策略：

bash
-v /local/policies:/policies

查看日志

通过容器日志查看策略执行情况和邮件发送状态：

bash
docker logs <container_id>

参考文档

• https://cloudcustodian.io/docs/tools/c7n-mailer.html
• https://github.com/cloud-custodian/cloud-custodian/tree/master/tools/c7n_mailer