Skip to content

Commit 2d6df63

Browse files
committed
Helm: Update README with new options
* Added documentation for report-ingress-status related values * Added documentation for leader-election
1 parent 931afc5 commit 2d6df63

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

helm-chart/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ The command removes all the Kubernetes components associated with the chart and
5353

5454
## Configuration
5555

56-
The following tables lists the configurable parameters of the NGINX Ingress controller chart and their default values.
56+
The following tables lists the configurable parameters of the NGINX Ingress controller chart and their default values.
5757

5858
Parameter | Description | Default
5959
--- | --- | ---
@@ -81,6 +81,9 @@ Parameter | Description | Default
8181
`controller.useIngressClassOnly` | Ignore Ingress resources without the `"kubernetes.io/ingress.class"` annotation. | false
8282
`controller.watchNamespace` | Namespace to watch for Ingress resources. By default the Ingress controller watches all namespaces. | ""
8383
`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
84+
`controller.reportIngressStatus.enable` | Update the address field in the status of Ingresses resources. Requires `controller.reportIngressStatus.externalService`, or `controller.config.entries.external-status-address` to be set. **Note:** `controller.reportIngressStatus.externalService` takes preference if both are set. | false
85+
`controller.reportIngressStatus.externalService` | Specifies the name of the service with the type LoadBalancer through which the Ingress controller pods are exposed externally. The external address of the service is used when reporting the status of Ingress resources. `controller.reportIngressStatus.enable` must be set to `true`. | nginx-ingress
86+
`controller.reportIngressStatus.enableLeaderElection`. | Enable Leader election to avoid multiple replicas of the controller reporting the status of Ingress resources. `controller.reportIngressStatus.enable` must be set to `true`. | true
8487
`rbac.create` | Configures RBAC. | true
8588
`prometheues.create` | Deploys a Prometheus exporter container within the Ingress controller pod. Requires NGINX Plus. `controller.nginxplus` must be set to `true`. | false
8689
`prometheus.port` | Configures the port to scrape the metrics. | 9113

0 commit comments

Comments
 (0)