mirror/catalog
1
0
Fork 0
mirror of https://github.com/tektoncd/catalog.git synced 2024-11-26 06:23:37 +00:00
Code Issues Releases Activity

Add documentation about platform information for resources

Browse Source 
Following TEP 70, tekton.dev/platforms annotation can be used to
specify on which platforms the resource can be run.

- add best practices for platform information in the recommendations.md
- add example of usage for tekton.dev/platforms annotation

Signed-off-by: Yulia Gaponenko <yulia.gaponenko1@de.ibm.com>
This commit is contained in:
Yulia Gaponenko 2021-06-30 15:53:50 +02:00 committed by tekton-robot
parent 84906df9a3
commit 15caec9b2d
2 changed files with 23 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -52,17 +52,18 @@ _See [our project roadmap](roadmap.md)._
```yaml
labels:
app.kubernetes.io/version: "0.1" 👈 Version of the resource
app.kubernetes.io/version: "0.1" 👈 Version of the resource
annotations:
tekton.dev/pipelines.minVersion: "0.12.1" 👈 Min Version of pipeline resource is compatible
tekton.dev/tags: "ansible, cli" 👈 Comma separated list of tags
tekton.dev/displayName: "Ansible Tower Cli" 👈 displayName can be optional
tekton.dev/pipelines.minVersion: "0.12.1" 👈 Min Version of pipeline resource is compatible
tekton.dev/tags: "ansible, cli" 👈 Comma separated list of tags
tekton.dev/displayName: "Ansible Tower Cli" 👈 displayName can be optional
tekton.dev/platforms: "linux/amd64,linux/s390x" 👈 Comma separated list of platforms, can be optional
spec:
description: |-
ansible-tower-cli task simplifies
workflow, jobs, manage users... 👈 Summary
workflow, jobs, manage users... 👈 Summary
Ansible Tower (formerly ‘AWX’) is a ...

17
recommendations.md
View File

@ -315,3 +315,20 @@ it already exists, nothing happens.
This technique can be used to "short circuit" work when it is not
necessary to _re-run_.
## Provide "tekton.dev/platforms" annotation
`tekton.dev/platforms` annotation indicates on which platforms (for
instance, "linux/amd64,linux/arm64" or "windows/amd64") resource can
be run.
The most reliable option to verify the platform list is to run the
e2e tests provided with the resource. Minimal requirement is to use
the container image, which has support for corresponding platform.
Add `Platforms` section into the README.md of the corresponding resource.
If running of the resource on specific platform requires to use another
image or do other customization, it should be also mentioned in the section.
If you don't know, which platforms to specify, good start is to use
"linux/amd64", as it is most popular platform and most likely the tests,
you've done, were on top of it.