API Reference¶
Packages¶
config.gateway.envoyproxy.io/v1alpha1¶
Package v1alpha1 contains API schema definitions for the config.gateway.envoyproxy.io API group.
Resource Types¶
EnvoyGateway¶
EnvoyGateway is the schema for the envoygateways API.
Field |
Description |
---|---|
|
|
|
|
|
EnvoyGatewaySpec defines the desired state of EnvoyGateway. |
EnvoyGatewayFileProvider¶
EnvoyGatewayFileProvider defines configuration for the File provider.
Appears in:
EnvoyGatewayKubernetesProvider¶
EnvoyGatewayKubernetesProvider defines configuration for the Kubernetes provider.
Appears in:
Field |
Description |
---|---|
|
RateLimitDeployment defines the desired state of the Envoy ratelimit deployment resource. If unspecified, default settings for the manged Envoy ratelimit deployment resource are applied. |
EnvoyGatewayProvider¶
EnvoyGatewayProvider defines the desired configuration of a provider.
Appears in:
Field |
Description |
---|---|
|
Type is the type of provider to use. Supported types are “Kubernetes”. |
|
Kubernetes defines the configuration of the Kubernetes provider. Kubernetes provides runtime configuration via the Kubernetes API. |
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. |
EnvoyGatewaySpec¶
EnvoyGatewaySpec defines the desired state of Envoy Gateway.
Appears in:
Field |
Description |
---|---|
|
Gateway defines desired Gateway API specific configuration. If unset, default configuration parameters will apply. |
|
Provider defines the desired provider and provider-specific configuration. If unspecified, the Kubernetes provider is used with default configuration parameters. |
|
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. |
|
Extension defines an extension to register for the Envoy Gateway Control Plane. |
EnvoyProxy¶
EnvoyProxy is the schema for the envoyproxies API.
Field |
Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
EnvoyProxySpec defines the desired state of EnvoyProxy. |
EnvoyProxyKubernetesProvider¶
EnvoyProxyKubernetesProvider defines configuration for the Kubernetes resource provider.
Appears in:
Field |
Description |
---|---|
|
EnvoyDeployment defines the desired state of the Envoy deployment resource. If unspecified, default settings for the manged Envoy deployment resource are applied. |
|
EnvoyService defines the desired state of the Envoy service resource. If unspecified, default settings for the manged Envoy service resource are applied. |
EnvoyProxyProvider¶
EnvoyProxyProvider defines the desired state of a resource provider.
Appears in:
Field |
Description |
---|---|
|
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 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. |
EnvoyProxySpec¶
EnvoyProxySpec defines the desired state of EnvoyProxy.
Appears in:
Field |
Description |
---|---|
|
Provider defines the desired resource provider and provider-specific configuration. If unspecified, the “Kubernetes” resource provider is used with default configuration parameters. |
|
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. |
|
Bootstrap defines the Envoy Bootstrap as a YAML string. Visit https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/bootstrap/v3/bootstrap.proto#envoy-v3-api-msg-config-bootstrap-v3-bootstrap to learn more about the syntax. If set, this is the Bootstrap configuration used for the managed Envoy Proxy fleet instead of the default Bootstrap configuration set by Envoy Gateway. Some fields within the Bootstrap that are required to communicate with the xDS Server (Envoy Gateway) and receive xDS resources from it are not configurable and will result in the |
Extension¶
Extension defines the configuration for registering an extension to the Envoy Gateway control plane.
Appears in:
Field |
Description |
---|---|
|
Resources defines the set of K8s resources the extension will handle. |
|
Hooks defines the set of hooks the extension supports |
|
Service defines the configuration of the extension service that the Envoy Gateway Control Plane will call through extension hooks. |
ExtensionHooks¶
ExtensionHooks defines extension hooks across all supported runners
Appears in:
Field |
Description |
---|---|
|
XDSTranslator defines all the supported extension hooks for the xds-translator runner |
ExtensionService¶
ExtensionService defines the configuration for connecting to a registered extension service.
Appears in:
Field |
Description |
---|---|
|
Host define the extension service hostname. |
|
Port defines the port the extension service is exposed on. |
|
TLS defines TLS configuration for communication between Envoy Gateway and the extension service. |
ExtensionTLS¶
ExtensionTLS defines the TLS configuration when connecting to an extension service
Appears in:
Field |
Description |
---|---|
|
CertificateRef contains a references to objects (Kubernetes objects or otherwise) that contains a TLS certificate and private keys. These certificates are used to establish a TLS handshake to the extension server. |
CertificateRef can only reference a Kubernetes Secret at this time. |
Gateway¶
Gateway defines the desired Gateway API configuration of Envoy Gateway.
Appears in:
Field |
Description |
---|---|
|
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 |
GroupVersionKind¶
GroupVersionKind unambiguously identifies a Kind. It can be converted to k8s.io/apimachinery/pkg/runtime/schema.GroupVersionKind
Appears in:
Field |
Description |
---|---|
|
|
|
|
|
KubernetesContainerSpec¶
KubernetesContainerSpec defines the desired state of the Kubernetes container resource.
Appears in:
Field |
Description |
---|---|
|
Resources required by this container. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
|
Image specifies the EnvoyProxy container image to be used, instead of the default image. |
KubernetesDeploymentSpec¶
KubernetesDeploymentSpec defines the desired state of the Kubernetes deployment resource.
Appears in:
Field |
Description |
---|---|
|
Replicas is the number of desired pods. Defaults to 1. |
Pod defines the desired annotations and securityContext of container. |
|
|
Container defines the resources and securityContext of container. |
KubernetesPodSpec¶
KubernetesPodSpec defines the desired state of the Kubernetes pod resource.
Appears in:
Field |
Description |
---|---|
|
Annotations are the annotations that should be appended to the pods. By default, no pod annotations are appended. |
|
SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field. |
KubernetesServiceSpec¶
KubernetesServiceSpec defines the desired state of the Kubernetes service resource.
Appears in:
Field |
Description |
---|---|
|
Annotations that should be appended to the service. By default, no annotations are appended. |
|
Type determines how the Service is exposed. Defaults to LoadBalancer. Valid options are ClusterIP and LoadBalancer. “LoadBalancer” means a service will be exposed via an external load balancer (if the cloud provider supports it). “ClusterIP” means a service will only be accessible inside the cluster, via the cluster IP. |
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:
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:
ProviderType¶
Underlying type: string
ProviderType defines the types of providers supported by Envoy Gateway.
Appears in:
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:
Field |
Description |
---|---|
|
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:
Field |
Description |
---|---|
|
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:
Field |
Description |
---|---|
Type is the type of database backend to use. Supported types are: * Redis: Connects to a Redis database. |
|
|
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:
RateLimitRedisSettings¶
RateLimitRedisSettings defines the configuration for connecting to a Redis database.
Appears in:
Field |
Description |
---|---|
|
URL of the Redis Database. |
ServiceType¶
Underlying type: string
ServiceType string describes ingress methods for a service
Appears in:
XDSTranslatorHook¶
Underlying type: string
XDSTranslatorHook defines the types of hooks that an Envoy Gateway extension may support for the xds-translator
Appears in:
XDSTranslatorHooks¶
XDSTranslatorHooks contains all the pre and post hooks for the xds-translator runner.
Appears in:
Field |
Description |
---|---|
|
|
|