Install GitLab Runner on Red Hat OpenShift
- Introduced in GitLab 13.3.
- Updated in GitLab 13.7.
You can install the GitLab Runner on Red Hat OpenShift v4 and later using the GitLab Runner Operator available from the beta channel of OperatorHub embedded in OpenShift’s web console. Once installed, you can run your GitLab CI/CD jobs using the newly deployed GitLab Runner instance. Each CI/CD job will run in a separate pod.
Prerequisites
- OpenShift 4.x cluster with administrator privileges
- GitLab Runner registration token
Install the OpenShift Operator
First you must install the OpenShift Operator.
- Open the OpenShift UI and log in as a user with administrator privileges.
- In the left pane, click Operators, then OperatorHub.
-
In the main pane, below All Items, search for the keyword
GitLab
. - To install, click the GitLab Runner Operator.
- On the GitLab Runner Operator summary page, click Install.
-
On the Install Operator page, under Installed Namespace, select the desired namespace and click Install.
On the Installed Operators page, when the GitLab Operator is ready, the status changes to Succeeded.
Install GitLab Runner
Now install GitLab Runner. The version you’re installing is tagged as the latest in the Red Hat Ecosystem Catalog container list.
- Obtain a token that you’ll use to register the runner:
- For a shared runner, have an administrator go to the GitLab Admin Area and click Overview > Runners.
- For a group runner, go to Settings > CI/CD and expand the Runners section.
- For a project-specific runner, go to Settings > CI/CD and expand the Runners section.
- Under Use the following registration token during setup:, copy the token.
-
Open an OpenShift console and switch to the project namespace:
oc project "PROJECT NAMESPACE"
-
Create the secret file with your GitLab project’s runner token:
cat > gitlab-runner-secret.yml << EOF apiVersion: v1 kind: Secret metadata: name: gitlab-runner-secret type: Opaque stringData: runner-registration-token: REPLACE_ME # your project runner secret EOF
-
Create the secret in your cluster by running:
oc apply -f gitlab-runner-secret.yml
-
Create the Custom Resource Definition (CRD) file and include the following information. The
tags
value must beopenshift
for the job to run.cat > gitlab-runner.yml << EOF apiVersion: apps.gitlab.com/v1beta2 kind: Runner metadata: name: gitlab-runner spec: gitlabUrl: https://gitlab.example.com buildImage: alpine token: gitlab-runner-secret tags: openshift EOF
-
Now apply the CRD file by running the command:
oc apply -f gitlab-runner.yml
-
Confirm that GitLab Runner is installed by running:
oc get runners NAME AGE gitlab-runner 5m
-
The runner pod should also be visible:
oc get pods NAME READY STATUS RESTARTS AGE gitlab-runner-bf9894bdb-wplxn 1/1 Running 0 5m