Skip to content

Commit 284ff99

Browse files
whynowyyhl25
authored andcommitted
chore: rename and respect pipeline.deletionGracePeriodSeconds (#2226)
Signed-off-by: Derek Wang <[email protected]>
1 parent 1343e4d commit 284ff99

File tree

18 files changed

+711
-585
lines changed

18 files changed

+711
-585
lines changed

api/json-schema/schema.json

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20922,8 +20922,13 @@
2092220922
"io.numaproj.numaflow.v1alpha1.Lifecycle": {
2092320923
"properties": {
2092420924
"deleteGracePeriodSeconds": {
20925-
"description": "DeleteGracePeriodSeconds used to delete pipeline gracefully",
20926-
"format": "int32",
20925+
"description": "DeleteGracePeriodSeconds used to delete pipeline gracefully Deprecated: Use DeletionGracePeriodSeconds instead",
20926+
"format": "int64",
20927+
"type": "integer"
20928+
},
20929+
"deletionGracePeriodSeconds": {
20930+
"description": "DeletionGracePeriodSeconds used to delete pipeline gracefully",
20931+
"format": "int64",
2092720932
"type": "integer"
2092820933
},
2092920934
"desiredPhase": {
@@ -20932,7 +20937,7 @@
2093220937
},
2093320938
"pauseGracePeriodSeconds": {
2093420939
"description": "PauseGracePeriodSeconds used to pause pipeline gracefully",
20935-
"format": "int32",
20940+
"format": "int64",
2093620941
"type": "integer"
2093720942
}
2093820943
},

api/openapi-spec/swagger.json

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20918,9 +20918,14 @@
2091820918
"type": "object",
2091920919
"properties": {
2092020920
"deleteGracePeriodSeconds": {
20921-
"description": "DeleteGracePeriodSeconds used to delete pipeline gracefully",
20921+
"description": "DeleteGracePeriodSeconds used to delete pipeline gracefully Deprecated: Use DeletionGracePeriodSeconds instead",
2092220922
"type": "integer",
20923-
"format": "int32"
20923+
"format": "int64"
20924+
},
20925+
"deletionGracePeriodSeconds": {
20926+
"description": "DeletionGracePeriodSeconds used to delete pipeline gracefully",
20927+
"type": "integer",
20928+
"format": "int64"
2092420929
},
2092520930
"desiredPhase": {
2092620931
"description": "DesiredPhase used to bring the pipeline from current phase to desired phase",
@@ -20929,7 +20934,7 @@
2092920934
"pauseGracePeriodSeconds": {
2093020935
"description": "PauseGracePeriodSeconds used to pause pipeline gracefully",
2093120936
"type": "integer",
20932-
"format": "int32"
20937+
"format": "int64"
2093320938
}
2093420939
}
2093520940
},

config/base/crds/full/numaflow.numaproj.io_pipelines.yaml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,11 @@ spec:
108108
properties:
109109
deleteGracePeriodSeconds:
110110
default: 30
111-
format: int32
111+
format: int64
112+
type: integer
113+
deletionGracePeriodSeconds:
114+
default: 30
115+
format: int64
112116
type: integer
113117
desiredPhase:
114118
default: Running
@@ -122,7 +126,7 @@ spec:
122126
type: string
123127
pauseGracePeriodSeconds:
124128
default: 30
125-
format: int32
129+
format: int64
126130
type: integer
127131
type: object
128132
limits:

config/install.yaml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9846,7 +9846,11 @@ spec:
98469846
properties:
98479847
deleteGracePeriodSeconds:
98489848
default: 30
9849-
format: int32
9849+
format: int64
9850+
type: integer
9851+
deletionGracePeriodSeconds:
9852+
default: 30
9853+
format: int64
98509854
type: integer
98519855
desiredPhase:
98529856
default: Running
@@ -9860,7 +9864,7 @@ spec:
98609864
type: string
98619865
pauseGracePeriodSeconds:
98629866
default: 30
9863-
format: int32
9867+
format: int64
98649868
type: integer
98659869
type: object
98669870
limits:

config/namespace-install.yaml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9846,7 +9846,11 @@ spec:
98469846
properties:
98479847
deleteGracePeriodSeconds:
98489848
default: 30
9849-
format: int32
9849+
format: int64
9850+
type: integer
9851+
deletionGracePeriodSeconds:
9852+
default: 30
9853+
format: int64
98509854
type: integer
98519855
desiredPhase:
98529856
default: Running
@@ -9860,7 +9864,7 @@ spec:
98609864
type: string
98619865
pauseGracePeriodSeconds:
98629866
default: 30
9863-
format: int32
9867+
format: int64
98649868
type: integer
98659869
type: object
98669870
limits:

docs/APIs.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5497,15 +5497,15 @@ Description
54975497

54985498
<td>
54995499

5500-
<code>deleteGracePeriodSeconds</code></br> <em> int32 </em>
5500+
<code>deletionGracePeriodSeconds</code></br> <em> int64 </em>
55015501
</td>
55025502

55035503
<td>
55045504

55055505
<em>(Optional)</em>
55065506
<p>
55075507

5508-
DeleteGracePeriodSeconds used to delete pipeline gracefully
5508+
DeletionGracePeriodSeconds used to delete pipeline gracefully
55095509
</p>
55105510

55115511
</td>
@@ -5538,7 +5538,7 @@ phase
55385538

55395539
<td>
55405540

5541-
<code>pauseGracePeriodSeconds</code></br> <em> int32 </em>
5541+
<code>pauseGracePeriodSeconds</code></br> <em> int64 </em>
55425542
</td>
55435543

55445544
<td>
@@ -5553,6 +5553,26 @@ PauseGracePeriodSeconds used to pause pipeline gracefully
55535553

55545554
</tr>
55555555

5556+
<tr>
5557+
5558+
<td>
5559+
5560+
<code>deleteGracePeriodSeconds</code></br> <em> int64 </em>
5561+
</td>
5562+
5563+
<td>
5564+
5565+
<em>(Optional)</em>
5566+
<p>
5567+
5568+
DeleteGracePeriodSeconds used to delete pipeline gracefully Deprecated:
5569+
Use DeletionGracePeriodSeconds instead
5570+
</p>
5571+
5572+
</td>
5573+
5574+
</tr>
5575+
55565576
</tbody>
55575577

55585578
</table>

docs/user-guide/reference/pipeline-operations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,4 @@ The command below will bring the pipeline back to `Running` status.
3636

3737
## Delete a Pipeline
3838

39-
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`.
39+
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`.

0 commit comments

Comments
 (0)