RHDEVDOCS-6210: Remove deprecated ClusterTask from docs #84204
Conversation
openshift-ci-robot
added
the
jira/valid-reference
|
@eromanova97: This pull request references RHDEVDOCS-6210 which is a valid jira issue. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
openshift-ci
bot
added
the
size/L
eromanova97
force-pushed
the
RHDEVDOCS-6210
branch
from
e3d73db to
a7ae5cd
Compare
|
@eromanova97: This pull request references RHDEVDOCS-6210 which is a valid jira issue. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
|
Hello @pratap0007 @ppitonak could you please review? Thank you! |
modules/op-advantages-and-disadvantages-of-non-versioned-and-versioned-cluster-tasks.adoc
Show resolved
Hide resolved
modules/op-differences-between-non-versioned-and-versioned-cluster-tasks.adoc
Show resolved
Hide resolved
eromanova97
force-pushed
the
RHDEVDOCS-6210
branch
2 times, most recently
from
83cd01e to
26574a2
Compare
|
@eromanova97: This pull request references RHDEVDOCS-6210 which is a valid jira issue. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
|
@eromanova97: This pull request references RHDEVDOCS-6210 which is a valid jira issue. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
eromanova97
force-pushed
the
RHDEVDOCS-6210
branch
2 times, most recently
from
c8dff57 to
ceed60e
Compare
|
@eromanova97: This pull request references RHDEVDOCS-6210 which is a valid jira issue. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
eromanova97
force-pushed
the
RHDEVDOCS-6210
branch
from
ceed60e to
f9bf2b1
Compare
|
@mramendi @eromanova97 should we add some example as part of this PR to show how a PipelineRun looks with ClusterTasks and before upgrading to 1.17 what steps user has to follow to use tasks using cluster Resolver |
Sounds good to me. If you can provide such examples, then we can find a way to add them into the doc. However, we do not have the resources to craft these examples on our own. |
eromanova97
force-pushed
the
RHDEVDOCS-6210
branch
2 times, most recently
from
50a6441 to
ef08ef9
Compare
|
@eromanova97: This pull request references RHDEVDOCS-6210 which is a valid jira issue. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
|
/label peer-review-needed |
openshift-ci
bot
added
the
peer-review-needed
adellape
added
the
peer-review-in-progress
eromanova97
force-pushed
the
RHDEVDOCS-6210
branch
from
ef08ef9 to
3b59034
Compare
openshift-ci
bot
added
size/XL
eromanova97
force-pushed
the
RHDEVDOCS-6210
branch
from
3b59034 to
caf636b
Compare
openshift-ci
bot
added
size/L
eromanova97
force-pushed
the
RHDEVDOCS-6210
branch
2 times, most recently
from
fcef987 to
6c2bfb3
Compare
openshift-ci
bot
added
size/XL
eromanova97
changed the base branch from
pipelines-docs-main
to
pipelines-docs-1.17
|
@eromanova97: This pull request references RHDEVDOCS-6210 which is a valid jira issue. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
eromanova97
changed the base branch from
pipelines-docs-1.17
to
pipelines-docs-main
|
@eromanova97: This pull request references RHDEVDOCS-6210 which is a valid jira issue. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
eromanova97
force-pushed
the
RHDEVDOCS-6210
branch
from
6c2bfb3 to
857e61a
Compare
openshift-ci
bot
added
size/L
|
/label merge-review-needed |
openshift-ci
bot
added
the
merge-review-needed
|
To the merge reviewer: I had some rebase issues which messed with the size labels a little bit before I got it fixed, so sorry for that 😅 |
ShaunaDiaz
added
merge-review-in-progress
| 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. |
There was a problem hiding this comment.
| 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. | |
| Until version 1.16, {pipelines-shortname} included `ClusterTask` functionality. Versions 1.17 and later do not 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. |
I would simplify this at some point for minimalism. It sounds like 1.17 and later used to also have this function, but it was removed ("no longer"). If they never had it, I would just say they don't. Not required for merge, just a thought.
|
|
||
| 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. |
There was a problem hiding this comment.
| Before adopting non-versioned or versioned tasks and step actions as a standard in production environments, cluster administrators might consider their advantages and disadvantages. | |
| Before adopting non-versioned or versioned tasks and step actions as a standard in production environments, cluster administrators should consider their advantages and disadvantages. |
Hmm, is it advisable to consider the differences? "Might" doesn't sound like advice, per se; seems very very optional. What's the happy path to direct customers to do?
| 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. | ||
|
|
There was a problem hiding this comment.
IDK what the latest guidance is on TOC level, but it might (ha) be nice to have L3 headings above these table sections for scannability. I am not certain where we are landing with the depth of the TOCs on docs.redhat, though, so take my thought with a grain of salt.
|
/cherrypick pipelines-docs-1.17 |
|
@ShaunaDiaz: new pull request created: #86099 In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
ShaunaDiaz
removed
the
merge-review-in-progress
10 participants
Version(s):
pipelines-docs-1.17Issue: RHDEVDOCS-6210
Links to docs preview:
QE review:
Additional information: