From b36e33b02b693bb20393171cee9e13b693ee06d1 Mon Sep 17 00:00:00 2001 From: Marlon Moser <marlon.moser@adfinis.com> Date: Tue, 26 Nov 2024 10:48:17 +0100 Subject: [PATCH] docs(configure-arch): add description about how to configure build architectures --- .gitlab/README.md.template | 8 ++++++++ README.md | 8 ++++++++ 2 files changed, 16 insertions(+) diff --git a/.gitlab/README.md.template b/.gitlab/README.md.template index d29a179..34162eb 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 cfe642c..584f4d3 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. -- GitLab