AWS Inventory 项目使用教程

AWS Inventory 项目使用教程

aws-inventory Discover resources created in an AWS account. 项目地址: https://gitcode.com/gh_mirrors/aw/aws-inventory

1. 项目的目录结构及介绍

aws-inventory/
├── aws_inventory/
│   ├── __init__.py
│   ├── aws_inventory.py
│   └── ...
├── gui/
│   ├── aws_inventory_data-<environment_name>.json
│   └── ...
├── screenshots/
│   └── ...
├── tests/
│   └── ...
├── tools/
│   └── ...
├── .gitignore
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── TODO.md
├── aws_inventory.py
├── blog_writeup.html
├── blog_writeup.md
├── operation_blacklist.conf
└── requirements.txt

目录结构介绍

• aws_inventory/: 包含项目的主要代码文件，如 aws_inventory.py。
• gui/: 包含用于显示进度和结果的GUI相关文件。
• screenshots/: 包含项目截图。
• tests/: 包含项目的测试代码。
• tools/: 包含项目的工具代码。
• .gitignore: Git忽略文件配置。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• README.md: 项目介绍和使用说明。
• TODO.md: 项目待办事项。
• aws_inventory.py: 项目的主启动文件。
• blog_writeup.html: 博客文章的HTML版本。
• blog_writeup.md: 博客文章的Markdown版本。
• operation_blacklist.conf: 操作黑名单配置文件。
• requirements.txt: 项目依赖的Python包列表。

2. 项目的启动文件介绍

aws_inventory.py

aws_inventory.py 是项目的主启动文件。它负责发现AWS账户中创建的所有资源。你可以通过以下命令运行该脚本：

python aws_inventory.py

该脚本会搜索AWS凭证，并根据配置文件和命令行参数执行相应的操作。

3. 项目的配置文件介绍

operation_blacklist.conf

operation_blacklist.conf 是一个配置文件，用于指定在执行过程中需要过滤的服务操作。该文件默认包含在项目中，并会在脚本运行时被加载。

requirements.txt

requirements.txt 文件列出了项目依赖的Python包。你可以使用以下命令安装这些依赖：

pip install -r requirements.txt

.gitignore

.gitignore 文件用于指定Git在版本控制中忽略的文件和目录。

CONTRIBUTING.md

CONTRIBUTING.md 文件提供了项目的贡献指南，帮助开发者了解如何为项目做出贡献。

LICENSE

LICENSE 文件包含了项目的许可证信息，通常是Apache-2.0许可证。

README.md

README.md 文件是项目的介绍和使用说明，包含了项目的安装、配置和使用方法。

TODO.md

TODO.md 文件列出了项目的待办事项和未来计划。

aws-inventory Discover resources created in an AWS account. 项目地址: https://gitcode.com/gh_mirrors/aw/aws-inventory