Operations on Envoy Gateway

Customize EnvoyProxy

Mon, 01 Jan 0001 00:00:00 +0000

Envoy Gateway provides an EnvoyProxy CRD that can be linked to the ParametersRef in a Gateway and GatewayClass, allowing cluster admins to customize the managed EnvoyProxy Deployment and Service. To learn more about GatewayClass and ParametersRef, please refer to Gateway API documentation.

Prerequisites

Follow the steps below to install Envoy Gateway and the example manifest. Before proceeding, you should be able to query the example backend using HTTP.

Expand for instructions

Install the Gateway API CRDs and Envoy Gateway using Helm:

Deployment Mode

Mon, 01 Jan 0001 00:00:00 +0000

Deployment modes

One GatewayClass per Envoy Gateway Controller

An Envoy Gateway is associated with a single GatewayClass resource under one controller. This is the simplest deployment mode and is suitable for scenarios where each Gateway needs to have its own dedicated set of resources and configurations.

Multiple GatewayClasses per Envoy Gateway Controller

An Envoy Gateway is associated with multiple GatewayClass resources under one controller.
Support for accepting multiple GatewayClasses was added here.

Separate Envoy Gateway Controllers

If you’ve instantiated multiple GatewayClasses, you can also run separate Envoy Gateway controllers in different namespaces, linking a GatewayClass to each of them for multi-tenancy. Please follow the example Multi-tenancy.

Standalone Deployment Mode

Mon, 01 Jan 0001 00:00:00 +0000

Notice

Standalone mode is an experimental feature, please DO NOT use it in production.

Envoy Gateway also supports running in standalone mode. In this mode, Envoy Gateway does not need to rely on Kubernetes and can be deployed directly on bare metal or virtual machines.

Currently, Envoy Gateway only support the file provider and the host infrastructure provider combinations.

The file provider will configure the Envoy Gateway to get all gateway-api resources from file system.
The host infrastructure provider will configure the Envoy Gateway to deploy one Envoy Proxy as a host process.

Quick Start

Running locally on the host machine

In this quick-start, we will run Envoy Gateway in standalone mode with the file provider and the host infrastructure provider.

Use egctl

Mon, 01 Jan 0001 00:00:00 +0000

egctl is a command line tool to provide additional functionality for Envoy Gateway users.

egctl experimental translate

This subcommand allows users to translate from an input configuration type to an output configuration type.

The translate subcommand can translate Kubernetes resources to:

Gateway API resources This is useful in order to see how validation would occur if these resources were applied to Kubernetes.

Use the --to gateway-api parameter to translate to Gateway API resources.