triggers icon indicating copy to clipboard operation
triggers copied to clipboard

Published 20 hours ago • verified publisher icon tektoncd

Improve Triggers getting-started tutorial

Open dibyom opened this issue 3 years ago • 6 comments

Feature request

The getting started tutorial is fairly old and could use a refresh.

  • [x] Urgent Remove PipelineResources from the pipeline

    • PipelineResources are deprecated and we should not use deprecated features in examples
    • Replace cloudevent resource with https://hub.tekton.dev/tekton/task/cloudevent
    • Replace git resource with git-clone task
    • Replace image resource with tasks that write image produced as a result and deploy task to use this as a param

  • [ ] Simplify the Create and execute the ingress and webhook Tasks section

    • [ ] Explain at a high level why we need ingress and the webhooks to be created and how they are connected
    • [ ] Replace create-ingress task with a link to the exposing eventlisteners documentation
      • The tutorial says, the create-ingress task must be used. But there are plenty of ways of exposing an EL that might even be simpler than running the task
    • [ ] Mention other ways of creating webhooks aside from the task that might be simpler
    • [ ] Consider adding a new page on creating webhooks? (or maybe a tkn plugin?)

  • [ ] Simplify the Configure your Cluster section

    • [ ] Remove ingress sub-domain and lets-encrypt certs - not necessary for a simple getting-started tutorial
    • [ ] webhook user, role, and rolebinding is only necessary if the user is using the create-webhook task

  • [ ] Simplify the Pipeline

    • [ ] A basic pipeline that receives info from an incoming GitHub event and prints it out
    • [ ] A more real world pipeline that clones, builds, and pushes

  • [ ] Use more up to date patterns for configuring Triggers

    • [ ] Use a Trigger resource with inline binding and template instead of a trigger embedded within the EventListener
    • [ ] Use label or namespace selectors

dibyom avatar Aug 18 '22 21:08 dibyom

it does appear that there are more than just the getting started that need this attention. most of the pipelines in the examples directory use resources instead of workspaces. could we make an issue that is just "refactor examples to align with latest pipeline release". once that's done, it may be simpler to break down the Getting Started updates into smaller tasks

jmcshane avatar Sep 28 '22 14:09 jmcshane

could we make an issue that is just "refactor examples to align with latest pipeline release". once that's done, it may be simpler to break down the Getting Started updates into smaller tasks

yeah that sounds like a good idea!

dibyom avatar Sep 28 '22 16:09 dibyom

OK, I'm working on the pipeline samples across the entire examples directory now

jmcshane avatar Sep 28 '22 16:09 jmcshane

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 avatar May 09 '23 16:05 tekton-robot

/remove-lifecycle stale

khrm avatar May 11 '23 09:05 khrm

as per the Triggers WG discussion this issue would be good for Hactoberfest

cc @wlynch

savitaashture avatar Aug 09 '23 15:08 savitaashture