Deploying GitLab Runner on a Yandex Compute Cloud virtual machine
GitLab Runner.gitlab-ci.yml. You can deploy GitLab Runner not only in a Yandex Managed Service for Kubernetes cluster but also on a Compute Cloud virtual machine, which is an easier and cheaper option.
For a custom (self-managed) GitLab installation, you can manually install GitLab Runner on a Compute Cloud VM.
For Yandex Managed Service for GitLab, you can also manually install GitLab Runner or automatically deploy a runner in the management console
Note
To get started with GitLab Runner using Compute Cloud:
- Set up your infrastructure.
- Get a GitLab Runner token.
- Deploy GitLab Runner.
- Create a test scenario.
If you no longer need the resources you created, delete them.
Required paid resources
The infrastructure support cost includes:
- Fee for disks and continuously running VMs (see Yandex Compute Cloud pricing).
- Fee for using a public IP address (see Yandex Virtual Private Cloud pricing).
Set up your infrastructure
- Create and activate a Managed Service for GitLab instance.
- Create a GitLab
project.
Get a GitLab Runner token
You can get a token when creating a GitLab Runner in GitLab. You specify this token when deploying GitLab Runner on a Compute Cloud VM to have a runner authenticated in GitLab.
To create and configure GitLab Runner for the entire GitLab instance, proceed as follows (GitLab admin permissions required):
- Open GitLab.
- In the bottom-left corner, click Admin.
- In the left-hand menu, select CI/CD → Runners.
- Click New instance runner and create a new GitLab Runner.
- Save the value of the
Runner authentication tokenparameter.
To create and set up GitLab Runner for a project
- Open GitLab.
- Select a project.
- In the left-hand menu, select Settings → CI/CD.
- Under Runners, click Expand.
- Click New project runner and create a new GitLab Runner.
- Save the value of the
Runner authentication tokenparameter.
Deploy GitLab Runner
You can install GitLab Runner manually or deploy a runner in the management console automatically.
Install GitLab Runner on a VM manually
-
Create a VM from a public Ubuntu 22.04 LTS image.
-
Connect to the VM over SSH:
ssh <login>@<VM_public_IP_address> -
Install the git and jq utilities:
sudo apt-get --yes install git jq -
Add a repository with GitLab Runner to the package manager:
curl --location https://packages.gitlab.com/install/repositories/runner/gitlab-runner/script.deb.sh | sudo bash -
Install GitLab Runner:
sudo apt-get -y install gitlab-runner -
Register GitLab Runner:
sudo gitlab-runner registerThe command will prompt you for additional data:
- URL of the GitLab instance in
https://<domain>/format. - Previously obtained GitLab Runner token.
- GitLab Runner description.
- Do not specify GitLab Runner tags and the update settings (
maintenance note). executor:shell.
Result:
Runner registered successfully. Feel free to start it, but if it's running already the config should be automatically reloaded! Configuration (with the authentication token) was saved in "/etc/gitlab-runner/config.toml" - URL of the GitLab instance in
Create a runner using the management console
Note
Warning
There is a fee for using VM instances (workers) (see Compute Cloud pricing).
The feature of creating runners from the management console is only available for Managed Service for GitLab instances.
-
Select the Managed Service for GitLab instance you need to create a runner for.
-
Select the Runners tab.
-
Click Create Runner.
-
Enter a name for the runner:
- The name must be 2 to 63 characters long.
- It can only contain lowercase Latin letters, numbers, and hyphens.
- It must start with a letter and cannot end with a hyphen.
-
Optionally, enter a random decription for the runner.
-
Enter the previously obtained GitLab Runner token.
-
Select or create a service account for the runner.
Note
This service account will be used only to create the VM and will not be linked to it. The service account must have the compute.admin, vpc.admin, and iam.serviceAccounts.user roles. For more information, see Assigning roles to a service account.
-
Optionally, add labels to break runners into logical groups.
-
Under Autoscale settings, specify:
- Minimum workers: Number of workers that are always running and ready to execute jobs. Default value:
1; minimum:0; maximum:10. - Maximum workers: Maximum number of workers that can be created to execute jobs. Default value:
3; minimum:1; maximum:30. The maximum number of workers cannot be less than the minimum number. - Maximum worker downtime, in minutes: Maximum idle time after which the additionally created worker will be deleted. Default value:
10; minimum:0. - Maximum number of jobs per worker: Maximum number of jobs after which the worker will be deleted. Default value:
100; minimum:0. - Number of parallel tasks per worker: Number of parallel jobs per worker. Default value:
1; minimum:0.
- Minimum workers: Number of workers that are always running and ready to execute jobs. Default value:
-
Optionally, add labels for the worker.
-
Under Computing resources, select a computing resource configuration.
-
Under Disks and file storages, configure the boot disk:
- Select the disk type.
- Specify the disk size.
-
Optionally, select or create a service account for the worker.
Note
This service account will be associated with the worker VM. The worker can use the account to authenticate in the Yandex Cloud API and access cloud resources.
Assign your service account a role for the resource you want to manage.
-
Optionally, select a security group.
-
Click Create.
Test the runner
-
If GitLab Runner was created for the whole GitLab instance:
- In the bottom-left corner, click Admin.
- In the left-hand menu, select CI/CD → Runners.
- Make sure the new runner is now in the list.
-
If GitLab Runner was created for a project:
- Open your project.
- In the left-hand menu, select Settings → CI/CD.
- Under Runners, click Expand.
- Make sure the new runner has appeared in the Assigned project runners section.
Make sure the new VMs with the runner- name prefix have appeared in the Virtual machines section.
Create a test scenario
-
Open the GitLab project.
-
Select Build → Pipeline editor in the left-hand menu. A page will open asking you to add a new file named
.gitlab-ci.yml, in which you need to describe the scenario in YAML format. -
Add the scenario text:
build: stage: build script: - echo "Hello, $GITLAB_USER_LOGIN!" test: stage: test script: - echo "This job tests something" deploy: stage: deploy script: - echo "This job deploys something from the $CI_COMMIT_BRANCH branch." environment: production -
Click Commit changes.
-
Select Build → Jobs in the left-hand menu.
-
Make sure that three jobs have the
Passedstatus.
Delete the resources you created
Some resources are not free of charge. Delete the resources you no longer need to avoid paying for them: