feat: introduce readyReplicas for Vertex and MonoVertex (#2014)

Signed-off-by: Derek Wang <[email protected]>
numaproj · Sep 3, 2024 · c6530d3 · c6530d3
1 parent 7b7a3ec
commit c6530d3
Show file tree

Hide file tree

Showing 25 changed files with 985 additions and 564 deletions.
diff --git a/api/json-schema/schema.json b/api/json-schema/schema.json
@@ -19278,7 +19278,8 @@
           "x-kubernetes-patch-strategy": "merge"
         },
         "lastScaledAt": {
-          "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
+          "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time",
+          "description": "Time of last scaling operation."
         },
         "lastUpdated": {
           "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
@@ -19287,26 +19288,30 @@
           "type": "string"
         },
         "observedGeneration": {
+          "description": "The generation observed by the MonoVertex controller.",
           "format": "int64",
           "type": "integer"
         },
         "phase": {
           "type": "string"
         },
+        "readyReplicas": {
+          "description": "The number of pods targeted by this MonoVertex with a Ready Condition.",
+          "format": "int64",
+          "type": "integer"
+        },
         "reason": {
           "type": "string"
         },
         "replicas": {
+          "description": "Total number of non-terminated pods targeted by this MonoVertex (their labels match the selector).",
           "format": "int64",
           "type": "integer"
         },
         "selector": {
           "type": "string"
         }
       },
-      "required": [
-        "replicas"
-      ],
       "type": "object"
     },
     "io.numaproj.numaflow.v1alpha1.NativeRedis": {
@@ -19654,6 +19659,7 @@
           "type": "string"
         },
         "observedGeneration": {
+          "description": "The generation observed by the Pipeline controller.",
           "format": "int64",
           "type": "integer"
         },
@@ -20542,33 +20548,37 @@
           "x-kubernetes-patch-strategy": "merge"
         },
         "lastScaledAt": {
-          "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
+          "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time",
+          "description": "Time of last scaling operation."
         },
         "message": {
           "type": "string"
         },
         "observedGeneration": {
+          "description": "The generation observed by the Vertex controller.",
           "format": "int64",
           "type": "integer"
         },
         "phase": {
           "type": "string"
         },
+        "readyReplicas": {
+          "description": "The number of pods targeted by this Vertex with a Ready Condition.",
+          "format": "int64",
+          "type": "integer"
+        },
         "reason": {
           "type": "string"
         },
         "replicas": {
+          "description": "Total number of non-terminated pods targeted by this Vertex (their labels match the selector).",
           "format": "int64",
           "type": "integer"
         },
         "selector": {
           "type": "string"
         }
       },
-      "required": [
-        "phase",
-        "replicas"
-      ],
       "type": "object"
     },
     "io.numaproj.numaflow.v1alpha1.VertexTemplate": {

diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
@@ -19263,9 +19263,6 @@
     },
     "io.numaproj.numaflow.v1alpha1.MonoVertexStatus": {
       "type": "object",
-      "required": [
-        "replicas"
-      ],
       "properties": {
         "conditions": {
           "description": "Conditions are the latest available observations of a resource's current state.",
@@ -19277,6 +19274,7 @@
           "x-kubernetes-patch-strategy": "merge"
         },
         "lastScaledAt": {
+          "description": "Time of last scaling operation.",
           "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
         },
         "lastUpdated": {
@@ -19286,16 +19284,23 @@
           "type": "string"
         },
         "observedGeneration": {
+          "description": "The generation observed by the MonoVertex controller.",
           "type": "integer",
           "format": "int64"
         },
         "phase": {
           "type": "string"
         },
+        "readyReplicas": {
+          "description": "The number of pods targeted by this MonoVertex with a Ready Condition.",
+          "type": "integer",
+          "format": "int64"
+        },
         "reason": {
           "type": "string"
         },
         "replicas": {
+          "description": "Total number of non-terminated pods targeted by this MonoVertex (their labels match the selector).",
           "type": "integer",
           "format": "int64"
         },
@@ -19641,6 +19646,7 @@
           "type": "string"
         },
         "observedGeneration": {
+          "description": "The generation observed by the Pipeline controller.",
           "type": "integer",
           "format": "int64"
         },
@@ -20509,10 +20515,6 @@
     },
     "io.numaproj.numaflow.v1alpha1.VertexStatus": {
       "type": "object",
-      "required": [
-        "phase",
-        "replicas"
-      ],
       "properties": {
         "conditions": {
           "description": "Conditions are the latest available observations of a resource's current state.",
@@ -20524,22 +20526,30 @@
           "x-kubernetes-patch-strategy": "merge"
         },
         "lastScaledAt": {
+          "description": "Time of last scaling operation.",
           "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
         },
         "message": {
           "type": "string"
         },
         "observedGeneration": {
+          "description": "The generation observed by the Vertex controller.",
           "type": "integer",
           "format": "int64"
         },
         "phase": {
           "type": "string"
         },
+        "readyReplicas": {
+          "description": "The number of pods targeted by this Vertex with a Ready Condition.",
+          "type": "integer",
+          "format": "int64"
+        },
         "reason": {
           "type": "string"
         },
         "replicas": {
+          "description": "Total number of non-terminated pods targeted by this Vertex (their labels match the selector).",
           "type": "integer",
           "format": "int64"
         },

diff --git a/config/advanced-install/minimal-crds.yaml b/config/advanced-install/minimal-crds.yaml
@@ -75,6 +75,9 @@ spec:
     - jsonPath: .status.replicas
       name: Current
       type: string
+    - jsonPath: .status.readyReplicas
+      name: Ready
+      type: string
     - jsonPath: .metadata.creationTimestamp
       name: Age
       type: date
@@ -209,6 +212,9 @@ spec:
     - jsonPath: .status.replicas
       name: Current
       type: string
+    - jsonPath: .status.readyReplicas
+      name: Ready
+      type: string
     - jsonPath: .metadata.creationTimestamp
       name: Age
       type: date

diff --git a/config/base/crds/full/numaflow.numaproj.io_monovertices.yaml b/config/base/crds/full/numaflow.numaproj.io_monovertices.yaml
@@ -27,6 +27,9 @@ spec:
     - jsonPath: .status.replicas
       name: Current
       type: string
+    - jsonPath: .status.readyReplicas
+      name: Ready
+      type: string
     - jsonPath: .metadata.creationTimestamp
       name: Age
       type: date
@@ -5551,15 +5554,16 @@ spec:
                 - Paused
                 - Deleting
                 type: string
+              readyReplicas:
+                format: int32
+                type: integer
               reason:
                 type: string
               replicas:
                 format: int32
                 type: integer
               selector:
                 type: string
-            required:
-            - replicas
             type: object
         required:
         - spec

diff --git a/config/base/crds/full/numaflow.numaproj.io_vertices.yaml b/config/base/crds/full/numaflow.numaproj.io_vertices.yaml
@@ -27,6 +27,9 @@ spec:
     - jsonPath: .status.replicas
       name: Current
       type: string
+    - jsonPath: .status.readyReplicas
+      name: Ready
+      type: string
     - jsonPath: .metadata.creationTimestamp
       name: Age
       type: date
@@ -5480,16 +5483,16 @@ spec:
                 - Running
                 - Failed
                 type: string
+              readyReplicas:
+                format: int32
+                type: integer
               reason:
                 type: string
               replicas:
                 format: int32
                 type: integer
               selector:
                 type: string
-            required:
-            - phase
-            - replicas
             type: object
         required:
         - spec

diff --git a/config/base/crds/minimal/numaflow.numaproj.io_monovertices.yaml b/config/base/crds/minimal/numaflow.numaproj.io_monovertices.yaml
@@ -23,6 +23,9 @@ spec:
     - jsonPath: .status.replicas
       name: Current
       type: string
+    - jsonPath: .status.readyReplicas
+      name: Ready
+      type: string
     - jsonPath: .metadata.creationTimestamp
       name: Age
       type: date

diff --git a/config/base/crds/minimal/numaflow.numaproj.io_vertices.yaml b/config/base/crds/minimal/numaflow.numaproj.io_vertices.yaml
@@ -23,6 +23,9 @@ spec:
     - jsonPath: .status.replicas
       name: Current
       type: string
+    - jsonPath: .status.readyReplicas
+      name: Ready
+      type: string
     - jsonPath: .metadata.creationTimestamp
       name: Age
       type: date

diff --git a/config/install.yaml b/config/install.yaml
@@ -2671,6 +2671,9 @@ spec:
     - jsonPath: .status.replicas
       name: Current
       type: string
+    - jsonPath: .status.readyReplicas
+      name: Ready
+      type: string
     - jsonPath: .metadata.creationTimestamp
       name: Age
       type: date
@@ -8195,15 +8198,16 @@ spec:
                 - Paused
                 - Deleting
                 type: string
+              readyReplicas:
+                format: int32
+                type: integer
               reason:
                 type: string
               replicas:
                 format: int32
                 type: integer
               selector:
                 type: string
-            required:
-            - replicas
             type: object
         required:
         - spec
@@ -18108,6 +18112,9 @@ spec:
     - jsonPath: .status.replicas
       name: Current
       type: string
+    - jsonPath: .status.readyReplicas
+      name: Ready
+      type: string
     - jsonPath: .metadata.creationTimestamp
       name: Age
       type: date
@@ -23561,16 +23568,16 @@ spec:
                 - Running
                 - Failed
                 type: string
+              readyReplicas:
+                format: int32
+                type: integer
               reason:
                 type: string
               replicas:
                 format: int32
                 type: integer
               selector:
                 type: string
-            required:
-            - phase
-            - replicas
             type: object
         required:
         - spec