The following document will take you through the process of installing, verifying the installation, and uninstalling Gloo Portal for Gloo Edge Enterprise.

Before you begin

Set up the following tools and environment:

Install Gloo Portal

To install Gloo Portal, you use a Helm chart.

  1. Add the Helm repository and update the repo contents.

    # Add the Helm repository for Gloo Portal
    helm repo add gloo-portal
    helm repo update
  2. Create a Helm values override file.

    cat << EOF > gloo-values.yaml
      enabled: true
        name: license
        namespace: gloo-system
        key: license-key

    Review the following table for a brief explanation of the Helm file values.

    Value Description
    glooEdge.enabled Enables the integration with Gloo Edge Enterprise.
    licenseKey When running on Gloo Edge, Gloo Portal requires a valid Gloo Edge Enterprise license key. Because you already installed Gloo Edge Enterprise to your cluster, you can use licenseKey.secretRef to refer to the existing license key secret. For more information on getting a Gloo Edge Enterprise license, see the Gloo Edge docs.
  3. Create the target namespace for the deployment and install Gloo Portal with the previous Helm values override file.

    # Create the namespace and install the Helm chart
    kubectl create namespace gloo-portal
    helm install gloo-portal gloo-portal/gloo-portal -n gloo-portal --values gloo-values.yaml

    Want to install a different version than latest? Get the version you want from the Changelog, and then include the --version option in the helm install command.

    Example output of the gloo-portal Helm chart installation:

    NAME: gloo-portal
    NAMESPACE: gloo-portal
    STATUS: deployed
    TEST SUITE: None

Verify your installation

To verify your installation, check that the Gloo Portal deployments and services are created. For more information on each component, refer to the Architecture page.

If you installed Gloo Portal into a namespace other than gloo-portal, update the following command.

kubectl get all -n gloo-portal
NAME                                READY   STATUS    RESTARTS   AGE
pod/gloo-portal-admin-server-557b64597d-q7vxl   3/3     Running   0          45s
pod/gloo-portal-controller-7d56b8876d-ns7l6     1/1     Running   0          45s

NAME                   TYPE        CLUSTER-IP     EXTERNAL-IP   PORT(S)    AGE
service/gloo-portal                ClusterIP     <none>        8080/TCP   45s
service/gloo-portal-admin-server   ClusterIP   <none>        8080/TCP   45s

NAME                           READY   UP-TO-DATE   AVAILABLE   AGE
deployment.apps/gloo-portal-admin-server   1/1     1            1           45s
deployment.apps/gloo-portal-controller     1/1     1            1           45s

NAME                                      DESIRED   CURRENT   READY   AGE
replicaset.apps/gloo-portal-admin-server-557b64597d   1         1         1       45s
replicaset.apps/gloo-portal-controller-7d56b8876d     1         1         1       45s

Uninstall Gloo Portal

To uninstall Gloo Portal, run the following command:

helm uninstall gloo-portal -n gloo-portal

Next steps

After installing the product, walk through the Concepts and Getting Started guides.