云托管-自动策略文档
c7n-autodoc的Python项目详细描述
自动云托管策略文档
什么是c7n autodoc？
为您的业务合作伙伴提供自动化云托管策略文档。
为什么使用c7n autodoc？
云平台的管理员需要提供他们的业务合作伙伴 有关于安全、治理和 成本控制政策。最容易掌握文档的方法 就是让它自动化。此实用程序将创建一个包含易于阅读的信息的html文件 关于你现有的云托管政策。
功能包括：
- 自动写入S3存储桶
- 按资源类型对策略分组
- 按类别分组策略（即“安全和治理”与“成本控制”）
- 提供到gitlab/github中底层文件的链接
- 使用策略标记确定适用的环境
假设
- 您已将任何必要的安全控制添加到目标S3存储桶中
- BOTO3模块存在本地凭证，将文件推到S3
安装
注意：需要python3
pip3安装pyyaml boto3 jinja2 jsonschema
配置
您只需要自定义配置yaml文件，它是 脚本。查看提供的示例文件，以确定哪些字段是必需的，哪些字段是必需的 是可选的。您还可以自定义jinja2模板来进一步修改html 创建的文档。
将容纳html文件的s3 bucket需要启用Static website hosting。这个
默认值（index.html，error.html）很好，因为您将直接针对c7n-autodoc.html
文件。
运行
为了获得最佳结果，该脚本应该作为ci/cd管道的一部分运行。
python3 c7n-autodoc.py-c my_config_file.yml
假设没有任何问题，您应该在s3 bucket中看到html文件。
示例
待办事项
- 为正确渲染考虑不同的策略
- 改进的用户界面布局
- 更方便的用户设置
欢迎加入QQ群-->： 979659372
