bitnamicharts/gitlab-runner repository overview

⁠Bitnami Secure Images Helm chart for Gitlab Runner

Gitlab Runner is an auxiliary application for Gitlab installations. Written in Go, it allows to run CI/CD jobs and send the results back to Gitlab.

Overview of Gitlab Runner⁠

Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

⁠ TL;DR

helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/gitlab-runner

⁠ Introduction

This chart bootstraps a Gitlab Runner⁠ deployment on a Kubernetes⁠ cluster using the Helm⁠ package manager.

⁠ Before you begin

• Kubernetes 1.23+
• Helm 3.8.0+

⁠ Installing the Chart

To install the chart with the release name my-release:

helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/gitlab-runner

These commands deploy Gitlab Runner on the Kubernetes cluster in the default configuration. The Parameters⁠ section lists the parameters that can be configured during installation.

⁠ Configuration and installation details

This section describes credentials, configuration, and other installation options.

⁠ Connect to Gitlab instance

Gitlab Runner requires connecting to an existing Gitlab installation. Follow these steps in your Gitlab installation:

• Create a runner in the CI/CD admin panel⁠
• Obtain the registration token
• Deploy Gitlab Runner setting the runnerToken (or provide a secret with existingSecret) value with the previously obtained token, as well as the gitlabUrl value with the URL of the Gitlab instance.
• Check the registration status in your Gitlab instance.

⁠ Setting the runner configuration

The Gitlab Runner chart deploys a runner with kubernetes as the executor. It is possible to modify the default configuration by changing the runners.config value. In the example below we change the default job image:

runners:
  config: |
    [[runners]]
      [runners.kubernetes]
        namespace = "{{ include "common.names.namespace" . }}"
        image = "bitnami/os-shell"

⁠ Prometheus metrics

This chart can be integrated with Prometheus by setting metrics.enabled to true. This will expose the Gitlab Runner native Prometheus endpoint in a metrics service, which can be configured under the metrics.service section. It will have the necessary annotations to be automatically scraped by Prometheus.

⁠Prometheus requirements

It is necessary to have a working installation of Prometheus or Prometheus Operator for the integration to work. Install the Bitnami Prometheus helm chart⁠ or the Bitnami Kube Prometheus helm chart⁠ to easily have a working Prometheus in your cluster.

⁠Integration with Prometheus Operator

The chart can deploy ServiceMonitor objects for integration with Prometheus Operator installations. To do so, set the value metrics.serviceMonitor.enabled=true. Ensure that the Prometheus Operator CustomResourceDefinitions are installed in the cluster or it will fail with the following error:

no matches for kind "ServiceMonitor" in version "monitoring.coreos.com/v1"

Install the Bitnami Kube Prometheus helm chart⁠ for having the necessary CRDs and the Prometheus Operator.

⁠ Resource requests and limits

Bitnami charts allow setting resource requests and limits for all containers inside the chart deployment. These are inside the resources value (check parameter table). Setting requests is essential for production workloads and these should be adapted to your specific use case.

To make this process easier, the chart contains the resourcesPreset values, which automatically sets the resources section according to different presets. Check these presets in the bitnami/common chart⁠. However, in production workloads using resourcesPreset is discouraged as it may not fully adapt to your specific needs. Find more information on container resource management in the official Kubernetes documentation⁠.

⁠ Rolling vs Immutable tags⁠

It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.

Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.

⁠ Enable RBAC security

In order to enable Role-Based Access Control (RBAC) for Gitlab Runner, use the following parameter: rbac.create=true.

⁠ Set Pod affinity

This chart allows you to set custom Pod affinity using the affinity parameter. Find more information about Pod affinity in the Kubernetes documentation⁠.

As an alternative, you can use one of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common⁠ chart. To do so, set the podAffinityPreset, podAntiAffinityPreset, or nodeAffinityPreset parameters.

⁠ Gateway API

This chart provides support for exposing Session Server using the Gateway API⁠ and its HTTPRoute resource. If you have a Gateway controller installed on your cluster, such as APISIX, Contour, Envoy Gateway, NGINX Gateway Fabric or Kong Ingress Controller you can utilize the Gateway controller to serve your application. To enable Gateway API integration, set sessionServer.httpRoute.enabled to true. The Gateway to be used can be customized by setting the sessionServer.httpRoute.parentRefs parameter. By default, it will reference a Gateway named gateway in the same namespace as the release.

You can specify the list of hostnames to be mapped to the deployment using the sessionServer.httpRoute.hostnames parameter. Additionally, you can customize the rules used to route the traffic to the service by modifying the sessionServer.httpRoute.matches and sessionServer.httpRoute.filters parameters or adding new rules using the sessionServer.httpRoute.extraRules parameter.

⁠ Ingress

This chart provides support for Ingress resources for the session server. If you have an ingress controller installed on your cluster, such as nginx-ingress-controller⁠ or contour⁠ you can utilize the ingress controller to serve your application. To enable Ingress integration, set sessionServer.ingress.enabled to true.

The most common scenario is to have one host name mapped to the deployment. In this case, the sessionServer.ingress.hostname property can be used to set the host name. The sessionServer.ingress.tls parameter can be used to add the TLS configuration for this host.

However, it is also possible to have more than one host. To facilitate this, the sessionServer.ingress.extraHosts parameter (if available) can be set with the host names specified as an array. The sessionServer.ingress.extraTLS parameter (if available) can also be used to add the TLS configuration for extra hosts.

Adding the TLS parameter (where available) will cause the chart to generate HTTPS URLs, and the application will be available on port 443. The actual TLS secrets do not have to be generated by this chart. However, if TLS is enabled, the Ingress record will not work until the TLS secret exists.

Learn more about Ingress controllers⁠.

⁠ FIPS parameters

The FIPS parameters only have effect if you are using images from the Bitnami Secure Images catalog⁠.

For more information on this new support, please refer to the FIPS Compliance section⁠.

⁠ Parameters

The following subsections list global, common, and component-specific parameters.

⁠ Global parameters

⁠ Common parameters

⁠ Gitlab Runner parameters

Note: the README for this chart is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at https://techdocs.broadcom.com/us/en/vmware-tanzu/bitnami-secure-images/bitnami-secure-images/services/bsi-app-doc/apps-charts-gitlab-runner-index.html⁠