diff --git a/.gitlab/README.md.template b/.gitlab/README.md.template index d29a17928aadccb63e1c3f585b112907f3425e4f..c2556569b66201891dee8ccc0b5ad1b5d33c8172 100644 --- a/.gitlab/README.md.template +++ b/.gitlab/README.md.template @@ -578,6 +578,14 @@ See also the official GitLab documentation for it If you want to save runner resources you may disable the unit and integration tests by setting the `SKIP_TESTS` CI/CD variable to `true`. +The component builds by default a multi-arch image for `linux/amd64` and `linux/arm64`. +There are multiple reasons why you might want to change this behavior, like saving runner resources. +To configure for what architectures the container image should be built, you can go to +the CI/CD variables in the project settings and add a variable called `PLATFORMS`. +The value is one or more `OS/ARCH[/VARIANT]`. If you have multiple platforms, they have to be comma separated. +**Keep in mind that the component is tested with `linux/amd64` and `linux/arm64`, +other platforms are not officially supported!** + You can set the `OPENTOFU_COMPONENT_IMAGE_BUILD_RUNNER_TAG` CI/CD variable to a custom runner tag to use for the image build job. This may be useful if you require a dedicated privileged runner. diff --git a/README.md b/README.md index cfe642cd9f82ce2c6861534f86aad418c6264035..f3e7b37e3fff3579c9d05d85232025fdb2c66e6b 100644 --- a/README.md +++ b/README.md @@ -654,6 +654,14 @@ See also the official GitLab documentation for it If you want to save runner resources you may disable the unit and integration tests by setting the `SKIP_TESTS` CI/CD variable to `true`. +The component builds by default a multi-arch image for `linux/amd64` and `linux/arm64`. +There are multiple reasons why you might want to change this behavior, like saving runner resources. +To configure for what architectures the container image should be built, you can go to +the CI/CD variables in the project settings and add a variable called `PLATFORMS`. +The value is one or more `OS/ARCH[/VARIANT]`. If you have multiple platforms, they have to be comma separated. +**Keep in mind that the component is tested with `linux/amd64` and `linux/arm64`, +other platforms are not officially supported!** + You can set the `OPENTOFU_COMPONENT_IMAGE_BUILD_RUNNER_TAG` CI/CD variable to a custom runner tag to use for the image build job. This may be useful if you require a dedicated privileged runner.