feat: rolling update for MonoVertex (#2029)

numaproj · Sep 7, 2024 · 3287887 · 3287887
1 parent 4f6b02e
commit 3287887
Show file tree

Hide file tree

Showing 30 changed files with 2,477 additions and 707 deletions.
diff --git a/api/json-schema/schema.json b/api/json-schema/schema.json
@@ -19270,6 +19270,10 @@
           },
           "type": "array"
         },
+        "updateStrategy": {
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.UpdateStrategy",
+          "description": "The strategy to use to replace existing pods with new ones."
+        },
         "volumes": {
           "items": {
             "$ref": "#/definitions/io.k8s.api.core.v1.Volume"
@@ -19293,11 +19297,11 @@
           "x-kubernetes-patch-strategy": "merge"
         },
         "currentHash": {
-          "description": "If not empty, indicates the version of the MonoVertex used to generate Pods in the sequence [0,currentReplicas).",
+          "description": "If not empty, indicates the current version of the MonoVertex used to generate Pods.",
           "type": "string"
         },
-        "currentReplicas": {
-          "description": "The number of Pods created by the controller from the MonoVertex version indicated by currentHash.",
+        "desiredReplicas": {
+          "description": "The number of desired replicas.",
           "format": "int64",
           "type": "integer"
         },
@@ -19336,9 +19340,14 @@
           "type": "string"
         },
         "updateHash": {
-          "description": "If not empty, indicates the version of the MonoVertx used to generate Pods in the sequence [replicas-updatedReplicas,replicas)",
+          "description": "If not empty, indicates the updated version of the MonoVertex used to generate Pods.",
           "type": "string"
         },
+        "updatedReadyReplicas": {
+          "description": "The number of ready Pods created by the controller from the MonoVertex version indicated by updateHash.",
+          "format": "int64",
+          "type": "integer"
+        },
         "updatedReplicas": {
           "description": "The number of Pods created by the controller from the MonoVertex version indicated by updateHash.",
           "format": "int64",
@@ -19803,6 +19812,16 @@
       },
       "type": "object"
     },
+    "io.numaproj.numaflow.v1alpha1.RollingUpdateStrategy": {
+      "description": "RollingUpdateStrategy is used to communicate parameter for RollingUpdateStrategyType.",
+      "properties": {
+        "maxUnavailable": {
+          "$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
+          "description": "The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. Defaults to 25%. Example: when this is set to 30%, the old pods can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old pods can be scaled down further, followed by scaling up the new pods, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods."
+        }
+      },
+      "type": "object"
+    },
     "io.numaproj.numaflow.v1alpha1.SASL": {
       "properties": {
         "gssapi": {
@@ -20318,6 +20337,23 @@
       },
       "type": "object"
     },
+    "io.numaproj.numaflow.v1alpha1.UpdateStrategy": {
+      "description": "UpdateStrategy indicates the strategy that the controller will use to perform updates for Vertex or MonoVertex.",
+      "properties": {
+        "rollingUpdate": {
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.RollingUpdateStrategy",
+          "description": "RollingUpdate is used to communicate parameters when Type is RollingUpdateStrategy."
+        },
+        "type": {
+          "description": "Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.\n\nPossible enum values:\n - `\"RollingUpdate\"`",
+          "enum": [
+            "RollingUpdate"
+          ],
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "io.numaproj.numaflow.v1alpha1.Vertex": {
       "properties": {
         "apiVersion": {

diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
@@ -19266,6 +19266,10 @@
             "$ref": "#/definitions/io.k8s.api.core.v1.Toleration"
           }
         },
+        "updateStrategy": {
+          "description": "The strategy to use to replace existing pods with new ones.",
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.UpdateStrategy"
+        },
         "volumes": {
           "type": "array",
           "items": {
@@ -19289,11 +19293,11 @@
           "x-kubernetes-patch-strategy": "merge"
         },
         "currentHash": {
-          "description": "If not empty, indicates the version of the MonoVertex used to generate Pods in the sequence [0,currentReplicas).",
+          "description": "If not empty, indicates the current version of the MonoVertex used to generate Pods.",
           "type": "string"
         },
-        "currentReplicas": {
-          "description": "The number of Pods created by the controller from the MonoVertex version indicated by currentHash.",
+        "desiredReplicas": {
+          "description": "The number of desired replicas.",
           "type": "integer",
           "format": "int64"
         },
@@ -19332,9 +19336,14 @@
           "type": "string"
         },
         "updateHash": {
-          "description": "If not empty, indicates the version of the MonoVertx used to generate Pods in the sequence [replicas-updatedReplicas,replicas)",
+          "description": "If not empty, indicates the updated version of the MonoVertex used to generate Pods.",
           "type": "string"
         },
+        "updatedReadyReplicas": {
+          "description": "The number of ready Pods created by the controller from the MonoVertex version indicated by updateHash.",
+          "type": "integer",
+          "format": "int64"
+        },
         "updatedReplicas": {
           "description": "The number of Pods created by the controller from the MonoVertex version indicated by updateHash.",
           "type": "integer",
@@ -19789,6 +19798,16 @@
         }
       }
     },
+    "io.numaproj.numaflow.v1alpha1.RollingUpdateStrategy": {
+      "description": "RollingUpdateStrategy is used to communicate parameter for RollingUpdateStrategyType.",
+      "type": "object",
+      "properties": {
+        "maxUnavailable": {
+          "description": "The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. Defaults to 25%. Example: when this is set to 30%, the old pods can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old pods can be scaled down further, followed by scaling up the new pods, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.",
+          "$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString"
+        }
+      }
+    },
     "io.numaproj.numaflow.v1alpha1.SASL": {
       "type": "object",
       "required": [
@@ -20304,6 +20323,23 @@
         }
       }
     },
+    "io.numaproj.numaflow.v1alpha1.UpdateStrategy": {
+      "description": "UpdateStrategy indicates the strategy that the controller will use to perform updates for Vertex or MonoVertex.",
+      "type": "object",
+      "properties": {
+        "rollingUpdate": {
+          "description": "RollingUpdate is used to communicate parameters when Type is RollingUpdateStrategy.",
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.RollingUpdateStrategy"
+        },
+        "type": {
+          "description": "Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.\n\nPossible enum values:\n - `\"RollingUpdate\"`",
+          "type": "string",
+          "enum": [
+            "RollingUpdate"
+          ]
+        }
+      }
+    },
     "io.numaproj.numaflow.v1alpha1.Vertex": {
       "type": "object",
       "required": [

diff --git a/config/advanced-install/minimal-crds.yaml b/config/advanced-install/minimal-crds.yaml
@@ -69,7 +69,7 @@ spec:
     - jsonPath: .status.phase
       name: Phase
       type: string
-    - jsonPath: .spec.replicas
+    - jsonPath: .status.desiredReplicas
       name: Desired
       type: string
     - jsonPath: .status.replicas

diff --git a/config/base/crds/full/numaflow.numaproj.io_monovertices.yaml b/config/base/crds/full/numaflow.numaproj.io_monovertices.yaml
@@ -21,7 +21,7 @@ spec:
     - jsonPath: .status.phase
       name: Phase
       type: string
-    - jsonPath: .spec.replicas
+    - jsonPath: .status.desiredReplicas
       name: Desired
       type: string
     - jsonPath: .status.replicas
@@ -4790,6 +4790,23 @@ spec:
                       type: string
                   type: object
                 type: array
+              updateStrategy:
+                default:
+                  rollingUpdate:
+                    maxUnavailable: 25%
+                  type: RollingUpdate
+                properties:
+                  rollingUpdate:
+                    properties:
+                      maxUnavailable:
+                        anyOf:
+                        - type: integer
+                        - type: string
+                        x-kubernetes-int-or-string: true
+                    type: object
+                  type:
+                    type: string
+                type: object
               volumes:
                 items:
                   properties:
@@ -5551,7 +5568,7 @@ spec:
                 type: array
               currentHash:
                 type: string
-              currentReplicas:
+              desiredReplicas:
                 format: int32
                 type: integer
               lastScaledAt:
@@ -5586,6 +5603,9 @@ spec:
                 type: string
               updateHash:
                 type: string
+              updatedReadyReplicas:
+                format: int32
+                type: integer
               updatedReplicas:
                 format: int32
                 type: integer

diff --git a/config/base/crds/minimal/numaflow.numaproj.io_monovertices.yaml b/config/base/crds/minimal/numaflow.numaproj.io_monovertices.yaml
@@ -17,7 +17,7 @@ spec:
     - jsonPath: .status.phase
       name: Phase
       type: string
-    - jsonPath: .spec.replicas
+    - jsonPath: .status.desiredReplicas
       name: Desired
       type: string
     - jsonPath: .status.replicas

diff --git a/config/install.yaml b/config/install.yaml
@@ -2665,7 +2665,7 @@ spec:
     - jsonPath: .status.phase
       name: Phase
       type: string
-    - jsonPath: .spec.replicas
+    - jsonPath: .status.desiredReplicas
       name: Desired
       type: string
     - jsonPath: .status.replicas
@@ -7434,6 +7434,23 @@ spec:
                       type: string
                   type: object
                 type: array
+              updateStrategy:
+                default:
+                  rollingUpdate:
+                    maxUnavailable: 25%
+                  type: RollingUpdate
+                properties:
+                  rollingUpdate:
+                    properties:
+                      maxUnavailable:
+                        anyOf:
+                        - type: integer
+                        - type: string
+                        x-kubernetes-int-or-string: true
+                    type: object
+                  type:
+                    type: string
+                type: object
               volumes:
                 items:
                   properties:
@@ -8195,7 +8212,7 @@ spec:
                 type: array
               currentHash:
                 type: string
-              currentReplicas:
+              desiredReplicas:
                 format: int32
                 type: integer
               lastScaledAt:
@@ -8230,6 +8247,9 @@ spec:
                 type: string
               updateHash:
                 type: string
+              updatedReadyReplicas:
+                format: int32
+                type: integer
               updatedReplicas:
                 format: int32
                 type: integer

diff --git a/config/namespace-install.yaml b/config/namespace-install.yaml
@@ -2665,7 +2665,7 @@ spec:
     - jsonPath: .status.phase
       name: Phase
       type: string
-    - jsonPath: .spec.replicas
+    - jsonPath: .status.desiredReplicas
       name: Desired
       type: string
     - jsonPath: .status.replicas
@@ -7434,6 +7434,23 @@ spec:
                       type: string
                   type: object
                 type: array
+              updateStrategy:
+                default:
+                  rollingUpdate:
+                    maxUnavailable: 25%
+                  type: RollingUpdate
+                properties:
+                  rollingUpdate:
+                    properties:
+                      maxUnavailable:
+                        anyOf:
+                        - type: integer
+                        - type: string
+                        x-kubernetes-int-or-string: true
+                    type: object
+                  type:
+                    type: string
+                type: object
               volumes:
                 items:
                   properties:
@@ -8195,7 +8212,7 @@ spec:
                 type: array
               currentHash:
                 type: string
-              currentReplicas:
+              desiredReplicas:
                 format: int32
                 type: integer
               lastScaledAt:
@@ -8230,6 +8247,9 @@ spec:
                 type: string
               updateHash:
                 type: string
+              updatedReadyReplicas:
+                format: int32
+                type: integer
               updatedReplicas:
                 format: int32
                 type: integer