API Reference

Packages

• config.gateway.envoyproxy.io/v1alpha1

config.gateway.envoyproxy.io/v1alpha1

Package v1alpha1 contains API schema definitions for the config.gateway.envoyproxy.io API group.

Resource Types

• EnvoyGateway

• EnvoyProxy

EnvoyGateway

EnvoyGateway is the schema for the envoygateways API.

Field	Description
apiVersion string	config.gateway.envoyproxy.io/v1alpha1
kind string	EnvoyGateway
EnvoyGatewaySpec EnvoyGatewaySpec	EnvoyGatewaySpec defines the desired state of EnvoyGateway.

EnvoyGatewaySpec

EnvoyGatewaySpec defines the desired state of Envoy Gateway.

Appears in:

• EnvoyGateway

Field	Description
gateway Gateway	Gateway defines desired Gateway API specific configuration. If unset, default configuration parameters will apply.
provider Provider	Provider defines the desired provider and provider-specific configuration. If unspecified, the Kubernetes provider is used with default configuration parameters.
rateLimit RateLimit	RateLimit defines the configuration associated with the Rate Limit service deployed by Envoy Gateway required to implement the Global Rate limiting functionality. The specific rate limit service used here is the reference implementation in Envoy. For more details visit https://github.com/envoyproxy/ratelimit. This configuration is unneeded for “Local” rate limiting.

EnvoyProxy

EnvoyProxy is the schema for the envoyproxies API.

Field	Description
apiVersion string	config.gateway.envoyproxy.io/v1alpha1
kind string	EnvoyProxy
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec EnvoyProxySpec	EnvoyProxySpec defines the desired state of EnvoyProxy.

EnvoyProxySpec

EnvoyProxySpec defines the desired state of EnvoyProxy.

Appears in:

• EnvoyProxy

Field	Description
provider ResourceProvider	Provider defines the desired resource provider and provider-specific configuration. If unspecified, the “Kubernetes” resource provider is used with default configuration parameters.
logging ProxyLogging	Logging defines logging parameters for managed proxies. If unspecified, default settings apply. This type is not implemented until https://github.com/envoyproxy/gateway/issues/280 is fixed.

FileProvider

FileProvider defines configuration for the File provider.

Appears in:

• Provider

Gateway

Gateway defines the desired Gateway API configuration of Envoy Gateway.

Appears in:

• EnvoyGatewaySpec

Field	Description
controllerName string	ControllerName defines the name of the Gateway API controller. If unspecified, defaults to “gateway.envoyproxy.io/gatewayclass-controller”. See the following for additional details: https://gateway-api.sigs.k8s.io/v1alpha2/references/spec/#gateway.networking.k8s.io/v1alpha2.GatewayClass

KubernetesDeploymentSpec

KubernetesDeploymentSpec defines the desired state of the Kubernetes deployment resource.

Appears in:

• KubernetesResourceProvider

Field	Description
replicas integer	Replicas is the number of desired pods. Defaults to 1.

KubernetesProvider

KubernetesProvider defines configuration for the Kubernetes provider.

Appears in:

• Provider

KubernetesResourceProvider

KubernetesResourceProvider defines configuration for the Kubernetes resource provider.

Appears in:

• ResourceProvider

Field	Description
envoyDeployment KubernetesDeploymentSpec	EnvoyDeployment defines the desired state of the Envoy deployment resource. If unspecified, default settings for the manged Envoy deployment resource are applied.

LogComponent

Underlying type: string

LogComponent defines a component that supports a configured logging level. This type is not implemented until https://github.com/envoyproxy/gateway/issues/280 is fixed.

Appears in:

• ProxyLogging

LogLevel

Underlying type: string

LogLevel defines a log level for system logs. This type is not implemented until https://github.com/envoyproxy/gateway/issues/280 is fixed.

Appears in:

• ProxyLogging

Provider

Provider defines the desired configuration of a provider.

Appears in:

• EnvoyGatewaySpec

Field	Description
type ProviderType	Type is the type of provider to use. Supported types are “Kubernetes”.
kubernetes KubernetesProvider	Kubernetes defines the configuration of the Kubernetes provider. Kubernetes provides runtime configuration via the Kubernetes API.
file FileProvider	File defines the configuration of the File provider. File provides runtime configuration defined by one or more files. This type is not implemented until https://github.com/envoyproxy/gateway/issues/1001 is fixed.

ProviderType

Underlying type: string

ProviderType defines the types of providers supported by Envoy Gateway.

Appears in:

• Provider

• ResourceProvider

ProxyLogging

ProxyLogging defines logging parameters for managed proxies. This type is not implemented until https://github.com/envoyproxy/gateway/issues/280 is fixed.

Appears in:

• EnvoyProxySpec

Field	Description
level object (keys:LogComponent, values:LogLevel)	Level is a map of logging level per component, where the component is the key and the log level is the value. If unspecified, defaults to “System: Info”.

RateLimit

RateLimit defines the configuration associated with the Rate Limit Service used for Global Rate Limiting.

Appears in:

• EnvoyGatewaySpec

Field	Description
backend RateLimitDatabaseBackend	Backend holds the configuration associated with the database backend used by the rate limit service to store state associated with global ratelimiting.

RateLimitDatabaseBackend

RateLimitDatabaseBackend defines the configuration associated with the database backend used by the rate limit service.

Appears in:

• RateLimit

Field	Description
type RateLimitDatabaseBackendType	Type is the type of database backend to use. Supported types are: * Redis: Connects to a Redis database.
redis RateLimitRedisSettings	Redis defines the settings needed to connect to a Redis database.

RateLimitDatabaseBackendType

Underlying type: string

RateLimitDatabaseBackendType specifies the types of database backend to be used by the rate limit service.

Appears in:

• RateLimitDatabaseBackend

RateLimitRedisSettings

RateLimitRedisSettings defines the configuration for connecting to a Redis database.

Appears in:

• RateLimitDatabaseBackend

Field	Description
url string	URL of the Redis Database.

ResourceProvider

ResourceProvider defines the desired state of a resource provider.

Appears in:

• EnvoyProxySpec

Field	Description
type ProviderType	Type is the type of resource provider to use. A resource provider provides infrastructure resources for running the data plane, e.g. Envoy proxy, and optional auxiliary control planes. Supported types are “Kubernetes”.
kubernetes KubernetesResourceProvider	Kubernetes defines the desired state of the Kubernetes resource provider. Kubernetes provides infrastructure resources for running the data plane, e.g. Envoy proxy. If unspecified and type is “Kubernetes”, default settings for managed Kubernetes resources are applied.