Skip to content
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

Replacing PipelineResources in tutorial #3705

Closed
psschwei opened this issue Jan 21, 2021 · 23 comments
Closed

Replacing PipelineResources in tutorial #3705

psschwei opened this issue Jan 21, 2021 · 23 comments
Assignees
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.

Comments

@psschwei
Copy link
Contributor

psschwei commented Jan 21, 2021

Currently, the Pipeline tutorial uses git and image PipelineResources for Task inputs/outputs see here. As there are beta-supported alternatives for both PipelineResources (for git, for image), it might be good to update the tutorial to use these alternatives.

@pritidesai
Copy link
Member

/kind documentation

@tekton-robot tekton-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Jan 22, 2021
@pritidesai pritidesai added the good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. label Jan 22, 2021
@rudeigerc
Copy link
Member

Hi, I'd like to make an update. However, the entire tutorial used PipelineResource as the resource input and output.
Should the update be imported as a complement of the origin tutorial or a brand new one?

@pritidesai
Copy link
Member

We could add as complementing to the original tutorial that way folks can compare a pipeline with and without resources. @psschwei would that work?

@psschwei
Copy link
Contributor Author

@pritidesai I like the idea of including both alternatives. However, for a new user looking to get started with Tekton (which I assume is the main audience for the tutorial), would it be better to keep things simple and only present a single way of doing things?

@pritidesai
Copy link
Member

Sure @psschwei sounds good.

How are we updating this section to replace pipeline resources? I am asking because this section refers to a task using pipeline resources to build an image. After replacing pipeline resources with the catalog tasks, it can no longer be represented as a single task instead it has to be converted to a pipeline to combine git-clone and kaniko or buildah catalog task 😞.

@vdemeester
Copy link
Member

@pritidesai we would need to have a task that does all (the git-clone and the build). This means we wouldn't use a task from the catalog but it would work 👼🏼.

@psschwei
Copy link
Contributor Author

@pritidesai we would need to have a task that does all (the git-clone and the build). This means we wouldn't use a task from the catalog but it would work 👼🏼.

Does it make sense to add a clone&build task to the catalog?

@vdemeester
Copy link
Member

@pritidesai we would need to have a task that does all (the git-clone and the build). This means we wouldn't use a task from the catalog but it would work 👼🏼.

Does it make sense to add a clone&build task to the catalog?

I am less sure about that yet. Let's see a bit where discussions on tektoncd/community#316 and https://github.com/tektoncd/community/pull/318/files are going before 👼🏼 🙏🏼

@pritidesai
Copy link
Member

I am less sure about that yet. Let's see a bit where discussions on tektoncd/community#316 and https://github.com/tektoncd/community/pull/318/files are going before 👼🏼 🙏🏼

Yup, I agree with @vdemeester, lets wait and see how the discussion unfolds on tektoncd/community#316 and tektoncd/community#318.

@psschwei you have hit this at the right time and I am hopeful we will find a solution to it.

@sbose78
Copy link
Contributor

sbose78 commented Feb 25, 2021

+1

We need to start having folks get used to the alternatives of PipelineResources sooner.

@psschwei
Copy link
Contributor Author

Adding link to TEP-0044 now that it's merged. It includes a comparison with the TEP formerly known as 0046, which was closed.

@tekton-robot
Copy link
Collaborator

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale with a justification.
Stale issues rot after an additional 30d of inactivity and eventually close.
If this issue is safe to close now please do so with /close with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/lifecycle stale

Send feedback to tektoncd/plumbing.

@tekton-robot tekton-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 15, 2021
@tekton-robot
Copy link
Collaborator

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten with a justification.
Rotten issues close after an additional 30d of inactivity.
If this issue is safe to close now please do so with /close with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/lifecycle rotten

Send feedback to tektoncd/plumbing.

@tekton-robot tekton-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Nov 14, 2021
@jerop
Copy link
Member

jerop commented Nov 15, 2021

/lifecycle frozen

we still need to do this to help users migrate off pipelineresources

@tekton-robot tekton-robot added lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. and removed lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. labels Nov 15, 2021
jerop added a commit to jerop/pipeline that referenced this issue Nov 15, 2021
When we [released Tekton Pipelines Beta in March 2020](https://github.com/tektoncd/pipeline/releases/tag/v0.11.0),
we [decided not to make `PipelineResources` Beta](https://github.com/tektoncd/pipeline/blob/e76d4132ab2ecfbedc45a964f08a01022e2d4c14/docs/resources.md#why-arent-pipelineresources-in-beta).

In [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-deprecate-pipelineresources.md),
we decided to officially deprecate `PipelineResources`.

This change announces, documents and warns about the deprecation of
`PipelineResources`.

Follow-on work includes:
- Replace `PipelineResources` from the tutorial - tektoncd#3705
- Replace `PipelineResources` from the examples and documentation - tektoncd#4375
- Continue updating the documentation as work progresses on [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-deprecate-pipelineresources.md)
and features replacing `PipelineResources` become available

Closes tektoncd#4344.
@jerop jerop mentioned this issue Nov 15, 2021
4 tasks
jerop added a commit to jerop/pipeline that referenced this issue Nov 16, 2021
When we [released Tekton Pipelines Beta in March 2020](https://github.com/tektoncd/pipeline/releases/tag/v0.11.0),
we [decided not to make `PipelineResources` Beta](https://github.com/tektoncd/pipeline/blob/e76d4132ab2ecfbedc45a964f08a01022e2d4c14/docs/resources.md#why-arent-pipelineresources-in-beta).

In [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-deprecate-pipelineresources.md),
we decided to officially deprecate `PipelineResources`.

This change announces, documents and warns about the deprecation of
`PipelineResources`.

Follow-on work includes:
- Replace `PipelineResources` from the tutorial - tektoncd#3705
- Replace `PipelineResources` from the examples and documentation - tektoncd#4375
- Continue updating the documentation as work progresses on [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-deprecate-pipelineresources.md)
and features replacing `PipelineResources` become available

Closes tektoncd#4344.
jerop added a commit to jerop/pipeline that referenced this issue Nov 16, 2021
When we [released Tekton Pipelines Beta in March 2020](https://github.com/tektoncd/pipeline/releases/tag/v0.11.0),
we [decided not to make `PipelineResources` Beta](https://github.com/tektoncd/pipeline/blob/e76d4132ab2ecfbedc45a964f08a01022e2d4c14/docs/resources.md#why-arent-pipelineresources-in-beta).

In [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-deprecate-pipelineresources.md),
we decided to officially deprecate `PipelineResources`.

This change announces, documents and warns about the deprecation of
`PipelineResources`.

Follow-on work includes:
- Replace `PipelineResources` from the tutorial - tektoncd#3705
- Replace `PipelineResources` from the examples and documentation - tektoncd#4375
- Continue updating the documentation as work progresses on [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-deprecate-pipelineresources.md)
and features replacing `PipelineResources` become available

Closes tektoncd#4344.
tekton-robot pushed a commit that referenced this issue Nov 16, 2021
When we [released Tekton Pipelines Beta in March 2020](https://github.com/tektoncd/pipeline/releases/tag/v0.11.0),
we [decided not to make `PipelineResources` Beta](https://github.com/tektoncd/pipeline/blob/e76d4132ab2ecfbedc45a964f08a01022e2d4c14/docs/resources.md#why-arent-pipelineresources-in-beta).

In [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-deprecate-pipelineresources.md),
we decided to officially deprecate `PipelineResources`.

This change announces, documents and warns about the deprecation of
`PipelineResources`.

Follow-on work includes:
- Replace `PipelineResources` from the tutorial - #3705
- Replace `PipelineResources` from the examples and documentation - #4375
- Continue updating the documentation as work progresses on [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-deprecate-pipelineresources.md)
and features replacing `PipelineResources` become available

Closes #4344.
@jeremyjjbrown
Copy link

The staleness of such an important ticket (and easy?) makes me pause on using this project.

@vdemeester vdemeester added the priority/critical-urgent Highest priority. Must be actively worked on as someone's top priority right now. label Jan 6, 2022
@lbernick lbernick moved this to Todo in Pipelines V1 Jan 27, 2022
@rebelopsio
Copy link

I’m currently working through learning Tekton from a newcomer’s perspective including making use of workspaces. I’d love to help get the documentation updated around this topic.

@dibyom
Copy link
Member

dibyom commented Feb 8, 2022

Thanks @rebelopsio I think @geriom also has some ideas in this space.

@geriom
Copy link
Contributor

geriom commented Feb 8, 2022

I created an introductory tutorial last year. I'll make my priority to update it and get it merged this week.

That wasn't merged because we struggled to decide where that doc fits, in the end we decided to step back and rethink the docs strategy, we (the documentation working group) came up with a roadmap, new structure and new doc guidelines to make the overall documentation experience a lot better.

I'll open a bunch of issues with the proper context for every documentation item we have in mind. The idea is to have a good, friendly and educational documentation experience for the launch of pipelines v1.

@jerop jerop added priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. and removed priority/critical-urgent Highest priority. Must be actively worked on as someone's top priority right now. labels Feb 8, 2022
@geriom
Copy link
Contributor

geriom commented Feb 8, 2022

Tracking these guides now in #4554 and #4555

@lbernick
Copy link
Member

/assign geriom

Geri, sounds like you are working on this currently? feel free to remove your assignment if not.

@lbernick lbernick moved this from Todo to In Progress in Pipelines V1 Feb 22, 2022
@geriom geriom mentioned this issue Apr 25, 2022
5 tasks
@geriom
Copy link
Contributor

geriom commented Apr 26, 2022

@dibyom with #4789 merged I think we can close this issue. I'm don't have the permissions to do it.

@vdemeester
Copy link
Member

/close
@geriom you should be able to close with the /close comment I think

@tekton-robot
Copy link
Collaborator

@vdemeester: Closing this issue.

In response to this:

/close
@geriom you should be able to close with the /close comment I think

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.

Repository owner moved this from In Progress to Done in Pipelines V1 Apr 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.
Projects
Status: Done
Development

No branches or pull requests