Skip to content
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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 5 additions & 6 deletions api/v1alpha1/envoygateway_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -560,13 +560,12 @@
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 can only reference a Kubernetes Secret at this time.
// CertificateRef is a reference to a Kubernetes Secret with a CA certificate in a key named `tls.crt`.

Check failure on line 565 in api/v1alpha1/envoygateway_types.go

View workflow job for this annotation

GitHub Actions / lint

File is not properly formatted (gci)
//
// 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
Original file line number Diff line number Diff line change
Expand Up @@ -1681,14 +1681,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 /><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 /><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
4 changes: 2 additions & 2 deletions site/content/zh/latest/api/extension_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -1681,14 +1681,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 /><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 /><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
Loading