Skip to content

Commit 5a8fb99

Browse files
author
edge-katanomi-app2[bot]
committed
📚 Sync docs from alaudadevops/tektoncd-operator on 09aba9d56f81394581a0ce5c32155dc88870c2f8
Source: feat: [DEVOPS-42788] support multi-version images for catalog Tasks (#875) Author: yzc Ref: refs/heads/main Commit: 09aba9d56f81394581a0ce5c32155dc88870c2f8 This commit automatically syncs documentation changes from the source-docs repository. 🔗 View source commit: https://github.com/alaudadevops/tektoncd-operator/commit/09aba9d56f81394581a0ce5c32155dc88870c2f8 🤖 Synced on 2025-12-04 09:03:38 UTC
1 parent 36cdb9f commit 5a8fb99

File tree

3 files changed

+57
-15
lines changed

3 files changed

+57
-15
lines changed

‎.github/SYNC_INFO.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Documentation Sync Information
22

3-
- **Last synced**: 2025-12-02 14:33:58 UTC
3+
- **Last synced**: 2025-12-04 09:03:38 UTC
44
- **Source repository**: alaudadevops/tektoncd-operator
5-
- **Source commit**: [a90e048c6ebe4f7738049c98aba9c8c05e17a4b4](https://github.com/alaudadevops/tektoncd-operator/commit/a90e048c6ebe4f7738049c98aba9c8c05e17a4b4)
5+
- **Source commit**: [09aba9d56f81394581a0ce5c32155dc88870c2f8](https://github.com/alaudadevops/tektoncd-operator/commit/09aba9d56f81394581a0ce5c32155dc88870c2f8)
66
- **Triggered by**: edge-katanomi-app2[bot]
7-
- **Workflow run**: [#106](https://github.com/alaudadevops/tektoncd-operator/actions/runs/19862247353)
7+
- **Workflow run**: [#107](https://github.com/alaudadevops/tektoncd-operator/actions/runs/19923390282)
88

99
## Files synced:
1010
- docs/

‎docs/en/development/catalog/convention.md‎

Lines changed: 53 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -108,12 +108,60 @@ spec:
108108
memory: "4Gi"
109109
```
110110
111-
### 4. Building Custom Images with Dependencies
111+
### 4. Image Management for Catalog Tasks
112112
113-
If Tasks in the catalog depend on custom images, we need to provide `Dockerfile` and build pipelines in the catalog.
113+
Catalog Tasks that expose configurable runtime images must publish metadata and defaults consistently so the UI and controllers can discover them.
114114
115-
- Build environments are stored in the `images/{image-name}` directory
116-
- Image build pipeline orchestration files are stored in `.tekton/images/build-{image-name}.yaml`
115+
#### Configurable Image Metadata
116+
117+
Represent each image option with a single `ConfigMap` scoped to one Task and one Task version. Include the human-readable name and full image reference, and add labels so the UI/controller can filter by Task/version.
118+
119+
```yaml
120+
apiVersion: v1
121+
kind: ConfigMap
122+
metadata:
123+
name: tekton-task-go-1-25
124+
namespace: kube-public
125+
labels:
126+
catalog.tekton.dev/source: system
127+
catalog.tekton.dev/tool-image-golang: 1.25
128+
catalog.tekton.dev/tool-image-run-script: go-1.25
129+
data:
130+
name: "Go 1.25"
131+
image: "registry.example.com/tekton/golang:1.25"
132+
```
133+
134+
Key fields and labels:
135+
- `data.name`: dropdown label.
136+
- `data.image`: full image reference.
137+
- `catalog.tekton.dev/source`: identifies the source.
138+
- `catalog.tekton.dev/tool-image-<tool>`: identifies the tool image for the Task.
139+
- `catalog.tekton.dev/tool-image-run-script`: identifies the tool image for `run-script` Task.
140+
141+
#### Catalog Defaults and Tagging
142+
143+
- Keep existing `image` parameter defaults in Tasks; do not clear them.
144+
- Use minor-only tags for catalog images (for example, `v7.0`) and publish a `latest` alias for the newest minor release.
145+
- Publish one `ConfigMap` per runtime version with `name` and `image` data plus Task/version labels; keep defaults on the current minor until a new Task minor is added.
146+
- When introducing a new runtime minor (for example, Python 3.14), keep the older Task minor default on the previous image (3.13), add a new Task minor with no default image to force explicit selection, and add the corresponding per-version `ConfigMap` entries.
147+
148+
```yaml
149+
global:
150+
images:
151+
python-3_13:
152+
repository: devops/tektoncd/hub/python
153+
tag: v3.13
154+
python-latest:
155+
repository: devops/tektoncd/hub/python
156+
tag: latest
157+
```
158+
159+
#### Custom Image Builds
160+
161+
If Tasks in the catalog depend on custom images, provide the `Dockerfile` and build pipelines in the catalog so they can be reproduced.
162+
163+
- Build environments are stored in the `images/{image-name}` directory.
164+
- Image build pipeline orchestration files are stored in `.tekton/images/build-{image-name}.yaml`.
117165

118166
#### Image Security
119167

@@ -136,11 +184,7 @@ If Tasks in the catalog depend on custom images, we need to provide `Dockerfile`
136184

137185
#### Image Tags
138186

139-
If the image is custom, you can directly use the version number generated by `git-version` in the pipeline as the Tag.
140-
141-
If the image is customized based on a specific community version, it is recommended to add the community version number as a prefix in the Tag. For example, `v0.56.0-{version}`
142-
143-
In the pipeline, you can specify the image prefix by configuring the `tag-prefix` parameter.
187+
Follow the catalog tagging strategy above for custom builds (minor-only tags plus a `latest` alias). If the image is derived from a specific community version, include that upstream version in the tag prefix when needed for traceability (for example, `v0.56.0-v7.0`).
144188

145189
#### Image Path
146190

‎docs/en/teps/catalog/0005-configurable-task-images.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -226,13 +226,11 @@ Required labels (example keys shown above):
226226
```yaml
227227
global:
228228
images:
229-
python-3.13:
229+
python-3_13:
230230
repository: devops/tektoncd/hub/python
231-
digest: sha256:c603e490c552823f9361cbd7fde2f2b374ec66f2b1175b3871ec9dc474c36bff
232231
tag: v3.13
233232
python-latest:
234233
repository: devops/tektoncd/hub/python
235-
digest: sha256:c603e490c552823f9361cbd7fde2f2b374ec66f2b1175b3871ec9dc474c36bff
236234
tag: latest
237235
```
238236

0 commit comments

Comments
 (0)