Skip to content

feat: adds helm docs for startup probe in NIC #805

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Parent: Update release notes for 5.2.1
merged 1 commit into from
Jul 14, 2025
Merged

feat: adds helm docs for startup probe in NIC #805

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions content/nic/installation/installing-nic/installation-with-helm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -432,6 +432,14 @@ The following tables lists the configurable parameters of the NGINX Ingress Cont
| **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 |
| **controller.readyStatus.port** | The HTTP port for the readiness endpoint. | 8081 |
| **controller.readyStatus.initialDelaySeconds** | The number of seconds after the Ingress Controller pod has started before readiness probes are initiated. | 0 |
| **controller.startupStatus.enable** | Enables the startup probe for the Ingress Controller. | false |
| **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 |
| **controller.startupStatus.path** | The path to the startup endpoint. This is a required field if `controller.startupStatus.enable` is set to true. | N/A |
| **controller.startupStatus.initialDelaySeconds** | The number of seconds after the Ingress Controller pod has started before startup probes are initiated. | N/A |
| **controller.startupStatus.periodSeconds** | The number of seconds between each startup probe. | N/A |
| **controller.startupStatus.timeoutSeconds** | The number of seconds after which the startup probe times out. | N/A |
| **controller.startupStatus.successThreshold** | Minimum consecutive successes for the probe to be considered successful. | N/A |
| **controller.startupStatus.failureThreshold** | When a probe fails, Kubernetes will try failureThreshold times before giving up. | N/A |
| **controller.enableLatencyMetrics** | Enable collection of latency metrics for upstreams. Requires `prometheus.create`. | false |
| **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 |
| **controller.autoscaling.enabled** | Enables HorizontalPodAutoscaling. | false |
Expand Down