From 46eb3013c635e7267843e8a227ffb9fb45915558 Mon Sep 17 00:00:00 2001 From: Michael Pleshakov Date: Fri, 26 Mar 2021 16:47:59 -0700 Subject: [PATCH] Update docs about enabling snippets --- cmd/nginx-ingress/main.go | 2 +- deployments/helm-chart/README.md | 2 +- deployments/helm-chart/values.yaml | 2 +- .../global-configuration/command-line-arguments.md | 2 +- docs-web/installation/installation-with-helm.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/cmd/nginx-ingress/main.go b/cmd/nginx-ingress/main.go index bc2f287d9c..f57f624904 100644 --- 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 index 0c9300930a..d87cbc4897 100644 --- 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 index 9ac0c15660..bbcbcde5a6 100644 --- 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 index fe752db55e..35d0998f59 100644 --- 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 diff --git a/docs-web/installation/installation-with-helm.md b/docs-web/installation/installation-with-helm.md index 46e2fae28e..c626bc2d33 100644 --- 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.