Gitlab runner - Revision history

Gabyx: feat: add link to podman executor

2026-09-23T12:12:38Z

feat: add link to podman executor

← Older revision		Revision as of 12:12, 23 September 2026
Line 5:		Line 5:
	Once you have Gitlab installed and running you can install a Gitlab Runner. The Runner does not need to run on the same machine as Gitlab and you will need to register the Runner with Gitlab, to do this you will generate a token in Gitlab.		Once you have Gitlab installed and running you can install a Gitlab Runner. The Runner does not need to run on the same machine as Gitlab and you will need to register the Runner with Gitlab, to do this you will generate a token in Gitlab.

	~~== The state of gitlab-runner in nixpkgs ==~~		As of 20.09 NixOS comes with a revamped Gitlab Runner module which provides the capabilities to set up custom to meet your needs. The {{nixos:option\|services.gitlab-runner.services}} documents a number of typical setups and this article gives an overview of some of the more complex setups.
	As of 20.09 NixOS comes with a revamped ~~gitlab-runner~~ module which provides the capabilities to set up custom to meet your needs.
	The {{nixos:option\|services.gitlab-runner.services}} documents a number of typical setups and this article gives an overview of some of the more complex setups.

	The ~~NixOS manual [~~https://~~nixos~~.~~org~~/~~manual~~/nixos~~/unstable/#module-services~~-gitlab-runner gives ~~an extensive~~ runner ~~example (~~the ~~VM test)] which demonstrates the following~~ features:		== Configuring a <code>podman</code>-Executor with Nix Store Caching ==
			The repository https://github.com/gabyx/nixos-gitlab-runner gives a production-ready runner setup for your Nix CI. It was motivated by the below simpler examples but provides more features.

	* a <code>docker</code>-~~executor using <code>podman</code> and serving a containerized~~ Nix Store ~~daemon among all jobs.~~		== Configuring a <code>docker</code>-Executor with Nix Store Caching ==
	* Multiple Gitlab job container images which work with <code>nix</code>.

	~~The following examples give some motivations for the above.~~

	~~== Configuring a caching dockerized gitlab build runner~~ ==
	With the configuration defined below a gitlab runner will be created which provides a caching docker container to run nix-build.		With the configuration defined below a gitlab runner will be created which provides a caching docker container to run nix-build.
	<syntaxHighlight lang=nix>		<syntaxHighlight lang=nix>

Gabyx at 23:07, 25 January 2026

2026-01-25T23:07:22Z

← Older revision		Revision as of 23:07, 25 January 2026
Line 14:		Line 14:
	* Multiple Gitlab job container images which work with <code>nix</code>.		* Multiple Gitlab job container images which work with <code>nix</code>.

	The following give some ~~easier to understand~~ motivations for the above.		The following examples give some motivations for the above.

	== Configuring a caching dockerized gitlab build runner ==		== Configuring a caching dockerized gitlab build runner ==

Gabyx: feat: add the NixOS manual Gitlab runner example link

2026-01-25T23:06:56Z

feat: add the NixOS manual Gitlab runner example link

← Older revision		Revision as of 23:06, 25 January 2026
Line 8:		Line 8:
	As of 20.09 NixOS comes with a revamped gitlab-runner module which provides the capabilities to set up custom to meet your needs.		As of 20.09 NixOS comes with a revamped gitlab-runner module which provides the capabilities to set up custom to meet your needs.
	The {{nixos:option\|services.gitlab-runner.services}} documents a number of typical setups and this article gives an overview of some of the more complex setups.		The {{nixos:option\|services.gitlab-runner.services}} documents a number of typical setups and this article gives an overview of some of the more complex setups.

			The NixOS manual [https://nixos.org/manual/nixos/unstable/#module-services-gitlab-runner gives an extensive runner example (the VM test)] which demonstrates the following features:

			* a <code>docker</code>-executor using <code>podman</code> and serving a containerized Nix Store daemon among all jobs.
			* Multiple Gitlab job container images which work with <code>nix</code>.

			The following give some easier to understand motivations for the above.

	== Configuring a caching dockerized gitlab build runner ==		== Configuring a caching dockerized gitlab build runner ==

Mic92: imported from old wiki

2024-09-27T08:27:14Z

imported from old wiki

← Older revision		Revision as of 08:27, 27 September 2024
Line 1:		Line 1:
			== Introduction ==
			This is the partner page to [[Gitlab]].
			A Gitlab pipeline runs operations on a Gitlab Runner. These operations can include building an executable, running a test suite, pushing a docker image, etc.

			Once you have Gitlab installed and running you can install a Gitlab Runner. The Runner does not need to run on the same machine as Gitlab and you will need to register the Runner with Gitlab, to do this you will generate a token in Gitlab.

	== The state of gitlab-runner in nixpkgs ==		== The state of gitlab-runner in nixpkgs ==
	As of 20.09 NixOS comes with a revamped gitlab-runner module which provides the capabilities to set up custom to meet your needs.		As of 20.09 NixOS comes with a revamped gitlab-runner module which provides the capabilities to set up custom to meet your needs.
	The {{nixos:option\|services.gitlab-runner.services}} documents a number of typical setups and this article gives an overview of some of the more complex setups.		The {{nixos:option\|services.gitlab-runner.services}} documents a number of typical setups and this article gives an overview of some of the more complex setups.

	== Configuring a caching dockerized gitlab build runner ==		== Configuring a caching dockerized gitlab build runner ==
	With the configuration defined below a gitlab runner will be created which provides a caching docker container to run nix-build.		With the configuration defined below a gitlab runner will be created which provides a caching docker container to run nix-build.

Klinger: Category:Applications Category:Server Category:Container

2024-04-19T21:04:17Z

Category:Applications Category:Server Category:Container

← Older revision		Revision as of 21:04, 19 April 2024
Line 178:		Line 178:

	[[Category:Applications]]		[[Category:Applications]]
			[[Category:Server]]
			[[Category:Container]]

imported>Cynerd at 08:27, 20 October 2022

2022-10-20T08:27:06Z

@@ Line 65: / Line 65: @@
 </syntaxHighlight>
 }}
 [[Category:Applications]]

imported>Novmar at 13:53, 19 October 2022

2022-10-19T13:53:29Z

← Older revision		Revision as of 13:53, 19 October 2022
Line 7:		Line 7:
	{		{
	boot.kernel.sysctl."net.ipv4.ip_forward" = true; # 1		boot.kernel.sysctl."net.ipv4.ip_forward" = true; # 1
	~~virtualization~~.docker.enable = true;		virtualisation.docker.enable = true;
	services.gitlab-runner = {		services.gitlab-runner = {
	enable = true;		enable = true;

imported>Yajo: This is the correct env to load for a daemon nix environment

2022-07-22T16:49:15Z

This is the correct env to load for a daemon nix environment

← Older revision		Revision as of 16:49, 22 July 2022
Line 35:		Line 35:
	mkdir -p -m 0755 /nix/var/nix/profiles/per-user/root		mkdir -p -m 0755 /nix/var/nix/profiles/per-user/root
	mkdir -p -m 0700 "$HOME/.nix-defexpr"		mkdir -p -m 0700 "$HOME/.nix-defexpr"
	. ${pkgs.nix}/etc/profile.d/nix.sh		. ${pkgs.nix}/etc/profile.d/nix-daemon.sh
	${pkgs.nix}/bin/nix-channel --add https://nixos.org/channels/nixos-20.09 nixpkgs # 3		${pkgs.nix}/bin/nix-channel --add https://nixos.org/channels/nixos-20.09 nixpkgs # 3
	${pkgs.nix}/bin/nix-channel --update nixpkgs		${pkgs.nix}/bin/nix-channel --update nixpkgs

imported>Nix: add Software/Applications subcategory

2021-09-20T05:50:57Z

add Software/Applications subcategory

← Older revision		Revision as of 05:50, 20 September 2021
Line 65:		Line 65:
	</syntaxHighlight>		</syntaxHighlight>
	}}		}}

			[[Category:Applications]]

imported>Makefu: init

2020-11-24T22:44:36Z

init

New page

== The state of gitlab-runner in nixpkgs ==
As of 20.09 NixOS comes with a revamped gitlab-runner module which provides the capabilities to set up custom to meet your needs.
The {{nixos:option|services.gitlab-runner.services}} documents a number of typical setups and this article gives an overview of some of the more complex setups.
== Configuring a caching dockerized gitlab build runner ==
With the configuration defined below a gitlab runner will be created which provides a caching docker container to run nix-build.
<syntaxHighlight lang=nix>
{
boot.kernel.sysctl."net.ipv4.ip_forward" = true; # 1
virtualization.docker.enable = true;
services.gitlab-runner = {
enable = true;
services= {
# runner for building in docker via host's nix-daemon
# nix store will be readable in runner, might be insecure
nix = with lib;{
# File should contain at least these two variables:
# `CI_SERVER_URL`
# `REGISTRATION_TOKEN`
registrationConfigFile = toString ./path/to/ci-env; # 2
dockerImage = "alpine";
dockerVolumes = [
"/nix/store:/nix/store:ro"
"/nix/var/nix/db:/nix/var/nix/db:ro"
"/nix/var/nix/daemon-socket:/nix/var/nix/daemon-socket:ro"
];
dockerDisableCache = true;
preBuildScript = pkgs.writeScript "setup-container" ''
mkdir -p -m 0755 /nix/var/log/nix/drvs
mkdir -p -m 0755 /nix/var/nix/gcroots
mkdir -p -m 0755 /nix/var/nix/profiles
mkdir -p -m 0755 /nix/var/nix/temproots
mkdir -p -m 0755 /nix/var/nix/userpool
mkdir -p -m 1777 /nix/var/nix/gcroots/per-user
mkdir -p -m 1777 /nix/var/nix/profiles/per-user
mkdir -p -m 0755 /nix/var/nix/profiles/per-user/root
mkdir -p -m 0700 "$HOME/.nix-defexpr"
. ${pkgs.nix}/etc/profile.d/nix.sh
${pkgs.nix}/bin/nix-channel --add https://nixos.org/channels/nixos-20.09 nixpkgs # 3
${pkgs.nix}/bin/nix-channel --update nixpkgs
${pkgs.nix}/bin/nix-env -i ${concatStringsSep " " (with pkgs; [ nix cacert git openssh ])}
'';
environmentVariables = {
ENV = "/etc/profile";
USER = "root";
NIX_REMOTE = "daemon";
PATH = "/nix/var/nix/profiles/default/bin:/nix/var/nix/profiles/default/sbin:/bin:/sbin:/usr/bin:/usr/sbin";
NIX_SSL_CERT_FILE = "/nix/var/nix/profiles/default/etc/ssl/certs/ca-bundle.crt";
};
tagList = [ "nix" ];
};
};
};
}
</syntaxHighlight>

# enabling <code>ip_forward</code> on the host machine is important for the docker container to be able to perform networking tasks (such as cloning the gitlab repo)
# the <code>registrationConfigFile</code> must contain the gitlab token for registering a gitlab-runner
# this line defines the default nixpkgs channel to be used inside the container

{{Note|In order to have <code>NIX_PATH</code> set, the <code>etc/profile.d/nix.sh</code> file must be sourced in the <code>.gitlab-ci.yml</code> of your project:
<syntaxHighlight lang=yaml>
before_script:
- . "$HOME/.nix-profile/etc/profile.d/nix.sh"
...
</syntaxHighlight>
}}