TCP Load Balancer


This guide provides instructions on how to create a TCP load balancer in F5® Distributed Cloud Console (Console) using guided configuration that walks you through the steps of configuring metadata to advanced configuration. This includes configuring the required objects for the virtual host. To know more about virtual host concepts, see Virtual Host.

Using the instructions provided in this guide, you can create a TCP load balancer and optionally create origin pools for the same.


The following prerequisites apply:

  • An F5® Distributed Cloud Services Account. If you do not have an account, see Create an Account.

  • A valid DNS domain delegated to Distributed Cloud Services. For instructions on how to delegate your domain, see Domain Delegation.

  • A Distributed Cloud Services CE site in cases of deploying your applications on CE site. If you do not have a site, create a site using the instructions included in the Site Management guides. See vK8s Deployment guides to deploy your applications on Distributed Cloud Services network cloud or edge cloud.


The following video shows a tutorial for TCP load balancer creation:

The configuration option to create the TCP load balancer guides you through the steps for required configuration. This document covers each guided step and explains the required actions to be performed for each step.

Step 1: Navigate to the TCP load balancer configuration page.
  • Log into Console.

  • Click Load Balancers.

Figure: Console Homepage
Figure: Console Homepage

  • Select your namespace from the menu.

  • Select Manage > Load Balancers > TCP Load Balancers.

Step 2: Start load balancer creation process.
  • Click Add TCP Load Balancer to open the load balancer creation form.

Figure: Load Creation Form
Figure: Load Creation Form

  • In the Metadata section, enter a name for your TCP load balancer.

  • Optionally, set labels and enter a description for your TCP load balancer.

Figure: Creation Form
Figure: Creation Form

Step 3: Configure domain and listening port.
  • In the Basic Configuration section, perform the following:

    • Click Add item to add a domain. You can add more than one domain.

    • In the Domains field, enter the name of the domain to be used with this load balancer.

    • In the Listen Port field, enter a number. This is the TCP listening port.

    • Optionally, from the SNI and Default LB choice menu, select the SNI checkbox to set the load balancer as a TCP load balancer with Server Name Indication (SNI).

    • Optionally, select Automatically Manage DNS Records to have your DNS records managed by Distributed Cloud Services.

Figure: List of Domains
Figure: List of Domains

Step 4: Configure origin pools.
  • In the Origin Pools section, perform the following:

    • Click Add Item to open the configuration form.

    • From the Origin Pool drop-down menu, select an existing origin pool or click Create new origin pool to create and apply a new origin pool.

  • Optionally, enter values for the Weight and Priority fields.

  • Click Apply.

Figure: Origin Pool Configuration
Figure: Origin Pool Configuration

Note: You can click Add Item to add more routes per your requirements.

Step 5: Configure VIP advertisement.

Note: In case of tenants with shared VIPs, advertising on a public network is supported only with the proxy type TCP_PROXY_WITH_SNI and on port 443.

  • From the Where to Advertise the VIP menu, select an option:

    • Advertise On Public: This option advertises the load balancer on a public network. Default option.

    • Advertise Custom: This option enables you to configure your own advertisement policy.

Figure: Advertise VIP
Figure: Advertise VIP

  • To configure a custom VIP:

    • Select Advertise Custom.

    • Click Configure.

    • Click Add Item.

    • From the Select Where to Advertise menu, select an option:

      • Site

      • Virtual Site

      • vK8s Service Network on RE

      • Virtual Network

    • From the Site Network menu, select a network type. Or select both types in case you selected Site or Virtual Site as the advertisement location.

    • Select an appropriate reference object from the Site Reference menu.

    • For Site only, enable Show Advanced Fields and then enter an IP address in the IP Address field.

    • Configure a TCP listener port or select the default option from the TCP Listen Port Choice menu. The default option sets port 80 for HTTP and port 443 for HTTPS. Select TCP Listen Port to enter a custom port number.

    • Select Apply.

Step 6: Set the load balancing control and advanced configuration.
  • From the Load Balancer Type menu, select an option to set TLS with an automatic or custom certificate.

  • From the Load Balancing Control menu, select an option:

    • Round Robin

    • Least Active Connections

    • Random

    • Source IP Stickiness

  • In the Advanced Configuration section, enable the Show Advanced Fields option.

  • From the Idle Timeout field, set an amount for the stream.

  • Optionally, configure cluster retraction:

    • From the Select Cluster retract option menu, select an option to specify whether the cluster is retracted or not.

Figure: Advanced Options
Figure: Advanced Options

Step 7: Complete creating the load balancer.
  • Click Save and Exit.

  • Verify that the requests to the configured domain are processed successfully using a terminal.

The following sample shows an example command sent for a DNS query over TCP:

dig +tcp


API References