SpaceSiren 项目教程

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

SpaceSiren 是一个用于 AWS 的蜜罐令牌管理与警报系统。以下是项目的目录结构及其介绍：

spacesiren/
├── docs/
│   ├── ...          # 项目文档文件
├── functions/
│   ├── ...          # Lambda 函数代码
├── terraform/
│   ├── ...          # Terraform 配置文件
├── .gitignore
├── CHANGELOG.md
├── LICENSE
├── README.md

目录结构介绍

• docs/: 包含项目的文档文件，如使用指南、API 文档等。
• functions/: 包含 AWS Lambda 函数的代码。
• terraform/: 包含 Terraform 配置文件，用于定义和管理 AWS 资源。
• .gitignore: 指定 Git 忽略的文件和目录。
• CHANGELOG.md: 记录项目的变更日志。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的主文档文件，包含项目概述、安装和使用说明等。

2. 项目的启动文件介绍

SpaceSiren 是一个完全无服务器的应用程序，主要通过 Terraform 进行资源管理和部署。以下是启动文件的介绍：

Terraform 配置文件

在 terraform/ 目录下，主要的启动文件包括：

• main.tf: 定义了主要的 AWS 资源，如 DynamoDB、Lambda、API Gateway 等。
• variables.tf: 定义了 Terraform 使用的变量。
• outputs.tf: 定义了 Terraform 部署后的输出信息。

Lambda 函数

在 functions/ 目录下，主要的启动文件包括：

• handler.py: Lambda 函数的主处理文件，负责处理 API 请求和触发警报。

3. 项目的配置文件介绍

SpaceSiren 的配置主要通过 Terraform 和环境变量进行管理。以下是主要的配置文件介绍：

Terraform 配置文件

• variables.tf: 定义了 Terraform 使用的变量，如 AWS 区域、DynamoDB 表名等。
• terraform.tfvars: 包含实际的变量值，用于覆盖 variables.tf 中的默认值。

环境变量

在 Lambda 函数中，可以通过环境变量配置一些参数，如：

• ALERT_EMAIL: 警报发送的邮箱地址。
• ALERT_SLACK_WEBHOOK: 警报发送的 Slack Webhook URL。

通过这些配置文件和环境变量，可以灵活地管理和配置 SpaceSiren 项目。