Gloo Mesh Gateway is a feature-rich, Kubernetes-native ingress controller and next-generation API gateway. With Gloo Mesh Gateway, you have access to its exceptional function-level routing, discovery capabilities, numerous features, tight integration with leading open-source projects, and support for legacy apps, microservices, and serverless. Gloo Mesh Gateway is uniquely designed to support hybrid applications in which multiple technologies, architectures, protocols, and clouds can coexist.

You can follow this guide to quickly get started with Gloo Mesh Gateway. To learn more about the benefits and architecture, see About. To customize your installation with Helm instead, see the advanced installation guide. To set up the management plane in a dedicated management cluster and the data plane in workload clusters instead of a single-cluster setup, see the multicluster installation guide.

Before you begin

  1. Install the following command-line (CLI) tools.

    • kubectl, the Kubernetes command line tool. Download the kubectl version that is within one minor version of the Kubernetes clusters you plan to use.
    • meshctl, the Solo command line tool.
        curl -sL https://run.solo.io/meshctl/install | GLOO_MESH_VERSION=v2.3.23 sh -
export PATH=$HOME/.gloo-mesh/bin:$PATH

  2. Create or use an existing Kubernetes or OpenShift cluster, and save the cluster name in an environment variable. Note: The cluster name must be alphanumeric with no special characters except a hyphen (-), lowercase, and begin with a letter (not a number).

      export CLUSTER_NAME=<cluster_name>

  3. Set your Gloo Mesh Gateway license key as an environment variable. If you do not have one, contact an account representative. If you prefer to specify license keys in a secret instead, see Licensing.

      export GLOO_MESH_GATEWAY_LICENSE_KEY=<license_key>

Install Gloo Mesh Gateway

Install Gloo Mesh Gateway and an ingress gateway proxy in your cluster. This command uses a basic profile to install the management plane components, such as the management server and Prometheus server, and the data plane components, such as the agent, gateway proxy, rate limit server, and external auth server, in your cluster.

  meshctl install --profiles gloo-gateway-single,ratelimit,extauth \
  --set common.cluster=$CLUSTER_NAME \
  --set common.addonNamespace=gloo-mesh \
  --set licensing.glooGatewayLicenseKey=$GLOO_MESH_GATEWAY_LICENSE_KEY
  1. Elevate the permissions of the following service accounts that will be created. These permissions allow the to make use of a user ID that is normally restricted by OpenShift. For more information, see the Istio on OpenShift documentation.
      oc adm policy add-scc-to-group anyuid system:serviceaccounts:gloo-mesh
oc adm policy add-scc-to-group anyuid system:serviceaccounts:istio-system
oc adm policy add-scc-to-group anyuid system:serviceaccounts:gloo-mesh-gateways
oc adm policy add-scc-to-group anyuid system:serviceaccounts:gm-iop-1-18
  2. Create the gloo-mesh-gateways project, and create a NetworkAttachmentDefinition custom resource for the project.
      kubectl create ns gloo-mesh-gateways

cat <<EOF | oc -n gloo-mesh-gateways create -f -
apiVersion: "k8s.cni.cncf.io/v1"
kind: NetworkAttachmentDefinition
metadata:
  name: istio-cni
EOF
  3. Install Gloo Mesh Gateway.
      meshctl install --profiles gloo-gateway-single,ratelimit,extauth \
  --set common.cluster=$CLUSTER_NAME \
  --set common.addonNamespace=gloo-mesh \
  --set licensing.glooGatewayLicenseKey=$GLOO_MESH_GATEWAY_LICENSE_KEY

Note: In OpenShift 4.11 and later, you might see warnings for the pods and containers which violate the OpenShift PodSecurity "restricted:v1.24" profile, due to the elevated permissions required by Istio. You can ignore these warnings. For more info, see this article.

Verify the installation

  1. Verify that your Gloo Mesh Gateway setup is correctly installed. If not, try debugging the relay connection. Note that this check might take a few seconds to verify that:

    • Your Gloo product license is valid and current.
    • The Gloo CRDs are installed at the correct version.
    • The management plane pods in the management cluster are running and healthy.
    • The Gloo agent is running and connected to the management server.
      meshctl check

    Example output:

      🟢 License status

INFO  gloo-gateway enterprise license expiration is 25 Aug 24 10:38 CDT
INFO  Valid GraphQL license module found

🟢 CRD version check

🟢 Gloo deployment status

Namespace | Name                           | Ready | Status
gloo-mesh | ext-auth-service               | 1/1   | Healthy
gloo-mesh | gloo-mesh-agent                | 1/1   | Healthy
gloo-mesh | gloo-mesh-mgmt-server          | 1/1   | Healthy
gloo-mesh | gloo-mesh-redis                | 1/1   | Healthy
gloo-mesh | gloo-mesh-ui                   | 1/1   | Healthy
gloo-mesh | gloo-telemetry-collector-agent | 3/3   | Healthy
gloo-mesh | prometheus-server              | 1/1   | Healthy
gloo-mesh | rate-limiter                   | 1/1   | Healthy

🟢 Mgmt server connectivity to workload agents

Cluster | Registered | Connected Pod                                   
test    | true       | gloo-mesh/gloo-mesh-mgmt-server-558cddbbd7-rf2hv

Connected Pod                                    | Clusters
gloo-mesh/gloo-mesh-mgmt-server-558cddbbd7-rf2hv | 1

  2. Verify that the gateway proxy service is created and assigned an external address. It might take a few minutes for the load balancer to deploy.

      kubectl get svc -n gloo-mesh-gateways

    Example output:

      NAME                   TYPE           CLUSTER-IP      EXTERNAL-IP      PORT(S)                                                      AGE
istio-ingressgateway   LoadBalancer   10.XX.XXX.XXX   35.XXX.XXX.XXX   15021:30826/TCP,80:31257/TCP,443:30673/TCP,15443:30789/TCP   48s
  3. Optional: Check out the workspace and workspace settings that were created for you. Workspaces help to organize team resources in your cluster, and to isolate Kubernetes and Gloo resources. Because the default workspace is used for demonstration purposes, it does not isolate any resources, and instead allows all Kubernetes and Gloo resources in the workspace.
      kubectl get workspace $CLUSTER_NAME -n gloo-mesh -o yaml
  
      kubectl get workspacesettings default -n gloo-mesh -o yaml

  4. Optional for OpenShift: Expose the ingress gateway by using an OpenShift route.

      oc -n gloo-mesh-gateways expose svc istio-ingressgateway --port=http2

Next

Deploy sample apps to try out the routing capabilities and traffic policies in Gloo Mesh Gateway.

Understand what happened

Find out more information about the Gloo Mesh Gateway environment that you set up in this guide.

Gloo Mesh Gateway installation: This quick start guide used meshctl to install a minimum deployment of Gloo Mesh Gateway for testing purposes, and some optional components are not installed. For more information, check out the CLI install profiles. To learn more about production-level installation options, including advanced configuration options available in the Gloo Helm chart, see the advanced installation guide.

Management server and agent: When you installed the Gloo management plane, a deployment named gloo-mesh-mgmt-server was created to translate and implement your Gloo configurations. Additionally, because the glooAgent.enabled: true setting is included in the gloo-gateway-single install profile, the cluster was also registered to be managed by Gloo. The deployment named gloo-mesh-agent was created to run the Gloo agent as part of the Gloo data plane.

Relay architecture: When you installed Gloo Mesh Gateway, the connection between the Gloo management server and agent was secured by using mutual TLS. During the installation, Gloo Mesh Gateway automatically generates self-signed root and intermediate CA credentials that are used to derive a certificate for the Gloo management server and agent. To establish initial trust and obtain the certificate for the Gloo agent, the agent uses a relay identity token that is automatically created during the installation. Only if the token is successfully validated by the Gloo management server, the certificate for the agent is issued. In subsequent requests, the Gloo management server and agent use their certificates to prove their identities during the TLS handshake. To learn more about other options to secure the relay connection, see Setup options. In a multicluster setup, the Gloo agent discovers Gloo and Kubernetes resources, such as deployments and services, and sends snapshots of them to the management server for translation and implementation. However, in a single cluster setup, your resources are written directly to the cluster without relay. For more information about relay server-agent communication, see the relay architecture page.

Gateway proxy installation: The gateway proxy installation profiles in this getting started guide were provided within the Gloo installation Helm chart. However, Gloo Mesh Gateway can discover gateway deployments regardless of their installation options. For more information about gateway proxy lifecycle management with Gloo, check out the Gateway lifecycle manager API.

Gloo workspace: Gloo workspaces let you organize team resources across Kubernetes namespaces and clusters. In this example, a single workspace is created for everything. Later, as your teams grow, you can create a workspace for each team, to enforce service isolation, set up federation, and even share resources by importing and exporting. You can also change the default workspace by following the Workspace setup guide.