TCP Load Balancer


This guide provides instructions on how to create a TCP load balancer in VoltConsole using guided configuration that walks you through the steps of configuring meta data 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 loadbalancer and optionally create origin pools for the same.


The following prerequisites apply:

  • Volterra Account

  • A valid DNS domain delegated to Volterra.

    • Note: For instructions on how to delegate your domain to Volterra, see Delegate Domain.
  • A Volterra CE site in case of deploying your applications on CE site.

    • Note: 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 Volterra network cloud or edge cloud.


The following video shows a tutorial for HTTP 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: Log into the VoltConsole and navigate to the TCP load balancer configuration.

Change to your application namespace. You can navigate to the TCP load balancers from either of the following ways:

  • Select Virtual Hosts in the configuration menu and Load Balancers -> TCP Load Balancers in the options.

Figure: Navigation through Virtual Hosts Menu

  • Select Manage in the configuration menu and Load Balancers -> TCP Load Balancers in the options.

Figure: Navigation through Manage Menu

Step 2: Start the load balancer creation and enter metadata.

Click Add TCP load balancer to open the load balancer creation form and perform following steps:

  • Enter a name in the Metadata section.
  • Optionally, set labels and enter a description for your load balancer.
Step 3: Configure domain and listening port.

Go to the Basic Configuration and perform the following:

  • Enter a domain in the Domains field. Click Add item to add more than one domain.
  • Enter a port number in the Listen Port field. This is the TCP listening port.
  • Optionally, select the With SNI checkbox to set the load balancer as TCP loadbalancer with SNI.
Step 4: Configure origin pools.
  • Click Configure in the Origin Pools field to open origin pool configuration form.
  • Perform on of the following for the Select Origin Pool Method option:

    • Select Origin Pool and select an existing origin pool from the Origin Pool drop-down or click Create new pool to create and apply a new origin pool.
    • Select Custom Cluster and select an existing cluster from the Custom Cluster drop-down or click Create new cluster to create and apply a new cluster.
  • Optionally, enter a value for the Weight field.

    This sample shows configuring a new origin pool with public DNS names of origin servers as the type of origin servers:

Figure: Origin Pool Configuration

  • Click Apply to add the origin pool.

Note: You can click Add item and add more routes as per your requirement.

Step 5: Configure VIP advertisement.

The Where to Advertise the VIP field displays Advertise Custom and Advertise On Public options with the latter being selected by default.

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

Proceed with the default option or click Show Advanced Fields option to enable more options and set one of the options as per the following guidelines:

  • Select Advertise on Public With Specified VIP and enter an IP address in the Public IP field to advertise that IP as VIP on the public network.
  • Select Advertise Custom, click Configure in the Advertise Custom field enabled, and perform the configuration as per the following guidelines:

    • Select Site or Virtual Site or vK8s Service Network on RE options for the Select Where to Advertise field and select appropriate reference objects in the Reference fields. In case of site, you can also optionally set an IP address as the VIP.
    • Select inside network or outside network or both for the Site Network field in case you selected Site or Virtual Site as the advertisement location.
    • Configure a TCP listener port or select default option for the TCP Listen Port Choice field. The default option sets port 80 for HTTP, 443 for HTTPS, and the listen port you set in basic configuration for TCP.
    • Click Apply to add the custom VIP advertisement configuration.
  • Select Advertise on Public to advertise the default VIP on the public network.

This example sets advertising on public.

Note: Select Do Not Advertise to disable VIP advertisement.

Step 6:Complete creating the load balancer.

Click Continue to complete creating the load balancer.

Figure: Load Balancer Created

Verify that the requests to the configured domain are processed successfully. The following sample shows example command to send a DNS query over TCP:

dig +tcp


API References