[FEATURE] #1217 Added feature to emulate gitlab hosted runner using the --container-emulate option with the name of one of the gitlab preset.
#1219
Conversation
Added feature to emulate gitlab hosted runner using the `--emulate` option with the name of one of the gitlab preset.
tests/test-cases/gitlab-runner-emulation/integration.emulate-runner.test.ts
Outdated
Show resolved
Hide resolved
Changed initBashSpy function to return the spy in order to validate function call on it. Changed tests to use initBashSpy function. Changed memory preset to use `* 1024`, which helps readability.
ANGkeith
changed the title
--emulate option with the name of one of the gitlab preset.--container-emulate option with the name of one of the gitlab preset.
Changed emulation option from `--emulate` to `--container-emulate` to follow container option convention.
|
thanks for the contribution ! |
Added gitlab hosted runner documentation url in the description of the new `--container-emulate` option. Replaced "container-emulate" with "containerEmulate".
|
@nicDamours I don't see the purpose of the amd64 postfix. |
@firecow it's the name given by gitlab for those specific runner: https://docs.gitlab.com/ee/ci/runners/hosted_runners/linux.html#machine-types-available-for-linux---x86-64 It's not essential for this feature but it helps linking gitlab's runner to the preset defined here. |
I can imagine people with ARM processors will be very confused, when they realise that using such a preset, actually works 😄 |
|
I can see how that would be confusing. I will remove the amd64 prefix 🙂 |
Removed amd64 suffix from possible runner emulation name.
Removed "AMD_64" from runner preset enum.
summary
Added an option to prefill
memory,kernel-memoryandcpusdocker options based on the configuration of Gitlab's hosted runner. This is useful when attempting to debug performance issue. By default, no limit is applied, the host resources are all available.When passing the option
--container-emulate=with the name of a gitlab hosted runner, the docker resources is limited to the resource available for this class of hosted runner. As of this PR, those are the valuessaas-linux-smallsaas-linux-mediumsaas-linux-largesaas-linux-xlargesaas-linux-2xlargesee the gitlab documentation here
Of course, you are also limited to the host resources. You cannot have 128 GB of RAM on a host that only has 16 GB.
As of right now, I've only added support for the base linux machine. This does not include runner with a GPUs. This could be a nice amelioration in the futur. The runners names does not contains the architecture, as this is based on the host CPU, and cannot be emulated.
Usage
You can pass an additional option
--containter-emulatewith one of the previously mentionned runner name. For example, using the namesaas-linux-smallwill limit the container resource to 8 GB or RAM and 2 CPUs.You can check the memory limit and CPU usage using the
docker stats {container_id}command.This PR Closes #1217