Install with Kubernetes YAML

This task walks you through installing Envoy Gateway in your Kubernetes cluster.

The manual install process does not allow for as much control over configuration as the Helm install method, so if you need more control over your Envoy Gateway installation, it is recommended that you use helm.

Before you begin

Envoy Gateway is designed to run in Kubernetes for production. The most essential requirements are:

  • Kubernetes 1.27 or later
  • The kubectl command-line tool

Install with YAML

Envoy Gateway is typically deployed to Kubernetes from the command line. If you don’t have Kubernetes, you should use kind to create one.

  1. In your terminal, run the following command:

    kubectl apply --server-side -f https://github.com/envoyproxy/gateway/releases/download/latest/install.yaml
    
  2. Next Steps

    Envoy Gateway should now be successfully installed and running, but in order to experience more abilities of Envoy Gateway, you can refer to Tasks.

Upgrading from v1.0

Due to breaking changes in Gateway API v1.1, some manual migration steps are required to upgrade Envoy Gateway to v1.1.

  1. Delete BackendTLSPolicy CRD (and resources):
kubectl delete crd backendtlspolicies.gateway.networking.k8s.io
  1. Update Gateway-API and Envoy Gateway CRDs:
helm pull oci://docker.io/envoyproxy/gateway-helm --version latest --untar
kubectl apply --force-conflicts --server-side -f ./gateway-helm/crds/gatewayapi-crds.yaml
kubectl apply --force-conflicts --server-side -f ./gateway-helm/crds/generated
  1. Update your BackendTLSPolicy and GRPCRoute resources according to Gateway-API v1.1 Upgrade Notes

  2. Update your Envoy Gateway xPolicy resources: remove the namespace section from targetRef.

  3. Install Envoy Gateway latest:

helm upgrade eg oci://docker.io/envoyproxy/gateway-helm --version latest -n envoy-gateway-system

Last modified November 1, 2024: [release/v1.1] release v1.1.3 (#4600) (a88e6eb)