Deploy Virtual Interface

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.

Virtual interface is a core component in Direct Connect service, used to establish logical connections between dedicated lines and VPCs. Through virtual interfaces, you can achieve routing and forwarding of dedicated line traffic, supporting both static routing and BGP dynamic routing, meeting the needs of different network architectures. This best practice will introduce how to use Terraform to automatically deploy DC virtual interfaces, including VPC creation, virtual gateway creation, and virtual interface configuration.

Related Resources/Data Sources

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

Data Sources

None

Resources

• VPC Resource (huaweicloud_vpc)

• DC Virtual Gateway Resource (huaweicloud_dc_virtual_gateway)

• DC Virtual Interface Resource (huaweicloud_dc_virtual_interface)

Resource/Data Source Dependencies

huaweicloud_vpc.test
    └── huaweicloud_dc_virtual_gateway.test
        └── huaweicloud_dc_virtual_interface.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 VPC

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

variable "vpc_name" {
  description = "VPC name"
  type        = string
}

variable "vpc_cidr" {
  description = "VPC CIDR block"
  type        = string
  default     = "192.168.0.0/16"
}

# Create a VPC resource under the specified region (if the region parameter is omitted, it defaults to the region specified in the current provider block)
resource "huaweicloud_vpc" "test" {
  name = var.vpc_name
  cidr = var.vpc_cidr
}

Parameter Description:

• name: VPC name, assigned by referencing the input variable vpc_name

• cidr: VPC CIDR block, assigned by referencing the input variable vpc_cidr

3. Create DC Virtual Gateway

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

variable "virtual_gateway_name" {
  description = "Virtual gateway name"
  type        = string
}

# Create a DC virtual 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_virtual_gateway" "test" {
  vpc_id = huaweicloud_vpc.test.id
  name   = var.virtual_gateway_name

  local_ep_group = [
    huaweicloud_vpc.test.cidr,
  ]
}

Parameter Description:

• vpc_id: VPC ID, assigned by referencing the VPC resource (huaweicloud_vpc.test) ID

• name: Virtual gateway name, assigned by referencing the input variable virtual_gateway_name

• local_ep_group: Local endpoint group, assigned by referencing the VPC resource (huaweicloud_vpc.test) CIDR

4. Create DC Virtual Interface

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

variable "direct_connect_id" {
  description = "Direct connect connection ID associated with the virtual interface"
  type        = string
}

variable "virtual_interface_name" {
  description = "Virtual interface name"
  type        = string
}

variable "virtual_interface_description" {
  description = "Virtual interface description"
  type        = string
  default     = "Created by Terraform"
}

variable "virtual_interface_type" {
  description = "Virtual interface type"
  type        = string
  default     = "private"
}

variable "route_mode" {
  description = "Virtual interface routing mode"
  type        = string
  default     = "static"
}

variable "vlan" {
  description = "Customer-side VLAN"
  type        = number
}

variable "bandwidth" {
  description = "Virtual interface inbound bandwidth size"
  type        = number
}

variable "remote_ep_group" {
  description = "Remote subnet CIDR list"
  type        = list(string)
}

variable "address_family" {
  description = "Virtual interface address family type"
  type        = string
  default     = "ipv4"
}

variable "local_gateway_v4_ip" {
  description = "Cloud-side virtual interface IPv4 address"
  type        = string
}

variable "remote_gateway_v4_ip" {
  description = "Customer-side virtual interface IPv4 address"
  type        = string
}

variable "enable_bfd" {
  description = "Whether to enable Bidirectional Forwarding Detection (BFD) function"
  type        = bool
  default     = false
}

variable "enable_nqa" {
  description = "Whether to enable Network Quality Analysis (NQA) function"
  type        = bool
  default     = false
}

variable "virtual_interface_tags" {
  description = "Virtual interface tags"
  type        = map(string)
  default = {
    "Owner" = "terraform"
    "Env"   = "test"
  }
}

# Create a DC virtual interface 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_virtual_interface" "test" {
  direct_connect_id = var.direct_connect_id
  vgw_id            = huaweicloud_dc_virtual_gateway.test.id
  name              = var.virtual_interface_name
  description       = var.virtual_interface_description
  type              = var.virtual_interface_type
  route_mode        = var.route_mode
  vlan              = var.vlan
  bandwidth         = var.bandwidth

  remote_ep_group = var.remote_ep_group

  address_family       = var.address_family
  local_gateway_v4_ip  = var.local_gateway_v4_ip
  remote_gateway_v4_ip = var.remote_gateway_v4_ip

  enable_bfd = var.enable_bfd
  enable_nqa = var.enable_nqa

  tags = var.virtual_interface_tags
}

Parameter Description:

• direct_connect_id: Direct connect connection ID, assigned by referencing the input variable direct_connect_id

• vgw_id: Virtual gateway ID, assigned by referencing the DC virtual gateway resource (huaweicloud_dc_virtual_gateway.test) ID

• name: Virtual interface name, assigned by referencing the input variable virtual_interface_name

• description: Virtual interface description, assigned by referencing the input variable virtual_interface_description

• type: Virtual interface type, assigned by referencing the input variable virtual_interface_type, supports "private" and "public"

• route_mode: Routing mode, assigned by referencing the input variable route_mode, supports "static" and "bgp"

• vlan: Customer-side VLAN, assigned by referencing the input variable vlan

• bandwidth: Inbound bandwidth size, assigned by referencing the input variable bandwidth

• remote_ep_group: Remote subnet CIDR list, assigned by referencing the input variable remote_ep_group

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

• local_gateway_v4_ip: Cloud-side IPv4 address, assigned by referencing the input variable local_gateway_v4_ip

• remote_gateway_v4_ip: Customer-side IPv4 address, assigned by referencing the input variable remote_gateway_v4_ip

• enable_bfd: Whether to enable BFD function, assigned by referencing the input variable enable_bfd

• enable_nqa: Whether to enable NQA function, assigned by referencing the input variable enable_nqa

• tags: Tags, assigned by referencing the input variable virtual_interface_tags

5. 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"

# VPC configuration
vpc_name = "tf_test_vpc"
vpc_cidr = "192.168.0.0/16"

# Virtual gateway configuration
virtual_gateway_name = "tf_test_virtual_gateway"

# Virtual interface configuration
virtual_interface_name        = "tf_test_virtual_interface"
virtual_interface_description = "Created by Terraform"
virtual_interface_type        = "private"
route_mode                    = "static"
direct_connect_id             = "f50a0a20-7214-4614-b2f8-830994186934"
vlan                          = 100
bandwidth                     = 100
remote_ep_group               = ["10.10.10.0/30"]
address_family                = "ipv4"
local_gateway_v4_ip           = "10.10.10.1/30"
remote_gateway_v4_ip          = "10.10.10.2/30"
enable_bfd                    = false
enable_nqa                    = false

# Tag configuration
virtual_interface_tags = {
  "Owner"      = "terraform"
  "Env"        = "test"
  "Project"    = "dc-demo"
  "CostCenter" = "IT"
}

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="vpc_name=my-vpc" -var="virtual_interface_name=my-interface"

2. Environment variables: export TF_VAR_vpc_name=my-vpc

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.

6. 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 virtual interface

4. Run terraform show to view the details of the created DC virtual interface

Reference Information

• Huawei Cloud DC Product Documentation

• Huawei Cloud Provider Documentation

• Best Practice Source Code Reference For DC Virtual Interface