diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 065af27e64b8..907be6bcdc67 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -74,8 +74,6 @@ Topics: File: using-manual-approval - Name: Using Red Hat entitlements in pipelines File: using-rh-entitlements-pipelines -- Name: Managing non-versioned and versioned cluster tasks - File: managing-nonversioned-and-versioned-cluster-tasks --- Name: Observability in OpenShift Pipelines Dir: records diff --git a/create/creating-applications-with-cicd-pipelines.adoc b/create/creating-applications-with-cicd-pipelines.adoc index 1492e6ac1d16..4a1919b33a94 100644 --- a/create/creating-applications-with-cicd-pipelines.adoc +++ b/create/creating-applications-with-cicd-pipelines.adoc @@ -37,12 +37,6 @@ include::modules/op-creating-project-and-checking-pipeline-service-account.adoc[ include::modules/op-creating-pipeline-tasks.adoc[leveloffset=+1] -[role="_additional-resources"] -[id="additional-resources-creating_{context}"] -.Additional resources - -* xref:../create/managing-nonversioned-and-versioned-cluster-tasks.adoc#managing-nonversioned-and-versioned-cluster-tasks[Managing non-versioned and versioned cluster tasks] - include::modules/op-assembling-a-pipeline.adoc[leveloffset=+1] include::modules/op-mirroring-images-to-run-pipelines-in-restricted-environment.adoc[leveloffset=+1] diff --git a/create/managing-nonversioned-and-versioned-cluster-tasks.adoc b/create/managing-nonversioned-and-versioned-cluster-tasks.adoc deleted file mode 100644 index 87c40401b974..000000000000 --- a/create/managing-nonversioned-and-versioned-cluster-tasks.adoc +++ /dev/null @@ -1,22 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -include::_attributes/common-attributes.adoc[] -[id="managing-nonversioned-and-versioned-cluster-tasks"] -= Managing non-versioned and versioned cluster tasks -:context: managing-nonversioned-and-versioned-cluster-tasks - -toc::[] - -As a cluster administrator, installing the {pipelines-title} Operator creates variants of each default cluster task known as _versioned cluster tasks_ (VCT) and _non-versioned cluster tasks_ (NVCT). For example, installing the {pipelines-title} Operator v1.7 creates a `buildah-1-7-0` VCT and a `buildah` NVCT. - -Both NVCT and VCT have the same metadata, behavior, and specifications, including `params`, `workspaces`, and `steps`. However, they behave differently when you disable them or upgrade the Operator. - -[IMPORTANT] -==== -In {pipelines-title} 1.10, `ClusterTask` functionality is deprecated and is planned to be removed in a future release. -==== - -include::modules/op-differences-between-non-versioned-and-versioned-cluster-tasks.adoc[leveloffset=+1] - -include::modules/op-advantages-and-disadvantages-of-non-versioned-and-versioned-cluster-tasks.adoc[leveloffset=+1] - -include::modules/op-disabling-non-versioned-and-versioned-cluster-tasks.adoc[leveloffset=+1] diff --git a/create/remote-pipelines-tasks-resolvers.adoc b/create/remote-pipelines-tasks-resolvers.adoc index abc4e146f87d..31f482a19b05 100644 --- a/create/remote-pipelines-tasks-resolvers.adoc +++ b/create/remote-pipelines-tasks-resolvers.adoc @@ -85,6 +85,7 @@ include::modules/op-resolver-cluster-tasks-ref.adoc[leveloffset=+1] include::modules/op-resolver-stepactions-ref.adoc[leveloffset=+1] +include::modules/op-resolver-tasks-step-actions-about.adoc[leveloffset=+1] [role="_additional-resources"] [id="additional-resources_{context}"] diff --git a/install_config/customizing-configurations-in-the-tektonconfig-cr.adoc b/install_config/customizing-configurations-in-the-tektonconfig-cr.adoc index c91ca20c1f8a..d271b37a6e56 100644 --- a/install_config/customizing-configurations-in-the-tektonconfig-cr.adoc +++ b/install_config/customizing-configurations-in-the-tektonconfig-cr.adoc @@ -13,7 +13,7 @@ In {pipelines-title}, you can customize the following configurations by using th * Changing the default service account * Disabling the service monitor * Configuring pipeline resolvers -* Disabling cluster tasks and pipeline templates +* Disabling pipeline templates * Disabling the integration of {tekton-hub} * Disabling the automatic creation of RBAC resources * Pruning of task runs and pipeline runs @@ -41,7 +41,7 @@ include::modules/op-disabling-the-service-monitor.adoc[leveloffset=+1] include::modules/op-configuring-pipeline-resolvers.adoc[leveloffset=+1] -include::modules/op-disabling-cluster-tasks-and-pipeline-templates.adoc[leveloffset=+1] +include::modules/op-disabling-pipeline-templates.adoc[leveloffset=+1] include::modules/op-disabling-the-integretion-of-tekton-hub.adoc[leveloffset=+1] @@ -63,6 +63,5 @@ include::modules/op-additional-options-webhooks.adoc[leveloffset=+1] == Additional resources * xref:../secure/authenticating-pipelines-repos-using-secrets.adoc#authenticating-pipelines-repos-using-secrets[Authenticating pipelines with repositories using secrets] -* xref:../create/managing-nonversioned-and-versioned-cluster-tasks.adoc#managing-nonversioned-and-versioned-cluster-tasks[Managing non-versioned and versioned cluster tasks] * xref:../create/working-with-pipelines-web-console.adoc#using-custom-pipeline-template-for-git-import_working-with-pipelines-web-console[Creating pipeline templates in the Administrator perspective] * link:https://docs.openshift.com/container-platform/latest/applications/pruning-objects.html[Pruning objects to reclaim resources] diff --git a/modules/op-about-pipelines-as-code-resolver.adoc b/modules/op-about-pipelines-as-code-resolver.adoc index ccae0e4c73d7..5f7d4a046e53 100644 --- a/modules/op-about-pipelines-as-code-resolver.adoc +++ b/modules/op-about-pipelines-as-code-resolver.adoc @@ -13,7 +13,6 @@ If {pac} cannot resolve the referenced tasks in the `Pipeline` or `PipelineSpec` The resolver skips resolving if it observes the following type of tasks: -* A reference to a cluster task. * A task or pipeline bundle. * A custom task with an API version that does not have a `tekton.dev/` prefix. diff --git a/modules/op-advantages-and-disadvantages-of-non-versioned-and-versioned-cluster-tasks.adoc b/modules/op-advantages-and-disadvantages-of-non-versioned-and-versioned-cluster-tasks.adoc deleted file mode 100644 index 0e3de53829bb..000000000000 --- a/modules/op-advantages-and-disadvantages-of-non-versioned-and-versioned-cluster-tasks.adoc +++ /dev/null @@ -1,32 +0,0 @@ -// This module is included in the following assemblies: -// * create/managing-nonversioned-and-versioned-cluster-tasks.adoc - -:_mod-docs-content-type: CONCEPT -[id="advantages-and-disadvantages-of-non-versioned-and-versioned-cluster-tasks_{context}"] -= Advantages and disadvantages of non-versioned and versioned cluster tasks - -Before adopting non-versioned or versioned cluster tasks as a standard in production environments, cluster administrators might consider their advantages and disadvantages. - -.Advantages and disadvantages of non-versioned and versioned cluster tasks -[options="header"] -|=== - -| Cluster task | Advantages | Disadvantages - -| Non-versioned cluster task (NVCT) -a| -* If you prefer deploying pipelines with the latest updates and bug fixes, use the NVCT. -* Upgrading the Operator upgrades the non-versioned cluster tasks, which consume fewer resources than multiple versioned cluster tasks. -a| If you deploy pipelines that use NVCT, they might break after an Operator upgrade if the automatically upgraded cluster tasks are not backward-compatible. - -| Versioned cluster task (VCT) -a| -* If you prefer stable pipelines in production, use the VCT. -* The earlier version is retained on the cluster even after the later version of a cluster task is installed. You can continue using the earlier cluster tasks. -a| -* If you continue using an earlier version of a cluster task, you might miss the latest features and critical security updates. -* The earlier versions of cluster tasks that are not operational consume cluster resources. -* * After it is upgraded, the Operator cannot manage the earlier VCT. You can delete the earlier VCT manually by using the `oc delete clustertask` command, but you cannot restore it. -| - -|=== \ No newline at end of file diff --git a/modules/op-constructing-pipelines-using-pipeline-builder.adoc b/modules/op-constructing-pipelines-using-pipeline-builder.adoc index 6cb39e10634a..49a99d02ce82 100644 --- a/modules/op-constructing-pipelines-using-pipeline-builder.adoc +++ b/modules/op-constructing-pipelines-using-pipeline-builder.adoc @@ -9,13 +9,7 @@ In the *Developer* perspective of the console, you can use the *+Add* -> *Pipeline* -> *Pipeline builder* option to: * Configure pipelines using either the *Pipeline builder* or the *YAML view*. -* Construct a pipeline flow using existing tasks and cluster tasks. When you install the {pipelines-shortname} Operator, it adds reusable pipeline cluster tasks to your cluster. - -[IMPORTANT] -==== -In {pipelines-title} 1.10, `ClusterTask` functionality is deprecated and is planned to be removed in a future release. -==== - +* Construct a pipeline flow using existing tasks. When you install the {pipelines-shortname} Operator, it adds reusable pipeline tasks to your cluster that can be used with the cluster resolver. * Specify the type of resources required for the pipeline run, and if required, add additional parameters to the pipeline. * Reference these pipeline resources in each of the tasks in the pipeline as input and output resources. * If required, reference any additional parameters added to the pipeline in the task. The parameters for a task are prepopulated based on the specifications of the task. @@ -25,7 +19,7 @@ In {pipelines-title} 1.10, `ClusterTask` functionality is deprecated and is plan [IMPORTANT] ==== In the developer perspective, you can create a customized pipeline using your own set of curated tasks. To search, install, and upgrade your tasks directly from the developer console, your cluster administrator needs to install and deploy a local Tekton Hub instance and link that hub to the OpenShift Container Platform cluster. For more details, see _Using Tekton Hub with {pipelines-shortname}_ in the _Additional resources_ section. -If you do not deploy any local Tekton Hub instance, by default, you can only access the cluster tasks, namespace tasks and public Tekton Hub tasks. +If you do not deploy any local Tekton Hub instance, by default, you can only access namespace tasks and public Tekton Hub tasks. ==== .Procedure diff --git a/modules/op-creating-pipeline-tasks.adoc b/modules/op-creating-pipeline-tasks.adoc index 1ea39e211871..a01abfa1ded9 100644 --- a/modules/op-creating-pipeline-tasks.adoc +++ b/modules/op-creating-pipeline-tasks.adoc @@ -31,31 +31,3 @@ NAME DESCRIPTION AGE apply-manifests 1 minute ago update-deployment 48 seconds ago ---- - -. Use the `tkn clustertasks list` command to list the Operator-installed additional cluster tasks such as `buildah` and `s2i-python`: -+ -[NOTE] -==== -To use the `buildah` cluster task in a restricted environment, you must ensure that the Dockerfile uses an internal image stream as the base image. -==== -+ -[source,terminal] ----- -$ tkn clustertasks list ----- -+ -The output lists the Operator-installed `ClusterTask` resources: -+ -[source,terminal] ----- -NAME DESCRIPTION AGE -buildah 1 day ago -git-clone 1 day ago -s2i-python 1 day ago -tkn 1 day ago ----- - -[IMPORTANT] -==== -In {pipelines-title} 1.10, `ClusterTask` functionality is deprecated and is planned to be removed in a future release. -==== diff --git a/modules/op-differences-between-non-versioned-and-versioned-cluster-tasks.adoc b/modules/op-differences-between-non-versioned-and-versioned-cluster-tasks.adoc deleted file mode 100644 index a7aaabe1a537..000000000000 --- a/modules/op-differences-between-non-versioned-and-versioned-cluster-tasks.adoc +++ /dev/null @@ -1,24 +0,0 @@ -// This module is included in the following assemblies: -// * create/managing-nonversioned-and-versioned-cluster-tasks.adoc - -:_mod-docs-content-type: CONCEPT -[id="differences-between-non-versioned-and-versioned-cluster-tasks_{context}"] -= Differences between non-versioned and versioned cluster tasks - -Non-versioned and versioned cluster tasks have different naming conventions. And, the {pipelines-title} Operator upgrades them differently. - -.Differences between non-versioned and versioned cluster tasks -[options="header"] -|=== - -| | Non-versioned cluster task | Versioned cluster task - -| Nomenclature -| The NVCT only contains the name of the cluster task. For example, the name of the NVCT of Buildah installed with Operator v1.7 is `buildah`. -| The VCT contains the name of the cluster task, followed by the version as a suffix. For example, the name of the VCT of Buildah installed with Operator v1.7 is `buildah-1-7-0`. - -| Upgrade -| When you upgrade the Operator, it updates the non-versioned cluster task with the latest changes. The name of the NVCT remains unchanged. -| Upgrading the Operator installs the latest version of the VCT and retains the earlier version. The latest version of a VCT corresponds to the upgraded Operator. For example, installing Operator 1.7 installs `buildah-1-7-0` and retains `buildah-1-6-0`. - -|=== \ No newline at end of file diff --git a/modules/op-disabling-automatic-creation-of-rbac-resources.adoc b/modules/op-disabling-automatic-creation-of-rbac-resources.adoc index 71b4dc089c63..5e6db7f0a40f 100644 --- a/modules/op-disabling-automatic-creation-of-rbac-resources.adoc +++ b/modules/op-disabling-automatic-creation-of-rbac-resources.adoc @@ -9,6 +9,17 @@ The default installation of the {pipelines-title} Operator creates multiple role To disable the automatic creation of cluster-wide RBAC resources after the {pipelines-title} Operator is installed, cluster administrators can set the `createRbacResource` parameter to `false` in the cluster-level `TektonConfig` custom resource (CR). +.Procedure + +. Edit the `TektonConfig` CR by running the following command: ++ +[source,terminal] +---- +$ oc edit TektonConfig config +---- + +. In the `TektonConfig` CR, set the `createRbacResource` param value to `false`: + .Example `TektonConfig` CR [source,yaml] ---- @@ -20,11 +31,5 @@ spec: params: - name: createRbacResource value: "false" -... +# ... ---- - -[WARNING] -==== -As a cluster administrator or an user with appropriate privileges, when you disable the automatic creation of RBAC resources for all namespaces, the default `ClusterTask` resource does not work. For the `ClusterTask` resource to function, you must create the RBAC resources manually for each intended namespace. -==== - diff --git a/modules/op-disabling-cluster-tasks-and-pipeline-templates.adoc b/modules/op-disabling-cluster-tasks-and-pipeline-templates.adoc deleted file mode 100644 index a335dd1edb89..000000000000 --- a/modules/op-disabling-cluster-tasks-and-pipeline-templates.adoc +++ /dev/null @@ -1,35 +0,0 @@ -// This module is included in the following assemblies: -// * install_config/customizing-configurations-in-the-tektonconfig-cr.adoc - -:_mod-docs-content-type: CONCEPT -[id="op-disabling-cluster-tasks-and-pipeline-templates_{context}"] -= Disabling cluster tasks and pipeline templates - -By default, the `TektonAddon` custom resource (CR) installs `clusterTasks` and `pipelineTemplates` resources along with {pipelines-shortname} on the cluster. - -You can disable installation of the `clusterTasks` and `pipelineTemplates` resources by setting the parameter value to `false` in the `.spec.addon` specification. In addition, you can disable the `communityClusterTasks` parameter. - - -.Example - -[source,yaml] ----- -apiVersion: operator.tekton.dev/v1alpha1 -kind: TektonConfig -metadata: - name: config -spec: - addon: - params: - - name: clusterTasks - value: 'false' - - name: pipelineTemplates - value: 'false' - - name: communityClusterTasks - value: 'true' ----- - -[IMPORTANT] -==== -In {pipelines-title} 1.10, `ClusterTask` functionality is deprecated and is planned to be removed in a future release. -==== diff --git a/modules/op-disabling-non-versioned-and-versioned-cluster-tasks.adoc b/modules/op-disabling-non-versioned-and-versioned-cluster-tasks.adoc deleted file mode 100644 index 3705bc563f93..000000000000 --- a/modules/op-disabling-non-versioned-and-versioned-cluster-tasks.adoc +++ /dev/null @@ -1,59 +0,0 @@ -// This module is included in the following assemblies: -// * create/managing-nonversioned-and-versioned-cluster-tasks.adoc - -:_mod-docs-content-type: PROCEDURE -[id="disabling-non-versioned-and-versioned-cluster-tasks_{context}"] -= Disabling non-versioned and versioned cluster tasks - -As a cluster administrator, you can disable cluster tasks that the {pipelines-shortname} Operator installed. - -.Procedure - -. To delete all non-versioned cluster tasks and latest versioned cluster tasks, edit the `TektonConfig` custom resource definition (CRD) and set the `clusterTasks` parameter in `spec.addon.params` to `false`. -+ -.Example `TektonConfig` CR -[source,yaml] ----- -apiVersion: operator.tekton.dev/v1alpha1 -kind: TektonConfig -metadata: - name: config -spec: - params: - - name: createRbacResource - value: "false" - profile: all - targetNamespace: openshift-pipelines - addon: - params: - - name: clusterTasks - value: "false" -... ----- -+ -When you disable cluster tasks, the Operator removes all the non-versioned cluster tasks and only the latest version of the versioned cluster tasks from the cluster. -+ -[NOTE] -==== -Re-enabling cluster tasks installs the non-versioned cluster tasks. -==== - -. Optional: To delete earlier versions of the versioned cluster tasks, use any one of the following methods: -.. To delete individual earlier versioned cluster tasks, use the `oc delete clustertask` command followed by the versioned cluster task name. For example: -+ -[source,terminal] ----- -$ oc delete clustertask buildah-1-6-0 ----- -.. To delete all versioned cluster tasks created by an old version of the Operator, you can delete the corresponding installer set. For example: -+ -[source,terminal] ----- -$ oc delete tektoninstallerset versioned-clustertask-1-6-k98as ----- -+ -[CAUTION] -==== -If you delete an old versioned cluster task, you cannot restore it. You can only restore versioned and non-versioned cluster tasks that the current version of the Operator has created. -==== - diff --git a/modules/op-disabling-pipeline-templates.adoc b/modules/op-disabling-pipeline-templates.adoc new file mode 100644 index 000000000000..45a559a9eac7 --- /dev/null +++ b/modules/op-disabling-pipeline-templates.adoc @@ -0,0 +1,44 @@ +// This module is included in the following assemblies: +// * install_config/customizing-configurations-in-the-tektonconfig-cr.adoc + +:_mod-docs-content-type: CONCEPT +[id="op-disabling-pipeline-templates_{context}"] += Disabling resolver tasks and pipeline templates + +By default, the `TektonAddon` custom resource (CR) installs `resolverTasks` and `pipelineTemplates` resources along with {pipelines-shortname} on the cluster. + +You can disable the installation of the resolver tasks and pipeline templates by setting the parameter value to `false` in the `.spec.addon` specification. + +.Procedure + +. Edit the `TektonConfig` CR by running the following command: ++ +[source,terminal] +---- +$ oc edit TektonConfig config +---- + +. In the `TektonConfig` CR, set the `resolverTasks` and `pipelineTemplates` parameter value in `.addon.params` spec to `false`: ++ +.Example of disabling resolver task and pipeline template resources +[source,yaml] +---- +apiVersion: operator.tekton.dev/v1alpha1 +kind: TektonConfig +metadata: + name: config +spec: +# ... + addon: + params: + - name: resolverTasks + value: 'false' + - name: pipelineTemplates + value: 'false' +# ... +---- ++ +[IMPORTANT] +==== +You can set the value of the `pipelinesTemplates` parameter to `true` only when the value of the `resolverTasks` parameter is `true`. +==== \ No newline at end of file diff --git a/modules/op-installing-pipelines-operator-in-web-console.adoc b/modules/op-installing-pipelines-operator-in-web-console.adoc index 4aec7957108c..74c68ad40964 100644 --- a/modules/op-installing-pipelines-operator-in-web-console.adoc +++ b/modules/op-installing-pipelines-operator-in-web-console.adoc @@ -22,7 +22,7 @@ The supported profiles are: * Lite: This installs only Tekton Pipelines. * Basic: This installs Tekton Pipelines, Tekton Triggers, and Tekton Chains. -* All: This is the default profile used when the `TektonConfig` CR is installed. This profile installs all of the Tekton components, including Tekton Pipelines, Tekton Triggers, Tekton Chains, {pac}, and Tekton Addons. Tekton Addons includes the `ClusterTasks`, `ClusterTriggerBindings`, `ConsoleCLIDownload`, `ConsoleQuickStart`, and `ConsoleYAMLSample` resources, as well as the tasks available using the cluster resolver from the `openshift-pipelines` namespace. +* All: This is the default profile used when the `TektonConfig` CR is installed. This profile installs all of the Tekton components, including Tekton Pipelines, Tekton Triggers, Tekton Chains, {pac}, and Tekton Addons. Tekton Addons includes the `ClusterTriggerBindings`, `ConsoleCLIDownload`, `ConsoleQuickStart`, and `ConsoleYAMLSample` resources, as well as the tasks and step actions available using the cluster resolver from the `openshift-pipelines` namespace. [discrete] .Procedure diff --git a/modules/op-nonroot-buildah-user-namespaces.adoc b/modules/op-nonroot-buildah-user-namespaces.adoc index 3ff6629cbe79..dfdb5c3b54a3 100644 --- a/modules/op-nonroot-buildah-user-namespaces.adoc +++ b/modules/op-nonroot-buildah-user-namespaces.adoc @@ -42,7 +42,7 @@ metadata: name: assemble-containerimage namespace: pipeline-namespace spec: - description: This cluster task builds an image. + description: This task builds an image. # ... stepTemplate: env: diff --git a/modules/op-resolver-cluster-tasks-ref.adoc b/modules/op-resolver-cluster-tasks-ref.adoc index 22435c64904f..ee44441417d9 100644 --- a/modules/op-resolver-cluster-tasks-ref.adoc +++ b/modules/op-resolver-cluster-tasks-ref.adoc @@ -8,7 +8,7 @@ An {pipelines-shortname} installation includes a set of standard tasks that you can use in your pipelines. These tasks are located in the {pipelines-shortname} installation namespace, which is normally the `openshift-pipelines` namespace. You can use the cluster resolver to access the tasks. -`ClusterTask` functionality is deprecated since {pipelines-shortname} 1.10 and is planned for removal in a future release. If your pipelines use `ClusterTasks`, you can re-create them with the tasks that are available from the {pipelines-shortname} installation namespace by using the cluster resolver. However, certain changes are made in these tasks compared to the existing `ClusterTasks`. +Until version 1.16, {pipelines-shortname} included `ClusterTask` functionality. Versions 1.17 and later no longer include this functionality. If your pipelines use `ClusterTask` references, you can re-create them with the tasks that are available from the {pipelines-shortname} installation namespace by using the cluster resolver. However, certain changes are made in these tasks compared to the previously existing `ClusterTask` definitions. You cannot specify a custom execution image in any of the tasks available in the {pipelines-shortname} installation namespace. These tasks do not support parameters such as `BUILDER_IMAGE`, `gitInitImage`, or `KN_IMAGE`. If you want to use a custom execution image, create a copy of the task and replace the image by editing the copy. diff --git a/modules/op-resolver-tasks-step-actions-about.adoc b/modules/op-resolver-tasks-step-actions-about.adoc new file mode 100644 index 000000000000..768a9d6313ed --- /dev/null +++ b/modules/op-resolver-tasks-step-actions-about.adoc @@ -0,0 +1,65 @@ +// This module is included in the following assemblies: +// * create/remote-pipelines-tasks-resolvers.adoc + +// // *openshift_pipelines/remote-pipelines-tasks-resolvers.adoc +:_mod-docs-content-type: CONCEPT +[id="resolver-tasks-step-actions-about_{context}"] + += About non-versioned and versioned tasks and step actions + +The `openshift-pipelines` namespace includes versioned tasks and step actions alongside standard non-versioned tasks and step actions. For example, installing the {pipelines-title} Operator v1.16 creates the following items: + +* `buildah-1-16-0` versioned task +* `buildah` non-versioned task +* `git-clone-1-16-0` versioned `StepAction` definition +* `git-clone` non-versioned `StepAction` definition + +Non-versioned and versioned tasks and step actions have the same metadata, behavior, and specifications, including `params`, `workspaces`, and `steps`. However, they behave differently when you disable them or upgrade the Operator. + +Before adopting non-versioned or versioned tasks and step actions as a standard in production environments, cluster administrators might consider their advantages and disadvantages. + +.Advantages and disadvantages of non-versioned and versioned tasks and step actions +[options="header"] +|=== + +| | Advantages | Disadvantages + +s| Non-versioned tasks and step actions +a| +* If you prefer deploying pipelines with the latest updates and bug fixes, use non-versioned tasks and step actions. +* Upgrading the Operator upgrades the non-versioned tasks and step actions, which consumes fewer resources than multiple versioned tasks and step actions. +a| +* If you deploy pipelines that use non-versioned tasks and step actions, they might break after an Operator upgrade if the automatically upgraded tasks and step actions are not backward-compatible. + +s| Versioned tasks and step actions +a| +* If you prefer stable pipelines in production, use versioned tasks and step actions. +* Earlier versions are retained on the cluster even after the later version of a task or step action is installed. You can continue using the earlier versions. +a| +* If you continue using the earlier versions, you might miss the latest features and critical security updates. +* The earlier versions that are not operational consume cluster resources. +* After an upgrade, the Operator cannot manage the earlier versioned tasks and step actions. You can delete the earlier versions manually, but you cannot restore them. +| +|=== + +Non-versioned and versioned tasks and step actions have different naming conventions, and the {pipelines-title} Operator upgrades them differently. + +.Differences between non-versioned and versioned tasks and step actions +[options="header"] +|=== + +| | Nomenclature | Upgrade + +s| Non-versioned tasks and step actions + +| Non-versioned tasks and step actions only contain the name of the task or step action. For example, the name of the non-versioned task of Buildah installed with Operator v1.16 is `buildah`. +| When you upgrade the Operator, it updates the non-versioned tasks and step actions with the latest changes. The name remains unchanged. + +s| Versioned tasks and step actions + +| Versioned tasks and step actions contain the name, followed by the version as a suffix. For example, the name of the versioned task of Buildah installed with Operator v1.16 is `buildah-1-16-0`. +| Upgrading the Operator installs the latest version of versioned tasks and step actions and retains the earlier version. The latest version corresponds to the upgraded Operator. For example, installing Operator 1.17 installs the `git-clone-1-17-0` step action and retains the `git-clone-1-16-0` step action. +|=== + + + diff --git a/modules/op-starting-a-task-run-pipeline-run-build-user.adoc b/modules/op-starting-a-task-run-pipeline-run-build-user.adoc index b93a724c41c6..8236400e2b9a 100644 --- a/modules/op-starting-a-task-run-pipeline-run-build-user.adoc +++ b/modules/op-starting-a-task-run-pipeline-run-build-user.adoc @@ -6,7 +6,7 @@ [id="starting-a-task-run-with-custom-config-map-or-a-pipeline-run_{context}"] = Starting a task run with custom config map, or a pipeline run -After defining the custom Buildah cluster task, you can create a `TaskRun` object that builds an image as a `build` user with user id `1000`. In addition, you can integrate the `TaskRun` object as part of a `PipelineRun` object. +After defining the custom Buildah task, you can create a `TaskRun` object that builds an image as a `build` user with user id `1000`. In addition, you can integrate the `TaskRun` object as part of a `PipelineRun` object. .Procedure @@ -127,7 +127,7 @@ spec: requests: storage: 100Mi ---- -<1> Use the `git-clone` cluster task to fetch the source containing a Dockerfile and build it using the modified Buildah task. +<1> Use the `git-clone` task to fetch the source containing a Dockerfile and build it using the modified Buildah task. <2> Refer to the modified Buildah task. <3> Use the service account that you created for the Buildah task. <4> Share data between the `git-clone` task and the modified Buildah task using a persistent volume claim (PVC) created automatically by the controller. diff --git a/modules/op-tkn-clustertask-management.adoc b/modules/op-tkn-clustertask-management.adoc deleted file mode 100644 index ab6c869a7e26..000000000000 --- a/modules/op-tkn-clustertask-management.adoc +++ /dev/null @@ -1,54 +0,0 @@ -// This module is included in the following assemblies: -// * tkn_cli/op-tkn-reference.adoc - -[id="op-tkn-clustertask-management-commands_{context}"] -= ClusterTask management commands - -[IMPORTANT] -==== -In {pipelines-title} 1.10, ClusterTask functionality of the `tkn` command line utility is deprecated and is planned to be removed in a future release. -==== - -== clustertask -Manage ClusterTasks. - -.Example: Display help -[source,terminal] ----- -$ tkn clustertask --help ----- - -== clustertask delete -Delete a ClusterTask resource in a cluster. - -.Example: Delete `mytask1` and `mytask2` ClusterTasks -[source,terminal] ----- -$ tkn clustertask delete mytask1 mytask2 ----- - -== clustertask describe -Describe a ClusterTask. - -.Example: Describe the `mytask` ClusterTask -[source,terminal] ----- -$ tkn clustertask describe mytask1 ----- - -== clustertask list -List ClusterTasks. - -.Example: List ClusterTasks -[source,terminal] ----- -$ tkn clustertask list ----- -== clustertask start -Start ClusterTasks. - -.Example: Start the `mytask` ClusterTask -[source,terminal] ----- -$ tkn clustertask start mytask ----- diff --git a/secure/configuring-security-context-for-pods.adoc b/secure/configuring-security-context-for-pods.adoc index 840e07cacc8f..efb1bc108739 100644 --- a/secure/configuring-security-context-for-pods.adoc +++ b/secure/configuring-security-context-for-pods.adoc @@ -22,7 +22,7 @@ fsGroup: # ... ---- -In addition, the `Buildah` cluster task, shipped as part of {pipelines-shortname}, uses `vfs` as the default storage driver. +In addition, the `Buildah` task, shipped as part of {pipelines-shortname}, uses `vfs` as the default storage driver. You can configure the security context for pods that {pipelines-shortname} creates for pipeline runs and task runs. You can make the following changes: diff --git a/snippets/ref-s2i-task.adoc b/snippets/ref-s2i-task.adoc index 43eff3d48238..dc46704d104d 100644 --- a/snippets/ref-s2i-task.adoc +++ b/snippets/ref-s2i-task.adoc @@ -59,12 +59,4 @@ spec: |`IMAGE_DIGEST` |`string` |Digest of the image that was built. |=== -.Changes from the `s2i-{lang}` `ClusterTask` - -* Several new parameters were added. -* The `BASE_IMAGE` parameter was removed. -* The parameter name `PATH_CONTEXT` was changed to `CONTEXT`. -* The parameter name `TLS_VERIFY` was changed to `TLSVERIFY`. -* The `IMAGE_URL` result was added. - :!lang: diff --git a/tkn_cli/op-tkn-reference.adoc b/tkn_cli/op-tkn-reference.adoc index 8dd6af788fa9..b81473fa7c88 100644 --- a/tkn_cli/op-tkn-reference.adoc +++ b/tkn_cli/op-tkn-reference.adoc @@ -33,9 +33,6 @@ include::modules/op-tkn-task-run.adoc[leveloffset=+1] // Pipeline resources commands include::modules/op-tkn-pipeline-resource-management.adoc[leveloffset=+1] -// ClusterTask management commands -include::modules/op-tkn-clustertask-management.adoc[leveloffset=+1] - // Trigger management commands include::modules/op-tkn-trigger-management.adoc[leveloffset=+1]