Apply suggestions from code review

Co-authored-by: Michael Pleshakov <pleshakov@users.noreply.github.com>
nginxinc · Jul 8, 2020 · 2b68d04 · 2b68d04
1 parent 8dfc4dd
commit 2b68d04
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/cmd/nginx-ingress/main.go b/cmd/nginx-ingress/main.go
@@ -155,7 +155,7 @@ var (
 		`Specifies the address of the running Spire agent. For use with NGINX Service Mesh only. If the flag is set,
 			but the Ingress Controller is not able to connect with the Spire Agent, the Ingress Controller will fail to start.`)
 
-	readyStatus = flag.Bool("ready-status", false, "Enables readiness endpoint '/nginx-ready'. The endpoint returns a success code when NGINX has loaded all the config after startup")
+	readyStatus = flag.Bool("ready-status", false, "Enables the readiness endpoint '/nginx-ready'. The endpoint returns a success code when NGINX has loaded all the config after the startup")
 
 	readyStatusPort = flag.Int("ready-status-port", 8081, "Set the port where the readiness endpoint is exposed. [1024 - 65535]")
 )

diff --git a/deployments/helm-chart/README.md b/deployments/helm-chart/README.md
@@ -255,8 +255,8 @@ Parameter | Description | Default
 `controller.reportIngressStatus.annotations` | The annotations of the leader election configmap. | {}
 `controller.pod.annotations` | The annotations of the Ingress Controller pod. | {}
 `controller.appprotect.enable` | Enables the App Protect module in the Ingress Controller. | false
-`controller.readyStatus.enable` | Enables readiness endpoint `"/nginx-ready"`. The endpoint returns a success code when NGINX has loaded all the config after startup. | false
- `controller.readyStaus.port` | The HTTP port for the readiness endpoint | 8081
+`controller.readyStatus.enable` | Enables the readiness endpoint `"/nginx-ready"`. The endpoint returns a success code when NGINX has loaded all the config after the startup. This also configures a readiness probe for the Ingress Controller pods that uses the readiness endpoint. | false
+ `controller.readyStaus.port` | The HTTP port for the readiness endpoint. | 8081
 `rbac.create` | Configures RBAC. | true
 `prometheus.create` | Expose NGINX or NGINX Plus metrics in the Prometheus format. | false
 `prometheus.port` | Configures the port to scrape the metrics. | 9113