-
Notifications
You must be signed in to change notification settings - Fork 386
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: clarify ExtensionTLS
type
#5154
base: main
Are you sure you want to change the base?
Conversation
Current document says to mount a secret that has a TLS private key. This is incorrect - Envoy Gateway acting as a client should not receive any private key. Envoy Gateway doesn't support mTLS when connecting to extension server, so there is no need for private key today. This is verified by reading the code. EG is only looking for `tls.crt` https://github.com/envoyproxy/gateway/blob/28e1a485fad395291dd633e3d472f130455de0e8/internal/extension/registry/extension_manager.go#L265-L276 Cert-manager docs explain this concept concisely, so link directly to it. Signed-off-by: Teju Nareddy <tejunareddy@gmail.com>
The implementation right now is a bit confusing. I propose that we adopt something similar to GW-API caCertificateRefs here to avoid the confusion. Regarding the change at hand: I would avoid linking cert-manager here, and keep it more concise, like:
|
Signed-off-by: Teju Nareddy <tejunareddy@gmail.com>
Thanks for the quick review @guydc ! Overall agree with what you said. Updated docs to match current state |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5154 +/- ##
=======================================
Coverage 66.89% 66.90%
=======================================
Files 210 210
Lines 32979 32979
=======================================
+ Hits 22061 22064 +3
+ Misses 9583 9580 -3
Partials 1335 1335 ☔ View full report in Codecov by Sentry. |
@nareddyt can you run |
Current document says to mount a secret that has a TLS private key. This is incorrect - Envoy Gateway acting as a client should not receive any private key.
Envoy Gateway doesn't support mTLS when connecting to extension server, so there is no need for private key today. This is verified by reading the code. EG is only looking for
tls.crt
gateway/internal/extension/registry/extension_manager.go
Lines 265 to 276 in 28e1a48
Cert-manager docs explain this concept concisely, so link directly to it.
Release Notes: No