DevOps as Craft

DevOps and DeSecOps in Romania - descoperă cum să integrezi securitatea în procesul de dezvoltare a aplicațiilor. Practica, tendințe, și instrumente.

How to Add GitLab Runner: A Comprehensive Tutorial

by ·

Setting up a GitLab Runner can seem like a big task, but it’s not too hard if you break it down into steps. This guide will walk you through everything you need to do to get a GitLab Runner up and running. Whether you’re updating your system, installing the runner, or configuring it just right, we’ve got you covered.

Key Takeaways

  • Always update your Ubuntu packages before starting any installation process to ensure everything runs smoothly.
  • Registering your GitLab Runner with your GitLab instance requires a special token from your GitLab project settings.
  • Starting and enabling the GitLab Runner service ensures it runs automatically whenever you boot your system.
  • Configuring the GitLab Runner involves editing a configuration file to set parameters like the runner’s name, URL, and token.
  • Uninstalling GitLab Runner involves stopping the service, removing the packages, and cleaning up configuration files.

Preparing Your System for GitLab Runner

Before diving into the installation of GitLab Runner, it’s crucial to prepare your system. This ensures a smooth installation process and optimal performance. Follow these steps to get your system ready.

Installing GitLab Runner

Downloading the GitLab Runner Package

First, you need to download the GitLab Runner package. This is a crucial step to get the runner up and running on your system. Use the following command to add the official GitLab repository:

curl -L "https://packages.gitlab.com/install/repositories/runner/gitlab-runner/script.deb.sh" | sudo bash

This command will add the necessary repository to your system, making it easier to install the GitLab Runner package.

Running the Installation Command

Once the repository is added, you can proceed with the installation. Run the following command to install GitLab Runner:

sudo apt-get install gitlab-runner

This command will download and install the GitLab Runner package on your system. Make sure to follow the prompts during the installation process to ensure everything is set up correctly.

Verifying the Installation

After the installation is complete, it’s important to verify that GitLab Runner is installed correctly. You can do this by checking the version of GitLab Runner installed on your system. Run the following command:

gitlab-runner --version

This command will display the version of GitLab Runner installed, confirming that the installation was successful. If you see the version number, you’re good to go!

Registering GitLab Runner with Your GitLab Instance

Obtaining Your GitLab Registration Token

First, you need to get your GitLab registration token. This token is essential for linking your runner to your GitLab instance. Head over to your GitLab project, navigate to Settings > CI/CD, and expand the Runners section. Here, you’ll find the registration token. Copy it, as you’ll need it in the next steps.

Running the Registration Command

With your token in hand, it’s time to register your runner. Open your terminal and run the following command:

sudo gitlab-runner register

This command will start an interactive session where you’ll be prompted to enter several pieces of information.

Entering Required Information

During the interactive session, you’ll need to provide the following details:

  1. GitLab instance URL: Enter the URL of your GitLab instance (e.g., https://gitlab.com).
  2. Registration token: Paste the token you copied earlier.
  3. Description: Give your runner a name. This helps you identify it later.
  4. Tags: Add tags to your runner. Tags are useful for specifying which jobs should run on this runner.
  5. Executor: Choose an executor. For most cases, docker is a good choice.
  6. Default Docker image: If you chose Docker as your executor, specify a default Docker image (e.g., alpine).

Once you’ve entered all the required information, your runner will be registered and ready to use.

Pro Tip: Make sure to double-check the URL and token to avoid any registration issues.

Starting and Enabling GitLab Runner

Starting the GitLab Runner Service

Once you’ve registered your GitLab Runner, it’s time to start the service. Open your terminal and type:

sudo gitlab-runner start

This command will start the GitLab Runner service, making it ready to execute jobs. Ensure the service is running to avoid any interruptions in your CI/CD pipeline.

Enabling Auto-Start on Boot

To make sure your GitLab Runner starts automatically every time your system boots, you need to enable the auto-start feature. Run the following command:

sudo gitlab-runner enable

This will configure your system to start the GitLab Runner service on boot, ensuring it’s always available to run your jobs.

Checking the Runner Status

Finally, you should verify that your GitLab Runner is up and running. Use this command to check its status:

sudo gitlab-runner status

This will display the current status of the GitLab Runner service. If everything is set up correctly, you should see a message indicating that the service is active and running.

Keeping your GitLab Runner service active is crucial for maintaining a smooth CI/CD workflow. Regularly check its status to ensure everything is functioning as expected.

Configuring GitLab Runner

Editing the Configuration File

After installing and registering your GitLab Runner, it’s time to tweak the configuration file. Open the file located at /etc/gitlab-runner/config.toml using a text editor. This file holds all the settings for your runner. Make sure to back up this file before making any changes.

In this file, you’ll see sections for each runner. You can adjust settings like the runner’s name, URL, and token. For example:

[[runners]]
  name = "my-runner"
  url = "https://gitlab.com/"
  token = "your-token"
  executor = "docker"

Setting Up Runner Parameters

Configuring the runner parameters is crucial for optimal performance. You can set parameters like executor, cache, and volumes. If you’re using Docker as an executor, you might want to set up volume directories. Here’s an example:

[runners.docker]
  tls_verify = false
  image = "alpine:latest"
  privileged = false
  disable_entrypoint_overwrite = false
  oom_kill_disable = false
  disable_cache = false
  volumes = ["/var/run/docker.sock:/var/run/docker.sock", "/cache"]
  shm_size = 0

Restarting GitLab Runner to Apply Changes

Once you’ve made your changes, you need to restart the GitLab Runner service to apply them. Use the following command:

sudo gitlab-runner restart

After restarting, check the status to ensure everything is running smoothly:

sudo gitlab-runner status

Remember, proper configuration is key to a smooth CI/CD pipeline. Take your time to review and adjust settings as needed.

Advanced Configuration Tips

Using Docker as an Executor

Using Docker as an executor can greatly enhance your CI/CD pipelines. Docker allows you to run jobs in containers, providing a consistent and isolated environment. This is especially useful for complex builds and tests. To set it up, simply specify docker as the executor in your .gitlab-ci.yml file.

Setting Up Volume Directories

Volume directories are essential for persisting data between jobs. You can mount directories from your host machine into the Docker container. This is useful for caching dependencies or sharing data between jobs. Add the volumes keyword in your configuration to set this up.

Maintaining Your Runner

Regular maintenance of your GitLab Runner ensures smooth operation. Keep your runner updated to the latest version to benefit from new features and security patches. Also, monitor the runner’s performance and logs to catch any issues early. Explore essential GitLab CI/CD strategies to streamline your DevOps workflows.

Proper maintenance and configuration can save you a lot of headaches down the line.

Uninstalling GitLab Runner

If you need to remove GitLab Runner from your system, follow these steps. This guide will help you cleanly uninstall GitLab Runner and remove all associated files.

Stopping the GitLab Runner Service

First, you need to stop the GitLab Runner service. Open your terminal and type:

sudo gitlab-runner stop

This command will stop the service, ensuring no processes are running during the uninstallation.

Removing GitLab Runner Packages

Next, remove the GitLab Runner package from your system. Use the following command:

sudo apt autoremove --purge gitlab-runner

This command will uninstall GitLab Runner and clean up any unnecessary dependencies.

Cleaning Up Configuration Files

Finally, delete any remaining configuration files and directories. Run these commands:

sudo rm -rf /etc/apt/sources.list.d/runner_gitlab-runner.list
sudo deluser --remove-home gitlab-runner
sudo rm -rf /etc/gitlab-runner

These commands will remove the repository list, delete the GitLab Runner user, and clean up the configuration directory.

Note: Make sure to back up any important data before running these commands.

By following these steps, you can ensure that GitLab Runner is completely removed from your system. If you ever need to reinstall it, you can follow the steps in our [comprehensive tutorial](building a robust ci/cd pipeline in gitlab).

Frequently Asked Questions

What is GitLab Runner and why do I need it?

GitLab Runner is a tool that runs jobs and sends the results back to GitLab. It helps automate tasks like testing and deploying code, making your development process smoother and faster.

How do I install GitLab Runner on my Ubuntu system?

First, update your Ubuntu packages. Then, add the GitLab Runner repository and install the package using the command ‘sudo apt install gitlab-runner’.

Where can I find the registration token for GitLab Runner?

You can find the registration token in your GitLab project settings. Go to Settings > CI/CD and expand the Runners section to find the token.

How do I start and enable GitLab Runner to start at boot?

Use the command ‘sudo gitlab-runner start’ to start the service. To enable it to start at boot, use ‘sudo gitlab-runner enable’.

Can I use Docker with GitLab Runner?

Yes, you can use Docker as an executor for GitLab Runner. This allows you to run jobs in Docker containers, providing a clean and consistent environment for each job.

How do I uninstall GitLab Runner from my system?

To uninstall GitLab Runner, stop the service using ‘sudo gitlab-runner stop’, remove the package with ‘sudo apt autoremove –purge gitlab-runner’, and delete the configuration files.

Tags:

You may also like...