-
Notifications
You must be signed in to change notification settings - Fork 319
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: create concepts docs page and diagram (#3808)
* Adding concept page with visual to docs site Signed-off-by: Erica Hughberg <erica.sundberg.90@gmail.com> * Fix EnvoyGatewayPatchPolicy to EnvoyPatchPolicy Signed-off-by: Erica Hughberg <erica.sundberg.90@gmail.com> * Fix ordering of columns and adding links. Signed-off-by: Erica Hughberg <erica.sundberg.90@gmail.com> * Adding to v1.0.2 as well Signed-off-by: Erica Hughberg <erica.sundberg.90@gmail.com> * Fixing links Signed-off-by: Erica Hughberg <erica.sundberg.90@gmail.com> * Added Backend resource to concept overview Signed-off-by: Erica Hughberg <erica.sundberg.90@gmail.com> * Tidy up and update docs for 1.0.2 Signed-off-by: Erica Hughberg <erica.sundberg.90@gmail.com> * Update arrow from Route to route targets Signed-off-by: Erica Hughberg <erica.sundberg.90@gmail.com> * fix: wrong path & title and add diagram Signed-off-by: bitliu <bitliu@tencent.com> --------- Signed-off-by: Erica Hughberg <erica.sundberg.90@gmail.com> Signed-off-by: bitliu <bitliu@tencent.com> Co-authored-by: Xunzhuo <bitliu@tencent.com>
- Loading branch information
Showing
3 changed files
with
59 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| title: "Concepts" | ||
| weight: 1 | ||
| description: Learn about key concepts when working with Envoy Gateway | ||
| --- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| +++ | ||
| title = "Envoy Gateway Resources" | ||
| +++ | ||
|
|
||
| There are several resources that play a part in enabling you to meet your Kubernetes ingress traffic handling needs. This page provides a brief overview of the resources you’ll be working with. | ||
|
|
||
| ## Overview | ||
|
|
||
|  | ||
|
|
||
| There are several resources that play a part in enabling you to meet your Kubernetes ingress traffic handling needs. This page provides a brief overview of the resources you’ll be working with. | ||
|
|
||
| # Overview | ||
|
|
||
| ## Kubernetes Gateway API Resources | ||
| - **GatewayClass:** Defines a class of Gateways with common configuration. | ||
| - **Gateway:** Specifies how traffic can enter the cluster. | ||
| - **Routes:** **HTTPRoute, GRPCRoute, TLSRoute, TCPRoute, UDPRoute:** Define routing rules for different types of traffic. | ||
| ## Envoy Gateway (EG) API Resources | ||
| - **EnvoyProxy:** Represents the deployment and configuration of the Envoy proxy within a Kubernetes cluster, managing its lifecycle and settings. | ||
| - **EnvoyPatchPolicy, ClientTrafficPolicy, SecurityPolicy, BackendTrafficPolicy, EnvoyExtensionPolicy, BackendTLSPolicy:** Additional policies and configurations specific to Envoy Gateway. | ||
| - **Backend:** A resource that makes routing to cluster-external backends easier and makes access to external processes via Unix Domain Sockets possible. | ||
|
|
||
| | Resource | API | Required | Purpose | References | Description | | ||
| | ----------------------------------------------------------------------- | ----------- | -------- | ------------------ | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | [GatewayClass][1] | Gateway API | Yes | Gateway Config | Core | Defines a class of Gateways with common configuration. | | ||
| | [Gateway][2] | Gateway API | Yes | Gateway Config | GatewayClass | Specifies how traffic can enter the cluster. | | ||
| | [HTTPRoute][3] [GRPCRoute][4] [TLSRoute][5] [TCPRoute][6] [UDPRoute][7] | Gateway API | Yes | Routing | Gateway | Define routing rules for different types of traffic. **Note:**_For simplicity these resources are referenced collectively as Route in the References column_ | | ||
| | [Backend][8] | EG API | No | Routing | N/A | Used for routing to cluster-external backends using FQDN or IP. Can also be used when you want to extend Envoy with external processes accessed via Unix Domain Sockets. | | ||
| | [ClientTrafficPolicy][9] | EG API | No | Traffic Handling | Gateway | Specifies policies for handling client traffic, including rate limiting, retries, and other client-specific configurations. | | ||
| | [BackendTrafficPolicy][10] | EG API | No | Traffic Handling | Gateway Route | Specifies policies for traffic directed towards backend services, including load balancing, health checks, and failover strategies. **Note:**_Most specific configuration wins_ | | ||
| | [SecurityPolicy][11] | EG API | No | Security | Gateway Route | Defines security-related policies such as authentication, authorization, and encryption settings for traffic handled by Envoy Gateway. **Note:**_Most specific configuration wins_ | | ||
| | [BackendTLSPolicy][12] | Gateway API | No | Security | Service | Defines TLS settings for backend connections, including certificate management, TLS version settings, and other security configurations. This policy is applied to Kubernetes Services. | | ||
| | [EnvoyProxy][13] | EG API | No | Customize & Extend | GatewayClass Gateway | The EnvoyProxy resource represents the deployment and configuration of the Envoy proxy itself within a Kubernetes cluster, managing its lifecycle and settings. **Note:**_Most specific configuration wins_ | | ||
| | [EnvoyPatchPolicy][14] | EG API | No | Customize & Extend | GatewayClass Gateway | This policy defines custom patches to be applied to Envoy Gateway resources, allowing users to tailor the configuration to their specific needs. **Note:**_Most specific configuration wins_ | | ||
| | [EnvoyExtensionPolicy][15] | EG API | No | Customize & Extend | Gateway Route, Backend | Allows for the configuration of Envoy proxy extensions, enabling custom behavior and functionality. **Note:**_Most specific configuration wins_ | | ||
|
|
||
|
|
||
|
|
||
| [1]: https://gateway-api.sigs.k8s.io/api-types/gatewayclass/ | ||
| [2]: https://gateway-api.sigs.k8s.io/api-types/gateway/ | ||
| [3]: https://gateway-api.sigs.k8s.io/api-types/httproute/ | ||
| [4]: https://gateway-api.sigs.k8s.io/api-types/grpcroute/ | ||
| [5]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1alpha2.TLSRoute | ||
| [6]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1alpha2.TCPRoute | ||
| [7]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1alpha2.UDPRoute | ||
| [8]: ../tasks/traffic/backend | ||
| [9]: ../api/extension_types#clienttrafficpolicy | ||
| [10]: ../api/extension_types#backendtrafficpolicy | ||
| [11]: ../api/extension_types#securitypolicy | ||
| [12]: https://gateway-api.sigs.k8s.io/api-types/backendtlspolicy/ | ||
| [13]: ../api/extension_types#envoyproxy | ||
| [14]: ../api/extension_types#envoypatchpolicy | ||
| [15]: ../api/extension_types#envoyextensionpolicy |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.