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

fix(Konflux 5917): add an example how user can use a secret in pipeline #208

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

kasemAlem
Copy link

@kasemAlem kasemAlem commented Jan 15, 2025

We added a tekton task as an example how user can use the created secrets
within a build or integration pipeline

KONFLUX-5917

@kasemAlem kasemAlem changed the title Konflux 5917 fix(Konflux 5917): add an example how user can use a secret in pipeline Jan 15, 2025
Copy link

🚀 Preview is available at https://pr-208--konflux-docs.netlify.app

Comment on lines +68 to +70
- name: registry-credentials
secret:
secretName: registry.redhat.io
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is how you use a secret, but what does this secret look like that you are using? Is it clear how values need to match up between the secret and its use?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1. I think only one secret name in volumes might not enough as one example.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm confused, maybe I'm missing something
In the current documentation of creating secrets it's detailed step by step how user can create a secret of each type, also there is a good example stated in a note frame :

One such task is the [sast-snyk-check](https://github.com/konflux-ci/build-definitions/tree/main/task/sast-snyk-check) task that uses the third-party service [snyk](https://snyk.io/) to perform static application security testing (SAST) as a part of the default {ProductName} pipeline. Use this procedure to upload your snyk.io token. Name the secret snyk-secret so that the snyk task in the {ProductName} pipeline will recognize it and use it.

It's an example how a third party tool in task requires a specific secret and how it's been used within the task , isn't ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would providing a link to the Creating registry pull secrets section of the guide either above or below this example do the job of clarifying how the secret should look like?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants