Install PorterLB on KubeSphere

This document describes how to install and delete PorterLB on the KubeSphere web console.

NOTE

  • In a Kubernetes cluster, you only need to install PorterLB once. After the installation is complete, a porter-manager Deployment that contains a porter-manager Pod is installed in the cluster. The porter-manager Pod implements the functionality of PorterLB for the entire Kubernetes cluster.
  • After the installation is complete, you can scale the porter-manager Deployment and assign multiple PorterLB replicas (porter-manager Pods) to multiple cluster nodes to ensure high availability. For details, see Configure Multiple PorterLB Replicas.

Prerequisites

You need to prepare a Kubernetes cluster with KubeSphere, and ensure that the Kubernetes version is 1.15 or later. PorterLB requires CustomResourceDefinition (CRD) v1, which is only supported by Kubernetes 1.15 or later. You can use the following methods to install KubeSphere:

PorterLB is designed to be used in bare-metal Kubernetes environments. However, you can also use a cloud-based Kubernetes cluster for learning and testing.

Install PorterLB on the KubeSphere Web Console

  1. Log in to the KubeSphere console and go to your workspace.

    enter-workspace

  2. On the left navigation bar, choose Apps Management > App Repos, and click Add Repo on the right.

    add-repo

  3. In the displayed dialog box, set App Repository Name (for example, KubeSphere-test), set URL to https://charts.kubesphere.io/test, click Validate to check the URL, and click OK.

    repo-spec

  4. Go to your project, choose Application Workloads > Applications on the left navigation bar, and click Deploy New Application on the right.

    deploy-new-app

  5. In the displayed dialog box, click From App Templates.

    from-app-templates

  6. Select KubeSphere-test from the drop-down list and click porter.

    porter-template

  7. Click Deploy and follow the wizard instructions to complete the installation. You can customize the chart configuration in the YAML file based on your requirements.

    deploy-porter

    porter-yaml

  8. Choose Application Workloads > Pods on the left navigation bar to check whether the status of porter-manager is running. If yes, PorterLB has been installed successfully.

    verify-porter

Delete PorterLB on the KubeSphere Web Console

To delete PorterLB on the KubeSphere web console, go to your project, choose Application Workloads > Applications on the left navigation bar, click porter-operation on the right of the PorterLB application, and choose Delete from the drop-down list.

delete-porter

NOTE

Before deleting PorterLB, you must first delete all Services that use PorterLB.

Last modified March 31, 2021: Relocated files to adapt to localization and changed links. (6b5fcb1)