# 部署带宽包

## 应用场景

云连接（Cloud Connect，CC）带宽包是云连接服务提供的带宽资源管理功能，用于为云连接实例提供带宽资源。通过创建带宽包，您可以统一管理和分配跨区域、跨网络的带宽资源，实现灵活的网络带宽配置。通过Terraform自动化创建带宽包，可以确保带宽资源管理的规范化和一致性，提高运维效率。本最佳实践将介绍如何使用Terraform自动化创建云连接带宽包。

## 相关资源/数据源

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

### 资源

* [云连接带宽包资源（huaweicloud\_cc\_bandwidth\_package）](https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs/resources/cc_bandwidth_package)

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

```
huaweicloud_cc_bandwidth_package
```

## 操作步骤

### 1. 脚本准备

在指定工作空间中准备好用于编写当前最佳实践脚本的TF文件（如main.tf），确保其中（也可以是其他同级目录下的TF文件）包含部署资源所需的provider版本声明和华为云鉴权信息。 配置介绍参考[部署华为云资源前的准备工作](https://hcbp.gitbook.io/hua-wei-yun-provider/chan-pin-jie-shao/prepare_before_deploy)一文中的介绍。

### 2. 创建云连接带宽包资源

在TF文件（如main.tf）中添加以下脚本以告知Terraform创建云连接带宽包资源：

```hcl
variable "bandwidth_package_name" {
  description = "The name of the bandwidth package"
  type        = string
}

variable "local_area_id" {
  description = "The local area ID"
  type        = string
}

variable "remote_area_id" {
  description = "The remote area ID"
  type        = string
}

variable "charge_mode" {
  description = "Billing option of the bandwidth package"
  type        = string
}

variable "billing_mode" {
  description = "Billing mode of the bandwidth package"
  type        = string
}

variable "bandwidth" {
  description = "Bandwidth in the bandwidth package"
  type        = number
}

variable "bandwidth_package_description" {
  description = "The description about the bandwidth package"
  type        = string
  default     = "Created by Terraform"
}

variable "enterprise_project_id" {
  description = "ID of the enterprise project that the bandwidth package belongs to"
  type        = string
  default     = "0"
}

variable "bandwidth_package_tags" {
  description = "The tags of the bandwidth package"
  type        = map(string)
  default     = {
    "Owner" = "terraform"
    "Env"   = "test"
  }
}

# 在指定region（region参数缺省时默认继承当前provider块中所指定的region）下创建云连接带宽包资源
resource "huaweicloud_cc_bandwidth_package" "test" {
  name                  = var.bandwidth_package_name
  local_area_id         = var.local_area_id
  remote_area_id        = var.remote_area_id
  charge_mode           = var.charge_mode
  billing_mode          = var.billing_mode
  bandwidth             = var.bandwidth
  description           = var.bandwidth_package_description
  enterprise_project_id = var.enterprise_project_id

  tags = var.bandwidth_package_tags
}
```

**参数说明**：

* **name**：带宽包名称，通过引用输入变量bandwidth\_package\_name进行赋值
* **local\_area\_id**：本端区域ID，通过引用输入变量local\_area\_id进行赋值
* **remote\_area\_id**：对端区域ID，通过引用输入变量remote\_area\_id进行赋值
* **charge\_mode**：带宽包的计费方式，通过引用输入变量charge\_mode进行赋值
* **billing\_mode**：带宽包的计费模式，通过引用输入变量billing\_mode进行赋值
* **bandwidth**：带宽包中的带宽值，通过引用输入变量bandwidth进行赋值
* **description**：带宽包的描述信息，通过引用输入变量bandwidth\_package\_description进行赋值，默认值为"Created by Terraform"
* **enterprise\_project\_id**：带宽包所属的企业项目ID，通过引用输入变量enterprise\_project\_id进行赋值，默认值为"0"
* **tags**：带宽包的标签，通过引用输入变量bandwidth\_package\_tags进行赋值，默认值包含"Owner"和"Env"标签

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

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

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

```hcl
# 云连接带宽包配置
bandwidth_package_name = "tf_test_bandwidth_package"
local_area_id          = "Chinese-Mainland"
remote_area_id         = "Chinese-Mainland"
charge_mode            = "bandwidth"
billing_mode           = "prepaid"
bandwidth              = 5
```

**使用方法**：

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

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

1. 命令行参数：`terraform apply -var="bandwidth_package_name=test-package" -var="bandwidth=10"`
2. 环境变量：`export TF_VAR_bandwidth_package_name=test-package` 和 `export TF_VAR_bandwidth=10`
3. 自定义命名的变量文件：`terraform apply -var-file="custom.tfvars"`

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

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

完成以上脚本配置后，执行以下步骤来创建云连接带宽包：

1. 运行 `terraform init` 初始化环境
2. 运行 `terraform plan` 查看资源创建计划
3. 确认资源计划无误后，运行 `terraform apply` 开始创建云连接带宽包
4. 运行 `terraform show` 查看已创建的云连接带宽包详情

## 参考信息

* [华为云云连接产品文档](https://support.huaweicloud.com/cc/index.html)
* [华为云Provider文档](https://registry.terraform.io/providers/huaweicloud/huaweicloud/latest/docs)
* [带宽包最佳实践源码参考](https://github.com/huaweicloud/terraform-provider-huaweicloud/tree/master/examples/cc/bandwidth-package)