云守护者（Cloud Custodian）入门指南

云守护者（Cloud Custodian）入门指南

cloud-custodianCloud Custodian 是一个用于管理 Amazon Web Services (AWS) 资源的开源工具，可提供安全、成本优化、符合性等方面的管理功能。 * 管理 AWS 资源、安全审查、成本优化、符合性管理等功能 * 有什么特点：针对 AWS 资源管理、支持多种策略、可扩展性强项目地址:https://gitcode.com/gh_mirrors/cl/cloud-custodian

1. 项目目录结构及介绍

云守护者（Cloud Custodian）的源码仓库通常具有以下主要目录结构：

.
├── docs                    # 文档相关材料
├── bin                     # 可执行脚本和工具
├── c7n                      # 主要的Python包，包含了c7n库
│   ├── __init__.py         # 包初始化文件
│   └── ...                 # 其他子模块
├── tests                   # 测试相关的代码
└── tools                   # 辅助工具和脚本

• docs 存放项目的文档，包括Markdown格式的说明和API参考。
• bin 目录可能包含一些用于执行或部署Cloud Custodian的命令行工具。
• c7n 是核心的Python包，包含了实现Cloud Custodian功能的代码。
• tests 包含单元测试和集成测试，确保代码的功能性和稳定性。
• tools 提供了辅助工具，比如自动化构建或部署。

2. 项目的启动文件介绍

Cloud Custodian的主要入口点是通过命令行工具运行的，通常是名为custodian的脚本。这个脚本解析YAML定义的策略文件，然后执行相应的资源管理操作。例如，你可以通过以下方式在本地环境中运行Cloud Custodian：

python3 -m venv custodian    # 创建虚拟环境
source custodian/bin/activate  # 激活虚拟环境
pip install c7n             # 安装Cloud Custodian
custodian run -c my_policy.yml   # 运行策略文件

在这里，my_policy.yml是你的策略配置文件，它定义了如何筛选和操作云资源。

3. 项目的配置文件介绍

Cloud Custodian的配置文件通常以.yml扩展名保存，使用YAML语法定义策略。一个基本的策略文件包含以下几个部分：

• policies: 策略集合，每个策略由名称、资源类型、过滤器和动作组成。
• mode: 控制策略的执行模式，如定时任务（cron）、事件驱动等。
• filters: 定义资源选择条件，例如基于标签、状态或其他属性。
• actions: 指定对匹配资源的操作，如标记、删除、通知等。

下面是一个示例策略文件：

policies:
  - name: ec2-unused
    resource: ec2
    filters:
      - State.Name: stopped
    actions:
      - terminate

在这个例子中，策略ec2-unused会查找所有停止状态的EC2实例并终止它们。

更多关于策略配置的详细信息，可以查阅官方文档中的相应章节。

请按照这些步骤和示例开始探索Cloud Custodian，以管理你的云端资源，实现安全和成本优化。

cloud-custodianCloud Custodian 是一个用于管理 Amazon Web Services (AWS) 资源的开源工具，可提供安全、成本优化、符合性等方面的管理功能。 * 管理 AWS 资源、安全审查、成本优化、符合性管理等功能 * 有什么特点：针对 AWS 资源管理、支持多种策略、可扩展性强项目地址:https://gitcode.com/gh_mirrors/cl/cloud-custodian