Skip to content
This repository was archived by the owner on May 24, 2023. It is now read-only.

Commit 56b4a7c

Browse files
committed
Update enableSnippets docs
1 parent 651d57a commit 56b4a7c

File tree

3 files changed

+5
-4
lines changed

3 files changed

+5
-4
lines changed

deploy/crds/k8s.nginx.org_nginxingresscontrollers_crd.yaml

+3-2
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,9 @@ spec:
7878
description: Enables preview policies. Requires enableCRDs set to true.
7979
type: boolean
8080
enableSnippets:
81-
description: Enable custom NGINX configuration snippets in VirtualServer
82-
and VirtualServerRoute resources. Requires enableCRDs set to true.
81+
description: Enable custom NGINX configuration snippets in VirtualServer,
82+
VirtualServerRoute and TransportServer resources. Requires enableCRDs
83+
set to true.
8384
type: boolean
8485
enableTLSPassthrough:
8586
description: Enable TLS Passthrough on port 443. Requires enableCRDs

docs/nginx-ingress-controller.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ spec:
8484
| `defaultSecret` | `string` | The TLS Secret for TLS termination of the default server. The format is namespace/name. The secret must be of the type kubernetes.io/tls. If not specified, the operator will generate and deploy a TLS Secret with a self-signed certificate and key. | No |
8585
| `serviceType` | `string` | The type of the Service for the Ingress Controller. Valid Service types are `NodePort` or `LoadBalancer`. | Yes |
8686
| `enableCRDs` | `boolean` | Enables the use of NGINX Ingress Resource Definitions (VirtualServer and VirtualServerRoute). Default is `true`. | No |
87-
| `enableSnippets` | `boolean` | Enable custom NGINX configuration snippets in VirtualServer and VirtualServerRoute resources. Requires `enableCRDs` set to `true`. | No |
87+
| `enableSnippets` | `boolean` | Enable custom NGINX configuration snippets in VirtualServer, VirtualServerRoute and TransportServer resources. Requires `enableCRDs` set to `true`. | No |
8888
| `enablePreviewPolicies` | `boolean` | Enables preview policies. Requires `enableCRDs` set to `true`. | No |
8989
| `ingressClass` | `string` | A class of the Ingress controller. For Kubernetes >= 1.18, the Ingress controller only processes resources that belong to its class - i.e. have the "ingressClassName" field resource equal to the class. Additionally the Ingress Controller processes all the VirtualServer/VirtualServerRoute resources that do not have the "ingressClassName" field. For Kubernetes < 1.18, the Ingress Controller only processes resources that belong to its class - i.e have the annotation "kubernetes.io/ingress.class" (for Ingress resources) or field "ingressClassName" (for VirtualServer/VirtualServerRoute resources) equal to the class. Additionally, the Ingress Controller processes resources that do not have the class set, which can be disabled by setting `useIngressClassOnly` to `true`. Default is `nginx`. | No |
9090
| `service` | [service](#nginxingresscontrollerservice) | The service of the Ingress Controller. | No |

pkg/apis/k8s/v1alpha1/nginxingresscontroller_types.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ type NginxIngressControllerSpec struct {
3838
// +nullable
3939
// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors=true
4040
EnableCRDs *bool `json:"enableCRDs"`
41-
// Enable custom NGINX configuration snippets in VirtualServer and VirtualServerRoute resources.
41+
// Enable custom NGINX configuration snippets in VirtualServer, VirtualServerRoute and TransportServer resources.
4242
// Requires enableCRDs set to true.
4343
// +kubebuilder:validation:Optional
4444
// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors=true

0 commit comments

Comments
 (0)