add readiness probe for nginx on startup

Author: salonichf5

apis/v1alpha2/nginxproxy_types.go

@@ -386,6 +386,49 @@ type KubernetesSpec struct {
 	//
 	// +optional
 	Service *ServiceSpec `json:"service,omitempty"`
+
+	// ReadinessProbe is the configuration for the NGINX Readiness probe.
+	//
+	// +optional
+	ReadinessProbe *ReadinessProbeSpec `json:"readinessProbe,omitempty"`
+}
+
+// ReadinessProbeSpec defines the configuration for the NGINX readiness probe.
+type ReadinessProbeSpec struct {
+	// Port is the port on which the readiness endpoint is exposed.
+	// If not specified, the default port is 8081.
+	//
+	// +optional
+	// +kubebuilder:default:=8081
+	// +kubebuilder:validation:Minimum=1
+	// +kubebuilder:validation:Maximum=65535
+	Port *int32 `json:"port,omitempty"`
+
+	// InitialDelaySeconds is the number of seconds after the container has
+	// started before the readiness probe is initiated.
+	// If not specified, the default is 3 seconds.
+	// +optional
+	// +kubebuilder:default:=3
+	// +kubebuilder:validation:Minimum=0
+	// +kubebuilder:validation:Maximum=3600
+	InitialDelaySeconds *int32 `json:"initialDelaySeconds,omitempty"`
+
+	// PeriodSeconds is the number of seconds between consecutive readiness probes.
+	// If not specified, the default is 10 seconds.
+	// +optional
+	// +kubebuilder:default:=10
+	// +kubebuilder:validation:Minimum=1
+	// +kubebuilder:validation:Maximum=3600
+	PeriodSeconds *int32 `json:"periodSeconds,omitempty"`
+
+	// TimeoutSeconds is the number of seconds after which the readiness probe times out.
+	// If not specified, the default is 1 second.
+	//
+	// +optional
+	// +kubebuilder:default:=1
+	// +kubebuilder:validation:Minimum=1
+	// +kubebuilder:validation:Maximum=3600
+	TimeoutSeconds *int32 `json:"timeoutSeconds,omitempty"`
 }
 
 // Deployment is the configuration for the NGINX Deployment.

apis/v1alpha2/zz_generated.deepcopy.go

@@ -264,7 +264,7 @@ The following table lists the configurable parameters of the NGINX Gateway Fabri
 | `certGenerator.ttlSecondsAfterFinished` | How long to wait after the cert generator job has finished before it is removed by the job controller. | int | `30` |
 | `clusterDomain` | The DNS cluster domain of your Kubernetes cluster. | string | `"cluster.local"` |
 | `gateways` | A list of Gateway objects. View https://gateway-api.sigs.k8s.io/reference/spec/#gateway for full Gateway reference. | list | `[]` |
-| `nginx` | The nginx section contains the configuration for all NGINX data plane deployments installed by the NGINX Gateway Fabric control plane. | object | `{"config":{},"container":{"hostPorts":[],"lifecycle":{},"resources":{},"volumeMounts":[]},"debug":false,"image":{"pullPolicy":"Always","repository":"ghcr.io/nginx/nginx-gateway-fabric/nginx","tag":"edge"},"imagePullSecret":"","imagePullSecrets":[],"kind":"deployment","plus":false,"pod":{},"replicas":1,"service":{"externalTrafficPolicy":"Local","loadBalancerClass":"","loadBalancerIP":"","loadBalancerSourceRanges":[],"nodePorts":[],"type":"LoadBalancer"},"usage":{"caSecretName":"","clientSSLSecretName":"","endpoint":"","resolver":"","secretName":"nplus-license","skipVerify":false}}` |
+| `nginx` | The nginx section contains the configuration for all NGINX data plane deployments installed by the NGINX Gateway Fabric control plane. | object | `{"config":{},"container":{"hostPorts":[],"lifecycle":{},"resources":{},"volumeMounts":[]},"debug":false,"image":{"pullPolicy":"Always","repository":"ghcr.io/nginx/nginx-gateway-fabric/nginx","tag":"edge"},"imagePullSecret":"","imagePullSecrets":[],"kind":"deployment","plus":false,"pod":{},"readinessProbe":{},"replicas":1,"service":{"externalTrafficPolicy":"Local","loadBalancerClass":"","loadBalancerIP":"","loadBalancerSourceRanges":[],"nodePorts":[],"type":"LoadBalancer"},"usage":{"caSecretName":"","clientSSLSecretName":"","endpoint":"","resolver":"","secretName":"nplus-license","skipVerify":false}}` |
 | `nginx.config` | The configuration for the data plane that is contained in the NginxProxy resource. This is applied globally to all Gateways managed by this instance of NGINX Gateway Fabric. | object | `{}` |
 | `nginx.container` | The container configuration for the NGINX container. This is applied globally to all Gateways managed by this instance of NGINX Gateway Fabric. | object | `{"hostPorts":[],"lifecycle":{},"resources":{},"volumeMounts":[]}` |
 | `nginx.container.hostPorts` | A list of HostPorts to expose on the host. This configuration allows containers to bind to a specific port on the host node, enabling external network traffic to reach the container directly through the host's IP address and port. Use this option when you need to expose container ports on the host for direct access, such as for debugging, legacy integrations, or when NodePort/LoadBalancer services are not suitable. Note: Using hostPort may have security and scheduling implications, as it ties pods to specific nodes and ports. | list | `[]` |

charts/nginx-gateway-fabric/README.md

@@ -58,3 +58,8 @@ spec:
       {{- end }}
       {{- end }}
     {{- end }}
+    readinessProbe:
+      port: {{ .Values.nginx.readinessProbe.port | default 8081 }}
+      initialDelaySeconds: {{ .Values.nginx.readinessProbe.initialDelaySeconds | default 3 }}
+      periodSeconds: {{ .Values.nginx.readinessProbe.periodSeconds | default 10 }}
+      timeoutSeconds: {{ .Values.nginx.readinessProbe.timeoutSeconds | default 1 }}

charts/nginx-gateway-fabric/templates/nginxproxy.yaml

@@ -447,6 +447,12 @@
           "title": "pod",
           "type": "object"
         },
+        "readinessProbe": {
+          "description": "# Defines the settings for the data plane readiness probe. This probe returns Ready when the NGINX data plane is ready to serve traffic.",
+          "required": [],
+          "title": "readinessProbe",
+          "type": "object"
+        },
         "replicas": {
           "default": 1,
           "description": "The number of replicas of the NGINX Deployment.",

charts/nginx-gateway-fabric/values.schema.json

@@ -493,6 +493,40 @@ nginx:
     # - port: 30025
     #   listenerPort: 80
 
+  ## Defines the settings for the data plane readiness probe. This probe returns Ready when the NGINX data plane is ready to serve traffic.
+  readinessProbe: {}
+    # @schema
+    # type: integer
+    # minimum: 1
+    # maximum: 65535
+    # @schema
+    # -- Port in which the readiness endpoint is exposed.
+    # port: 8081
+
+    # @schema
+    # type: integer
+    # minimum: 0
+    # maximum: 3600
+    # @schema
+    # -- The number of seconds after the Pod has started before the readiness probes are initiated.
+    # initialDelaySeconds: 3
+
+    # @schema
+    # type: integer
+    # minimum: 1
+    # maximum: 3600
+    # @schema
+    # -- The number of seconds between consecutive readiness probes.
+    # periodSeconds: 10
+
+    # @schema
+    # type: integer
+    # minimum: 1
+    # maximum: 3600
+    # @schema
+    # -- The number of seconds after which the readiness probe times out.
+    # timeoutSeconds: 1
+
   # -- Enable debugging for NGINX. Uses the nginx-debug binary. The NGINX error log level should be set to debug in the NginxProxy resource.
   debug: false
 

charts/nginx-gateway-fabric/values.yaml

@@ -6894,6 +6894,48 @@ spec:
                         format: int32
                         type: integer
                     type: object
+                  readinessProbe:
+                    description: ReadinessProbe is the configuration for the NGINX
+                      Readiness probe.
+                    properties:
+                      initialDelaySeconds:
+                        default: 3
+                        description: |-
+                          InitialDelaySeconds is the number of seconds after the container has
+                          started before the readiness probe is initiated.
+                          If not specified, the default is 3 seconds.
+                        format: int32
+                        maximum: 3600
+                        minimum: 0
+                        type: integer
+                      periodSeconds:
+                        default: 10
+                        description: |-
+                          PeriodSeconds is the number of seconds between consecutive readiness probes.
+                          If not specified, the default is 10 seconds.
+                        format: int32
+                        maximum: 3600
+                        minimum: 1
+                        type: integer
+                      port:
+                        default: 8081
+                        description: |-
+                          Port is the port on which the readiness endpoint is exposed.
+                          If not specified, the default port is 8081.
+                        format: int32
+                        maximum: 65535
+                        minimum: 1
+                        type: integer
+                      timeoutSeconds:
+                        default: 1
+                        description: |-
+                          TimeoutSeconds is the number of seconds after which the readiness probe times out.
+                          If not specified, the default is 1 second.
+                        format: int32
+                        maximum: 3600
+                        minimum: 1
+                        type: integer
+                    type: object
                   service:
                     description: Service is the configuration for the NGINX Service.
                     properties:

config/crd/bases/gateway.nginx.org_nginxproxies.yaml

@@ -421,6 +421,11 @@ spec:
         nodeSelector:
           kubernetes.io/os: linux
       replicas: 1
+    readinessProbe:
+      initialDelaySeconds: 3
+      periodSeconds: 10
+      port: 8081
+      timeoutSeconds: 1
     service:
       externalTrafficPolicy: Local
       type: LoadBalancer

deploy/azure/deploy.yaml

@@ -7479,6 +7479,48 @@ spec:
                         format: int32
                         type: integer
                     type: object
+                  readinessProbe:
+                    description: ReadinessProbe is the configuration for the NGINX
+                      Readiness probe.
+                    properties:
+                      initialDelaySeconds:
+                        default: 3
+                        description: |-
+                          InitialDelaySeconds is the number of seconds after the container has
+                          started before the readiness probe is initiated.
+                          If not specified, the default is 3 seconds.
+                        format: int32
+                        maximum: 3600
+                        minimum: 0
+                        type: integer
+                      periodSeconds:
+                        default: 10
+                        description: |-
+                          PeriodSeconds is the number of seconds between consecutive readiness probes.
+                          If not specified, the default is 10 seconds.
+                        format: int32
+                        maximum: 3600
+                        minimum: 1
+                        type: integer
+                      port:
+                        default: 8081
+                        description: |-
+                          Port is the port on which the readiness endpoint is exposed.
+                          If not specified, the default port is 8081.
+                        format: int32
+                        maximum: 65535
+                        minimum: 1
+                        type: integer
+                      timeoutSeconds:
+                        default: 1
+                        description: |-
+                          TimeoutSeconds is the number of seconds after which the readiness probe times out.
+                          If not specified, the default is 1 second.
+                        format: int32
+                        maximum: 3600
+                        minimum: 1
+                        type: integer
+                    type: object
                   service:
                     description: Service is the configuration for the NGINX Service.
                     properties:

deploy/crds.yaml

@@ -416,6 +416,11 @@ spec:
           repository: ghcr.io/nginx/nginx-gateway-fabric/nginx
           tag: edge
       replicas: 1
+    readinessProbe:
+      initialDelaySeconds: 3
+      periodSeconds: 10
+      port: 8081
+      timeoutSeconds: 1
     service:
       externalTrafficPolicy: Local
       type: LoadBalancer