diff --git a/docs/auth.md b/docs/auth.md index 00490bd5f5f..2e147823d22 100644 --- a/docs/auth.md +++ b/docs/auth.md @@ -1,9 +1,10 @@ + # Authentication at Run Time This document describes how Tekton handles authentication when executing diff --git a/docs/bundle-resolver.md b/docs/bundle-resolver.md index 8cc71821edb..c25393ed18e 100644 --- a/docs/bundle-resolver.md +++ b/docs/bundle-resolver.md @@ -1,3 +1,10 @@ + + # Bundles Resolver ## Resolver Type diff --git a/docs/cluster-resolver.md b/docs/cluster-resolver.md index 3e39702a0be..7dc656b67b3 100644 --- a/docs/cluster-resolver.md +++ b/docs/cluster-resolver.md @@ -1,3 +1,10 @@ + + # Cluster Resolver ## Resolver Type diff --git a/docs/compute-resources.md b/docs/compute-resources.md index fd8af332fc3..9765e05a0d2 100644 --- a/docs/compute-resources.md +++ b/docs/compute-resources.md @@ -1,7 +1,7 @@ diff --git a/docs/conditions.md b/docs/conditions.md deleted file mode 100644 index 7998558fe0a..00000000000 --- a/docs/conditions.md +++ /dev/null @@ -1,16 +0,0 @@ - -# Conditions - -**Note:** `Conditions` have been removed as of Pipeline 0.37.0, use [`when` expressions](pipelines.md#guard-task-execution-using-when-expressions) instead. - ---- - -Except as otherwise noted, the content of this page is licensed under the -[Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/), -and code samples are licensed under the -[Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0). diff --git a/docs/container-contract.md b/docs/container-contract.md index bee8a2c315b..de857770091 100644 --- a/docs/container-contract.md +++ b/docs/container-contract.md @@ -1,9 +1,10 @@ + # Container Contract Each container image that executes a `Step` in a [`Task`](tasks.md) must diff --git a/docs/customruns.md b/docs/customruns.md index dbdfdc0d50e..eeaa314cec6 100644 --- a/docs/customruns.md +++ b/docs/customruns.md @@ -1,7 +1,7 @@ diff --git a/docs/debug.md b/docs/debug.md index 0e729577e8c..ff3d62a9ff4 100644 --- a/docs/debug.md +++ b/docs/debug.md @@ -1,9 +1,10 @@ + # Debug - [Overview](#overview) @@ -82,4 +83,4 @@ to reflect step number. eg: Step 0 will have `/tekton/debug/info/0`, Step 1 will breakpoint for failed step 0. Running this script would create `/tekton/run/0` and `/tekton/run/0.breakpointexit`. `/tekton/debug/scripts/debug-fail-continue` : Mark the step as completed with failure by writing to `/tekton/run`. eg: User wants to exit -breakpoint for failed step 0. Running this script would create `/tekton/run/0.err` and `/tekton/run/0.breakpointexit`. \ No newline at end of file +breakpoint for failed step 0. Running this script would create `/tekton/run/0.err` and `/tekton/run/0.breakpointexit`. diff --git a/docs/deprecations.md b/docs/deprecations.md index a15cfaf878c..bec63960871 100644 --- a/docs/deprecations.md +++ b/docs/deprecations.md @@ -1,7 +1,7 @@ @@ -36,4 +36,4 @@ See [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-depreca - The [kubeconfigwriter](https://github.com/tektoncd/pipeline/blob/release-v0.43.x/pkg/apis/pipeline/images.go#L36) and [imagedigestexporter](https://github.com/tektoncd/pipeline/blob/release-v0.43.x/pkg/apis/pipeline/images.go#L46) images, used by the Cluster PipelineResource and Image PipelineResource, respectively -- The [`tekton_pipelines_controller_cloudevent_count`](https://github.com/tektoncd/pipeline/blob/main/docs/metrics.md) metric \ No newline at end of file +- The [`tekton_pipelines_controller_cloudevent_count`](https://github.com/tektoncd/pipeline/blob/main/docs/metrics.md) metric diff --git a/docs/enabling-ha.md b/docs/enabling-ha.md index ba68fc7690a..521f0e957e0 100644 --- a/docs/enabling-ha.md +++ b/docs/enabling-ha.md @@ -1,7 +1,7 @@ diff --git a/docs/events.md b/docs/events.md index 6b5a36fc211..6a2a3eec6a5 100644 --- a/docs/events.md +++ b/docs/events.md @@ -1,9 +1,10 @@ + # Events in Tekton Tekton's controllers emits [Kubernetes events](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#event-v1-core) diff --git a/docs/git-resolver.md b/docs/git-resolver.md index e8c94e45f43..d0e7348d07f 100644 --- a/docs/git-resolver.md +++ b/docs/git-resolver.md @@ -1,3 +1,10 @@ + + # Simple Git Resolver ## Resolver Type diff --git a/docs/hermetic.md b/docs/hermetic.md index 5b4287fc66f..1fd75d90ba0 100644 --- a/docs/hermetic.md +++ b/docs/hermetic.md @@ -1,9 +1,10 @@ + # Hermetic Execution Mode A Hermetic Build is a release engineering best practice for increasing the reliability and consistency of software builds. They are self-contained, and do not depend on anything outside of the build environment. diff --git a/docs/how-to-write-a-resolver.md b/docs/how-to-write-a-resolver.md index 9ccafbce9c7..5afb80c482b 100644 --- a/docs/how-to-write-a-resolver.md +++ b/docs/how-to-write-a-resolver.md @@ -1,6 +1,13 @@ -# How To Write a Resolver + + +# How to write a Resolver -This howto will outline the steps a developer needs to take when creating +This how-to will outline the steps a developer needs to take when creating a new (very basic) Resolver. Rather than focus on support for a particular version control system or cloud platform this Resolver will simply respond with with some hard-coded YAML. diff --git a/docs/hub-resolver.md b/docs/hub-resolver.md index beba8b926d8..f635faf1c36 100644 --- a/docs/hub-resolver.md +++ b/docs/hub-resolver.md @@ -1,3 +1,10 @@ + + # Hub Resolver Use resolver type `hub`. diff --git a/docs/install.md b/docs/install.md index e4f209bdb04..1f3dbaece3f 100644 --- a/docs/install.md +++ b/docs/install.md @@ -1,7 +1,7 @@ + # Labels and Annotations Tekton allows you to use custom [Kubernetes Labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) diff --git a/docs/logs.md b/docs/logs.md index 2dd3295924b..0f7046c9b34 100644 --- a/docs/logs.md +++ b/docs/logs.md @@ -1,9 +1,10 @@ + # Execution Logs Tekton stores execution logs for [`TaskRuns`](taskruns.md) and [`PipelineRuns`](pipelineruns.md) within diff --git a/docs/matrix.md b/docs/matrix.md index d4f991651a0..ff446029640 100644 --- a/docs/matrix.md +++ b/docs/matrix.md @@ -1,7 +1,7 @@ diff --git a/docs/metrics.md b/docs/metrics.md index 06eb6e0467e..7471cd724c5 100644 --- a/docs/metrics.md +++ b/docs/metrics.md @@ -1,9 +1,10 @@ + # Pipeline Controller Metrics The following pipeline metrics are available at `controller-service` on port `9090`. diff --git a/docs/migrating-from-knative-build.md b/docs/migrating-from-knative-build.md deleted file mode 100644 index 723c978c351..00000000000 --- a/docs/migrating-from-knative-build.md +++ /dev/null @@ -1,145 +0,0 @@ - -# Migrating from Knative Build - -Tekton Pipelines is the technological successor to [Knative Build](https://github.com/knative/build). Tekton -entities are based on Knative Build's entities but provide additional flexibility and reusability. This page -explains how to convert your Knative Build entities to Tekton entities of equivalent functionality. - -The table below lists the mapping between the old and new entities: - -| **Knative Build Entity** | **Tekton Entity** | -|--------------------------|--------------------| -| `Build` | `TaskRun` | -| `BuildTemplate` | `Task` | -| `ClusterBuildTemplate` | `ClusterTask` | - -## Conversion guidelines - -Follow the guidelines below when converting your Knative Build entities to Tekton entities: - -* All `steps` must specify a `name` value. - -* `BuildTemplate` [parameters](tasks.md#specifying-parameters) now reside inside the `input.params` field of a `Task`. In a - related change, parameter placeholders, such as `${FOO}`, now follow the format `$(input.parameters.FOO)`. For more information, - see [Using variable substitution](tasks.md#using-variable-substitution). - -* `Tasks` that ingest inputs from resources must now explicitly specify [`input.resources`](tasks.md#specifying-resources). - `BuildTemplates` did not explicitly specify input resources and just assumed those resources were always available. - -* Input resource data is no longer cloned into the `/workspace` directory. Instead, Tekton clones the data into a subdirectory - of your choice within the `/workspace` directory. You must specify this subdirectory using the `name` field in your input - resource definition. For example, if you specify a `git` resource named `foo`, Tekton clones the data into `/workspace/foo`. - Due to this change, we highly recommend that you set `workingDir: /workspace/foo` in the affected `steps` within your `Task`. - For more information, see [Controlling where resources are mounted](resources.md#controlling-where-resources-are-mounted). - -* `TaskRuns` which specify a `PipelineResource` as the value of the `input.resources` field of the invoked `Task` - can do so either by referencing an existing `PipelineResource` using the `resourceRef` field or by embedding - a complete `PipelineResource` definition using the [`resourceSpec`](taskruns.md#specifying-resources) field. - - > :warning: **`PipelineResources` are [deprecated](deprecations.md#deprecation-table).** - > - > Consider using replacement features instead. Read more in [documentation](migrating-v1alpha1-to-v1beta1.md#replacing-pipelineresources-with-tasks) - > and [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-deprecate-pipelineresources.md). - -* Containers that execute the `Steps` in your `Tasks` must now abide by Tekton's [container contract](container-contract.md) - and are now serialized without relying on init containers. Because of this, we highly recommend - that for each `Step` within your `Task` you specify a `command` value instead of an `entrypoint` and `args` pair. - -## Code examples - -Study the following code examples to better understand the conversion of entities described earlier in this document. - -### Converting a `BuildTemplate` to a `Task` - -This example `BuildTemplate` runs `go test`. - -``` -apiVersion: build.knative.dev/v1alpha1 -kind: BuildTemplate -metadata: - name: go-test -spec: - parameters: - - name: TARGET - description: The Go target to test - default: ./... - - steps: - - image: golang - args: ['go', 'test', '${TARGET}'] -``` - -Below is an equivalent `Task`. - -``` -apiVersion: tekton.dev/v1beta1 -kind: Task -metadata: - name: go-test -spec: - params: - - name: TARGET - description: The Go target to test - default: ./... - - # The Task must operate on a source, such as a Git repo. - resources: - inputs: - - name: source - type: git - - steps: - - name: go-test # <-- the step must specify a name. - image: golang - workingDir: /workspace/source # <-- set workingdir - command: ['go', 'test', '$(params.TARGET)'] # <-- specify params.TARGET -``` - -### Converting a `Build` to a `TaskRun` - -This example `Build` instantiates and runs the `BuildTemplate` from the previous example. - -``` -apiVersion: build.knative.dev/v1alpha1 -kind: Build -metadata: - name: go-test -spec: - source: - git: - url: https://github.com/my-user/my-repo - revision: master - template: - name: go-test - arguments: - - name: TARGET - value: ./path/to/test/... -``` - -Below is an equivalent `TaskRun`. - -``` -apiVersion: tekton.dev/v1beta1 -kind: TaskRun -metadata: - name: example-run -spec: - taskRef: - name: go-test - params: - - name: TARGET - value: ./path/to/test/... - resources: - inputs: - - name: source - resourceSpec: - type: git - params: - - name: url - value: https://github.com/my-user/my-repo -``` diff --git a/docs/migrating-v1alpha1-to-v1beta1.md b/docs/migrating-v1alpha1-to-v1beta1.md index 5733de3bf9e..bc255b81f5a 100644 --- a/docs/migrating-v1alpha1-to-v1beta1.md +++ b/docs/migrating-v1alpha1-to-v1beta1.md @@ -1,7 +1,7 @@ diff --git a/docs/pipeline-api.md b/docs/pipeline-api.md index 1d8b681187d..ec558e0fcb9 100644 --- a/docs/pipeline-api.md +++ b/docs/pipeline-api.md @@ -2,7 +2,7 @@ --- title: Pipeline API linkTitle: Pipeline API -weight: 1000 +weight: 404 --- --> diff --git a/docs/pipelineresources.md b/docs/pipelineresources.md index a046315e9b5..ace503feb0d 100644 --- a/docs/pipelineresources.md +++ b/docs/pipelineresources.md @@ -1,4 +1,11 @@ -## Replacing `PipelineResources` with `Tasks` + + +## Replacing PipelineResources with Tasks `PipelineResources` remained in alpha while the other resource kinds were promoted to beta. Since then, **`PipelineResources` have been deprecated**. We encourage users to use `Tasks` and other replacement @@ -134,4 +141,4 @@ You can replace a `cluster` resource with the [`kubeconfig-creator` Catalog `Tas ### Replacing a `cloudEvent` resource -You can replace a `cloudEvent` resource with the [`CloudEvent` Catalog `Task`](https://github.com/tektoncd/catalog/tree/main/task/cloudevent). \ No newline at end of file +You can replace a `cloudEvent` resource with the [`CloudEvent` Catalog `Task`](https://github.com/tektoncd/catalog/tree/main/task/cloudevent). diff --git a/docs/pipelineruns.md b/docs/pipelineruns.md index b73d089d843..3f9d617c142 100644 --- a/docs/pipelineruns.md +++ b/docs/pipelineruns.md @@ -1,9 +1,10 @@ + # PipelineRuns diff --git a/docs/pipelines.md b/docs/pipelines.md index 78b161b493b..909e9605f80 100644 --- a/docs/pipelines.md +++ b/docs/pipelines.md @@ -1,9 +1,10 @@ + # Pipelines - [Pipelines](#pipelines) diff --git a/docs/podtemplates.md b/docs/podtemplates.md index 994b0fd385e..cfd4f69245c 100644 --- a/docs/podtemplates.md +++ b/docs/podtemplates.md @@ -1,9 +1,10 @@ + # Pod templates A Pod template defines a portion of a [`PodSpec`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#pod-v1-core) diff --git a/docs/resolution-getting-started.md b/docs/resolution-getting-started.md index aea5284ae5b..e7487081a84 100644 --- a/docs/resolution-getting-started.md +++ b/docs/resolution-getting-started.md @@ -1,4 +1,12 @@ -# Getting Started + + + +# Getting Started with Resolvers ## Introduction diff --git a/docs/resolution.md b/docs/resolution.md index 737bae7d387..06969b8070f 100644 --- a/docs/resolution.md +++ b/docs/resolution.md @@ -1,4 +1,11 @@ -# Tekton Pipeline Remote Resolution Docs + + +# Tekton Pipeline Remote Resolution Remote Resolution is a Tekton feature that allows users to fetch tasks and pipelines from remote sources outside the cluster. Tekton provides a few built-in resolvers that can fetch from git repositories, OCI registries etc as well as a framework for writing custom resolvers. diff --git a/docs/resolver-reference.md b/docs/resolver-reference.md index d0e0062922c..68fa6fc9273 100644 --- a/docs/resolver-reference.md +++ b/docs/resolver-reference.md @@ -1,3 +1,10 @@ + + # Resolver Reference Writing a resolver is made easier with the diff --git a/docs/resources.md b/docs/resources.md index 27e57289cba..96820952dfd 100644 --- a/docs/resources.md +++ b/docs/resources.md @@ -1,9 +1,10 @@ + # PipelineResources > :warning: **`PipelineResources` are [deprecated](deprecations.md#deprecation-table).** diff --git a/docs/runs.md b/docs/runs.md index 6173a9bd38f..c6d989d60d2 100644 --- a/docs/runs.md +++ b/docs/runs.md @@ -1,7 +1,7 @@ diff --git a/docs/taskruns.md b/docs/taskruns.md index f85ee183861..5747908b5a3 100644 --- a/docs/taskruns.md +++ b/docs/taskruns.md @@ -1,11 +1,11 @@ -# `TaskRuns` +# TaskRuns - [Overview](#overview) diff --git a/docs/tasks.md b/docs/tasks.md index afad660654e..9ee19a97e63 100644 --- a/docs/tasks.md +++ b/docs/tasks.md @@ -1,9 +1,10 @@ + # Tasks - [Overview](#overview) diff --git a/docs/tekton-bundle-contracts.md b/docs/tekton-bundle-contracts.md index 475b13dbae1..ec507f3b4cd 100644 --- a/docs/tekton-bundle-contracts.md +++ b/docs/tekton-bundle-contracts.md @@ -1,7 +1,7 @@ diff --git a/docs/tekton-controller-performance-configuration.md b/docs/tekton-controller-performance-configuration.md index 70502e7dc9d..5c69553790a 100644 --- a/docs/tekton-controller-performance-configuration.md +++ b/docs/tekton-controller-performance-configuration.md @@ -1,7 +1,7 @@ diff --git a/docs/trusted-resources.md b/docs/trusted-resources.md index 88d97e76813..c11035fab74 100644 --- a/docs/trusted-resources.md +++ b/docs/trusted-resources.md @@ -1,3 +1,10 @@ + + # Trusted Resources - [Overview](#overview) diff --git a/docs/variables.md b/docs/variables.md index d8dd1f42237..26b4668094c 100644 --- a/docs/variables.md +++ b/docs/variables.md @@ -1,9 +1,10 @@ + # Variable Substitutions Supported by `Tasks` and `Pipelines` This page documents the variable substitutions supported by `Tasks` and `Pipelines`. diff --git a/docs/windows.md b/docs/windows.md index 6321e6ae4e2..fc3b39bd1dc 100644 --- a/docs/windows.md +++ b/docs/windows.md @@ -1,3 +1,10 @@ + + # Windows - [Overview](#overview) @@ -99,4 +106,4 @@ spec: operator: In values: - linux -``` \ No newline at end of file +``` diff --git a/docs/workspaces.md b/docs/workspaces.md index e4cd4a1289e..150d2040a8d 100644 --- a/docs/workspaces.md +++ b/docs/workspaces.md @@ -1,9 +1,10 @@ + # Workspaces - [Overview](#overview)