Skip to content

Commit 46eb301

Browse files
committed
Update docs about enabling snippets
1 parent b4d604f commit 46eb301

File tree

5 files changed

+5
-5
lines changed

5 files changed

+5
-5
lines changed

cmd/nginx-ingress/main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ var (
162162
"Enable preview policies")
163163

164164
enableSnippets = flag.Bool("enable-snippets", false,
165-
"Enable custom NGINX configuration snippets in VirtualServer and VirtualServerRoute resources.")
165+
"Enable custom NGINX configuration snippets in VirtualServer, VirtualServerRoute and TransportServer resources.")
166166

167167
globalConfiguration = flag.String("global-configuration", "",
168168
`A GlobalConfiguration resource for global configuration of the Ingress Controller. Requires -enable-custom-resources. If the flag is set,

deployments/helm-chart/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ Parameter | Description | Default
174174
`controller.enableTLSPassthrough` | Enable TLS Passthrough on port 443. Requires `controller.enableCustomResources`. | false
175175
`controller.globalConfiguration.create` | Creates the GlobalConfiguration custom resource. Requires `controller.enableCustomResources`. | false
176176
`controller.globalConfiguration.spec` | The spec of the GlobalConfiguration for defining the global configuration parameters of the Ingress Controller. | {}
177-
`controller.enableSnippets` | Enable custom NGINX configuration snippets in VirtualServer and VirtualServerRoute resources. | false
177+
`controller.enableSnippets` | Enable custom NGINX configuration snippets in VirtualServer, VirtualServerRoute and TransportServer resources. | false
178178
`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
179179
`controller.healthStatusURI` | Sets the URI of health status location in the default server. Requires `controller.healthStatus`. | "/nginx-health"
180180
`controller.nginxStatus.enable` | Enable the NGINX stub_status, or the NGINX Plus API. | true

deployments/helm-chart/values.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ controller:
168168
# port: 5353
169169
# protocol: TCP
170170

171-
## Enable custom NGINX configuration snippets in VirtualServer and VirtualServerRoute resources.
171+
## Enable custom NGINX configuration snippets in VirtualServer, VirtualServerRoute and TransportServer resources.
172172
enableSnippets: false
173173

174174
## 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.

docs-web/configuration/global-configuration/command-line-arguments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Below we describe the available command-line arguments:
88
```eval_rst
99
.. option:: -enable-snippets
1010
11-
Enable custom NGINX configuration snippets in VirtualServer and VirtualServerRoute resources. (default false)
11+
Enable custom NGINX configuration snippets in VirtualServer, VirtualServerRoute and TransportServer resources. (default false)
1212
1313
.. option:: -default-server-tls-secret <string>
1414

docs-web/installation/installation-with-helm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ The following tables lists the configurable parameters of the NGINX Ingress cont
251251
- The spec of the GlobalConfiguration for defining the global configuration parameters of the Ingress Controller.
252252
- {}
253253
* - ``controller.enableSnippets``
254-
- Enable custom NGINX configuration snippets in VirtualServer and VirtualServerRoute resources.
254+
- Enable custom NGINX configuration snippets in VirtualServer, VirtualServerRoute and TransportServer resources.
255255
- false
256256
* - ``controller.healthStatus``
257257
- 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.

0 commit comments

Comments
 (0)