Load Balancers in Tanzu Kubernetes Grid Integrated Edition
Warning: VMware Tanzu Kubernetes Grid Integrated Edition (TKGI) v1.8 is no longer supported because it has reached the End of General Support (EOGS) phase as defined by the Support Lifecycle Policy. To stay up to date with the latest software and security updates, upgrade to a supported version.
Note: As of v1.8, Enterprise PKS has been renamed to VMware Tanzu Kubernetes Grid Integrated Edition. Some screenshots in this documentation do not yet reflect the change.
Page last updated:
This topic describes the types of load balancers that are used in VMware Tanzu Kubernetes Grid Integrated Edition deployments. Load balancers differ by the type of deployment.
For Tanzu Kubernetes Grid Integrated Edition deployments on GCP, AWS, or vSphere without NSX-T, you can configure load balancers for the following:
- TKGI API: Configuring this load balancer enables you to run TKGI Command Line Interface (TKGI CLI) commands from your local workstation.
- Kubernetes Clusters: Configuring a load balancer for each new cluster enables you to run Kubernetes CLI (kubectl) commands on the cluster.
- Workloads: Configuring a load balancer for your application workloads enables external access to the services that run on your cluster.
The following diagram, applicable to GCP, AWS, and vSphere without NSX-T, shows where each of the above load balancers can be used within your Tanzu Kubernetes Grid Integrated Edition deployment.
If you use either vSphere without NSX-T or GCP, you are expected to create your own load balancers within your cloud provider console. If your cloud provider does not offer load balancing, you can use any external TCP or HTTPS load balancer of your choice.
The TKGI API load balancer enables you to access the TKGI API from outside the network on Tanzu Kubernetes Grid Integrated Edition deployments on GCP, AWS, and on vSphere without NSX-T. For example, configuring a load balancer for the TKGI API enables you to run TKGI CLI commands from your local workstation.
For information about configuring the TKGI API load balancer on vSphere without NSX-T, see Configuring TKGI API Load Balancer.
When you create an Tanzu Kubernetes Grid Integrated Edition cluster on GCP, AWS, and on vSphere without NSX-T, you must configure external access to the cluster by creating an external TCP or HTTPS load balancer. The load balancer enables the Kubernetes CLI to communicate with the cluster.
If you create a cluster in a non-production environment, you can choose not to use a load balancer. To enable kubectl to access the cluster without a load balancer, you can do one of the following:
- Create a DNS entry that points to the cluster’s master VM. For example:
my-cluster.example.com A 10.0.0.5
- On the workstation where you run kubectl commands, add the master IP address of your cluster and
/etc/hostsfile. For example:
For more information about configuring a cluster load balancer, see the following:
- Creating and Configuring a GCP Load Balancer for Tanzu Kubernetes Grid Integrated Edition Clusters
- Creating and Configuring an AWS Load Balancer for Tanzu Kubernetes Grid Integrated Edition Clusters
- Creating and Configuring an Azure Load Balancer for Tanzu Kubernetes Grid Integrated Edition Clusters
To enable external access to your Tanzu Kubernetes Grid Integrated Edition app on GCP, AWS, and on vSphere without NSX-T, you can either create a load balancer or expose a static port on your workload.
For information about configuring a load balancer for your app workload, see Deploying and Exposing Basic Linux Workloads.
If you use AWS, you must configure routing in the AWS console before you can create a load balancer for your workload. You must create a public subnet in each availability zone (AZ) where you are deploying the workload and tag the public subnet with your cluster’s unique identifier.
See the AWS Prerequisites section of Deploying and Exposing Basic Linux Workloads before you create a workload load balancer.
A Kubernetes ingress controller sits behind a load balancer, routing HTTP and HTTPS requests from outside the cluster to services within the cluster. Kubernetes ingress resources can be configured to load balance traffic, provide externally reachable URLs to services, and manage other aspects of network traffic.
If you add an ingress controller to your Tanzu Kubernetes Grid Integrated Edition deployment, traffic routing is controlled by the ingress resource rules you define. VMware recommends configuring Tanzu Kubernetes Grid Integrated Edition deployments with both a workload load balancer and an ingress controller.
The following diagram shows how the ingress routing can be used within your Tanzu Kubernetes Grid Integrated Edition deployment.
The load balancer on Tanzu Kubernetes Grid Integrated Edition on vSphere with NSX-T is automatically provisioned with Kubernetes ingress resources without the need to deploy and configure an additional ingress controller.
For information about deploying a load balancer configured with ingress routing on GCP, AWS, Azure, and vSphere without NSX-T, see Configuring Ingress Routing. For information about ingress routing on vSphere with NSX-T, see Configuring Ingress Resources and Load Balancer Services.
Tanzu Kubernetes Grid Integrated Edition deployments on vSphere with NSX-T do not require a load balancer configured to access the TKGI API. They require only a DNAT rule configured so that the TKGI API host is accessible. For more information, see Share the Tanzu Kubernetes Grid Integrated Edition Endpoint in Installing Tanzu Kubernetes Grid Integrated Edition on vSphere with NSX-T Integration.
NSX-T handles load balancer creation, configuration, and deletion automatically as part of the Kubernetes cluster create, update, and delete process. When a new Kubernetes cluster is created, NSX-T creates and configures a dedicated load balancer tied to it. The load balancer is a shared resource designed to provide efficient traffic distribution to master nodes as well as services deployed on worker nodes. Each application service is mapped to a virtual server instance, carved out from the same load balancer. For more information, see Logical Load Balancer in the NSX-T documentation.
Virtual server instances are created on the load balancer to provide access to the following:
- Kubernetes API and UI services on a Kubernetes cluster. This enables requests to be load balanced across multiple master nodes.
- Ingress controller. This enables the virtual server instance to dispatch HTTP and HTTPS requests to services associated with Ingress rules.
type:loadbalancerservices. This enables the server to handle TCP connections or UDP flows toward exposed services.
Load balancers are deployed in high-availability mode so that they are resilient to potential failures and able to recover quickly from critical conditions.
NodePort Service type is not supported for Tanzu Kubernetes Grid Integrated Edition deployments on vSphere with NSX-T. Only
type:LoadBalancerServices and Services associated with Ingress rules are supported on vSphere with NSX-T.
When a new Kubernetes cluster is provisioned using the TKGI API, NSX-T creates a dedicated load balancer for that new cluster. By default, the size of the load balancer is set to Small.
With network profiles, you can change the size of the load balancer deployed by NSX-T at the time of cluster creation. For information about network profiles, see Using Network Profiles (NSX-T Only).
For more information about the types of load balancers NSX-T provisions and their capacities, see Scaling Load Balancer Resources in the NSX-T documentation.
Please send any feedback you have to firstname.lastname@example.org.