chore: rename and respect pipeline.deletionGracePeriodSeconds (#2226)

Signed-off-by: Derek Wang <[email protected]>
numaproj · Dec 5, 2024 · 284ff99 · 284ff99
1 parent 1343e4d
commit 284ff99
Show file tree

Hide file tree

Showing 18 changed files with 711 additions and 585 deletions.
diff --git a/api/json-schema/schema.json b/api/json-schema/schema.json
@@ -20922,8 +20922,13 @@
     "io.numaproj.numaflow.v1alpha1.Lifecycle": {
       "properties": {
         "deleteGracePeriodSeconds": {
-          "description": "DeleteGracePeriodSeconds used to delete pipeline gracefully",
-          "format": "int32",
+          "description": "DeleteGracePeriodSeconds used to delete pipeline gracefully Deprecated: Use DeletionGracePeriodSeconds instead",
+          "format": "int64",
+          "type": "integer"
+        },
+        "deletionGracePeriodSeconds": {
+          "description": "DeletionGracePeriodSeconds used to delete pipeline gracefully",
+          "format": "int64",
           "type": "integer"
         },
         "desiredPhase": {
@@ -20932,7 +20937,7 @@
         },
         "pauseGracePeriodSeconds": {
           "description": "PauseGracePeriodSeconds used to pause pipeline gracefully",
-          "format": "int32",
+          "format": "int64",
           "type": "integer"
         }
       },

diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
@@ -20918,9 +20918,14 @@
       "type": "object",
       "properties": {
         "deleteGracePeriodSeconds": {
-          "description": "DeleteGracePeriodSeconds used to delete pipeline gracefully",
+          "description": "DeleteGracePeriodSeconds used to delete pipeline gracefully Deprecated: Use DeletionGracePeriodSeconds instead",
           "type": "integer",
-          "format": "int32"
+          "format": "int64"
+        },
+        "deletionGracePeriodSeconds": {
+          "description": "DeletionGracePeriodSeconds used to delete pipeline gracefully",
+          "type": "integer",
+          "format": "int64"
         },
         "desiredPhase": {
           "description": "DesiredPhase used to bring the pipeline from current phase to desired phase",
@@ -20929,7 +20934,7 @@
         "pauseGracePeriodSeconds": {
           "description": "PauseGracePeriodSeconds used to pause pipeline gracefully",
           "type": "integer",
-          "format": "int32"
+          "format": "int64"
         }
       }
     },

diff --git a/config/base/crds/full/numaflow.numaproj.io_pipelines.yaml b/config/base/crds/full/numaflow.numaproj.io_pipelines.yaml
@@ -108,7 +108,11 @@ spec:
                 properties:
                   deleteGracePeriodSeconds:
                     default: 30
-                    format: int32
+                    format: int64
+                    type: integer
+                  deletionGracePeriodSeconds:
+                    default: 30
+                    format: int64
                     type: integer
                   desiredPhase:
                     default: Running
@@ -122,7 +126,7 @@ spec:
                     type: string
                   pauseGracePeriodSeconds:
                     default: 30
-                    format: int32
+                    format: int64
                     type: integer
                 type: object
               limits:

diff --git a/config/install.yaml b/config/install.yaml
@@ -9846,7 +9846,11 @@ spec:
                 properties:
                   deleteGracePeriodSeconds:
                     default: 30
-                    format: int32
+                    format: int64
+                    type: integer
+                  deletionGracePeriodSeconds:
+                    default: 30
+                    format: int64
                     type: integer
                   desiredPhase:
                     default: Running
@@ -9860,7 +9864,7 @@ spec:
                     type: string
                   pauseGracePeriodSeconds:
                     default: 30
-                    format: int32
+                    format: int64
                     type: integer
                 type: object
               limits:

diff --git a/config/namespace-install.yaml b/config/namespace-install.yaml
@@ -9846,7 +9846,11 @@ spec:
                 properties:
                   deleteGracePeriodSeconds:
                     default: 30
-                    format: int32
+                    format: int64
+                    type: integer
+                  deletionGracePeriodSeconds:
+                    default: 30
+                    format: int64
                     type: integer
                   desiredPhase:
                     default: Running
@@ -9860,7 +9864,7 @@ spec:
                     type: string
                   pauseGracePeriodSeconds:
                     default: 30
-                    format: int32
+                    format: int64
                     type: integer
                 type: object
               limits:

diff --git a/docs/APIs.md b/docs/APIs.md
@@ -5497,15 +5497,15 @@ Description
 
 <td>
 
-<code>deleteGracePeriodSeconds</code></br> <em> int32 </em>
+<code>deletionGracePeriodSeconds</code></br> <em> int64 </em>
 </td>
 
 <td>
 
 <em>(Optional)</em>
 <p>
 
-DeleteGracePeriodSeconds used to delete pipeline gracefully
+DeletionGracePeriodSeconds used to delete pipeline gracefully
 </p>
 
 </td>
@@ -5538,7 +5538,7 @@ phase
 
 <td>
 
-<code>pauseGracePeriodSeconds</code></br> <em> int32 </em>
+<code>pauseGracePeriodSeconds</code></br> <em> int64 </em>
 </td>
 
 <td>
@@ -5553,6 +5553,26 @@ PauseGracePeriodSeconds used to pause pipeline gracefully
 
 </tr>
 
+<tr>
+
+<td>
+
+<code>deleteGracePeriodSeconds</code></br> <em> int64 </em>
+</td>
+
+<td>
+
+<em>(Optional)</em>
+<p>
+
+DeleteGracePeriodSeconds used to delete pipeline gracefully Deprecated:
+Use DeletionGracePeriodSeconds instead
+</p>
+
+</td>
+
+</tr>
+
 </tbody>
 
 </table>

diff --git a/docs/user-guide/reference/pipeline-operations.md b/docs/user-guide/reference/pipeline-operations.md
@@ -36,4 +36,4 @@ The command below will bring the pipeline back to `Running` status.
 
 ## Delete a Pipeline
 
-When deleting a pipeline, before terminating all the pods, it will try to wait for all the backlog messages that have already been ingested into the pipeline to be processed. However, it will not wait forever, if the backlog is too large, it will terminate the pods after `terminationGracePeriodSeconds`, which defaults to 30, and can be customized by setting `spec.lifecycle.terminationGracePeriodSeconds`.
+When deleting a pipeline, before terminating all the pods, it will try to wait for all the backlog messages that have already been ingested into the pipeline to be processed. However, it will not wait forever, if the backlog is too large, it will terminate the pods after `deletionGracePeriodSeconds`, which defaults to 30, and can be customized by setting `spec.lifecycle.deletionGracePeriodSeconds`.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -36,4 +36,4 @@ The command below will bring the pipeline back to `Running` status.

		## Delete a Pipeline

		When deleting a pipeline, before terminating all the pods, it will try to wait for all the backlog messages that have already been ingested into the pipeline to be processed. However, it will not wait forever, if the backlog is too large, it will terminate the pods after `terminationGracePeriodSeconds`, which defaults to 30, and can be customized by setting `spec.lifecycle.terminationGracePeriodSeconds`.
		When deleting a pipeline, before terminating all the pods, it will try to wait for all the backlog messages that have already been ingested into the pipeline to be processed. However, it will not wait forever, if the backlog is too large, it will terminate the pods after `deletionGracePeriodSeconds`, which defaults to 30, and can be customized by setting `spec.lifecycle.deletionGracePeriodSeconds`.