Update enableSnippets docs

nginxinc · Mar 26, 2021 · 56b4a7c · 56b4a7c
1 parent 651d57a
commit 56b4a7c
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/deploy/crds/k8s.nginx.org_nginxingresscontrollers_crd.yaml b/deploy/crds/k8s.nginx.org_nginxingresscontrollers_crd.yaml
@@ -78,8 +78,9 @@ spec:
               description: Enables preview policies. Requires enableCRDs set to true.
               type: boolean
             enableSnippets:
-              description: Enable custom NGINX configuration snippets in VirtualServer
-                and VirtualServerRoute resources. Requires enableCRDs set to true.
+              description: Enable custom NGINX configuration snippets in VirtualServer,
+                VirtualServerRoute and TransportServer resources. Requires enableCRDs
+                set to true.
               type: boolean
             enableTLSPassthrough:
               description: Enable TLS Passthrough on port 443. Requires enableCRDs

diff --git a/docs/nginx-ingress-controller.md b/docs/nginx-ingress-controller.md
@@ -84,7 +84,7 @@ spec:
 | `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 |
 | `serviceType` | `string` | The type of the Service for the Ingress Controller. Valid Service types are `NodePort` or `LoadBalancer`. | Yes |
 | `enableCRDs` | `boolean` | Enables the use of NGINX Ingress Resource Definitions (VirtualServer and VirtualServerRoute). Default is `true`. | No |
-| `enableSnippets` | `boolean` | Enable custom NGINX configuration snippets in VirtualServer and VirtualServerRoute resources. Requires `enableCRDs` set to `true`. | No |
+| `enableSnippets` | `boolean` | Enable custom NGINX configuration snippets in VirtualServer, VirtualServerRoute and TransportServer resources. Requires `enableCRDs` set to `true`. | No |
 | `enablePreviewPolicies` | `boolean` | Enables preview policies. Requires `enableCRDs` set to `true`. | No |
 | `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 |
 | `service` | [service](#nginxingresscontrollerservice) | The service of the Ingress Controller. | No |

diff --git a/pkg/apis/k8s/v1alpha1/nginxingresscontroller_types.go b/pkg/apis/k8s/v1alpha1/nginxingresscontroller_types.go
@@ -38,7 +38,7 @@ type NginxIngressControllerSpec struct {
 	// +nullable
 	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors=true
 	EnableCRDs *bool `json:"enableCRDs"`
-	// Enable custom NGINX configuration snippets in VirtualServer and VirtualServerRoute resources.
+	// Enable custom NGINX configuration snippets in VirtualServer, VirtualServerRoute and TransportServer resources.
 	// Requires enableCRDs set to true.
 	// +kubebuilder:validation:Optional
 	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors=true