diff --git a/README.md b/README.md index b2e090f6..ef9daa4d 100644 --- a/README.md +++ b/README.md @@ -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 ... diff --git a/recommendations.md b/recommendations.md index abbede51..074ded3e 100644 --- a/recommendations.md +++ b/recommendations.md @@ -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.