Terraspace 开源项目使用教程

---

一、项目目录结构及介绍

Terraspace 是一个基于 Terraform 的云基础设施自动化工具，旨在简化云资源的管理和部署过程。下面是该项目的基本目录结构以及关键组件的简介：

Terraspace
├── .terraspace_cache        # 缓存目录，存放下载的模块等临时数据。
├── .terraspace_config       # 配置目录，自定义 Terraspace 的配置文件所在。
│   └── terraspace.yml       # 主配置文件，用于设置全局选项。
├── modules                  # 自定义Terraform模块存放位置，可按环境或功能组织。
│   ├── module1              # 示例模块1
│   │   ├── main.tf          # Terraform 主配置文件
│   │   └── variables.tf     # 变量声明
│   └── module2             # 示例模块2
│       ├── main.tf
│       └── outputs.tf
├── environments             # 环境特定配置，如开发、测试、生产。
│   ├── development          # 开发环境配置
│   │   ├── terraspace.yml   # 环境特定配置
│   │   └── terraform.yml    # Terraform 配置
│   ├── staging              # 预发布环境
│   └── production           # 生产环境
├── terraspace.yml            # 应用级别配置文件
├── terraspace.rb             # 可选的Ruby脚本，用于扩展Terraspace行为
└── terraspace.init          # 初始化文件，指导如何开始新项目（非必需）

---

二、项目的启动文件介绍

在 Terraspace 中，没有单一的“启动文件”概念，但有关键的触发动作通常由命令行触发。首次运行或进行部署时，主要通过执行 terraspace up 命令来启动流程。虽然这不是一个静态文件，但它是驱动应用部署的核心操作。此外，环境中定义的 terraspace.yml 和 terraform.yml 文件会在执行过程中被解析并应用于特定环境的部署逻辑。

---

三、项目的配置文件介绍

3.1 .terraspace.yml

这是 Terraspace 的核心配置文件，位于项目根目录下。它允许设置跨所有环境的通用配置，比如默认的云提供者设置、共享变量等。示例配置可以包括AWS访问密钥、区域选择或其他全局策略。

# 示例 .terraspace.yml
cloud:
  provider: aws                    # 设置云服务提供商，默认为aws
regions:
  default: us-west-2              # 默认工作区域

3.2 environments/*/*.yml

环境特定配置文件分为两层：首先是.terraspace_config/terraspace.yml，其次是每个环境目录下的terraspace.yml和terraform.yml。

• terraspace.yml (环境目录中)：这里你可以覆盖全局设置，定义特定环境的行为，例如设置环境变量、特定环境的资源前缀等。

• terraform.yml (环境目录中)：详细指定该环境对应的Terraform配置，包括版本控制、state管理、额外的Terraform命令参数等。

# 假设在 environments/development/terraspace.yml
app_name: dev-env-app         # 设定此环境下应用的名称

# 在 environments/development/terraform.yml
backend:
  type: s3                      # 使用S3作为状态存储
  bucket: my-state-bucket-dev  # 指定状态存储桶名

---

以上就是对Terraspace项目的主要目录结构、启动机制以及配置文件的详细介绍。了解这些基础，将有助于快速上手并高效地使用Terraspace来管理您的云基础设施。