-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
POC: Canceling concurrent PipelineRuns #5501
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| # MacOS file viewer garbage. | ||
| .DS_Store | ||
| *.venv | ||
|
|
||
| # Compiled Object files | ||
| *.slo | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| apiVersion: tekton.dev/v1alpha1 | ||
| kind: ConcurrencyControl | ||
| metadata: | ||
| name: my-concurrency-control | ||
| namespace: concurrency | ||
| spec: | ||
| params: | ||
| - name: param-1 | ||
| key: $(params.param-1) | ||
| strategy: Cancel |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| apiVersion: apiextensions.k8s.io/v1 | ||
| kind: CustomResourceDefinition | ||
| metadata: | ||
| name: concurrencycontrols.tekton.dev | ||
| labels: | ||
| app.kubernetes.io/instance: default | ||
| app.kubernetes.io/part-of: tekton-pipelines | ||
| pipeline.tekton.dev/release: "devel" | ||
| version: "devel" | ||
| spec: | ||
| group: tekton.dev | ||
| scope: Namespaced | ||
| names: | ||
| kind: ConcurrencyControl | ||
| plural: concurrencycontrols | ||
| singular: concurrencycontrol | ||
| shortNames: | ||
| - cc | ||
| categories: | ||
| - tekton | ||
| versions: | ||
| - name: v1alpha1 | ||
| served: true | ||
| storage: true | ||
| schema: | ||
| openAPIV3Schema: | ||
| type: object | ||
| x-kubernetes-preserve-unknown-fields: true | ||
| subresources: | ||
| status: {} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| ## Concurrency control primitives | ||
|
|
||
| The "ConcurrencyControl" CRD is used for higher-level systems to control concurrency of PipelineRuns. | ||
| To use concurrency controls, first create an instance of a ConcurrencyControl, for example: | ||
|
|
||
| ```yaml | ||
| apiVersion: tekton.dev/v1alpha1 | ||
| kind: ConcurrencyControl | ||
| metadata: | ||
| name: my-concurrency-control | ||
| spec: | ||
| params: | ||
| - name: param-1 | ||
| - name: param-2 | ||
| key: $(params.param-1)-$(params.param-2) | ||
| strategy: Cancel | ||
| ``` | ||
|
|
||
| The only currently supported strategy is "Cancel", which will patch other PipelineRuns with the same | ||
| concurrency key in the same namespace as Canceled. | ||
| The parameters defined by the ConcurrencyControl should match the parameters declared in the resource | ||
| it applies to (currently, only PipelineRuns are supported). | ||
| The ConcurrencyControl must be in the same namespace as any PipelineRuns using it. | ||
|
|
||
| Next, create your PipelineRun with the label "tekton.dev/concurrency": "insert-name-of-concurrency-control-here". | ||
|
|
||
| The PipelineRun controller will apply a concurrency key label to your PipelineRun. | ||
| For example, for the following PipelineRun: | ||
|
|
||
| ```yaml | ||
| apiVersion: tekton.dev/v1beta1 | ||
| kind: PipelineRun | ||
| metadata: | ||
| labels: | ||
| tekton.dev/concurrency: my-concurrency-control | ||
| spec: | ||
| params: | ||
| - name: param-1 | ||
| value: foo | ||
| - name: param-2 | ||
| value: bar | ||
| ``` | ||
|
|
||
| the controller will apply the label "tekton.dev/concurrency-key": "foo-bar". | ||
| If any PipelineRuns in the same namespace have the same concurrency key, they will be canceled | ||
| before the existing PipelineRun begins running. | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Those would be "populated" by the
PipelineRunparams ?What happens if there is a mismatch between
PipelineRun's params and thatConcurrencyControlparams?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yup!
We would probably fail the PipelineRun (not sure how a separate controller outside of pipelines would do that though) or cancel it.