# 部署通过任务分组迁移对象

## 应用场景

对象存储迁移服务（Object Storage Migration Service，OMS）是华为云提供的一站式数据迁移服务，帮助用户快速、安全、高效地将数据从其他云服务商或本地环境迁移到华为云对象存储服务（OBS）。OMS服务支持多种数据源，包括AWS S3、阿里云OSS、腾讯云COS等主流云存储服务，以及本地文件系统。

任务分组迁移是OMS服务的重要功能，用于批量迁移对象存储数据。通过任务分组迁移，企业可以高效地迁移大量数据，支持增量同步、断点续传、数据校验等功能，确保数据迁移的完整性和一致性。任务分组迁移支持带宽控制、时间窗口设置、失败重试等高级功能，为企业提供可靠的数据迁移解决方案。本最佳实践将介绍如何使用Terraform自动化部署OMS任务分组迁移任务，包括KMS密钥创建、OBS桶配置、对象上传、桶策略设置和迁移任务组创建。

## 相关资源/数据源

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

### 资源

* [KMS密钥资源（huaweicloud\_kms\_key）](https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/resources/kms_key)
* [OBS桶资源（huaweicloud\_obs\_bucket）](https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/resources/obs_bucket)
* [OBS桶对象资源（huaweicloud\_obs\_bucket\_object）](https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/resources/obs_bucket_object)
* [OBS桶策略资源（huaweicloud\_obs\_bucket\_policy）](https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/resources/obs_bucket_policy)
* [OMS迁移任务组资源（huaweicloud\_oms\_migration\_task\_group）](https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/resources/oms_migration_task_group)

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

```
huaweicloud_kms_key.test
    └── huaweicloud_obs_bucket.test
        ├── huaweicloud_obs_bucket_object.test
        │   └── huaweicloud_oms_migration_task_group.test
        └── huaweicloud_obs_bucket_policy.test
            └── huaweicloud_oms_migration_task_group.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. 创建KMS密钥

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

```hcl
variable "bucket_encryption" {
  description = "OBS桶是否启用加密"
  type        = bool
  default     = true
}

variable "bucket_encryption_key_id" {
  description = "OBS桶加密密钥ID"
  type        = string
  default     = ""
  nullable    = false
}

variable "key_alias" {
  description = "KMS密钥别名"
  type        = string
  default     = ""
  nullable    = false

  validation {
    condition     = var.key_alias != "" && var.bucket_encryption && var.bucket_encryption_key_id == ""
    error_message = "当bucket_encryption为true且bucket_encryption_key_id未设置时，必须设置key_alias。"
  }
}

variable "key_usage" {
  description = "KMS密钥用途"
  type        = string
  default     = "ENCRYPT_DECRYPT"
}

# 在指定region（region参数缺省时默认继承当前provider块中所指定的region）下创建KMS密钥资源
resource "huaweicloud_kms_key" "test" {
  count = var.bucket_encryption && var.bucket_encryption_key_id == "" ? 1 : 0

  key_alias = var.key_alias
  key_usage = var.key_usage
}
```

**参数说明**：

* **key\_alias**：密钥别名，通过引用输入变量key\_alias进行赋值
* **key\_usage**：密钥用途，通过引用输入变量key\_usage进行赋值
* **count**：条件创建，当启用加密且未指定密钥ID时创建

### 3. 创建OBS桶

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

```hcl
variable "bucket_name" {
  description = "OBS桶名称"
  type        = string
}

variable "bucket_storage_class" {
  description = "OBS桶存储类型"
  type        = string
  default     = "STANDARD"
}

variable "bucket_acl" {
  description = "OBS桶访问控制列表"
  type        = string
  default     = "private"
}

variable "bucket_sse_algorithm" {
  description = "OBS桶服务端加密算法"
  type        = string
  default     = "kms"
}

variable "bucket_force_destroy" {
  description = "OBS桶是否强制删除"
  type        = bool
  default     = true
}

variable "bucket_tags" {
  description = "OBS桶标签"
  type        = map(string)
  default     = {}
}

# 在指定region（region参数缺省时默认继承当前provider块中所指定的region）下创建OBS桶资源
resource "huaweicloud_obs_bucket" "test" {
  bucket        = var.bucket_name
  storage_class = var.bucket_storage_class
  acl           = var.bucket_acl
  encryption    = var.bucket_encryption
  sse_algorithm = var.bucket_encryption ? var.bucket_sse_algorithm : null
  kms_key_id    = var.bucket_encryption ? var.bucket_encryption_key_id != "" ? var.bucket_encryption_key_id : huaweicloud_kms_key.test[0].id : null
  force_destroy = var.bucket_force_destroy
  tags          = var.bucket_tags

  lifecycle {
    ignore_changes = [
      sse_algorithm
    ]
  }
}
```

**参数说明**：

* **bucket**：桶名称，通过引用输入变量bucket\_name进行赋值
* **storage\_class**：存储类型，通过引用输入变量bucket\_storage\_class进行赋值
* **acl**：访问控制列表，通过引用输入变量bucket\_acl进行赋值
* **encryption**：是否启用加密，通过引用输入变量bucket\_encryption进行赋值
* **sse\_algorithm**：服务端加密算法，当启用加密时使用kms算法
* **kms\_key\_id**：KMS密钥ID，优先使用输入变量，如果为空则使用创建的KMS密钥
* **force\_destroy**：强制删除，通过引用输入变量bucket\_force\_destroy进行赋值
* **tags**：标签，通过引用输入变量bucket\_tags进行赋值

### 4. 创建OBS桶对象

在TF文件（如main.tf）中添加以下脚本以告知Terraform创建OBS桶对象资源：

```hcl
variable "object_extension_name" {
  description = "OBS对象扩展名"
  type        = string
  default     = ".txt"
  nullable    = false
}

variable "object_name" {
  description = "OBS对象名称"
  type        = string
}

variable "object_upload_content" {
  description = "OBS对象上传内容"
  type        = string
}

# 在指定region（region参数缺省时默认继承当前provider块中所指定的region）下创建OBS桶对象资源
resource "huaweicloud_obs_bucket_object" "test" {
  bucket       = huaweicloud_obs_bucket.test.id
  key          = var.object_extension_name != "" ? format("%s%s", var.object_name, var.object_extension_name) : var.object_name
  content_type = "application/xml"
  content      = var.object_upload_content
}
```

**参数说明**：

* **bucket**：桶ID，通过引用OBS桶资源（huaweicloud\_obs\_bucket.test）的ID进行赋值
* **key**：对象键名，根据扩展名和对象名称组合生成
* **content\_type**：内容类型，设置为application/xml
* **content**：对象内容，通过引用输入变量object\_upload\_content进行赋值

### 5. 创建OBS桶策略

在TF文件（如main.tf）中添加以下脚本以告知Terraform创建OBS桶策略资源：

```hcl
# 在指定region（region参数缺省时默认继承当前provider块中所指定的region）下创建OBS桶策略资源
resource "huaweicloud_obs_bucket_policy" "test" {
  bucket = huaweicloud_obs_bucket.test.id
  policy = <<POLICY
{
  "Statement": [
    {
      "Sid": "",
      "Effect": "Allow",
      "Principal": {"ID": "*"},
      "Action": ["GetObject"],
      "Resource": "${huaweicloud_obs_bucket.test.id}/*"
    }
  ]
}
POLICY
}
```

**参数说明**：

* **bucket**：桶ID，通过引用OBS桶资源（huaweicloud\_obs\_bucket.test）的ID进行赋值
* **policy**：桶策略，允许所有用户读取桶中的对象

### 6. 创建OMS迁移任务组

在TF文件（如main.tf）中添加以下脚本以告知Terraform创建OMS迁移任务组资源：

```hcl
variable "group_action_type" {
  description = "迁移任务组操作类型"
  type        = string
  default     = "stop"
}

variable "group_type" {
  description = "迁移任务组类型"
  type        = string
  default     = "PREFIX"
}

variable "group_enable_kms" {
  description = "迁移任务组是否启用KMS"
  type        = bool
  default     = true
}

variable "group_migrate_since" {
  description = "迁移任务组迁移起始时间"
  type        = string
  default     = null
}

variable "group_object_overwrite_mode" {
  description = "迁移任务组对象覆盖模式"
  type        = string
  default     = "CRC64_COMPARISON_OVERWRITE"
}

variable "group_consistency_check" {
  description = "迁移任务组一致性检查"
  type        = string
  default     = "crc64"
}

variable "group_enable_requester_pays" {
  description = "迁移任务组是否启用请求者付费"
  type        = bool
  default     = true
}

variable "group_enable_failed_object_recording" {
  description = "迁移任务组是否启用失败对象记录"
  type        = bool
  default     = true
}

variable "target_bucket_configuration" {
  description = "目标桶配置"
  type        = object({
    region      = optional(string, "")
    bucket      = string
    access_key  = optional(string, "")
    secret_key  = optional(string, "")
  })
}

variable "bandwidth_policy_configurations" {
  description = "带宽策略配置"
  type        = list(object({
    max_bandwidth = number
    start         = string
    end           = string
  }))
}

# 在指定region（region参数缺省时默认继承当前provider块中所指定的region）下创建OMS迁移任务组资源
resource "huaweicloud_oms_migration_task_group" "test" {
  depends_on = [
    huaweicloud_obs_bucket_object.test,
    huaweicloud_obs_bucket_policy.test
  ]

  action                         = var.group_action_type
  type                           = var.group_type
  enable_kms                     = var.group_enable_kms
  migrate_since                  = var.group_migrate_since
  object_overwrite_mode          = var.group_object_overwrite_mode
  consistency_check              = var.group_consistency_check
  enable_requester_pays          = var.group_enable_requester_pays
  enable_failed_object_recording = var.group_enable_failed_object_recording

  source_object {
    data_source = "HuaweiCloud"
    region      = huaweicloud_obs_bucket.test.region
    bucket      = huaweicloud_obs_bucket.test.id
    access_key  = var.access_key
    secret_key  = var.secret_key
    object      = [var.object_name]
  }

  destination_object {
    region     = var.target_bucket_configuration.region != "" ? var.target_bucket_configuration.region : huaweicloud_obs_bucket.test.region
    bucket     = var.target_bucket_configuration.bucket
    access_key = var.target_bucket_configuration.access_key != "" ? var.target_bucket_configuration.access_key : var.access_key
    secret_key = var.target_bucket_configuration.secret_key != "" ? var.target_bucket_configuration.secret_key : var.secret_key
  }

  dynamic "bandwidth_policy" {
    for_each = var.bandwidth_policy_configurations

    content {
      max_bandwidth = bandwidth_policy.value["max_bandwidth"]
      start         = bandwidth_policy.value["start"]
      end           = bandwidth_policy.value["end"]
    }
  }
}
```

**参数说明**：

* **action**：操作类型，通过引用输入变量group\_action\_type进行赋值
* **type**：任务组类型，通过引用输入变量group\_type进行赋值
* **enable\_kms**：是否启用KMS，通过引用输入变量group\_enable\_kms进行赋值
* **migrate\_since**：迁移起始时间，通过引用输入变量group\_migrate\_since进行赋值
* **object\_overwrite\_mode**：对象覆盖模式，通过引用输入变量group\_object\_overwrite\_mode进行赋值
* **consistency\_check**：一致性检查，通过引用输入变量group\_consistency\_check进行赋值
* **enable\_requester\_pays**：是否启用请求者付费，通过引用输入变量group\_enable\_requester\_pays进行赋值
* **enable\_failed\_object\_recording**：是否启用失败对象记录，通过引用输入变量group\_enable\_failed\_object\_recording进行赋值
* **source\_object**：源对象配置，包含数据源、区域、桶、访问密钥和对象列表
* **destination\_object**：目标对象配置，包含区域、桶和访问密钥
* **bandwidth\_policy**：带宽策略，动态创建带宽控制配置

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

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

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

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

# KMS密钥配置
key_alias   = "tf-test-obs-key"
key_usage   = "ENCRYPT_DECRYPT"

# OBS桶配置
bucket_name        = "tf-test-obs-bucket"
bucket_storage_class = "STANDARD"
bucket_acl         = "private"
bucket_encryption  = true
bucket_sse_algorithm = "kms"
bucket_force_destroy = true
bucket_tags        = {
  environment = "test"
  created_by  = "terraform"
}

# OBS对象配置
object_extension_name = ".txt"
object_name           = "tf-test-obs-object"
object_upload_content = <<EOT
def main():
    print("Hello, World!")

if __name__ == "__main__":
    main()
EOT

# 迁移任务组配置
group_action_type = "stop"
group_type = "PREFIX"
group_enable_kms = true
group_migrate_since = null
group_object_overwrite_mode = "CRC64_COMPARISON_OVERWRITE"
group_consistency_check = "crc64"
group_enable_requester_pays = true
group_enable_failed_object_recording = true

# 目标桶配置
target_bucket_configuration = {
  bucket = "tf-test-obs-bucket-target"
}

# 带宽策略配置
bandwidth_policy_configurations = [
  {
    max_bandwidth = 1
    start         = "03:00"
    end           = "04:00"
  }
]
```

**使用方法**：

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

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

1. 命令行参数：`terraform apply -var="bucket_name=my-bucket" -var="object_name=my-object"`
2. 环境变量：`export TF_VAR_bucket_name=my-bucket`
3. 自定义命名的变量文件：`terraform apply -var-file="custom.tfvars"`

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

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

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

1. 运行 `terraform init` 初始化环境
2. 运行 `terraform plan` 查看资源创建计划
3. 确认资源计划无误后，运行 `terraform apply` 开始创建迁移任务组
4. 运行 `terraform show` 查看已创建的迁移任务组

## 参考信息

* [华为云OMS产品文档](https://support.huaweicloud.com/oms/index.html)
* [华为云Provider文档](https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs)
* [OMS通过任务分组迁移对象最佳实践源码参考](https://github.com/huaweicloud/terraform-provider-huaweicloud/tree/master/examples/oms/migrate-objects-by-group)