Adding a listener to a network load balancer

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To add a listener to a network load balancer, run this command:

yc load-balancer network-load-balancer add-listener <load_balancer_name_or_ID> \
   --listener name=<listener_name>,`
             `port=<port>,`
             `target-port=<target_port>,`
             `protocol=<protocol>,`
             `external-address=<external_IP_address>,`
             `external-ip-version=<IP_version>

Where:

• listener: Listener parameters:
  • name: Name of the listener.
  • port: Port where the load balancer will accept incoming traffic. The acceptable values are from 1 to 32767.
  • target-port: Port to which the load balancer will redirect traffic. The acceptable values are from 1 to 32767.
  • protocol: Protocol the listener will use (TCP or UDP).
  • external-address: External IP address of the listener.
  • external-ip-version: Version of the external IP address (ipv4 or ipv6).

You can get the load balancer ID and name with a list of network load balancers in the folder.

Terraform allows you to quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. Configuration files store the infrastructure description in the HashiCorp Configuration Language (HCL). Terraform and its providers are distributed under the Business Source License.

For more information about the provider resources, see the documentation on the Terraform website or the mirror.

If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

If you don't have Terraform, install it and configure the Yandex Cloud provider.

1. Open the Terraform configuration file and add the listener section to the network load balancer description.

   resource "yandex_lb_network_load_balancer" "foo" {
     name = "<load_balancer_name>"
     ...
     listener {
       name = "<listener_name>"
       port = <port_number>
       external_address_spec {
         ip_version = "<IP_version>"
       }
     }
     ...
   }
   

   Where:

   • name: Name of the network load balancer.
   • listener: Listener parameters:
     • name: Listener name.
     • port: Port in the range of 1 to 32767 that the network load balancer will receive incoming traffic on.
     • external_address_spec: Specification of the listener for the external load balancer:
       • ip_version: External IP address specification. Set the IP address version: ipv4 or ipv6. The default value is ipv4.

   For more information about the yandex_lb_network_load_balancer resource in Terraform, see the provider documentation.

2. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

3. Add a listener.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

To add a listener to the network load balancer, use the addListener REST API method for the NetworkLoadBalancer resource or the NetworkLoadBalancerService/AddListener gRPC API call.

1. Open the Terraform configuration file and add the listener section to the network load balancer description.

   resource "yandex_lb_network_load_balancer" "foo" {
     name = "test-load-balancer"
     listener {
       name        = "test-listener"
       port        = 80
       target_port = 81
       protocol    = "tcp"
       external_address_spec {
         ip_version = "ipv4"
       }
     }
   }
   

   For more information about resources you can create with Terraform, see the provider documentation.

2. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

3. Create a network load balancer.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

Use the addListener API method and include the following information in the request body:

{
  "listenerSpec": {
    "name": "test-listener",
    "port": "80",
    "protocol": "TCP",
    "targetPort": "81",
    "externalAddressSpec": {
      "ipVersion": "ipv4"
    }
  }
}