feat!: allow to set all docker options for the Executor

[kayman-mk]

Description

Adds a new variable runners_docker_options which holds all values for the [runners.docker] section and makes the single variables

• runners_image
• runners_privileged
• runners_disable_cache
• runners_additional_volumes
• runners_shm_size
• runners_docker_runtime
• runners_helper_image
• runners_pull_policy

obsolete.

Migrations required

Yes, as the minimum Terraform version is 1.3.0 to support optional block variables with defaults.

A migration script is provided to restructure the variables. See /migrations/migrate-to-7-0-0.sh. Attention Mac users: The script will not work out of the box as the sed implementation is different. Use a Docker container with Alpine or Ubuntu to run the script.

module "gitlab_ci_runner" {
  ...
  runners_docker_options {
    # set whatever is necessary
  }

Verification

• Use current configuration and ensure that the config.toml remains unchanged
• Set all new block variables and ensure that the config.toml is valid (use `gitlab-runner verify)
• Check that the default settings with Terraform 1.3 work as expected
• Verify all docker settings against the documentation to ensure correct names

The runner starts in both cases and is available in Gitlab. No example tested but used our active configuration at Hapag-Lloyd.

[kayman-mk]

Make sure to write the toml file with correct data types, e.g. boolean and numbers without ""

[kayman-mk]

@npalm Not a good idea?
There are so many variables and many more to come as the issues here indicate (#467, #491, #513). Thought it would be better to place them in a map for a cleaner module interface.

[kayman-mk]

A block would be an alternative solution.

runners_docker_options {
  shm_size =0
}

[JulianCBC]

Could we get rid of the runners_enable_docker_options variable and maintain backwards compatibility by making the default just use the old variables?

We'd have to note on the old variables that if runners_docker_options is set, then they're ignored, but that'd simplify a lot of the code here.

[kayman-mk]

Sure. But setting a default for the new block is problematic. I have to know whether the new block is used or the old variables.

We could set a default null and then decide: if var.runners_docker_options == null then use old variables else use new block variables.

As soon as the old variables are removed we could set the default for the block.

[JulianCBC]

Other than enabling the experiment which I can't see actually being used right now, this looks good to me!

I can't help but wonder if you could use the template for both the original and new variable sets, and do all the formatting of the volumes string in the template, but those are pretty minor quibbles and the code I'm complaining about is deprecated.

[kayman-mk]

Yeah, the experiment is not my favorite too. But it made it into Terraform 1.3.0 (released soon). Default values will also be possible.

[kayman-mk]

Good point though. Reworked that section. Looks much better now.

[kayman-mk]

Looks better but doesn't work. I always access null variables. Reverted.

[npalm]

Would be great when we can move to Terrfaform 1.3. The optiional in object will made the code a lot cleaner on my places. Just checked, there are two alphaversions out. So it is still in an early state but at least we see the progress towards 1.3

[kayman-mk]

Still waiting for the Terraform 1.3 release. No idea when this will happen.

[demisx]

Can this be finalized and merged soon? We need to change wait_for_services_timeout param in runners.docker section and it appears there is no way to do so until this PR is merged. Thank you.

[tmeijn]

FYI: services_security_opt made it into GitLab Runner 15.10 today... https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/3760. It's not documented yet though...

[kayman-mk]

@npalm Conflicts solved and merged into the upcoming major release branch.