Skip to content

docs: clarify ExtensionTLS type #5154

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.

Sign up for GitHub

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

Merged
arkodg merged 2 commits into from
Mar 11, 2025
Merged

docs: clarify ExtensionTLS type #5154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
225048a
docs: clarify `ExtensionTLS` type
nareddyt Mar 10, 2025
9dbb757
Merge branch 'main' into patch-1
zirain Mar 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions api/v1alpha1/envoygateway_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -560,13 +560,12 @@ type ExtensionService struct {
TLS *ExtensionTLS `json:"tls,omitempty"`
}

// ExtensionTLS defines the TLS configuration when connecting to an extension service
// ExtensionTLS defines the TLS configuration when connecting to an extension service.
type ExtensionTLS struct {
// 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 is a reference to a Kubernetes Secret with a CA certificate in a key named "tls.crt".
//
// CertificateRef can only reference a Kubernetes Secret at this time.
// The CA certificate is used by Envoy Gateway the verify the server certificate presented by the extension server.
// At this time, Envoy Gateway does not support Client Certificate authentication of Envoy Gateway towards the extension server (mTLS).
//
// +kubebuilder:validation:Required
CertificateRef gwapiv1.SecretObjectReference `json:"certificateRef"`
Expand Down
4 changes: 2 additions & 2 deletions site/content/en/latest/api/extension_types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1721,14 +1721,14 @@ _Appears in:_



ExtensionTLS defines the TLS configuration when connecting to an extension service
ExtensionTLS defines the TLS configuration when connecting to an extension service.

_Appears in:_
- [ExtensionService](#extensionservice)

| Field | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `certificateRef` | _[SecretObjectReference](https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1.SecretObjectReference)_ | true | | CertificateRef contains a references to objects (Kubernetes objects or otherwise) that<br />contains a TLS certificate and private keys. These certificates are used to<br />establish a TLS handshake to the extension server.<br />CertificateRef can only reference a Kubernetes Secret at this time. |
| `certificateRef` | _[SecretObjectReference](https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1.SecretObjectReference)_ | true | | CertificateRef is a reference to a Kubernetes Secret with a CA certificate in a key named "tls.crt".<br />The CA certificate is used by Envoy Gateway the verify the server certificate presented by the extension server.<br />At this time, Envoy Gateway does not support Client Certificate authentication of Envoy Gateway towards the extension server (mTLS). |


#### ExtractFrom
Expand Down