# 部署磁盘快照

## 应用场景

云硬盘（Elastic Volume Service，EVS）是华为云提供的高性能、高可靠、可扩展的块存储服务，为ECS实例提供持久化存储。EVS支持多种存储类型，包括SSD、SAS、SATA等，满足不同业务场景的存储需求。

EVS磁盘快照是EVS服务的重要功能，用于创建云硬盘在特定时间点的数据备份。通过磁盘快照，企业可以保护重要数据，实现快速恢复，支持数据迁移和备份策略。磁盘快照支持增量备份，节省存储空间，提供可靠的数据保护机制。本最佳实践将介绍如何使用Terraform自动化部署EVS磁盘快照，包括云硬盘创建和快照配置。

## 相关资源/数据源

本最佳实践涉及以下主要资源和数据源：

### 数据源

* [可用区列表查询数据源（data.huaweicloud\_availability\_zones）](https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/data-sources/availability_zones)

### 资源

* [云硬盘资源（huaweicloud\_evs\_volume）](https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/resources/evs_volume)
* [EVS磁盘快照资源（huaweicloud\_evs\_snapshot）](https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/resources/evs_snapshot)

### 资源/数据源依赖关系

```
data.huaweicloud_availability_zones.test
    └── huaweicloud_evs_volume.test
        └── huaweicloud_evs_snapshot.test
```

## 操作步骤

### 1. 脚本准备

在指定工作空间中准备好用于编写当前最佳实践脚本的TF文件（如main.tf），确保其中（也可以是其他同级目录下的TF文件）包含部署资源所需的provider版本声明和华为云鉴权信息。 配置介绍参考[部署华为云资源前的准备工作](https://github.com/chnsz/hcbp-demo/blob/master/docs/zh-cn/best-practices/introductions/prepare_before_deploy.md)一文中的介绍。

### 2. 通过数据源查询可用区信息

在TF文件（如main.tf）中添加以下脚本以告知Terraform进行一次数据源查询，其查询结果用于创建云硬盘：

```hcl
# 获取指定region（region参数缺省时默认继承当前provider块中所指定的region）下所有的可用区信息，用于创建云硬盘
data "huaweicloud_availability_zones" "test" {}
```

**参数说明**：

* 无需额外参数，数据源会自动获取当前region下的所有可用区信息

### 3. 创建云硬盘

在TF文件（如main.tf）中添加以下脚本以告知Terraform创建云硬盘资源：

```hcl
variable "volume_availability_zone" {
  description = "云硬盘可用区"
  type        = string
  default     = ""
  nullable    = false
}

variable "volume_name" {
  description = "云硬盘名称"
  type        = string
}

variable "volume_type" {
  description = "云硬盘类型"
  type        = string
  default     = "SAS"
}

variable "volume_size" {
  description = "云硬盘大小"
  type        = number
  default     = 20
}

variable "voluem_description" {
  description = "云硬盘描述"
  type        = string
  default     = ""
}

variable "vouleme_multiattach" {
  description = "云硬盘是否为共享盘"
  type        = bool
  default     = false
}

# 在指定region（region参数缺省时默认继承当前provider块中所指定的region）下创建云硬盘资源
resource "huaweicloud_evs_volume" "test" {
  availability_zone = var.volume_availability_zone != "" ? var.volume_availability_zone : try(data.huaweicloud_availability_zones.test.names[0], null)
  name              = var.volume_name
  volume_type       = var.volume_type
  size              = var.volume_size
  description       = var.voluem_description
  multiattach       = var.vouleme_multiattach
}
```

**参数说明**：

* **availability\_zone**：可用区，优先使用输入变量，如果为空则使用可用区数据源的第一个结果
* **name**：云硬盘名称，通过引用输入变量volume\_name进行赋值
* **volume\_type**：云硬盘类型，通过引用输入变量volume\_type进行赋值
* **size**：云硬盘大小，通过引用输入变量volume\_size进行赋值
* **description**：云硬盘描述，通过引用输入变量voluem\_description进行赋值
* **multiattach**：是否为共享盘，通过引用输入变量vouleme\_multiattach进行赋值

### 4. 创建EVS磁盘快照

在TF文件（如main.tf）中添加以下脚本以告知Terraform创建EVS磁盘快照资源：

```hcl
variable "snapshot_name" {
  description = "快照名称"
  type        = string
}

variable "snapshot_description" {
  description = "快照描述"
  type        = string
  default     = ""
}

variable "snapshot_metadata" {
  description = "快照元数据信息"
  type        = map(string)
  default     = {}
}

variable "snapshot_force" {
  description = "强制创建快照标志"
  type        = bool
  default     = false
}

# 在指定region（region参数缺省时默认继承当前provider块中所指定的region）下创建EVS磁盘快照资源
resource "huaweicloud_evs_snapshot" "test" {
  volume_id   = huaweicloud_evs_volume.test.id
  name        = var.snapshot_name
  description = var.snapshot_description
  metadata    = var.snapshot_metadata
  force       = var.snapshot_force
}
```

**参数说明**：

* **volume\_id**：云硬盘ID，通过引用云硬盘资源（huaweicloud\_evs\_volume.test）的ID进行赋值
* **name**：快照名称，通过引用输入变量snapshot\_name进行赋值
* **description**：快照描述，通过引用输入变量snapshot\_description进行赋值
* **metadata**：快照元数据，通过引用输入变量snapshot\_metadata进行赋值
* **force**：强制创建标志，通过引用输入变量snapshot\_force进行赋值

### 5. 预设资源部署所需的入参（可选）

本实践中，部分资源、数据源使用了输入变量对配置内容进行赋值，这些输入参数在后续部署时需要手工输入。 同时，Terraform提供了通过`tfvars`文件预设这些配置的方法，可以避免每次执行时重复输入。

在工作目录下创建`terraform.tfvars`文件，示例内容如下：

```hcl
# 认证信息
region_name = "cn-north-4"
access_key  = "your-access-key"
secret_key  = "your-secret-key"

# 云硬盘配置
volume_name       = "tf_test_volume"
volume_type       = "SAS"
volume_size       = 20
voluem_description = "Test volume created by Terraform"

# 快照配置
snapshot_name     = "tf_test_snapshot"
snapshot_description = "Test snapshot created by Terraform"
snapshot_metadata = {
  test = "terraform"
}
snapshot_force    = false
```

**使用方法**：

1. 将上述内容保存为工作目录下的`terraform.tfvars`文件（该文件名可使用户在执行terraform命令时自动导入该`tfvars`文件中的内容，其他命名则需要在tfvars前补充`.auto`定义，如`variables.auto.tfvars`）
2. 根据实际需要修改参数值
3. 执行`terraform plan`或`terraform apply`时，Terraform会自动读取该文件中的变量值

除了使用`terraform.tfvars`文件外，还可以通过以下方式设置变量值：

1. 命令行参数：`terraform apply -var="volume_name=my-volume" -var="snapshot_name=my-snapshot"`
2. 环境变量：`export TF_VAR_volume_name=my-volume`
3. 自定义命名的变量文件：`terraform apply -var-file="custom.tfvars"`

> 注意：如果同一个变量通过多种方式进行设置，Terraform会按照以下优先级使用变量值：命令行参数 > 变量文件 > 环境变量 > 默认值。

### 6. 初始化并应用Terraform配置

完成以上脚本配置后，执行以下步骤来创建资源：

1. 运行 `terraform init` 初始化环境
2. 运行 `terraform plan` 查看资源创建计划
3. 确认资源计划无误后，运行 `terraform apply` 开始创建磁盘快照
4. 运行 `terraform show` 查看已创建的磁盘快照

## 参考信息

* [华为云EVS产品文档](https://support.huaweicloud.com/evs/index.html)
* [华为云Provider文档](https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs)
* [EVS磁盘快照最佳实践源码参考](https://github.com/huaweicloud/terraform-provider-huaweicloud/tree/master/examples/evs/snapshot)