Get going with Tetrate Enterprise Gateway for Envoy (TEG) in minutes!

Prerequisites

A Kubernetes cluster.

Note: Refer to the Compatibility Matrix for supported Kubernetes versions.

1. Option 1: Direct from Tetrate

   Install Tetrate Enterprise Gateway for Envoy (TEG) using Helm

   The easiest way to deploy Tetrate Enterprise Gateway for Envoy (TEG) is through Helm charts, this step typically takes 2-3 minutes to complete:

   export REGISTRY="oci://docker.io/tetrate"
   export CHART_VERSION="v1.8.1"
   helm install teg ${REGISTRY}/teg-envoy-gateway-helm \
    --version ${CHART_VERSION} \
    -n envoy-gateway-system --create-namespace

   (Alternative) Install the CRDs separately

   If you need more control on what CRDs are installed (for example, your Kubernetes provider already provides the Gateway API CRDs), you can install the CRDs first, then install TEG. You can do it as follows:

   warning

   If your Kubernetes provider already manages Gateway API CRDs for the cluster, confirm that the provider-installed Gateway API version and channel are compatible with the TEG release and the Gateway API resources you plan to use

   export REGISTRY="oci://docker.io/tetrate"
   export CHART_VERSION="v1.8.1"
   
   # Install the CRDs. By default the Gateway API, Envoy Gateway and TEG CRDs are installed
   helm install teg-crds ${REGISTRY}/teg-crds-helm  \
    --version ${CHART_VERSION}  \
    --set gateway-crds-helm.crds.gatewayAPI.enabled=true \
    --set gateway-crds-helm.crds.envoyGateway.enabled=true \
    --set teg.crds.enabled=true
   
   # Install TEG skipping the CRDs
   helm install teg ${REGISTRY}/teg-envoy-gateway-helm \
    --version ${CHART_VERSION} \
    -n envoy-gateway-system --create-namespace \
    --skip-crds

   Option 2: AWS Marketplace

   Installing from AWS Marketplace

   1. Configure the Installation

      Locate your Tetrate Enterprise Gateway for Envoy (TEG) SE Subscription in AWS Marketplace and choose to Configure the Software:

      Configure the TEG Software

      Select the most recent software version available. Click Continue to Launch.

      caution

      Do not follow the marketplace instructions! For best results, use the following instructions.

   2. Acquire the TEG repo charts

      The TEG images are located in the AWS Marketplace us-east-1 region. You can install these images into any selected AWS region.

      Log in to the AWS ECR repository:

      aws ecr get-login-password \
          --region us-east-1 | helm registry login \
          --username AWS \
          --password-stdin 709825985650.dkr.ecr.us-east-1.amazonaws.com

      Prepare the file structure on your workstation and download the charts:

      mkdir awsmp-chart && cd awsmp-chart
      
      helm pull oci://709825985650.dkr.ecr.us-east-1.amazonaws.com/tetrate-io/teg/teg-envoy-gateway-helm --version v1.8.1
      
      tar xf $(pwd)/* && find $(pwd) -maxdepth 1 -type f -delete

   3. Install TEG

      This step typically takes 5-10 minutes to complete.

      -helm install teg \
          --namespace envoy-gateway-system teg-envoy-gateway-helm/ \
          --create-namespace \
          --set image.registry=709825985650.dkr.ecr.us-east-1.amazonaws.com/tetrate-io/teg \
          --set image.tag=v1.8.1

2. Check if Tetrate Enterprise Gateway for Envoy (TEG) has been successfully installed

   Wait for Tetrate Enterprise Gateway for Envoy (TEG) to become available:

   kubectl wait --for=condition=Available --timeout=5m -n envoy-gateway-system \
       deployment/envoy-gateway

   The following components will be deployed:

   kubectl get pod -n envoy-gateway-system
   NAME                                 READY   STATUS    RESTARTS   AGE
   envoy-gateway-68487468d-9l9t9        1/1     Running   0          25s
   envoy-ratelimit-55864b46fb-glkk4     1/1     Running   0          19s
   teg-envoy-gateway-99cc9c977-dkjcf    1/1     Running   0          34s
   teg-redis-9f659ff8-r6rm2             1/1     Running   0          34s

3. Get started with your first application

   Let's expose your first application using the Tetrate Enterprise Gateway for Envoy (TEG)