Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: rename and respect pipeline.deletionGracePeriodSeconds #2226

Merged
merged 2 commits into from
Nov 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions api/json-schema/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand All @@ -20932,7 +20937,7 @@
},
"pauseGracePeriodSeconds": {
"description": "PauseGracePeriodSeconds used to pause pipeline gracefully",
"format": "int32",
"format": "int64",
"type": "integer"
}
},
Expand Down
11 changes: 8 additions & 3 deletions api/openapi-spec/swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -20929,7 +20934,7 @@
"pauseGracePeriodSeconds": {
"description": "PauseGracePeriodSeconds used to pause pipeline gracefully",
"type": "integer",
"format": "int32"
"format": "int64"
}
}
},
Expand Down
8 changes: 6 additions & 2 deletions config/base/crds/full/numaflow.numaproj.io_pipelines.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -122,7 +126,7 @@ spec:
type: string
pauseGracePeriodSeconds:
default: 30
format: int32
format: int64
type: integer
type: object
limits:
Expand Down
8 changes: 6 additions & 2 deletions config/install.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -9860,7 +9864,7 @@ spec:
type: string
pauseGracePeriodSeconds:
default: 30
format: int32
format: int64
type: integer
type: object
limits:
Expand Down
8 changes: 6 additions & 2 deletions config/namespace-install.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -9860,7 +9864,7 @@ spec:
type: string
pauseGracePeriodSeconds:
default: 30
format: int32
format: int64
type: integer
type: object
limits:
Expand Down
26 changes: 23 additions & 3 deletions docs/APIs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -5538,7 +5538,7 @@ phase

<td>

<code>pauseGracePeriodSeconds</code></br> <em> int32 </em>
<code>pauseGracePeriodSeconds</code></br> <em> int64 </em>
</td>

<td>
Expand All @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/reference/pipeline-operations.md
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`.
Loading
Loading