-
Notifications
You must be signed in to change notification settings - Fork 220
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
TEP-0087: Custom Tasks Graduation #523
Conversation
/kind tep |
dc2d254
to
776f0aa
Compare
627ff1d
to
46e1184
Compare
a34f9f9
to
5dfaae7
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @jerop , great work! I like the two tier approach, with lower bar for the first level.
I have a few questions on the integrated level.
/assign @afrittoli @sbwsg @vdemeester @pritidesai |
/assign @mattmoor |
@jerop: GitHub didn't allow me to assign the following users: mattmoor. Note that only tektoncd members, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time. 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/test-infra repository. |
/assign |
5dfaae7
to
4ad1c3f
Compare
This change adds the Tekton Enhancement Proposal for `Custom Tasks` Graduation. Today, `Custom Tasks` shared by the Tekton community are all *experimental*, and we don't have a process to promote them beyond *experimental*. As such: - Users can't depend on the `Custom Tasks` because they can change any time, they may not reflect the Tekton roadmap and they may not meet the Tekton standards because they haven't been reviewed in a Tekton Enhancement Proposal. - Contributors don't have a process to stabilize their `Custom Tasks` or integrate them to the *Tekton Pipelines API*. In this TEP, we aim to: - Define the graduation requirements path for `Custom Tasks`. - Provide `Custom Tasks` that are officially supported by Tekton and have stability guarantees. `Custom Tasks` will have four stability levels in their graduation path: 1. *Experimental*: `Custom Tasks` can change any time, [*alpha* API policy][api-policy] applies, as we are iterating on them. 2. *Stable*: `Custom Tasks` are stable, [*beta* API policy][api-policy] applies, and have been approved in a TEP. 3. *Packaged*: `Custom Tasks` are shipped with *Tekton Pipelines* releases, so are available for use out of the box. 4. *Integrated*: `Custom Tasks`' functionalities are natively supported in the *Tekton Pipelines API*. The *Tekton Pipelines* owners have the discretion to expedite the graduation process of a given `Custom Task`, such as when they agree early on that they want to integrate the functionality provided by the `Custom Task` directly to the *Tekton Pipelines API*. See also [TEP-0002: Enable Custom Tasks](https://github.com/tektoncd/community/blob/main/teps/0002-custom-tasks.md). [api-policy]: https://github.com/tektoncd/pipeline/blob/main/api_compatibility_policy.md#alpha-beta-and-ga
fce4227
to
f051bd6
Compare
@sbwsg @afrittoli @bobcatfish, thank you for the initial reviews -- this tep is ready for another look :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice, thank you for all the updates!
/approve
Strong +1 to this given dependence on custom tasks by downstream projects like kubeflow. Changes since my last read all look good to me. Thanks @jerop ! /approve |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: afrittoli, sbwsg The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reading this, I have a slight trouble understanding if it's about a set of particular Custom Task we want to bring in Tekton Pipelines or about a process around graduation.
Do we assume all Custom Task that are proposed in the tekton org (starting in the experimental repository) aim to be shipped as part of tektoncd/pipeline releases or integrated directly in the API (and thus fade away) ? I don't think we should make such an assumption, but maybe I am wrong ? 🤔
As commented below, I also have a little bit of trouble with stable and graduation here — for me, there are slightly unrelated, at least if we speak about "API stability" and graduation process. One (API stability) is about if the API will not break the next release, the other is about the "community" commitment on supporting a given piece of code (Custom Task here)
- Users can't depend on the `Custom Tasks` because they can change any time, they may not reflect the Tekton roadmap and | ||
they may not meet the Tekton standards because they haven't been reviewed in a Tekton Enhancement Proposal. | ||
- Contributors don't have a process to stabilize their `Custom Tasks` or integrate them to the *Tekton Pipelines API*. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think one main aspect is that, being in experimental, it's tricky to get a release out. If we were able to easily release custom task, with "stuck in time" payloads, it would be a little bit more decent for user to use them (but still, doesn't prevent from us to define a process)
|
||
In this TEP, we aim to: | ||
- Define the graduation requirements path for `Custom Tasks`. | ||
- Provide `Custom Tasks` that are officially supported by Tekton and have stability guarantees. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am not sure what this means ? We aim to provide a list of Custom Tasks
that are officially supported ?
If yes, I find it weird as this will change over time.
1. *Experimental*: `Custom Tasks` can change any time, [*alpha* API policy][api-policy] applies, as we are iterating on | ||
them. | ||
2. *Stable*: `Custom Tasks` are stable, [*beta* API policy][api-policy] applies, and have been approved in a TEP. | ||
3. *Packaged*: `Custom Tasks` are shipped with *Tekton Pipelines* releases, so are available for use out of the box. | ||
4. *Integrated*: `Custom Tasks`' functionalities are natively supported in the *Tekton Pipelines API*. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This gives the impression that all Custom Tasks
will or need to end-up in Tekton Pipelines API to be seen as stable and really usable, which, I think, is not what we should aim for.
We need to promote some `Custom Tasks` to the top level such that they are shipped with *Tekton Pipelines* releases, | ||
or even more, that their functionality is supported natively in the *Tekton Pipelines API*. On the other hand, | ||
we may decide not to natively support some functionalities provided in some `Custom Tasks` but we need to provide | ||
stability guarantees. Thus, we need to provide incremental stability levels and graduation path for `Custom Tasks`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From my point of view, Custom Tasks
do not need to be shipped with Tekton Pipelines to reach "stability". Some might, but most wouldn't need to. To reach stability, they need to be able to do releases as they want and have a stable API (**/v1
for example).
Be shipped as part of Tekton Pipelines (or even be "phased out" in the API) is yet another level of stability or integration.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(note: to be able to do releases, they might just need the proper infra or their own repository)
1. As a contributor, I want to stabilize my `Custom Tasks`, and possibly integrate them into the *Tekton Pipelines API*. | ||
As such, I need a process that I can follow with clear requirements for graduation to the next stability level. | ||
2. As a user, I need to use `Custom Tasks` that I can rely on. The stability expectations can vary depending on the | ||
requirements based on the use cases. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have that weird feeling we are talking stability and graduation on the same level. Nothing prevents any Custom Task
to be stable, today, on tektoncd/experimental
or outside of it. As stated above, you just need a stable API, most likely a k8s-like api policy some automated tests set-up and a way to do release — but all this is already achievable today.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nothing prevents any Custom Task to be stable, today, on tektoncd/experimental or outside of it.
one caveat is that if the authors of the Custom Task want the custom task to graduate, they may need to change the API, so in that sense, even if the Custom Task has been declared GA within experimental, the API might need to change once it's considered for graduation. So to me that makes it feel like stability and graduation are at least related - or can influence each other?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
They defenitely can influence each other, but they are not cause/consequence. If by graduation we mean having its own repository, maybe they wouldn't change their API at all. Also, if they went v1beta1
or v1
on the API while being in experimental, I don't really see why they would want to make breaking change in there (because they went beta or stable for a reason).
1. It has a TEP that has been approved. | ||
2. It is tested and has nightly releases. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+:100:
|
||
1. Add documentation for installation and provide examples of usage. | ||
2. Make nightly releases of the `Custom Task` to catch any failures. | ||
3. Make monthly releases with notes to drive adoption of the `Custom Task`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This goes with the rest of the assumptions, but, similarly, I don't see any "obvious" reason to decide a release cadence for a Custom Task.
1. Add documentation for installation and provide examples of usage. | ||
2. Make nightly releases of the `Custom Task` to catch any failures. | ||
3. Make monthly releases with notes to drive adoption of the `Custom Task`. | ||
4. To make changes to the *stable* `Custom Task`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What kind of changes are we talking about here ? API changes, or any changes (bugfix, refactoring, behaviour, …) ?
### Packaged | ||
|
||
When we find that a given *stable* `Custom Task` is necessary for common Continuous Delivery use cases, we can consider | ||
making it *packaged*. That is, when *Tekton Pipelines* is installed, the `Custom Task` is available with no extra step. | ||
The *packaged* `Custom Task` and its functionality is available out of the box with *Tekton Pipelines* installation. | ||
Not all *stable* `Custom Tasks` have to be *packaged* - a *stable* `Custom Task` that is not necessary in | ||
*Tekton Pipelines* can stay as a *stable* `Custom Task` in the long term. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should try to put the operator more into our stories — but that's on us (Operator owners). It is relatively easy to ship a "tiny-bit" opiniated setup of the tekton components with the Operator. We could decide to package Custom Task as part of the Operator so that we don't need to add more complexity to the Pipeline release process and payload.
For example, if we add a given Custom Task to the pipeline releases, it will be installed by default even — consuming resources — even if the user has no need for it (because its pipeline usage doesn't require it in any way). A user would have to "manually" remove the custom task part, and do that on each updates — or we would have to provide different payloads. The operator here is at a slightly higher level and allow to easily setup and manage Pipeline instance as well as other components, Custom Task being seen as components here.
|
||
###### Cons | ||
|
||
- Limiting for users who don't install and manage Tekton installations through the *Tekton Operator*. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's a good point, but, probably a question of perspective, I wouldn't put this in a Cons (or a very limited Cons). If the Operator becomes the way to easily install and managed a Tekton instance — Pipeline being just one, main, part of the overall setup — then it's not a Cons, it just is.
Some thoughts after reading @vdemeester 's feedback:
|
I agree it makes little sense to have experimental projects to become stable. Usually, even before they become stable, if we think they have value (to maintain), we "graduate" them. A good example here is the Hub 👼🏼. One of the idea of the experimental repository, in my head, is to experiment on something the community think it might be worth exploring and maybe maintaining (in any kind of form) — so the general path to graduation would be to end up in a
There is a relation for sure but, as of written, it makes it (at least how I read it) like if the goal of any Custom Task added in experimental has a aim to be shipped as part of tektoncd/pipeline ; and I disagree with this 😅 . I think the aim is, as you said, be part of tekton in some way, aka be maintained by the Tekton community — it doesn't have to be integrated into tektoncd/pipeline to be useful, successful or valuable. Going from experimental to its own repository and going from somewhere (experimental, another-repo, it-s-own-repo) to be shipped and/or integrated in the tekton pipeline API are two different thing, and in my eyes two different "graduation" process. One says "we value this, and the tekton community wil maintain it and drive it towards stability", the other is "this will be shipped and integrate into tekton pipeline" — you can want one without the other. In all honesty, this means the first graduation I am talking about (from experimental to somewhere), is not really tied to Custom Task, and is a general |
Makes sense to me @vdemeester and I agree! I wonder if part of the reason the TEP is coming across that way is because the motivation has been to progress custom tasks that we (at least @jerop and i haha) are interested in adding to the Pipelines API XD So 👍 to updating the proposal to make this clear |
API WG - @jerop is updating the TEP - in progress |
@jerop: PR needs rebase. 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/test-infra repository. |
Issues go stale after 90d of inactivity. /lifecycle stale Send feedback to tektoncd/plumbing. |
API WG - @jerop to revisit this soon |
Stale issues rot after 30d of inactivity. /lifecycle rotten Send feedback to tektoncd/plumbing. |
/lifecycle frozen |
hoping to revisit someday when I have the capacity, closing for now |
This change adds the Tekton Enhancement Proposal for
Custom Tasks
Graduation.Today,
Custom Tasks
shared by the Tekton community are all experimental, and we don't have a process to promotethem beyond experimental.
As such:
Custom Tasks
because they can change any time, they may not reflect the Tekton roadmap and they may not meet the Tekton standards because they haven't been reviewed in a Tekton Enhancement Proposal.Custom Tasks
or integrate them to the Tekton Pipelines API.In this TEP, we aim to:
Custom Tasks
.Custom Tasks
that are officially supported by Tekton and have stability guarantees.Custom Tasks
will have four stability levels in their graduation path:Custom Tasks
can change any time, alpha API policy applies, as we are iterating onthem.
Custom Tasks
are stable, beta API policy applies, and have been approved in a TEP.Custom Tasks
are shipped with Tekton Pipelines releases, so are available for use out of the box.Custom Tasks
' functionalities are natively supported in the Tekton Pipelines API.The Tekton Pipelines owners have the discretion to expedite the graduation process of a given
Custom Task
, such aswhen they agree early on that they want to integrate the functionality provided by the
Custom Task
directly to theTekton Pipelines API.
See also TEP-0002: Enable Custom Tasks.