Update docs about enabling snippets

nginxinc · Mar 29, 2021 · 46eb301 · 46eb301
1 parent b4d604f
commit 46eb301
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 5 deletions.
diff --git a/cmd/nginx-ingress/main.go b/cmd/nginx-ingress/main.go
@@ -162,7 +162,7 @@ var (
 		"Enable preview policies")
 
 	enableSnippets = flag.Bool("enable-snippets", false,
-		"Enable custom NGINX configuration snippets in VirtualServer and VirtualServerRoute resources.")
+		"Enable custom NGINX configuration snippets in VirtualServer, VirtualServerRoute and TransportServer resources.")
 
 	globalConfiguration = flag.String("global-configuration", "",
 		`A GlobalConfiguration resource for global configuration of the Ingress Controller. Requires -enable-custom-resources. If the flag is set,

diff --git a/deployments/helm-chart/README.md b/deployments/helm-chart/README.md
@@ -174,7 +174,7 @@ Parameter | Description | Default
 `controller.enableTLSPassthrough` | Enable TLS Passthrough on port 443. Requires `controller.enableCustomResources`. | false
 `controller.globalConfiguration.create` | Creates the GlobalConfiguration custom resource. Requires `controller.enableCustomResources`. | false
 `controller.globalConfiguration.spec` | The spec of the GlobalConfiguration for defining the global configuration parameters of the Ingress Controller. | {}
-`controller.enableSnippets` | Enable custom NGINX configuration snippets in VirtualServer and VirtualServerRoute resources. | false
+`controller.enableSnippets` | Enable custom NGINX configuration snippets in VirtualServer, VirtualServerRoute and TransportServer resources. | false
 `controller.healthStatus` | Add a location "/nginx-health" to the default server. The location responds with the 200 status code for any request. Useful for external health-checking of the Ingress controller. | false
 `controller.healthStatusURI` | Sets the URI of health status location in the default server. Requires `controller.healthStatus`. | "/nginx-health"
 `controller.nginxStatus.enable` | Enable the NGINX stub_status, or the NGINX Plus API. | true

diff --git a/deployments/helm-chart/values.yaml b/deployments/helm-chart/values.yaml
@@ -168,7 +168,7 @@ controller:
       #   port: 5353
       #   protocol: TCP
 
-  ## Enable custom NGINX configuration snippets in VirtualServer and VirtualServerRoute resources.
+  ## Enable custom NGINX configuration snippets in VirtualServer, VirtualServerRoute and TransportServer resources.
   enableSnippets: false
 
   ## Add a location based on the value of health-status-uri to the default server. The location responds with the 200 status code for any request.

diff --git a/docs-web/configuration/global-configuration/command-line-arguments.md b/docs-web/configuration/global-configuration/command-line-arguments.md
@@ -8,7 +8,7 @@ Below we describe the available command-line arguments:
 ```eval_rst
 .. option:: -enable-snippets
 
-	Enable custom NGINX configuration snippets in VirtualServer and VirtualServerRoute resources. (default false)
+	Enable custom NGINX configuration snippets in VirtualServer, VirtualServerRoute and TransportServer resources. (default false)
 
 .. option:: -default-server-tls-secret <string>
 

diff --git a/docs-web/installation/installation-with-helm.md b/docs-web/installation/installation-with-helm.md
@@ -251,7 +251,7 @@ The following tables lists the configurable parameters of the NGINX Ingress cont
      - The spec of the GlobalConfiguration for defining the global configuration parameters of the Ingress Controller.
      - {}
    * - ``controller.enableSnippets``
-     - Enable custom NGINX configuration snippets in VirtualServer and VirtualServerRoute resources.
+     - Enable custom NGINX configuration snippets in VirtualServer, VirtualServerRoute and TransportServer resources.
      - false
    * - ``controller.healthStatus``
      - Add a location "/nginx-health" to the default server. The location responds with the 200 status code for any request. Useful for external health-checking of the Ingress controller.