-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[TEP-0056]: Initial set of API refactors pertinent to Pipelines in Pi…
…pelines This is the first of many commits to begin implementing TEP-0056 - Added PipelineRef and PipelineSpec to PipelineTask - Updated and added pipeline validation tests to reflect the above additions - Updated and added pipeline type tests to reflect the above additions - Added a initial set of docs and examples using the existing proposal - The changes in this PR does not change existing behavior and merely introduces fields to existing types Note: Pipelines in Pipelines is not yet implemented Signed-off-by: Priti Desai <[email protected]>
- Loading branch information
1 parent
c887347
commit bf2597e
Showing
17 changed files
with
1,819 additions
and
47 deletions.
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
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,115 @@ | ||
| <!-- | ||
| --- | ||
| linkTitle: "Pipelines in Pipelines" | ||
| weight: 406 | ||
| --- | ||
| --> | ||
|
|
||
| # Pipelines in Pipelines | ||
|
|
||
| - [Overview](#overview) | ||
| - [Specifying `pipelineRef` in `Tasks`](#specifying-pipelineref-in-pipelinetasks) | ||
| - [Specifying `pipelineSpec` in `Tasks`](#specifying-pipelinespec-in-pipelinetasks) | ||
| - [Specifying `Parameters`](#specifying-parameters) | ||
|
|
||
| ## Overview | ||
|
|
||
| A mechanism to define and execute Pipelines in Pipelines, alongside Tasks and Custom Tasks, for a more in-depth background and inspiration, refer to the proposal [TEP-0056](https://github.com/tektoncd/community/blob/main/teps/0056-pipelines-in-pipelines.md "Proposal"). | ||
|
|
||
| > :seedling: **Pipelines in Pipelines is an [alpha](additional-configs.md#alpha-features) feature.** | ||
| > The `enable-api-fields` feature flag must be set to `"alpha"` to specify `pipelineRef` or `pipelineSpec` in a `pipelineTask`. | ||
| > This feature is in Preview Only mode and not yet supported/implemented. | ||
| ## Specifying `pipelineRef` in `pipelineTasks` | ||
|
|
||
| Defining Pipelines in Pipelines at authoring time, by either specifying `PipelineRef` or `PipelineSpec` fields to a `PipelineTask` alongside `TaskRef` and `TaskSpec`. | ||
|
|
||
| For example, a Pipeline named security-scans which is run within a Pipeline named clone-scan-notify where the PipelineRef is used: | ||
|
|
||
| ``` | ||
| apiVersion: tekton.dev/v1 | ||
| kind: Pipeline | ||
| metadata: | ||
| name: security-scans | ||
| spec: | ||
| tasks: | ||
| - name: scorecards | ||
| taskRef: | ||
| name: scorecards | ||
| - name: codeql | ||
| taskRef: | ||
| name: codeql | ||
| --- | ||
| apiVersion: tekton.dev/v1 | ||
| kind: Pipeline | ||
| metadata: | ||
| name: clone-scan-notify | ||
| spec: | ||
| tasks: | ||
| - name: git-clone | ||
| taskRef: | ||
| name: git-clone | ||
| - name: security-scans | ||
| pipelineRef: | ||
| name: security-scans | ||
| - name: notification | ||
| taskRef: | ||
| name: notification | ||
| ``` | ||
|
|
||
| ## Specifying `pipelineSpec` in `pipelineTasks` | ||
|
|
||
| The `pipelineRef` [example](#specifying-pipelineref-in-pipelinetasks) can be modified to use PipelineSpec instead of PipelineRef to instead embed the Pipeline specification: | ||
| ``` | ||
| apiVersion: tekton.dev/v1 | ||
| kind: Pipeline | ||
| metadata: | ||
| name: clone-scan-notify | ||
| spec: | ||
| tasks: | ||
| - name: git-clone | ||
| taskRef: | ||
| name: git-clone | ||
| - name: security-scans | ||
| pipelineSpec: | ||
| tasks: | ||
| - name: scorecards | ||
| taskRef: | ||
| name: scorecards | ||
| - name: codeql | ||
| taskRef: | ||
| name: codeql | ||
| - name: notification | ||
| taskRef: | ||
| name: notification | ||
| ``` | ||
|
|
||
| ## Specifying `Parameters` | ||
|
|
||
| Pipelines in Pipelines consume Parameters in the same way as Tasks in Pipelines | ||
| ``` | ||
| apiVersion: tekton.dev/v1 | ||
| kind: Pipeline | ||
| metadata: | ||
| name: clone-scan-notify | ||
| spec: | ||
| params: | ||
| - name: repo | ||
| value: $(params.repo) | ||
| tasks: | ||
| - name: git-clone | ||
| params: | ||
| - name: repo | ||
| value: $(params.repo) | ||
| taskRef: | ||
| name: git-clone | ||
| - name: security-scans | ||
| params: | ||
| - name: repo | ||
| value: $(params.repo) | ||
| pipelineRef: | ||
| name: security-scans | ||
| - name: notification | ||
| taskRef: | ||
| name: notification | ||
| ``` |
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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.