Skip to content

Commit a73827f

Browse files
author
Kasem Alem
committed
fix(KONFLUX-5917): adding tekton example of using secret
Signed-off-by: Kasem Alem <[email protected]>
1 parent ffddfa2 commit a73827f

File tree

1 file changed

+55
-7
lines changed

1 file changed

+55
-7
lines changed

docs/modules/ROOT/pages/how-tos/configuring/creating-secrets.adoc

Lines changed: 55 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,13 @@ NOTE: One such task is the link:https://github.com/konflux-ci/build-definitions/
3030
. Optional: Under **Labels**, add a label to tag or provide more context for your secret.
3131
. Click **Add secret**.
3232

33+
=== Notable task input secrets
34+
35+
* xref:/how-tos/configuring/activation-keys-subscription.adoc#adding-activation-keys-to-the-workspace[activation-key]
36+
* xref:/how-tos/configuring/prefetching-dependencies.adoc#creating-the-netrc-secret[netrc]
37+
* xref:/how-tos/testing/build/snyk.adoc[snyk-secret]
38+
* xref:/how-tos/testing/integration/third-parties/testing-farm.adoc[testing-farm-secret]
39+
3340
== Creating registry pull secrets
3441

3542
Some container builds may use parent images from registries that require authentication, for example, `registry.redhat.io`. Until these credentials have been configured, the builds will continue to fail due to the system being unable to pull the required images.
@@ -47,15 +54,56 @@ Some container builds may use parent images from registries that require authent
4754
. Enter the password for the registry in **Password**.
4855
. Click **Add secret**.
4956

57+
=== Example of creating a quay.io secret
58+
59+
. Login to Konflux console your workspace (https://console.redhat.com/application-pipeline/workspaces/<your workspace>/applications)
60+
. Click on `Secrets` on the left menu.
61+
. Click on `Add Secret`
62+
. Choose `Image pull secret` for `Secret type`
63+
. Enter `Secret name` , for example `my-quay-secret`
64+
. Choose `Image registry credentials` in `Authentication type` field
65+
. Enter `quay.io` in `Registry server address`
66+
. Enter your Quay.io username in `Username`
67+
. Enter your Quay.io API token in `Password` field.
68+
. Click on `Add secret`
69+
. Email is optional
70+
71+
72+
Here is the YAML representation of the secret (for reference):
73+
74+
[source,yaml]
75+
----
76+
apiVersion: v1
77+
data:
78+
.dockerconfigjson: <base64-encoded-credentials>
79+
kind: Secret
80+
metadata:
81+
name: my-quay-secret
82+
namespace: <your-workspace-tenant>
83+
type: kubernetes.io/dockerconfigjson
84+
----
85+
5086

5187
[NOTE]
5288
====
53-
Performing this operation through the UI will link the secret to the `appstudio-pipeline`
54-
`serviceaccount` automatically. If you instead wanted to add manually the secret to the
55-
namespace (creating the `secret` directly on the tenant
56-
workspace), you'll need to have the secret linked manually.
57-
58-
please review the xref:/troubleshooting/index.adoc#check-if-the-secret-is-linked-to-the-service-account[troubleshooting section]) for more info.
89+
* **Automatic Secret Linking via UI**
90+
The Konflux UI automatically links image pull secrets to the `appstudio-pipeline` ServiceAccount.
91+
- No pipeline YAML changes are required.
92+
- Tasks like the buildah task will use this secret automatically when pulling images from `quay.io`. (https://github.com/konflux-ci/build-definitions/blob/main/task/buildah-oci-ta/0.3/buildah-oci-ta.yaml in volumes)
93+
94+
* **Manual Secret Creation**
95+
. **Link Secret To SA**
96+
- If you create the secret manually (e.g., via `kubectl` or YAML), you must **manually link it** to the `appstudio-pipeline` ServiceAccount in your namespace.
97+
. **Secrets Via Workspace**
98+
- Explicitly mount secrets as files using a workspace
99+
- RBAC: Ensure the ServiceAccount has permission to access the secret (via Role/RoleBinding).
100+
101+
. **Secrets as Environment Variables**
102+
- Inject secrets into environment variables
103+
- RBAC: The ServiceAccount must have `get` permission for the secret.
104+
105+
* **Troubleshooting**
106+
For issues with secret linking, review the xref:/troubleshooting/index.adoc#check-if-the-secret-is-linked-to-the-service-account[troubleshooting section].
59107
====
60108

61109
== Creating source control secrets
@@ -164,4 +212,4 @@ stringData:
164212

165213
* For more information about GitLab access tokens, see link:https://docs.gitlab.com/ee/user/project/settings/project_access_tokens.html[Project access tokens].
166214

167-
* To configure push secrets for your Build and Release pipelines, see link:https://github.com/konflux-ci/konflux-ci?tab=readme-ov-file#configuring-a-push-secret-for-the-build-pipeline[Configuring push secrets] in the Konflux GitHub repository.
215+
* To configure push secrets for your Build and Release pipelines, see link:https://github.com/konflux-ci/konflux-ci?tab=readme-ov-file#configuring-a-push-secret-for-the-build-pipeline[Configuring push secrets] in the Konflux GitHub repository.

0 commit comments

Comments
 (0)