AWS Auto Cleanup 项目教程

AWS Auto Cleanup 项目教程

aws-auto-cleanup Programmatically delete AWS resources based on an allowlist and time to live (TTL) settings 项目地址: https://gitcode.com/gh_mirrors/aw/aws-auto-cleanup

1. 项目目录结构及介绍

aws-auto-cleanup/
├── app/
│   ├── __init__.py
│   ├── main.py
│   └── ...
├── api/
│   ├── __init__.py
│   ├── main.py
│   └── ...
├── web/
│   ├── __init__.py
│   ├── main.py
│   └── ...
├── static/
│   ├── css/
│   ├── js/
│   └── ...
├── .gitignore
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
└── requirements.txt

目录结构说明

• app/: 包含应用程序的主要逻辑和功能模块。
• api/: 包含API的实现代码，用于处理与AWS资源的交互。
• web/: 包含Web界面的代码，用于用户交互和管理。
• static/: 包含静态文件，如CSS、JavaScript等。
• .gitignore: 指定Git版本控制系统忽略的文件和目录。
• CHANGELOG.md: 记录项目的变更历史。
• CODE_OF_CONDUCT.md: 项目的代码行为准则。
• CONTRIBUTING.md: 贡献指南，指导开发者如何参与项目。
• LICENSE: 项目的开源许可证。
• README.md: 项目的介绍和使用说明。
• requirements.txt: 项目依赖的Python包列表。

2. 项目启动文件介绍

启动文件

• app/main.py: 应用程序的入口文件，负责初始化和启动应用程序。
• api/main.py: API的入口文件，负责处理API请求和响应。
• web/main.py: Web界面的入口文件，负责启动Web服务器和处理用户请求。

启动步骤

1. 进入项目根目录。
2. 安装依赖：pip install -r requirements.txt。
3. 启动应用程序：python app/main.py。
4. 启动API：python api/main.py。
5. 启动Web界面：python web/main.py。

3. 项目配置文件介绍

配置文件

• app/config.py: 应用程序的配置文件，包含各种配置选项，如AWS凭证、资源清理策略等。
• api/config.py: API的配置文件，包含API相关的配置选项。
• web/config.py: Web界面的配置文件，包含Web服务器和用户界面的配置选项。

配置示例

# app/config.py
AWS_ACCESS_KEY_ID = 'your-access-key-id'
AWS_SECRET_ACCESS_KEY = 'your-secret-access-key'
RESOURCE_TTL = 30  # 资源存活时间（天）
ALLOWLIST = ['resource-1', 'resource-2']  # 允许列表

配置说明

• AWS_ACCESS_KEY_ID: AWS访问密钥ID。
• AWS_SECRET_ACCESS_KEY: AWS秘密访问密钥。
• RESOURCE_TTL: 资源的时间存活时间，超过此时间的资源将被清理。
• ALLOWLIST: 允许保留的资源列表，即使超过存活时间也不会被清理。

通过以上配置，您可以根据自己的需求定制AWS Auto Cleanup的行为。

aws-auto-cleanup Programmatically delete AWS resources based on an allowlist and time to live (TTL) settings 项目地址: https://gitcode.com/gh_mirrors/aw/aws-auto-cleanup