自动化Cloud Custodian策略文档

什么是c7n-autodoc？

c7n-autodoc为您的商业合作伙伴提供自动化Cloud Custodian策略文档。

为什么使用c7n-autodoc？

云平台管理员需要为其商业合作伙伴提供关于安全、治理和成本控制政策的清晰准确文档。保持文档最新最简单的方式就是自动化它。此实用程序将创建一个包含有关现有Cloud Custodian策略的易于阅读信息的HTML文件。

功能包括

• 自动写入S3存储桶
• 按资源类型分组策略
• 按类别分组策略（例如‘安全 & 治理’与‘成本控制’）
• 提供到GitLab/GitHub中底层文件的链接
• 使用策略标记来确定适用环境

假设

• 您已将任何必要的安全控制添加到目标S3存储桶
• 本地凭据存在，以便boto3模块将文件推送到S3

安装

注意：需要python3

pip3 install pyyaml boto3 jinja2 jsonschema

配置

您唯一需要自定义的是脚本所需的配置YAML文件。查看提供的示例文件以确定哪些字段是必需的，哪些是可选的。您还可以自定义jinja2模板，以进一步修改创建的HTML文档。

将存放HTML文件的S3存储桶需要启用静态网站托管。默认（index.html，error.html）是可以的，因为您将直接针对c7n-autodoc.html文件。

运行

为了获得最佳结果，此脚本应作为CI/CD管道的一部分运行。

python3 c7n-autodoc.py -c my_config_file.yml

假设没有问题，你应该能在S3桶中看到HTML文件。

示例

待办

• 考虑到不同的策略以进行适当的渲染
• 改进的UI布局
• 更简单的用户设置