refactor: introducing lifecycle to Vertex spec (#2419)

Signed-off-by: Derek Wang <[email protected]>
numaproj · Feb 24, 2025 · b97885b · adarsh0728 · Feb 25, 2025 · whynowy
1 parent 1dc2b31
commit b97885b
Show file tree

Hide file tree

Showing 22 changed files with 1,118 additions and 612 deletions.
diff --git a/api/json-schema/schema.json b/api/json-schema/schema.json
@@ -20991,7 +20991,7 @@
     "io.numaproj.numaflow.v1alpha1.MonoVertexLifecycle": {
       "properties": {
         "desiredPhase": {
-          "description": "DesiredPhase used to bring the pipeline from current phase to desired phase",
+          "description": "DesiredPhase used to bring the MonoVertex from current phase to desired phase",
           "type": "string"
         }
       },
@@ -22391,6 +22391,15 @@
       },
       "type": "object"
     },
+    "io.numaproj.numaflow.v1alpha1.VertexLifecycle": {
+      "properties": {
+        "desiredPhase": {
+          "description": "DesiredPhase used to bring the vertex from current phase to desired phase",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "io.numaproj.numaflow.v1alpha1.VertexLimits": {
       "properties": {
         "bufferMaxLength": {
@@ -22491,6 +22500,10 @@
         "interStepBufferServiceName": {
           "type": "string"
         },
+        "lifecycle": {
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.VertexLifecycle",
+          "description": "Lifecycle defines the Lifecycle properties of a ertex"
+        },
         "limits": {
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.VertexLimits",
           "description": "Limits define the limitations such as buffer read batch size for all the vertices of a pipeline, will override pipeline level settings"

diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
@@ -20987,7 +20987,7 @@
       "type": "object",
       "properties": {
         "desiredPhase": {
-          "description": "DesiredPhase used to bring the pipeline from current phase to desired phase",
+          "description": "DesiredPhase used to bring the MonoVertex from current phase to desired phase",
           "type": "string"
         }
       }
@@ -22368,6 +22368,15 @@
         }
       }
     },
+    "io.numaproj.numaflow.v1alpha1.VertexLifecycle": {
+      "type": "object",
+      "properties": {
+        "desiredPhase": {
+          "description": "DesiredPhase used to bring the vertex from current phase to desired phase",
+          "type": "string"
+        }
+      }
+    },
     "io.numaproj.numaflow.v1alpha1.VertexLimits": {
       "type": "object",
       "properties": {
@@ -22473,6 +22482,10 @@
         "interStepBufferServiceName": {
           "type": "string"
         },
+        "lifecycle": {
+          "description": "Lifecycle defines the Lifecycle properties of a ertex",
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.VertexLifecycle"
+        },
         "limits": {
           "description": "Limits define the limitations such as buffer read batch size for all the vertices of a pipeline, will override pipeline level settings",
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.VertexLimits"

diff --git a/config/base/crds/full/numaflow.numaproj.io_vertices.yaml b/config/base/crds/full/numaflow.numaproj.io_vertices.yaml
@@ -1758,6 +1758,19 @@ spec:
                 type: array
               interStepBufferServiceName:
                 type: string
+              lifecycle:
+                default:
+                  desiredPhase: Running
+                properties:
+                  desiredPhase:
+                    default: Running
+                    enum:
+                    - ""
+                    - Running
+                    - Paused
+                    - Failed
+                    type: string
+                type: object
               limits:
                 properties:
                   bufferMaxLength:
@@ -6596,6 +6609,7 @@ spec:
                 enum:
                 - ""
                 - Running
+                - Paused
                 - Failed
                 type: string
               readyReplicas:

diff --git a/config/install.yaml b/config/install.yaml
@@ -23402,6 +23402,19 @@ spec:
                 type: array
               interStepBufferServiceName:
                 type: string
+              lifecycle:
+                default:
+                  desiredPhase: Running
+                properties:
+                  desiredPhase:
+                    default: Running
+                    enum:
+                    - ""
+                    - Running
+                    - Paused
+                    - Failed
+                    type: string
+                type: object
               limits:
                 properties:
                   bufferMaxLength:
@@ -28240,6 +28253,7 @@ spec:
                 enum:
                 - ""
                 - Running
+                - Paused
                 - Failed
                 type: string
               readyReplicas:

diff --git a/config/namespace-install.yaml b/config/namespace-install.yaml
@@ -23402,6 +23402,19 @@ spec:
                 type: array
               interStepBufferServiceName:
                 type: string
+              lifecycle:
+                default:
+                  desiredPhase: Running
+                properties:
+                  desiredPhase:
+                    default: Running
+                    enum:
+                    - ""
+                    - Running
+                    - Paused
+                    - Failed
+                    type: string
+                type: object
               limits:
                 properties:
                   bufferMaxLength:
@@ -28240,6 +28253,7 @@ spec:
                 enum:
                 - ""
                 - Running
+                - Paused
                 - Failed
                 type: string
               readyReplicas:

diff --git a/docs/APIs.md b/docs/APIs.md
@@ -6064,7 +6064,7 @@ MonoVertexPhase </a> </em>
 <em>(Optional)</em>
 <p>
 
-DesiredPhase used to bring the pipeline from current phase to desired
+DesiredPhase used to bring the MonoVertex from current phase to desired
 phase
 </p>
 
@@ -11840,6 +11840,27 @@ from the pipeline watermark settings.
 
 </tr>
 
+<tr>
+
+<td>
+
+<code>lifecycle</code></br> <em>
+<a href="#numaflow.numaproj.io/v1alpha1.VertexLifecycle">
+VertexLifecycle </a> </em>
+</td>
+
+<td>
+
+<em>(Optional)</em>
+<p>
+
+Lifecycle defines the Lifecycle properties of a ertex
+</p>
+
+</td>
+
+</tr>
+
 </table>
 
 </td>
@@ -11948,6 +11969,69 @@ Description
 
 </table>
 
+<h3 id="numaflow.numaproj.io/v1alpha1.VertexLifecycle">
+
+VertexLifecycle
+</h3>
+
+<p>
+
+(<em>Appears on:</em>
+<a href="#numaflow.numaproj.io/v1alpha1.VertexSpec">VertexSpec</a>)
+</p>
+
+<p>
+
+</p>
+
+<table>
+
+<thead>
+
+<tr>
+
+<th>
+
+Field
+</th>
+
+<th>
+
+Description
+</th>
+
+</tr>
+
+</thead>
+
+<tbody>
+
+<tr>
+
+<td>
+
+<code>desiredPhase</code></br> <em>
+<a href="#numaflow.numaproj.io/v1alpha1.VertexPhase"> VertexPhase </a>
+</em>
+</td>
+
+<td>
+
+<em>(Optional)</em>
+<p>
+
+DesiredPhase used to bring the vertex from current phase to desired
+phase
+</p>
+
+</td>
+
+</tr>
+
+</tbody>
+
+</table>
+
 <h3 id="numaflow.numaproj.io/v1alpha1.VertexLimits">
 
 VertexLimits
@@ -12083,6 +12167,7 @@ VertexPhase (<code>string</code> alias)
 <p>
 
 (<em>Appears on:</em>
+<a href="#numaflow.numaproj.io/v1alpha1.VertexLifecycle">VertexLifecycle</a>,
 <a href="#numaflow.numaproj.io/v1alpha1.VertexStatus">VertexStatus</a>)
 </p>
 
@@ -12241,6 +12326,27 @@ from the pipeline watermark settings.
 
 </tr>
 
+<tr>
+
+<td>
+
+<code>lifecycle</code></br> <em>
+<a href="#numaflow.numaproj.io/v1alpha1.VertexLifecycle">
+VertexLifecycle </a> </em>
+</td>
+
+<td>
+
+<em>(Optional)</em>
+<p>
+
+Lifecycle defines the Lifecycle properties of a ertex
+</p>
+
+</td>
+
+</tr>
+
 </tbody>
 
 </table>