diff --git a/docs/latest/design/config-api.md b/docs/latest/design/config-api.md index 3696860dd54..4caaefe3e43 100644 --- a/docs/latest/design/config-api.md +++ b/docs/latest/design/config-api.md @@ -77,7 +77,7 @@ type EnvoyGatewaySpec struct { // the Kubernetes provider is used with default parameters. // // +optional - Provider *Provider `json:"provider,omitempty"` + Provider *EnvoyGatewayProvider `json:"provider,omitempty"` } // Gateway defines desired Gateway API configuration of Envoy Gateway. @@ -92,9 +92,9 @@ type Gateway struct { ControllerName string `json:"controllerName,omitempty"` } -// Provider defines the desired configuration of a provider. +// EnvoyGatewayProvider defines the desired configuration of a provider. // +union -type Provider struct { +type EnvoyGatewayProvider struct { // Type is the type of provider to use. If unset, the Kubernetes provider is used. // // +unionDiscriminator @@ -103,13 +103,13 @@ type Provider struct { // provides runtime configuration via the Kubernetes API. // // +optional - Kubernetes *KubernetesProvider `json:"kubernetes,omitempty"` + Kubernetes *EnvoyGatewayKubernetesProvider `json:"kubernetes,omitempty"` // File defines the configuration of the File provider. File provides runtime // configuration defined by one or more files. // // +optional - File *FileProvider `json:"file,omitempty"` + File *EnvoyGatewayFileProvider `json:"file,omitempty"` } // ProviderType defines the types of providers supported by Envoy Gateway. @@ -123,13 +123,13 @@ const ( FileProviderType ProviderType = "File" ) -// KubernetesProvider defines configuration for the Kubernetes provider. -type KubernetesProvider struct { +// EnvoyGatewayKubernetesProvider defines configuration for the Kubernetes provider. +type EnvoyGatewayKubernetesProvider struct { // TODO: Add config as use cases are better understood. } -// FileProvider defines configuration for the File provider. -type FileProvider struct { +// EnvoyGatewayFileProvider defines configuration for the File provider. +type EnvoyGatewayFileProvider struct { // TODO: Add config as use cases are better understood. } ``` diff --git a/docs/latest/design/ratelimit.md b/docs/latest/design/rate-limit.md similarity index 100% rename from docs/latest/design/ratelimit.md rename to docs/latest/design/rate-limit.md diff --git a/docs/latest/design_docs.rst b/docs/latest/design_docs.rst index c9a1787ff15..6f3f6da161d 100644 --- a/docs/latest/design_docs.rst +++ b/docs/latest/design_docs.rst @@ -13,6 +13,6 @@ Learn about the internal details of Envoy Gateway. design/config-api design/tcp-udp-design design/egctl - design/ratelimit + design/rate-limit design/request-authentication design/bootstrap diff --git a/docs/latest/user/rate-limit.md b/docs/latest/user/rate-limit.md index 13fa2e14ff0..d7f470c9fb5 100644 --- a/docs/latest/user/rate-limit.md +++ b/docs/latest/user/rate-limit.md @@ -120,6 +120,61 @@ EOF kubectl rollout restart deployment envoy-gateway -n envoy-gateway-system ``` +### (Optional) Editing Kubernetes Resources settings for the Rate Limit Service + +* The default installation of Envoy Gateway installs a default [EnvoyGateway][] configuration and provides the initial rate +limit kubernetes resources settings. such as `replicas` is 1, requests resources cpu is `100m`, memory is `512Mi`. the others +like container `securityContext` and pod `annotations` and `securityContext` can be modified by modifying the `ConfigMap`. + +```shell +cat <