Skip to content

Commit e3942f4

Browse files
authored
feat: adds helm docs for startup probe in NIC (#805)
1 parent d1bb519 commit e3942f4

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

content/nic/installation/installing-nic/installation-with-helm.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -432,6 +432,14 @@ The following tables lists the configurable parameters of the NGINX Ingress Cont
432432
| **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. | true |
433433
| **controller.readyStatus.port** | The HTTP port for the readiness endpoint. | 8081 |
434434
| **controller.readyStatus.initialDelaySeconds** | The number of seconds after the Ingress Controller pod has started before readiness probes are initiated. | 0 |
435+
| **controller.startupStatus.enable** | Enables the startup probe for the Ingress Controller. | false |
436+
| **controller.startupStatus.port** | The port where the startup endpoint is exposed. This is a required field if `controller.startupStatus.enable` is set to true. | N/A |
437+
| **controller.startupStatus.path** | The path to the startup endpoint. This is a required field if `controller.startupStatus.enable` is set to true. | N/A |
438+
| **controller.startupStatus.initialDelaySeconds** | The number of seconds after the Ingress Controller pod has started before startup probes are initiated. | N/A |
439+
| **controller.startupStatus.periodSeconds** | The number of seconds between each startup probe. | N/A |
440+
| **controller.startupStatus.timeoutSeconds** | The number of seconds after which the startup probe times out. | N/A |
441+
| **controller.startupStatus.successThreshold** | Minimum consecutive successes for the probe to be considered successful. | N/A |
442+
| **controller.startupStatus.failureThreshold** | When a probe fails, Kubernetes will try failureThreshold times before giving up. | N/A |
435443
| **controller.enableLatencyMetrics** | Enable collection of latency metrics for upstreams. Requires `prometheus.create`. | false |
436444
| **controller.minReadySeconds** | Specifies the minimum number of seconds for which a newly created Pod should be ready without any of its containers crashing, for it to be considered available. [docs](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#min-ready-seconds) | 0 |
437445
| **controller.autoscaling.enabled** | Enables HorizontalPodAutoscaling. | false |

0 commit comments

Comments
 (0)