feat: allow customization on readyz and livez config (numaproj#2068)

Signed-off-by: Derek Wang <[email protected]>
SaniyaKalamkar · Jan 19, 2025 · 6ffc13b · 6ffc13b
1 parent f196841
commit 6ffc13b
Show file tree

Hide file tree

Showing 40 changed files with 6,463 additions and 597 deletions.
diff --git a/api/json-schema/schema.json b/api/json-schema/schema.json
@@ -17939,6 +17939,12 @@
         "imagePullPolicy": {
           "type": "string"
         },
+        "livenessProbe": {
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.Probe"
+        },
+        "readinessProbe": {
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.Probe"
+        },
         "resources": {
           "$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements"
         },
@@ -17972,6 +17978,12 @@
         "imagePullPolicy": {
           "type": "string"
         },
+        "livenessProbe": {
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.Probe"
+        },
+        "readinessProbe": {
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.Probe"
+        },
         "resources": {
           "$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements"
         },
@@ -19739,6 +19751,37 @@
       },
       "type": "object"
     },
+    "io.numaproj.numaflow.v1alpha1.Probe": {
+      "description": "Probe is used to customize the configuration for Readiness and Liveness probes.",
+      "properties": {
+        "failureThreshold": {
+          "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
+          "format": "int32",
+          "type": "integer"
+        },
+        "initialDelaySeconds": {
+          "description": "Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
+          "format": "int32",
+          "type": "integer"
+        },
+        "periodSeconds": {
+          "description": "How often (in seconds) to perform the probe.",
+          "format": "int32",
+          "type": "integer"
+        },
+        "successThreshold": {
+          "description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.",
+          "format": "int32",
+          "type": "integer"
+        },
+        "timeoutSeconds": {
+          "description": "Number of seconds after which the probe times out. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
+          "format": "int32",
+          "type": "integer"
+        }
+      },
+      "type": "object"
+    },
     "io.numaproj.numaflow.v1alpha1.RedisBufferService": {
       "properties": {
         "external": {

diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
@@ -17944,6 +17944,12 @@
         "imagePullPolicy": {
           "type": "string"
         },
+        "livenessProbe": {
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.Probe"
+        },
+        "readinessProbe": {
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.Probe"
+        },
         "resources": {
           "$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements"
         },
@@ -17977,6 +17983,12 @@
         "imagePullPolicy": {
           "type": "string"
         },
+        "livenessProbe": {
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.Probe"
+        },
+        "readinessProbe": {
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.Probe"
+        },
         "resources": {
           "$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements"
         },
@@ -19725,6 +19737,37 @@
         }
       }
     },
+    "io.numaproj.numaflow.v1alpha1.Probe": {
+      "description": "Probe is used to customize the configuration for Readiness and Liveness probes.",
+      "type": "object",
+      "properties": {
+        "failureThreshold": {
+          "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
+          "type": "integer",
+          "format": "int32"
+        },
+        "initialDelaySeconds": {
+          "description": "Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
+          "type": "integer",
+          "format": "int32"
+        },
+        "periodSeconds": {
+          "description": "How often (in seconds) to perform the probe.",
+          "type": "integer",
+          "format": "int32"
+        },
+        "successThreshold": {
+          "description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.",
+          "type": "integer",
+          "format": "int32"
+        },
+        "timeoutSeconds": {
+          "description": "Number of seconds after which the probe times out. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
+          "type": "integer",
+          "format": "int32"
+        }
+      }
+    },
     "io.numaproj.numaflow.v1alpha1.RedisBufferService": {
       "type": "object",
       "properties": {