Configuring PKS API Load Balancer

Page last updated:

This topic describes how to configure an external load balancer for the PKS API.

Overview

You must configure an external load balancer to make the PKS API accessible from outside the network. This external load balancer forwards traffic to the PKS API endpoint on ports 8443 and 9021. You can use any external load balancer for the PKS API.

To set up an external load balancer for the PKS API, do the following after you install the Enterprise PKS tile:

  1. Retrieve the PKS API Endpoint
  2. Configure an External Load Balancer

Prerequisites

Before configuring an external load balancer for the PKS API, you must have the following:

  • The PKS API certificate that you provided in the Enterprise PKS tile > PKS API > Certificate to secure the PKS API.
  • The PKS API hostname that you entered in the Enterprise PKS tile > PKS API > API Hostname (FQDN).

Step 1: Retrieve the PKS API Endpoint

You need to retrieve the PKS API endpoint to allow your organization to use the API to create, update, and delete Kubernetes clusters.

To retrieve the PKS API endpoint, do the following:

  1. Navigate to the Ops Manager Installation Dashboard.
  2. Click the Enterprise PKS tile.
  3. Click the Status tab and locate the Pivotal Container Service job. The IP address of the Pivotal Container Service job is the PKS API endpoint.

Step 2: Configure an External Load Balancer

To set up an external load balancer for the PKS API, configure the external load balancer to resolve to the domain name you entered in the Enterprise PKS tile > PKS API > API Hostname (FQDN) using the following information:

Next Installation Step

To set up Enterprise PKS admin users who can create and manage Kubernetes clusters, follow the instructions in Setting Up Enterprise PKS Admin Users on vSphere.


Please send any feedback you have to pks-feedback@pivotal.io.