Deploy Connect Gateway

Application Scenario

Direct Connect (DC) is a high-performance, low-latency, secure, and reliable dedicated line access service provided by Huawei Cloud, offering enterprises dedicated network connections from local data centers to Huawei Cloud. Direct Connect service supports multiple access methods, including physical dedicated lines and virtual dedicated lines, meeting network connection requirements for different scales and scenarios.

Connect gateway is a core component in Direct Connect service, used to establish network connections between local data centers and Huawei Cloud. Through connect gateways, you can achieve cross-region, cross-network dedicated line connections, supporting both IPv4 and IPv6 address families, meeting the needs of different network environments. This best practice will introduce how to use Terraform to automatically deploy DC connect gateways, including gateway creation and configuration.

Related Resources/Data Sources

This best practice involves the following main resources and data sources:

Data Sources

None

Resources

• DC Connect Gateway Resource (huaweicloud_dc_connect_gateway)

Resource/Data Source Dependencies

huaweicloud_dc_connect_gateway.test

Operation Steps

1. Script Preparation

Prepare the TF file (e.g., main.tf) in the specified workspace for writing the current best practice script, ensuring that it (or other TF files in the same directory) contains the provider version declaration and Huawei Cloud authentication information required for deploying resources. Refer to the "Preparation Before Deploying Huawei Cloud Resources" document for configuration introduction.

2. Create DC Connect Gateway

Add the following script to the TF file (e.g., main.tf) to instruct Terraform to create a DC connect gateway resource:

variable "connect_gateway_name" {
  description = "Connect gateway name"
  type        = string
}

variable "connect_gateway_description" {
  description = "Connect gateway description"
  type        = string
  default     = "Created by Terraform"
}

variable "address_family" {
  description = "Connect gateway address family type"
  type        = string
  default     = "ipv4"
}

# Create a DC connect gateway resource under the specified region (if the region parameter is omitted, it defaults to the region specified in the current provider block)
resource "huaweicloud_dc_connect_gateway" "test" {
  name           = var.connect_gateway_name
  description    = var.connect_gateway_description
  address_family = var.address_family
}

Parameter Description:

• name: Connect gateway name, assigned by referencing the input variable connect_gateway_name

• description: Connect gateway description, assigned by referencing the input variable connect_gateway_description

• address_family: Address family type, assigned by referencing the input variable address_family, supports "ipv4" and "ipv6"

3. Preset Input Parameters Required for Resource Deployment (Optional)

In this practice, some resources and data sources use input variables to assign values to configuration content. These input parameters need to be manually entered during subsequent deployments. At the same time, Terraform provides a method to preset these configurations through .tfvars files, which can avoid repeated input during each execution.

Create a terraform.tfvars file in the working directory with the following example content:

# Authentication information
region_name = "cn-north-4"
access_key  = "your-access-key"
secret_key  = "your-secret-key"

# Connect gateway configuration
connect_gateway_name        = "tf_test_connect_gateway"
connect_gateway_description = "Created by Terraform"
address_family              = "ipv4"

Usage:

1. Save the above content as terraform.tfvars file in the working directory (this file name allows users to automatically import the content of this tfvars file when executing terraform commands; for other names, .auto needs to be added before tfvars, such as variables.auto.tfvars)

2. Modify parameter values as needed

3. When executing terraform plan or terraform apply, Terraform will automatically read the variable values from this file

In addition to using terraform.tfvars file, variable values can also be set in the following ways:

1. Command line parameters: terraform apply -var="connect_gateway_name=my-gateway" -var="address_family=ipv4"

2. Environment variables: export TF_VAR_connect_gateway_name=my-gateway

3. Custom named variable files: terraform apply -var-file="custom.tfvars"

Note: If the same variable is set in multiple ways, Terraform will use the variable value according to the following priority: command line parameters > variable files > environment variables > default values.

4. Initialize and Apply Terraform Configuration

After completing the above script configuration, execute the following steps to create resources:

1. Run terraform init to initialize the environment

2. Run terraform plan to view the resource creation plan

3. After confirming the resource plan is correct, run terraform apply to start creating the DC connect gateway

4. Run terraform show to view the details of the created DC connect gateway

Reference Information

• Huawei Cloud DC Product Documentation

• Huawei Cloud Provider Documentation

• Best Practice Source Code Reference For DC Connect Gateway