Skip to content

Commit f16d8f6

Browse files
committed
RHDEVDOCS 6395 Document the fact that older versioned tasks and step actions can be deleted
1 parent 704176b commit f16d8f6

File tree

1 file changed

+18
-21
lines changed

1 file changed

+18
-21
lines changed

modules/op-resolver-tasks-step-actions-about.adoc

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77

88
= About non-versioned and versioned tasks and step actions
99

10-
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:
10+
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 version 1.18 creates the following items:
1111

12-
* `buildah-1-16-0` versioned task
12+
* `buildah-1-18-0` versioned task
1313
* `buildah` non-versioned task
14-
* `git-clone-1-16-0` versioned `StepAction` definition
14+
* `git-clone-1-18-0` versioned `StepAction` definition
1515
* `git-clone` non-versioned `StepAction` definition
1616

1717
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.
@@ -25,20 +25,20 @@ Before adopting non-versioned or versioned tasks and step actions as a standard
2525
| | Advantages | Disadvantages
2626

2727
s| Non-versioned tasks and step actions
28-
a|
29-
* If you prefer deploying pipelines with the latest updates and bug fixes, use non-versioned tasks and step actions.
30-
* Upgrading the Operator upgrades the non-versioned tasks and step actions, which consumes fewer resources than multiple versioned tasks and step actions.
31-
a|
32-
* 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.
28+
a|
29+
* If you prefer deploying pipelines with the latest updates and bug fixes, use non-versioned tasks and step actions.
30+
* Upgrading the Operator upgrades the non-versioned tasks and step actions, which consumes fewer resources than multiple versioned tasks and step actions.
31+
a|
32+
* 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.
3333

3434
s| Versioned tasks and step actions
35-
a|
36-
* If you prefer stable pipelines in production, use versioned tasks and step actions.
37-
* 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.
38-
a|
35+
a|
36+
* If you prefer pipelines in production that do not change after a version update, use versioned tasks and step actions.
37+
* When you install a new version of the Operator, the versioned tasks and step actions from the current minor version and the immediate previous minor version are retained.
38+
a|
3939
* If you continue using the earlier versions, you might miss the latest features and critical security updates.
40-
* The earlier versions that are not operational consume cluster resources.
41-
* 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.
40+
* After an upgrade, the Operator cannot manage the earlier versioned tasks and step actions. If you delete the earlier versions manually, you cannot restore them.
41+
* After an upgrade, the Operator can delete versioned tasks and step actions from versions earlier than the previous minor release. When you install a new version of {openshift-pipelines} and the versioned tasks or step actions from an earlier version are deleted, pipelines that use the versioned tasks from the earlier version stop working.
4242
|
4343
|===
4444

@@ -52,14 +52,11 @@ Non-versioned and versioned tasks and step actions have different naming convent
5252

5353
s| Non-versioned tasks and step actions
5454

55-
| 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`.
56-
| When you upgrade the Operator, it updates the non-versioned tasks and step actions with the latest changes. The name remains unchanged.
55+
| 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.18 is `buildah`.
56+
| When you upgrade the Operator, it updates the non-versioned tasks and step actions with the latest changes. The name remains unchanged.
5757

5858
s| Versioned tasks and step actions
5959

60-
| 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`.
61-
| 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.
60+
| 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.18 is `buildah-1-18-0`.
61+
| Upgrading the Operator installs the latest version of versioned tasks and step actions, retains the immediate previous version, and deletes the earlier versions. The latest version corresponds to the upgraded Operator. For example, installing Operator 1.18 installs the `buildah-1-18-0` task, retains the `buildah-1-17-0` task, and deletes earlier versions such as `buildah-1-16-0`.
6262
|===
63-
64-
65-

0 commit comments

Comments
 (0)