Setup
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:
helm
(versionv3.0.0
or higher)kubectl
- A compatible Kubernetes cluster setup (1.16 or higher), to which you can connect via
kubectl
- Gloo Edge Enterprise 1.5.0-beta9 or higher installed to your cluster. If you do not have a Gloo Edge Enterprise with Gloo Portal license key, you can request one by clicking on “Get a Demo” on our website.
- A Gloo Edge
Gateway
resource that exposes your APIs. The default Gloo Edge gateways work with Gloo Portal. If you modified the gateways, check the troubleshooting guide to make sure your gateways work. - If you have an existing, old version of Gloo Portal, remove the old custom resource definitions (CRDs).
Install Gloo Portal
To install Gloo Portal, you use a Helm chart.
-
Add the Helm repository and update the repo contents.
# Add the Helm repository for Gloo Portal helm repo add gloo-portal https://storage.googleapis.com/dev-portal-helm helm repo update
-
Create a Helm values override file.
cat << EOF > gloo-values.yaml glooEdge: enabled: true licenseKey: secretRef: name: license namespace: gloo-system key: license-key EOF
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. -
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 upgrade --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 thehelm install
command.Example output of the
gloo-portal
Helm chart installation:NAME: gloo-portal LAST DEPLOYED: XXXXXXXXXXX NAMESPACE: gloo-portal STATUS: deployed REVISION: 1 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 10.20.2.10 <none> 8080/TCP 45s
service/gloo-portal-admin-server ClusterIP 10.20.10.185 <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.