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

Call for a doc on how to use Pipelines with Chains #786

Closed
chuangw6 opened this issue Apr 25, 2023 · 7 comments · Fixed by #913
Closed

Call for a doc on how to use Pipelines with Chains #786

chuangw6 opened this issue Apr 25, 2023 · 7 comments · Fixed by #913
Assignees
Labels
kind/feature Categorizes issue or PR as related to a new feature. lifecycle/rotten

Comments

@chuangw6
Copy link
Member

One important step before using Chains is to write a Tekton Pipeline/Task and make sure the source artifacts being used and output artifacts being generated can be captured by Tekton Chains.

In Chains, currently there is no dedicated doc telling users how to write appropriate Tekton Pipeline/Task yamls. Type hinting sections attempt to do that but it's spreading across the 2 docs config.md and intoto.md.

So it would be great to have a dedicated doc telling users how to use Pipeline with Chains.

Proposal:

  • remove "Chains type hinting" section from config.md and make sure config.md only focus on how to configure Chains (not pipelines).
  • split intoto.md into 2 docs:
    • intoto.md itself: This doc should focus on SLSA provenance itself i.e. slsa brand, formatting etc. I am open for ideas.
    • using_with_Tekton_Pipelines.md: This doc should focus on how to use Tekton Pipelines with Tekton Chains.
@chuangw6 chuangw6 added the kind/feature Categorizes issue or PR as related to a new feature. label Apr 25, 2023
@chuangw6 chuangw6 changed the title Call for user-facing doc on using with Tekton pipelines Call for a doc on how to use Pipelines with Chains Apr 25, 2023
@lcarva
Copy link
Contributor

lcarva commented Apr 25, 2023

+1 for this. I think pointing to examples in the catalog is probably a good idea too.

@AlanGreene
Copy link
Member

also fyi: tektoncd/website#530
PR for new doc on the website showing how to use chains

@tekton-robot
Copy link

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
Copy link

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.

@chuangw6
Copy link
Member Author

/assign

chuangw6 added a commit to chuangw6/chains that referenced this issue Sep 1, 2023
Fixes tektoncd#786

The doc includes instruction on how to configure a pipeline/task so that
Tekton Chains can generate provenance properly.

Signed-off-by: Chuang Wang <chuangw@google.com>
chuangw6 added a commit to chuangw6/chains that referenced this issue Sep 1, 2023
Fixes tektoncd#786

The doc includes instruction on how to configure a pipeline/task so that
Tekton Chains can generate provenance properly.

Signed-off-by: Chuang Wang <chuangw@google.com>
chuangw6 added a commit to chuangw6/chains that referenced this issue Sep 1, 2023
Fixes tektoncd#786

The doc includes instruction on how to configure a pipeline/task so that
Tekton Chains can generate provenance properly.

Signed-off-by: Chuang Wang <chuangw@google.com>
chuangw6 added a commit to chuangw6/chains that referenced this issue Sep 1, 2023
Fixes tektoncd#786

The doc includes instruction on how to configure a pipeline/task so that
Tekton Chains can generate provenance properly.

Signed-off-by: Chuang Wang <chuangw@google.com>
chuangw6 added a commit to chuangw6/chains that referenced this issue Sep 6, 2023
Fixes tektoncd#786

The doc includes instruction on how to configure a pipeline/task so that
Tekton Chains can generate provenance properly.

Signed-off-by: Chuang Wang <chuangw@google.com>
chuangw6 added a commit to chuangw6/chains that referenced this issue Sep 6, 2023
Fixes tektoncd#786

The doc includes instruction on how to configure a pipeline/task so that
Tekton Chains can generate provenance properly.

Signed-off-by: Chuang Wang <chuangw@google.com>
chuangw6 added a commit to chuangw6/chains that referenced this issue Sep 6, 2023
Fixes tektoncd#786

The doc includes instruction on how to configure a pipeline/task so that
Tekton Chains can generate provenance properly.

Signed-off-by: Chuang Wang <chuangw@google.com>
chuangw6 added a commit to chuangw6/chains that referenced this issue Sep 6, 2023
Fixes tektoncd#786

The doc includes instruction on how to configure a pipeline/task so that
Tekton Chains can generate provenance properly.

Signed-off-by: Chuang Wang <chuangw@google.com>
chuangw6 added a commit to chuangw6/chains that referenced this issue Sep 6, 2023
Fixes tektoncd#786

The doc includes instruction on how to configure a pipeline/task so that
Tekton Chains can generate provenance properly.

Signed-off-by: Chuang Wang <chuangw@google.com>
@tekton-robot
Copy link

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen with a justification.
Mark the issue as fresh with /remove-lifecycle rotten with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/close

Send feedback to tektoncd/plumbing.

@tekton-robot
Copy link

@tekton-robot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen with a justification.
Mark the issue as fresh with /remove-lifecycle rotten with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/close

Send feedback to tektoncd/plumbing.

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.

chuangw6 added a commit to chuangw6/chains that referenced this issue Oct 5, 2023
Fixes tektoncd#786

The doc includes instruction on how to configure a pipeline/task so that
Tekton Chains can generate provenance properly.

Signed-off-by: Chuang Wang <chuangw@google.com>
chuangw6 added a commit to chuangw6/chains that referenced this issue Oct 5, 2023
Fixes tektoncd#786

The doc includes instruction on how to configure a pipeline/task so that
Tekton Chains can generate provenance properly.

Signed-off-by: Chuang Wang <chuangw@google.com>
chuangw6 added a commit to chuangw6/chains that referenced this issue Oct 5, 2023
Fixes tektoncd#786

The doc includes instruction on how to configure a pipeline/task so that
Tekton Chains can generate provenance properly.

Signed-off-by: Chuang Wang <chuangw@google.com>
chuangw6 added a commit to chuangw6/chains that referenced this issue Oct 5, 2023
Fixes tektoncd#786

The doc includes instruction on how to configure a pipeline/task so that
Tekton Chains can generate provenance properly.

Signed-off-by: Chuang Wang <chuangw@google.com>
chuangw6 added a commit to chuangw6/chains that referenced this issue Oct 11, 2023
Fixes tektoncd#786

The doc includes instruction on how to configure a pipeline/task so that
Tekton Chains can generate provenance properly.

Signed-off-by: Chuang Wang <chuangw@google.com>
chuangw6 added a commit to chuangw6/chains that referenced this issue Oct 11, 2023
Fixes tektoncd#786

The doc includes instruction on how to configure a pipeline/task so that
Tekton Chains can generate provenance properly.

Signed-off-by: Chuang Wang <chuangw@google.com>
chuangw6 added a commit to chuangw6/chains that referenced this issue Oct 11, 2023
Fixes tektoncd#786

The doc includes instruction on how to configure a pipeline/task so that
Tekton Chains can generate provenance properly.

Signed-off-by: Chuang Wang <chuangw@google.com>
tekton-robot pushed a commit that referenced this issue Oct 12, 2023
Fixes #786

The doc includes instruction on how to configure a pipeline/task so that
Tekton Chains can generate provenance properly.

Signed-off-by: Chuang Wang <chuangw@google.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature. lifecycle/rotten
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants