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.

Sign up for GitHub

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

Allow user to specify only tasks or finally timeout #5460

Merged
merged 1 commit into from
Sep 10, 2022
Merged

Allow user to specify only tasks or finally timeout #5460

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 21 additions & 1 deletion docs/pipelineruns.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -866,7 +866,7 @@ timeouts:
All three sub-fields are optional, and will be automatically processed according to the following constraint:
* `timeouts.pipeline >= timeouts.tasks + timeouts.finally`

You may combine the timeouts as follow:
Example timeouts usages are as follows:

Combination 1: Set the timeout for the entire `pipeline` and reserve a portion of it for `tasks`.

Expand All @@ -888,6 +888,26 @@ spec:
finally: "0h3m0s"
```

Combination 3: Set only a `tasks` timeout, with no timeout for the entire `pipeline`.

```yaml
kind: PipelineRun
spec:
timeouts:
pipeline: "0" # No timeout
tasks: "0h3m0s"
```

Combination : Set only a `finally` timeout, with no timeout for the entire `pipeline`.

```yaml
kind: PipelineRun
spec:
timeouts:
pipeline: "0" # No timeout
finally: "0h3m0s"
```

You can also use the *Deprecated* `timeout` field to set the `PipelineRun's` desired timeout value in minutes.
If you do not specify this value in the `PipelineRun`, the global default timeout value applies.
If you set the timeout to 0, the `PipelineRun` fails immediately upon encountering an error.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @lbernick for the fix!

Does this statement still hold true? This is documented in the next paragraph.

 If you set the timeout value or timeouts.pipeline to 0, the PipelineRun fails immediately upon encountering an error.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, this should still be correct, thanks for checking!

Expand Down
4 changes: 2 additions & 2 deletions pkg/apis/pipeline/v1/pipelinerun_validation.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ func (ps *PipelineRunSpec) validatePipelineTimeout(timeout time.Duration, errorM
if ps.Timeouts.Tasks != nil {
tasksTimeoutErr := false
tasksTimeoutStr := ps.Timeouts.Tasks.Duration.String()
if ps.Timeouts.Tasks.Duration > timeout {
if ps.Timeouts.Tasks.Duration > timeout && timeout != config.NoTimeoutDuration {
tasksTimeoutErr = true
}
if ps.Timeouts.Tasks.Duration == config.NoTimeoutDuration && timeout != config.NoTimeoutDuration {
Expand All @@ -253,7 +253,7 @@ func (ps *PipelineRunSpec) validatePipelineTimeout(timeout time.Duration, errorM
if ps.Timeouts.Finally != nil {
finallyTimeoutErr := false
finallyTimeoutStr := ps.Timeouts.Finally.Duration.String()
if ps.Timeouts.Finally.Duration > timeout {
if ps.Timeouts.Finally.Duration > timeout && timeout != config.NoTimeoutDuration {
finallyTimeoutErr = true
}
if ps.Timeouts.Finally.Duration == config.NoTimeoutDuration && timeout != config.NoTimeoutDuration {
Expand Down
32 changes: 32 additions & 0 deletions pkg/apis/pipeline/v1/pipelinerun_validation_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -793,6 +793,38 @@ func TestPipelineRunWithTimeout_Validate(t *testing.T) {
},
},
},
}, {
name: "timeouts.tasks only",
pr: v1.PipelineRun{
ObjectMeta: metav1.ObjectMeta{
Name: "pipelinelinename",
},
Spec: v1.PipelineRunSpec{
PipelineRef: &v1.PipelineRef{
Name: "prname",
},
Timeouts: &v1.TimeoutFields{
Pipeline: &metav1.Duration{Duration: 0 * time.Hour},
Tasks: &metav1.Duration{Duration: 30 * time.Minute},
},
},
},
}, {
name: "timeouts.finally only",
pr: v1.PipelineRun{
ObjectMeta: metav1.ObjectMeta{
Name: "pipelinelinename",
},
Spec: v1.PipelineRunSpec{
PipelineRef: &v1.PipelineRef{
Name: "prname",
},
Timeouts: &v1.TimeoutFields{
Pipeline: &metav1.Duration{Duration: 0 * time.Hour},
Finally: &metav1.Duration{Duration: 30 * time.Minute},
},
},
},
}}

for _, ts := range tests {
Expand Down
4 changes: 2 additions & 2 deletions pkg/apis/pipeline/v1beta1/pipelinerun_validation.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ func (ps *PipelineRunSpec) validatePipelineTimeout(timeout time.Duration, errorM
if ps.Timeouts.Tasks != nil {
tasksTimeoutErr := false
tasksTimeoutStr := ps.Timeouts.Tasks.Duration.String()
if ps.Timeouts.Tasks.Duration > timeout {
if ps.Timeouts.Tasks.Duration > timeout && timeout != config.NoTimeoutDuration {
tasksTimeoutErr = true
}
if ps.Timeouts.Tasks.Duration == config.NoTimeoutDuration && timeout != config.NoTimeoutDuration {
Expand All @@ -265,7 +265,7 @@ func (ps *PipelineRunSpec) validatePipelineTimeout(timeout time.Duration, errorM
if ps.Timeouts.Finally != nil {
finallyTimeoutErr := false
finallyTimeoutStr := ps.Timeouts.Finally.Duration.String()
if ps.Timeouts.Finally.Duration > timeout {
if ps.Timeouts.Finally.Duration > timeout && timeout != config.NoTimeoutDuration {
finallyTimeoutErr = true
}
if ps.Timeouts.Finally.Duration == config.NoTimeoutDuration && timeout != config.NoTimeoutDuration {
Expand Down
32 changes: 32 additions & 0 deletions pkg/apis/pipeline/v1beta1/pipelinerun_validation_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1054,6 +1054,38 @@ func TestPipelineRunWithTimeout_Validate(t *testing.T) {
},
},
},
}, {
name: "timeouts.tasks only",
pr: v1beta1.PipelineRun{
ObjectMeta: metav1.ObjectMeta{
Name: "pipelinelinename",
},
Spec: v1beta1.PipelineRunSpec{
PipelineRef: &v1beta1.PipelineRef{
Name: "prname",
},
Timeouts: &v1beta1.TimeoutFields{
Pipeline: &metav1.Duration{Duration: 0 * time.Hour},
Tasks: &metav1.Duration{Duration: 30 * time.Minute},
},
},
},
}, {
name: "timeouts.finally only",
pr: v1beta1.PipelineRun{
ObjectMeta: metav1.ObjectMeta{
Name: "pipelinelinename",
},
Spec: v1beta1.PipelineRunSpec{
PipelineRef: &v1beta1.PipelineRef{
Name: "prname",
},
Timeouts: &v1beta1.TimeoutFields{
Pipeline: &metav1.Duration{Duration: 0 * time.Hour},
Finally: &metav1.Duration{Duration: 30 * time.Minute},
},
},
},
}}

for _, ts := range tests {
Expand Down