Skip to content

docs: Conceptual Docs for Api Gateways, The Gateway Api & Envoy Proxy [Clean]#5939

Closed
melsal13 wants to merge 28 commits intoenvoyproxy:mainfrom
melsal13:docs-clean
Closed

docs: Conceptual Docs for Api Gateways, The Gateway Api & Envoy Proxy [Clean]#5939
melsal13 wants to merge 28 commits intoenvoyproxy:mainfrom
melsal13:docs-clean

Conversation

@melsal13
Copy link
Contributor

@melsal13 melsal13 commented May 7, 2025

What type of PR is this?
What type of PR is this?
Adds conceptual documentation for:

  • API Gateway
  • The Gateway API
  • Envoy Proxy

What this PR does / why we need it:
Introduces foundational conceptual docs to help onboard new users and improve documentation clarity.

Which issue(s) this PR fixes:
Fixes #5738
Fixes #5753
Fixes #5754

Release Notes: No

melsal13 added 3 commits May 6, 2025 16:50
Signed-off-by: melsal13 <mmvsal13@gmail.com>
Signed-off-by: melsal13 <mmvsal13@gmail.com>
@codecov
Copy link

codecov bot commented May 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 65.81%. Comparing base (0752df1) to head (77143dc).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5939      +/-   ##
==========================================
- Coverage   65.82%   65.81%   -0.01%     
==========================================
  Files         217      217              
  Lines       36063    36063              
==========================================
- Hits        23738    23736       -2     
- Misses      10845    10848       +3     
+ Partials     1480     1479       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

melsal13 and others added 25 commits May 9, 2025 12:10
Signed-off-by: melsal13 <mmvsal13@gmail.com>
Signed-off-by: melsal13 <mmvsal13@gmail.com>
Signed-off-by: melsal13 <mmvsal13@gmail.com>
clean up BTP status

Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>
Signed-off-by: melsal13 <mmvsal13@gmail.com>
e2e test for dynamic resolver backend using system ca for TLS

Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>
Signed-off-by: melsal13 <mmvsal13@gmail.com>
Signed-off-by: melsal13 <mmvsal13@gmail.com>
* fix: SecurityPolicy reference grant

Signed-off-by: kkk777-7 <kota.kimura0725@gmail.com>

* add: release note

Signed-off-by: kkk777-7 <kota.kimura0725@gmail.com>

* update: func name

Signed-off-by: kkk777-7 <kota.kimura0725@gmail.com>

* revert func name

Signed-off-by: kkk777-7 <kota.kimura0725@gmail.com>

* update: use processBackendRef to handle route backends

Signed-off-by: kkk777-7 <kota.kimura0725@gmail.com>

* fix: use not pointer type for extAuth backendRef

Signed-off-by: kkk777-7 <kota.kimura0725@gmail.com>

* Add: testcase for ExtAuth

Signed-off-by: kkk777-7 <kota.kimura0725@gmail.com>

* fix: add jwt backendref to backendSecurityPolicyIndexFunc

Signed-off-by: kkk777-7 <kota.kimura0725@gmail.com>

---------

Signed-off-by: kkk777-7 <kota.kimura0725@gmail.com>
Signed-off-by: melsal13 <mmvsal13@gmail.com>
Signed-off-by: Gavin Lam <gavin.oss@tutamail.com>
Signed-off-by: melsal13 <mmvsal13@gmail.com>
Signed-off-by: Mathias Westby Skoglund <mail@mathiaswskoglund.com>
Co-authored-by: Mathias Westby Skoglund <mail@mathiaswskoglund.com>
Signed-off-by: melsal13 <mmvsal13@gmail.com>
disable DynamicResolverBackendTest in IPV6

Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>
Signed-off-by: melsal13 <mmvsal13@gmail.com>
…(#5954)

* fix: proxy creation/deletion error handling in GatewayNamespace mode

Signed-off-by: zirain <zirain2009@gmail.com>

* nit

Signed-off-by: zirain <zirain2009@gmail.com>

* nit

Signed-off-by: zirain <zirain2009@gmail.com>

* more nit

Signed-off-by: zirain <zirain2009@gmail.com>

---------

Signed-off-by: zirain <zirain2009@gmail.com>
Signed-off-by: melsal13 <mmvsal13@gmail.com>
* ci: kube-deploy support helm values configuration file

Signed-off-by: zirain <zirain2009@gmail.com>

* move to test/cofnig

Signed-off-by: zirain <zirain2009@gmail.com>

* fix

Signed-off-by: zirain <zirain2009@gmail.com>

---------

Signed-off-by: zirain <zirain2009@gmail.com>
Signed-off-by: melsal13 <mmvsal13@gmail.com>
fix: process all gatewayClasses after encountering an err

* instead of returning from Reconcile after encountering an err
which processing a `GatewayClass`, `continue` instead
to process all GatewayClasses

Fixes: envoyproxy/gateway#5618

Signed-off-by: Arko Dasgupta <arko@tetrate.io>
Signed-off-by: melsal13 <mmvsal13@gmail.com>
* fix: enable http3 but panic

Signed-off-by: bitliu <bitliu@tencent.com>
Signed-off-by: melsal13 <mmvsal13@gmail.com>
* Add seed corpus related to traffic task.

Signed-off-by: sudipto baral <sudiptobaral.me@gmail.com>
Signed-off-by: melsal13 <mmvsal13@gmail.com>
release v1.3.3 notes

Signed-off-by: Guy Daich <guy.daich@sap.com>
Signed-off-by: melsal13 <mmvsal13@gmail.com>
* e2e: fix PreserveCase flaky

Signed-off-by: zirain <zirain2009@gmail.com>

* fix

Signed-off-by: zirain <zirain2009@gmail.com>

---------

Signed-off-by: zirain <zirain2009@gmail.com>
Signed-off-by: melsal13 <mmvsal13@gmail.com>
* Add proxyMetadata to xds config and validate JWT

Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com>

* Add controller namespace to infra

Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com>

* Add Metadata envoy bootstrap struct

Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com>

* Add release note

Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com>

* fix lint

Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com>

* fix doc

Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com>

* use projected service account tokens with eg audience

Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com>

* lint code

Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com>

* make gen

Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com>

* make gen

Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com>

* Revert "Add controller namespace to infra"

This reverts commit b2fa2caf58982432e5d5b31bd7d95a5ad523ed5e.

Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com>

* fetch the node id and initial metadata from first msg

Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com>

* update codegen

Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com>

* verify service account

Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>

* validate only sa

Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com>

* add local hash name func

Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com>

* Verify pod name for authz

This reverts commit b0748a0.

Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>

* lint code

Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com>

---------

Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com>
Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>
Co-authored-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>
Signed-off-by: melsal13 <mmvsal13@gmail.com>
* Add controller namespace to infra

Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com>

* make gen

Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com>

* rebase code and add controller namespace helper

Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com>

* rename to envoy namespace

Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com>

* rename to ControllerNamespace

Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com>

---------

Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com>
Signed-off-by: melsal13 <mmvsal13@gmail.com>
* enable gateway-namespace-mode e2e

Signed-off-by: zirain <zirain2009@gmail.com>

* fix ProxyMetrics

Signed-off-by: zirain <zirain2009@gmail.com>

* fix and skip some tests

Signed-off-by: zirain <zirain2009@gmail.com>

* enable MetricCompressorTest

Signed-off-by: zirain <zirain2009@gmail.com>

* fix upgrade test

Signed-off-by: zirain <zirain2009@gmail.com>
Signed-off-by: melsal13 <mmvsal13@gmail.com>
* support standard channel

Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>

* add comment

Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>

---------

Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>
Signed-off-by: melsal13 <mmvsal13@gmail.com>
e2e: bump upgrade test version

Signed-off-by: zirain <zirain2009@gmail.com>
Signed-off-by: melsal13 <mmvsal13@gmail.com>
* reject duplicated API keys
* enhance api-key-auth e2e test to cover duplicated client IDs

Signed-off-by: Gavin Lam <gavin.oss@tutamail.com>
Signed-off-by: melsal13 <mmvsal13@gmail.com>
@melsal13
Copy link
Contributor Author

melsal13 commented May 9, 2025

Closing this pr and replacing with the following:
#5981

@melsal13 melsal13 closed this May 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Conceptual doc for Envoy Proxy docs: Conceptual doc for The Gateway API docs: Conceptual doc for API Gateways