docs: Added platform documentation

Author: dploeger

README.md

@@ -9,11 +9,11 @@ required and configured to manage modern cloud infrastructures.
 
 The toolbox comes in different "flavours" depending on what cloud you are working in.
 Currently supported cloud flavours are:
-* ![Docker Image Version (latest semver)](https://img.shields.io/docker/v/dodevops/cloudcontrol-aws?sort=semver) [AWS](https://hub.docker.com/r/dodevops/cloudcontrol-aws) (based on [amazon/aws-cli](https://hub.docker.com/r/amazon/aws-cli))
-* ![Docker Image Version (latest semver)](https://img.shields.io/docker/v/dodevops/cloudcontrol-azure?sort=semver) [Azure](https://hub.docker.com/r/dodevops/cloudcontrol-azure) (based on [mcr.microsoft.com/azure-cli](https://hub.docker.com/_/microsoft-azure-cli))
-* ![Docker Image Version (latest semver)](https://img.shields.io/docker/v/dodevops/cloudcontrol-gcloud?sort=semver) [Google Cloud](https://hub.docker.com/r/dodevops/cloudcontrol-gcloud) (based on [google-cloud-cli](https://console.cloud.google.com/gcr/images/google.com:cloudsdktool/GLOBAL/google-cloud-cli))
-* ![Docker Image Version (latest semver)](https://img.shields.io/docker/v/dodevops/cloudcontrol-simple?sort=semver) [Simple](https://hub.docker.com/r/dodevops/cloudcontrol-simple) (based on [alpine](https://hub.docker.com/_/alpine))
-* ![Docker Image Version (latest semver)](https://img.shields.io/docker/v/dodevops/cloudcontrol-tanzu?sort=semver) [Tanzu](https://hub.docker.com/r/dodevops/cloudcontrol-tanzu) (based on [alpine](https://hub.docker.com/_/alpine))
+* [AWS](https://github.com/dodevops/cloudcontrol/pkgs/container/cloudcontrol-aws) (based on [amazon/aws-cli](https://hub.docker.com/r/amazon/aws-cli)) [linux/amd64, linux/arm64]
+* [Azure](https://github.com/dodevops/cloudcontrol/pkgs/container/cloudcontrol-azure) (based on [mcr.microsoft.com/azure-cli](https://hub.docker.com/_/microsoft-azure-cli)) [linux/amd64]
+* [Google Cloud](https://github.com/dodevops/cloudcontrol/pkgs/container/cloudcontrol-gcloud) (based on [google-cloud-cli](https://console.cloud.google.com/gcr/images/google.com:cloudsdktool/GLOBAL/google-cloud-cli)) [linux/amd64, linux/arm64]
+* [Simple](https://github.com/dodevops/cloudcontrol/pkgs/container/cloudcontrol-simple) (based on [alpine](https://hub.docker.com/_/alpine)) [linux/amd64, linux/arm64]
+* [Tanzu](https://github.com/dodevops/cloudcontrol/pkgs/container/cloudcontrol-tanzu) (based on [alpine](https://hub.docker.com/_/alpine)) [linux/amd64]
 
 Following features and tools are supported:
 * 🐟 Fish Shell
@@ -143,6 +143,16 @@ documentation and support of your Kubernetes distribution if something isn't wor
 
 ## FAQ
 
+### What does an error message like "no matching manifest for linux/arm64/v8 in the manifest list entries" mean?
+
+Apparently you're using *CloudControl* on a system for which no specific image exist. Some cloud providers have not
+provided base images for all architectures (e.g. the Apple ARM-based processors) yet. See the list of flavours above
+for the available platforms per flavour.
+
+As a workaround this, you can use the [`platform`](https://docs.docker.com/compose/compose-file/compose-file-v2/#platform)
+parameter for docker-compose or the `--platform` parameter for `docker run` to specify a compatible architecture
+(e.g. linux/amd64 on Apple ARM-based machines).
+
 ### How can I add an informational text for users of *CloudControl*?
 
 If you want to display a *custom login message* when users enter the container, set environment variable `MOTD`
@@ -760,3 +770,5 @@ flowchart TD
     click F "https://github.com/dodevops/cloudcontrol/blob/develop/.github/workflows/test.yml" "Test workflow"
     click H "https://github.com/dodevops/cloudcontrol/blob/develop/.github/workflows/release.yml" "Release workflow"
 ```mermaid
+maid
+

README.md.gotmpl

@@ -12,8 +12,8 @@ The toolbox comes in different "flavours" depending on what cloud you are workin
 Currently supported cloud flavours are:
 
 {{- range .Flavours }}
-* {{ .Title -}}
-{{ end }}
+* {{ .Title }} [{{ $sep := "" }}{{ range .Platforms }}{{ $sep }}{{ . }}{{ $sep = ", " }}{{ end }}]
+{{- end }}
 
 Following features and tools are supported:
 
@@ -108,6 +108,16 @@ documentation and support of your Kubernetes distribution if something isn't wor
 
 ## FAQ
 
+### What does an error message like "no matching manifest for linux/arm64/v8 in the manifest list entries" mean?
+
+Apparently you're using *CloudControl* on a system for which no specific image exist. Some cloud providers have not
+provided base images for all architectures (e.g. the Apple ARM-based processors) yet. See the list of flavours above
+for the available platforms per flavour.
+
+As a workaround this, you can use the [`platform`](https://docs.docker.com/compose/compose-file/compose-file-v2/#platform)
+parameter for docker-compose or the `--platform` parameter for `docker run` to specify a compatible architecture
+(e.g. linux/amd64 on Apple ARM-based machines).
+
 ### How can I add an informational text for users of *CloudControl*?
 
 If you want to display a *custom login message* when users enter the container, set environment variable `MOTD`

flavour/aws/flavour.yaml

@@ -1,4 +1,4 @@
-title: "![Docker Image Version (latest semver)](https://img.shields.io/docker/v/dodevops/cloudcontrol-aws?sort=semver) [AWS](https://hub.docker.com/r/dodevops/cloudcontrol-aws) (based on [amazon/aws-cli](https://hub.docker.com/r/amazon/aws-cli))"
+title: "[AWS](https://github.com/dodevops/cloudcontrol/pkgs/container/cloudcontrol-aws) (based on [amazon/aws-cli](https://hub.docker.com/r/amazon/aws-cli))"
 description: |
     Can be used to connect to infrastructure in the AWS cloud. Also see [the AWS CLI documentation](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html) for more configuration options.
     If you have activated MFA, set AWS_MFA_ARN to the ARN of your MFA device so CloudControl will ask you
@@ -9,3 +9,6 @@ configuration:
     - "Environment AWS_SECRET_ACCESS_KEY: Specifies the secret key associated with the access key. This is essentially the password for the access key"
     - "Environment AWS_DEFAULT_REGION: Specifies the AWS Region to send the request to"
     - "Environment AWS_MFA_ARN: ARN of the MFA device to use to log in"
+platforms:
+    - linux/amd64
+    - linux/arm64

flavour/azure/flavour.yaml

@@ -1,4 +1,4 @@
-title: "![Docker Image Version (latest semver)](https://img.shields.io/docker/v/dodevops/cloudcontrol-azure?sort=semver) [Azure](https://hub.docker.com/r/dodevops/cloudcontrol-azure) (based on [mcr.microsoft.com/azure-cli](https://hub.docker.com/_/microsoft-azure-cli))"
+title: "[Azure](https://github.com/dodevops/cloudcontrol/pkgs/container/cloudcontrol-azure) (based on [mcr.microsoft.com/azure-cli](https://hub.docker.com/_/microsoft-azure-cli))"
 description: |
     Can be used to connect to infrastructure in the Azure cloud. Because we're using a container,
     a device login will happen, requiring the user to go to a website, enter a code and login.
@@ -7,3 +7,5 @@ configuration:
     - "Environment AZ_SUBSCRIPTION: The Azure subscription to use in this container"
     - "Environment AZ_TENANTID: The Azure tenant id to log into (optional)"
     - "Environment AZ_USE_ARM_SPI: Uses the environment variables ARM_CLIENT_ID and ARM_CLIENT_SECRET for service principal auth [false]"
+platforms:
+    - linux/amd64

flavour/gcloud/flavour.yaml

@@ -1,4 +1,4 @@
-title: "![Docker Image Version (latest semver)](https://img.shields.io/docker/v/dodevops/cloudcontrol-gcloud?sort=semver) [Google Cloud](https://hub.docker.com/r/dodevops/cloudcontrol-gcloud) (based on [google-cloud-cli](https://console.cloud.google.com/gcr/images/google.com:cloudsdktool/GLOBAL/google-cloud-cli))"
+title: "[Google Cloud](https://github.com/dodevops/cloudcontrol/pkgs/container/cloudcontrol-gcloud) (based on [google-cloud-cli](https://console.cloud.google.com/gcr/images/google.com:cloudsdktool/GLOBAL/google-cloud-cli))"
 description: |
     Includes workflows and tools to connect to Google Cloud.
     
@@ -13,3 +13,6 @@ configuration:
     - "Environment GCLOUD_PROJECTID: The id of the Google Cloud project to connect to"
     - "Environment GCLOUD_USE_SA (Possible values: true, false. Defaults to false): Use a service account to log into Google Cloud. Requires GCLOUD_KEYPATH"
     - "Environment GCLOUD_KEYPATH: Path inside CloudControl that holds the service account JSON file"
+platforms:
+    - linux/amd64
+    - linux/arm64

flavour/simple/flavour.yaml

@@ -1,3 +1,6 @@
-title: "![Docker Image Version (latest semver)](https://img.shields.io/docker/v/dodevops/cloudcontrol-simple?sort=semver) [Simple](https://hub.docker.com/r/dodevops/cloudcontrol-simple) (based on [alpine](https://hub.docker.com/_/alpine))"
+title: "[Simple](https://github.com/dodevops/cloudcontrol/pkgs/container/cloudcontrol-simple) (based on [alpine](https://hub.docker.com/_/alpine))"
 description: |
     Can be used to connect to infrastructure outside of a specific cloud provider.
+platforms:
+    - linux/amd64
+    - linux/arm64

flavour/tanzu/flavour.yaml

@@ -1,4 +1,4 @@
-title: "![Docker Image Version (latest semver)](https://img.shields.io/docker/v/dodevops/cloudcontrol-tanzu?sort=semver) [Tanzu](https://hub.docker.com/r/dodevops/cloudcontrol-tanzu) (based on [alpine](https://hub.docker.com/_/alpine))"
+title: "[Tanzu](https://github.com/dodevops/cloudcontrol/pkgs/container/cloudcontrol-tanzu) (based on [alpine](https://hub.docker.com/_/alpine))"
 description: |
     Includes workflows and tools to connect to a Tanzu cluster.
     
@@ -7,3 +7,5 @@ description: |
     The kubernetes login tokens usually expire after a few hours already. You can run the `k8s-relogin` script
     (located in ~/bin, thus available without path) to re-execute the same login commands as the initialization process
     does.
+platforms:
+    - linux/amd64

internal/models.go

@@ -10,4 +10,5 @@ type YamlDescriptor struct {
 	Icon          string
 	Configuration []string
 	Test          TestConfiguration
+	Platforms     []string
 }