AWS Auto Inventory 项目教程

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

AWS Auto Inventory 项目的目录结构如下：

aws-auto-inventory/
├── devcontainer/
├── github/
├── vscode/
├── doc/
│   └── habits @ 5219f21
├── scan/
│   └── sample/
├── .gitignore
├── .gitmodules
├── .pre-commit-config.yaml
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── Makefile
├── NOTICE
├── README.md
├── SECURITY.md
├── requirements-and-versions.txt
├── requirements.txt
├── scan.py
└── scan_builder.py

目录结构介绍

• devcontainer/: 包含开发容器配置文件。
• github/: 包含 GitHub 相关的配置文件。
• vscode/: 包含 Visual Studio Code 相关的配置文件。
• doc/: 包含项目文档，如 habits @ 5219f21 文件。
• scan/: 包含扫描配置文件和示例文件。
• .gitignore: Git 忽略文件配置。
• .gitmodules: Git 子模块配置。
• .pre-commit-config.yaml: 预提交钩子配置。
• CHANGELOG.md: 项目变更日志。
• CODE_OF_CONDUCT.md: 项目行为准则。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证文件。
• Makefile: 项目构建文件。
• NOTICE: 项目通知文件。
• README.md: 项目介绍和使用说明。
• SECURITY.md: 项目安全指南。
• requirements-and-versions.txt: 项目依赖版本文件。
• requirements.txt: 项目依赖文件。
• scan.py: 项目主扫描脚本。
• scan_builder.py: 扫描构建脚本。

2. 项目的启动文件介绍

项目的启动文件是 scan.py。该文件是 AWS Auto Inventory 的核心脚本，用于扫描 AWS 资源并生成详细的资源清单。

scan.py 文件介绍

• 功能: 该脚本使用 Boto3 库与 AWS 服务进行交互，扫描指定或所有 AWS 区域和服务，生成资源清单。
• 参数: 脚本支持多种参数配置，如扫描文件路径、AWS 区域、输出目录、日志级别等。
• 使用示例:

  python scan.py -s scanfile.json --regions us-east-1 eu-west-1 --output_dir output
  

3. 项目的配置文件介绍

项目的配置文件主要是 scanfile.json，该文件定义了要扫描的 AWS 服务和资源。

scanfile.json 文件介绍

• 格式: JSON 格式，每个对象代表一个要扫描的 AWS 服务。
• 示例:

  [
    {
      "service": "s3",
      "function": "list_buckets"
    },
    {
      "service": "ec2",
      "function": "describe_instances",
      "result_key": "Reservations"
    }
  ]
  

• 字段说明:
  • service: 要扫描的 AWS 服务名称。
  • function: 要调用的 Boto3 客户端函数。
  • result_key: 可选字段，指定返回 JSON 对象中的键，用于提取所需数据。

通过以上配置文件和启动脚本，您可以轻松地扫描和管理 AWS 资源。