feat: add pause for monovertex (#2077)

Signed-off-by: Sidhant Kohli <[email protected]>
numaproj · Sep 24, 2024 · 6d1ebd0 · 6d1ebd0
1 parent b8c61de
commit 6d1ebd0
Show file tree

Hide file tree

Showing 20 changed files with 1,118 additions and 573 deletions.
diff --git a/api/json-schema/schema.json b/api/json-schema/schema.json
@@ -19132,6 +19132,15 @@
       ],
       "type": "object"
     },
+    "io.numaproj.numaflow.v1alpha1.MonoVertexLifecycle": {
+      "properties": {
+        "desiredPhase": {
+          "description": "DesiredPhase used to bring the pipeline from current phase to desired phase",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "io.numaproj.numaflow.v1alpha1.MonoVertexLimits": {
       "properties": {
         "readBatchSize": {
@@ -19213,6 +19222,10 @@
           },
           "type": "array"
         },
+        "lifecycle": {
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.MonoVertexLifecycle",
+          "description": "Lifecycle defines the Lifecycle properties of a MonoVertex"
+        },
         "limits": {
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.MonoVertexLimits",
           "description": "Limits define the limitations such as read batch size for the mono vertex."

diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
@@ -19127,6 +19127,15 @@
         }
       }
     },
+    "io.numaproj.numaflow.v1alpha1.MonoVertexLifecycle": {
+      "type": "object",
+      "properties": {
+        "desiredPhase": {
+          "description": "DesiredPhase used to bring the pipeline from current phase to desired phase",
+          "type": "string"
+        }
+      }
+    },
     "io.numaproj.numaflow.v1alpha1.MonoVertexLimits": {
       "type": "object",
       "properties": {
@@ -19209,6 +19218,10 @@
             "$ref": "#/definitions/io.k8s.api.core.v1.Container"
           }
         },
+        "lifecycle": {
+          "description": "Lifecycle defines the Lifecycle properties of a MonoVertex",
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.MonoVertexLifecycle"
+        },
         "limits": {
           "description": "Limits define the limitations such as read batch size for the mono vertex.",
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.MonoVertexLimits"

diff --git a/config/base/crds/full/numaflow.numaproj.io_monovertices.yaml b/config/base/crds/full/numaflow.numaproj.io_monovertices.yaml
@@ -2299,6 +2299,21 @@ spec:
                   - name
                   type: object
                 type: array
+              lifecycle:
+                default:
+                  desiredPhase: Running
+                properties:
+                  desiredPhase:
+                    default: Running
+                    enum:
+                    - ""
+                    - Running
+                    - Failed
+                    - Pausing
+                    - Paused
+                    - Deleting
+                    type: string
+                type: object
               limits:
                 properties:
                   readBatchSize:

diff --git a/config/install.yaml b/config/install.yaml
@@ -5195,6 +5195,21 @@ spec:
                   - name
                   type: object
                 type: array
+              lifecycle:
+                default:
+                  desiredPhase: Running
+                properties:
+                  desiredPhase:
+                    default: Running
+                    enum:
+                    - ""
+                    - Running
+                    - Failed
+                    - Pausing
+                    - Paused
+                    - Deleting
+                    type: string
+                type: object
               limits:
                 properties:
                   readBatchSize:

diff --git a/config/namespace-install.yaml b/config/namespace-install.yaml
@@ -5195,6 +5195,21 @@ spec:
                   - name
                   type: object
                 type: array
+              lifecycle:
+                default:
+                  desiredPhase: Running
+                properties:
+                  desiredPhase:
+                    default: Running
+                    enum:
+                    - ""
+                    - Running
+                    - Failed
+                    - Pausing
+                    - Paused
+                    - Deleting
+                    type: string
+                type: object
               limits:
                 properties:
                   readBatchSize:

diff --git a/docs/APIs.md b/docs/APIs.md
@@ -5893,6 +5893,27 @@ The strategy to use to replace existing pods with new ones.
 
 </tr>
 
+<tr>
+
+<td>
+
+<code>lifecycle</code></br> <em>
+<a href="#numaflow.numaproj.io/v1alpha1.MonoVertexLifecycle">
+MonoVertexLifecycle </a> </em>
+</td>
+
+<td>
+
+<em>(Optional)</em>
+<p>
+
+Lifecycle defines the Lifecycle properties of a MonoVertex
+</p>
+
+</td>
+
+</tr>
+
 </table>
 
 </td>
@@ -5919,6 +5940,69 @@ MonoVertexStatus </a> </em>
 
 </table>
 
+<h3 id="numaflow.numaproj.io/v1alpha1.MonoVertexLifecycle">
+
+MonoVertexLifecycle
+</h3>
+
+<p>
+
+(<em>Appears on:</em>
+<a href="#numaflow.numaproj.io/v1alpha1.MonoVertexSpec">MonoVertexSpec</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.MonoVertexPhase">
+MonoVertexPhase </a> </em>
+</td>
+
+<td>
+
+<em>(Optional)</em>
+<p>
+
+DesiredPhase used to bring the pipeline from current phase to desired
+phase
+</p>
+
+</td>
+
+</tr>
+
+</tbody>
+
+</table>
+
 <h3 id="numaflow.numaproj.io/v1alpha1.MonoVertexLimits">
 
 MonoVertexLimits
@@ -6010,6 +6094,7 @@ MonoVertexPhase (<code>string</code> alias)
 <p>
 
 (<em>Appears on:</em>
+<a href="#numaflow.numaproj.io/v1alpha1.MonoVertexLifecycle">MonoVertexLifecycle</a>,
 <a href="#numaflow.numaproj.io/v1alpha1.MonoVertexStatus">MonoVertexStatus</a>)
 </p>
 
@@ -6282,6 +6367,27 @@ The strategy to use to replace existing pods with new ones.
 
 </tr>
 
+<tr>
+
+<td>
+
+<code>lifecycle</code></br> <em>
+<a href="#numaflow.numaproj.io/v1alpha1.MonoVertexLifecycle">
+MonoVertexLifecycle </a> </em>
+</td>
+
+<td>
+
+<em>(Optional)</em>
+<p>
+
+Lifecycle defines the Lifecycle properties of a MonoVertex
+</p>
+
+</td>
+
+</tr>
+
 </tbody>
 
 </table>