Latest revision as of 05:45, 29 April 2022

External

https://tekton.dev

Internal

Overview

Tekton is a cloud-native solution for building CI/CD pipelines. Tekton installs and runs as an extension on your Kubernetes cluster and uses the well-established Kubernetes resource model. Tekton workloads execute inside Kubernetes containers. It is implemented as a set of Kubernetes Custom Resources. It has several components: Tekton Pipelines, Tekton CLI and Tekton Catalog. Once deployed, Tekton can be accessed via Tekton CLI commands or API calls. Tekton is part of the CD Foundation, a Linux Foundation project.

Tekton Runtime Model

Tekton Pipelines tracks the state of a pipeline using Kubernetes annotations, which are projected inside each step container in the form of files with the Kubernetes Downward API. The step container entrypoint binary watches these projected files and will only start the command the step is supposed to execute only if a specific annotation appears as file. For more details see:

Tekton Labels and Annotations

In addition, Tekton Pipelines schedules some containers to run automatically before and after the step containers to support built-in features such as the retrieval of input resources and the uploading the outputs to wherever they are supposed to go.

Task

Task

ClusterTask

A task is available in a certain namespace, while a ClusterTask is available across the entire cluster. A ClusterTask behaves identically to a task. When declaring a ClusterTask in the pipeline definition, the kind sub-field of the taskRef should be explicitly set to ClusterTask. If not specified, kind defaults to Task.

apiVersion: tekton.dev/v1beta1
kind: Pipeline
metadata:
[...]
spec:
  tasks:
    - name: some-cluster-task
      taskRef:
        name: some-task
        kind: ClusterTask
 ...

Custom Task and Run

Custom Task and Run

Step

Step

TaskRun

Include discussion on pod templates:

TaskRun

Pipeline

Pipeline

PipelineRun

PipelineRun

Workspaces

Workspaces

Resource

Resources

Result

Results

Events

Events

Bundles

Bundles

Parameters

Parameters

Resource Management

This section contains a discussion on LimitRange.

Resource Management

Security

Security

Metrics

Tekton Metrics

Hermetic Builds

https://tekton.dev/docs/pipelines/hermetic/

Conditions

https://tekton.dev/docs/pipelines/conditions/

Conditions are deprecated, use when expressions instead.

Programming Model

Process Task Authoring Recommendations: https://github.com/tektoncd/catalog/blob/main/recommendations.md

Variables

TO PROCESS:

https://tekton.dev/docs/pipelines/variables/
https://tekton.dev/docs/pipelines/tasks/#using-variable-substitution
Variables available in a Task https://tekton.dev/docs/pipelines/variables/#variables-available-in-a-task
Variables available in a Pipeline https://tekton.dev/docs/pipelines/variables/#variables-available-in-a-pipeline
Fields that accept variable substitutions: https://tekton.dev/docs/pipelines/variables/#fields-that-accept-variable-substitutions
Using variable substitution in pipelines: https://tekton.dev/docs/pipelines/pipelines/#using-variable-substitution

Code Examples

Code Examples: https://tekton.dev/docs/pipelines/tasks/#code-examples
Code Examples: https://github.com/tektoncd/pipeline/tree/main/examples
TaskRun code examples: https://tekton.dev/docs/pipelines/taskruns/#code-examples
https://github.com/tektoncd/pipeline/blob/release-v0.35.x/examples/v1beta1/taskruns/run-steps-as-non-root.yaml
Pipeline code examples: https://github.com/tektoncd/pipeline/tree/main/examples
Variable substitution: https://tekton.dev/docs/pipelines/tasks/#using-variable-substitution

Start the list here:

How to do this
How to do that

Playground

https://github.com/ovidiuf/playground/tree/master/tekton

Tekton Components

Tekton Pipelines

https://github.com/tektoncd/pipeline/blob/main/docs/README.md

Tekton Pipelines is the component that implements the core functionality of Tekton and sets the foundation for other components. It is implemented as a set of Kubernetes Custom Resources.

Tekton Pipeline Runtime

Tekton Pipelines Controller

Tekton Pipelines Webhook

Tekton Pipeline Operations

Installation

Tekton CLI

Tekton CLI

Tekton API

Tekton APIs are currently available for Pipelines and Triggers allow you to programmatically interact with the Tekton components.

Tekton Catalog

Tekton Catalog

Tekton Hub

Tekton Hub

Tekton Triggers

Tekton Triggers

Tekton Dashboard

Tekton Dashboard

Tekton Operator

Tekton Operator

HA Support

Tekton Operations | HA Support

@@ Line 1: / Line 1: @@
+=External=
+* https://tekton.dev
 =Internal=
 * [[Tekton#Subjects|Tekton]]
@@ Line 5: / Line 7: @@
 =Overview=
-Tekton is a cloud-native solution for building CI/CD pipelines. Tekton installs and runs as an extension on your Kubernetes cluster and uses the well-established Kubernetes resource model. Tekton workloads execute inside Kubernetes containers. It has several components: [[#Tekton_Pipelines|Tekton Pipelines]], [[#Tekton_CLI|Tekton CLI]] and [[#Tekton_Catalog|Tekton Catalog]]. Tekton is part of the [https://cd.foundation/ CD Foundation], a [https://www.linuxfoundation.org/projects/ Linux Foundation] project. It is implemented as a set of Kubernetes [[Kubernetes_Custom_Resources#Overview|Custom Resources]]. Once deployed, Tekton can be accessed via [[#Tekton_CLI|Tekton CLI]] commands or API calls.
+Tekton is a cloud-native solution for building CI/CD pipelines. Tekton installs and runs as an extension on your Kubernetes cluster and uses the well-established Kubernetes resource model. Tekton workloads execute inside Kubernetes containers. It is implemented as a set of Kubernetes [[Kubernetes_Custom_Resources#Overview|Custom Resources]]. It has several components: [[#Tekton_Pipelines|Tekton Pipelines]], [[#Tekton_CLI|Tekton CLI]] and [[#Tekton_Catalog|Tekton Catalog]]. Once deployed, Tekton can be accessed via [[#Tekton_CLI|Tekton CLI]] commands or API calls. Tekton is part of the [https://cd.foundation/ CD Foundation], a [https://www.linuxfoundation.org/projects/ Linux Foundation] project.
+=Tekton Runtime Model=
+[[#Tekton_Pipelines|Tekton Pipelines]] tracks the state of a [[Tekton_Pipeline#Overview|pipeline]] using [[Kubernetes_Labels_and_Annotations#Annotations|Kubernetes annotations]], which are projected inside each [[Tekton_Step#Step_Container|step container]] in the form of files with the [[Kubernetes_Downward_API_Concepts#Overview|Kubernetes Downward API]].  The step container entrypoint binary watches these projected files and will only start the command the step is supposed to execute only if a specific annotation appears as file. For more details see: {{Internal|Tekton_Labels_and_Annotations#Overview|Tekton Labels and Annotations}}
-=Tekton Domain Model=
+In addition, Tekton Pipelines schedules some containers to run automatically before and after the step containers to support built-in features such as the retrieval of input resources and the uploading the outputs to wherever they are supposed to go.
-==Task==
-{{External|https://github.com/tektoncd/pipeline/blob/main/docs/tasks.md}}
-A '''task''' defines a series of ordered [[#Step|steps]], which are executed in order in which they are declared. The output of a step can be used as the input of the next step. Each task executes in its own Kubernetes pod, where individual [[#Step|steps]] are executed as pod's containers, so by default, tasks within a [[#Pipeline|pipeline]] do not share data. To make tasks share data, they must be explicitly configured to make their outputs available to the next task, and to ingest the outputs of a previously executed task, as inputs. The task is implemented as a Kubernetes custom resource.
+=Task=
+{{Internal|Tekton Task|Task}}
+==ClusterTask==
+A [[#Task|task]] is available in a certain namespace, while a ClusterTask is available across the entire cluster. A ClusterTask behaves identically to a task. When declaring a ClusterTask in the pipeline definition, the <code>kind</code> sub-field of the <code>taskRef</code> should be explicitly set to <code>ClusterTask</code>. If not specified, <code>kind</code> defaults to <code>Task</code>.
 <syntaxhighlight lang='yaml'>
 apiVersion: tekton.dev/v1beta1
-kind: Task
+kind: Pipeline
 metadata:
-  name: hello
+[...]
 spec:
-   steps:
+   tasks:
-     - name: echo
+     - name: some-cluster-task
-       image: alpine
+       taskRef:
-      script: |
+        name: some-task
-         #!/bin/sh
+         kind: ClusterTask
-        echo "Hello World"
+ ...
 </syntaxhighlight>
-===Task Operations===
-* [[Tekton_Operations#List_Tasks|List tasks]]
-==Step==
+==Custom Task and Run==
-A '''step''' is an operation in a CI/CD workflow. An example is Java compilation or execution of unit tests. Each step is performed within a container image provided when the step is defined. A step processes a set of [[#Input|inputs]] and produces a set of [[#Output|outputs]]. Steps do not exist in isolation, they are part of [[#Task|tasks]], and they are executed as running containers with the task's pod. As such, a task's steps may share a volume, that allows them to exchange data.
+{{Internal|Tekton_Custom_Task_and_Run|Custom Task and Run}}
-==TaskRun==
+=Step=
-{{External|https://github.com/tektoncd/pipeline/blob/main/docs/taskruns.md}}
+{{Internal|Tekton Step|Step}}
+=TaskRun=
+Include discussion on [[Tekton_TaskRun#Pod_Template|pod templates]]:
+{{Internal|Tekton TaskRun#Overview|TaskRun}}
-A '''task run''' (or '''taskRun''') instantiates a specific [[#Task|task]] to execute on a particular set of [[#Input|inputs]] and produce a particular set of [[#Output|outputs]], within specific conditions (for example, build flags). A task run connects [[#Resource|resources]] with [[#Task|tasks]].
+=Pipeline=
+{{Internal|Tekton Pipeline#Overview|Pipeline}}
+=PipelineRun=
+{{Internal|Tekton_PipelineRun#Overview|PipelineRun}}
+=<span id='Workspace'></span>Workspaces=
+{{Internal|Tekton Workspaces#Overview|Workspaces}}
-<syntaxhighlight lang='yaml'>
+=<span id='Input_Resource'></span><span id='Output_Resource'></span><span id='PipelineResource'></span><span id='Input'></span><span id='Output'></span>Resource=
-apiVersion: tekton.dev/v1beta1
+{{Internal|Tekton Resource#Overview|Resources}}
-kind: TaskRun
-metadata:
-  name: hello-task-run
-spec:
-  taskRef:
-    name: hello
-</syntaxhighlight>
-===TaskRun Operations===
-* [[Tekton_Operations#List_TaskRuns|List taskruns]]
-* [[Tekton_Operations#Display_Execution_Log_of_a_TaskRun|Display execution log of a taskrun]]
-==Pipeline==
+=Result=
-{{External|https://github.com/tektoncd/pipeline/blob/main/docs/README.md}}
+{{Internal|Tekton_Results#Overview|Results}}
-{{External|https://github.com/tektoncd/pipeline/blob/main/docs/pipelines.md}}
-A '''pipeline''' defines a series of ordered [[#Task|tasks]]. Just like [[#Step|steps]], a task in a pipeline can use as [[#Input|input]] the [[#Output|output]] of a previously executed task. Tekton collects all the tasks, and based on the dependency relationships declared in definition of the pipeline, it orders the tasks in a [[Graph_Concepts#Directed_Acyclic_Graph_.28DAG.29|DAG]], and executes the graph in sequence. That results in the materialization of a number of task pods. The pipeline comes up with additional features, such as the capability to fan-out task execution, retry task execution or verify conditions that tasks must meet before proceeding. The pipeline is implemented as a Kubernetes custom resource.
-<syntaxhighlight lang='yaml'>
+=<span id='Event'></span>Events=
-apiVersion: tekton.dev/v1beta1
+{{Internal|Tekton Events|Events}}
-kind: Task
-metadata:
-  name: task1
-spec:
-  steps:
-    - name: echo
-      image: alpine
-      script: |
-        #!/bin/sh
-        echo "this is Task 1 output"
----
-apiVersion: tekton.dev/v1beta1
-kind: Task
-metadata:
-  name: task2
-spec:
-  steps:
-    - name: echo
-      image: alpine
-      script: |
-        #!/bin/sh
-        echo "this is Task 2 output"
----
-apiVersion: tekton.dev/v1beta1
-kind: Pipeline
-metadata:
-  name: simple-pipeline
-spec:
-  tasks:
-    - name: task1
-      taskRef:
-        name: task1
-    - name: task2
-      runAfter:
-        - task1
-      taskRef:
-        name: task2
-</syntaxhighlight>
-==PipelineRun==
-{{External|https://github.com/tektoncd/pipeline/blob/main/docs/pipelineruns.md}}
-A '''pipeline run''' (or '''pipelineRun''') instantiates a specific [[#Pipeline|pipeline]] to execute on a particular set of [[#Input|inputs]] and produce a particular set of [[#Output|outputs]].
+=<span id='Bundle'></span>Bundles=
+{{Internal|Tekton Bundle#Overview|Bundles}}
+=Parameters=
+{{Internal|Tekton_Parameters|Parameters}}
+=<span id='LimitRange'></span>Resource Management=
+This section contains a discussion on [[Tekton_Resource_Management#LimitRange|LimitRange]].
+{{Internal|Tekton Resource Management#Overview|Resource Management}}
-<syntaxhighlight lang='yaml'>
+=Security=
-apiVersion: tekton.dev/v1beta1
+{{Internal|Tekton_Security|Security}}
-kind: PipelineRun
+=Metrics=
-metadata:
+{{Internal|Tekton Metrics#Overview|Tekton Metrics}}
-  name: simple-pipeline-run
+=Hermetic Builds=
-spec:
+{{External|https://tekton.dev/docs/pipelines/hermetic/}}
-  pipelineRef:
+=Conditions=
-    name: simple-pipeline
+{{External|https://tekton.dev/docs/pipelines/conditions/}}
-</syntaxhighlight>
+Conditions are deprecated, use <code>[[Tekton_Pipeline#Conditional_Execution_with_when|when]]</code> expressions instead.
-===PipelineRun Operations===
-* [[Tekton_Operations#List_PipelineRuns|List pipelinerun]]
-* [[Tekton_Operations#Display_Execution_Log_of_a_PipelineRun|Display execution log of a pipelinerun]]
-==Trigger==
+=Programming Model=
-Implemented as part of the [[#Tekton_Triggers|Tekton Triggers]] component.
+<font color=darkkhaki>
-==Resource==
+Process Task Authoring Recommendations: https://github.com/tektoncd/catalog/blob/main/recommendations.md
-Resources are used to share data between [[#Step|steps]] and [[#Task|tasks]], and depending on which direction they are looked at, the can be [[#Input|input]] or [[#Output|output]] resources. Example of resources:
+</font>
-* git repository
+==<span id='Variable_Substitution'><span>Variables==
-* a pull request
+<font color=darkkhaki>TO PROCESS:
-* a container image
+* https://tekton.dev/docs/pipelines/variables/
-* a Kubernetes cluster
+* https://tekton.dev/docs/pipelines/tasks/#using-variable-substitution
-* storage: an object, a directory, etc.
+* Variables available in a Task https://tekton.dev/docs/pipelines/variables/#variables-available-in-a-task
-* a [[CloudEvents|CloudEvent]]
+* Variables available in a Pipeline https://tekton.dev/docs/pipelines/variables/#variables-available-in-a-pipeline
-===<span id='Input'></span>Input Resource===
+* Fields that accept variable substitutions: https://tekton.dev/docs/pipelines/variables/#fields-that-accept-variable-substitutions
-The input is defined relative to a [[#Step|step]]. Examples of input resources are: git repository.
+* Using variable substitution in pipelines: https://tekton.dev/docs/pipelines/pipelines/#using-variable-substitution
+</font>
-===<span id='Output'></span>Output Resource===
+==Code Examples==
-The output is defined relative to a [[#Step|step]]. Examples of output resources: container image.
+<font color=darkkhaki>
+* Code Examples: https://tekton.dev/docs/pipelines/tasks/#code-examples
+* Code Examples: https://github.com/tektoncd/pipeline/tree/main/examples
+* TaskRun code examples: https://tekton.dev/docs/pipelines/taskruns/#code-examples
+* https://github.com/tektoncd/pipeline/blob/release-v0.35.x/examples/v1beta1/taskruns/run-steps-as-non-root.yaml
+* Pipeline code examples: https://github.com/tektoncd/pipeline/tree/main/examples
+* Variable substitution: https://tekton.dev/docs/pipelines/tasks/#using-variable-substitution
+Start the list here:
+* How to do this
+* How to do that
+</font>
+=Playground=
+{{External|https://github.com/ovidiuf/playground/tree/master/tekton}}
 =Tekton Components=
 ==Tekton Pipelines==
@@ Line 140: / Line 114: @@
 ==Tekton CLI==
-{{External|https://github.com/tektoncd/cli/blob/main/README.md}}
+{{Internal|Tekton_CLI#Overview|Tekton CLI}}
-Tekton CLI provides the command interface called <code>tkn</code>.
-===Tekton CLI Operations===
-* [[Tekton_Operations#Tekton_CLI_Installation|Installation]]
 ==Tekton API==
 Tekton APIs are currently available for [[#Pipeline|Pipelines]] and [[#Trigger|Triggers]] allow you to programmatically interact with the Tekton components.
 ==Tekton Catalog==
-{{External|https://github.com/tektoncd/catalog/blob/v1beta1/README.md}}
+{{Internal|Tekton_Catalog#Overview|Tekton Catalog}}
-Tekton Catalog is a repository of community-contributed Tekton [[#Building_Block|building blocks]].
 ==Tekton Hub==
-{{External|https://hub.tekton.dev}}
+{{Internal|Tekton_Hub#Overview|Tekton Hub}}
-{{External|https://github.com/tektoncd/hub/blob/main/README.md}}
-Tekton Hub is a web GUI to access [[#Tekton_Catalog|Tekton Catalog]].
-==Tekton Triggers==
+==<span id='Trigger'></span>Tekton Triggers==
-{{External|https://github.com/tektoncd/triggers/blob/main/README.md}}
+{{Internal|Tekton_Triggers#Overview|Tekton Triggers}}
-Tekton Triggers provide [[#Trigger|triggers]], which allow instantiating pipelines based on events (a PR merge, etc.)
 ==Tekton Dashboard==
-{{External|https://github.com/tektoncd/dashboard/blob/main/README.md}}
+{{Internal|Tekton_Dashboard#Overview|Tekton Dashboard}}
-Tekton Dashboard is the web GUI that displays information about pipeline execution.
 ==Tekton Operator==
-{{External|https://github.com/tektoncd/operator/blob/main/README.md}}
+{{Internal|Tekton_Operator#Overview|Tekton Operator}}
-Tekton Operator is the implementation of the [[Kubernetes Operators Concepts|Kubernetes Operator pattern]] that assists with the operation of the Tekton projects.
-=Building Block=
+==HA Support==
-Tekton documentation refers to "building blocks". <font color=darkkhaki>Those are ... </font>
+{{Internal|Tekton_Operations#HA_Support|Tekton Operations &#124; HA Support}}

Tekton Concepts: Difference between revisions

Latest revision as of 05:45, 29 April 2022

External

Internal

Overview

Tekton Runtime Model

Task

ClusterTask

Custom Task and Run

Step

TaskRun

Pipeline

PipelineRun

Workspaces

Resource

Result

Events

Bundles

Parameters

Resource Management

Security

Metrics

Hermetic Builds

Conditions

Programming Model

Variables

Code Examples

Playground

Tekton Components

Tekton Pipelines

Tekton Pipeline Runtime

Tekton Pipelines Controller

Tekton Pipelines Webhook

Tekton Pipeline Operations

Tekton CLI

Tekton API

Tekton Catalog

Tekton Hub

Tekton Triggers

Tekton Dashboard

Tekton Operator

HA Support

Navigation menu

Search