Skip to content
Snippets Groups Projects

Helm chart install page: start structural revisions

Merged Amy Qualls requested to merge aqualls-k8s-structure1 into main
All threads resolved!
1 file
+ 43
52
Compare changes
  • Side-by-side
  • Inline
+ 43
52
@@ -66,6 +66,32 @@ To install GitLab Runner by using the Helm chart:
@@ -66,6 +66,32 @@ To install GitLab Runner by using the Helm chart:
to your `helm install` command. You can install any version of the chart, but more recent `values.yml` might
to your `helm install` command. You can install any version of the chart, but more recent `values.yml` might
be incompatible with older versions of the chart.
be incompatible with older versions of the chart.
 
### Check available GitLab Runner Helm Chart versions
 
 
Helm Chart and GitLab Runner do not follow the same versioning. To see version mappings
 
between the two, run the command for your version of Helm:
 
 
```shell
 
# For Helm 2
 
helm search -l gitlab/gitlab-runner
 
 
# For Helm 3
 
helm search repo -l gitlab/gitlab-runner
 
```
 
 
An example of the output:
 
 
```plaintext
 
NAME CHART VERSION APP VERSION DESCRIPTION
 
gitlab/gitlab-runner 0.64.0 16.11.0 GitLab Runner
 
gitlab/gitlab-runner 0.63.0 16.10.0 GitLab Runner
 
gitlab/gitlab-runner 0.62.1 16.9.1 GitLab Runner
 
gitlab/gitlab-runner 0.62.0 16.9.0 GitLab Runner
 
gitlab/gitlab-runner 0.61.3 16.8.1 GitLab Runner
 
gitlab/gitlab-runner 0.61.2 16.8.0 GitLab Runner
 
...
 
```
 
## Upgrading GitLab Runner using the Helm Chart
## Upgrading GitLab Runner using the Helm Chart
Prerequisites:
Prerequisites:
@@ -75,7 +101,7 @@ Prerequisites:
@@ -75,7 +101,7 @@ Prerequisites:
[authorization errors when they complete](../faq/index.md#helm-chart-error--unauthorized).
[authorization errors when they complete](../faq/index.md#helm-chart-error--unauthorized).
- You've ensured all jobs have completed.
- You've ensured all jobs have completed.
Use `helm upgrade` to change configuration or update charts, changing parameters as needed:
To change your configuration or update charts, use `helm upgrade`, changing parameters as needed:
```shell
```shell
helm upgrade --namespace <NAMESPACE> -f <CONFIG_VALUES_FILE> <RELEASE-NAME> gitlab/gitlab-runner
helm upgrade --namespace <NAMESPACE> -f <CONFIG_VALUES_FILE> <RELEASE-NAME> gitlab/gitlab-runner
@@ -89,41 +115,30 @@ helm upgrade --namespace <NAMESPACE> -f <CONFIG_VALUES_FILE> <RELEASE-NAME> gitl
@@ -89,41 +115,30 @@ helm upgrade --namespace <NAMESPACE> -f <CONFIG_VALUES_FILE> <RELEASE-NAME> gitl
- To update to a specific version of the GitLab Runner Helm Chart, rather than the latest one, add
- To update to a specific version of the GitLab Runner Helm Chart, rather than the latest one, add
`--version <RUNNER_HELM_CHART_VERSION>` to your `helm upgrade` command.
`--version <RUNNER_HELM_CHART_VERSION>` to your `helm upgrade` command.
## Check available GitLab Runner Helm Chart versions
## Uninstalling GitLab Runner using the Helm Chart
Versions of Helm Chart and GitLab Runner do not follow the same versioning.
To uninstall GitLab Runner:
Use the command below to get version mappings between Helm Chart and GitLab Runner:
```shell
1. Pause the runner in GitLab, and ensure any jobs have completed. This prevents job-related problems, such as
# For Helm 2
[authorization errors on completion](../faq/index.md#helm-chart-error--unauthorized).
helm search -l gitlab/gitlab-runner
1. Run, this command, modifying it as needed:
# For Helm 3
```shell
helm search repo -l gitlab/gitlab-runner
helm delete --namespace <NAMESPACE> <RELEASE-NAME>
```
```
An example of the output:
```plaintext
- `<NAMESPACE>` is the Kubernetes namespace where GitLab Runner is installed.
NAME CHART VERSION APP VERSION DESCRIPTION
- `<RELEASE-NAME>` is the name you gave the chart when you installed it.
gitlab/gitlab-runner 0.64.0 16.11.0 GitLab Runner
In the [installation section](#installing-gitlab-runner-using-the-helm-chart) of this page, we called it `gitlab-runner`.
gitlab/gitlab-runner 0.63.0 16.10.0 GitLab Runner
gitlab/gitlab-runner 0.62.1 16.9.1 GitLab Runner
gitlab/gitlab-runner 0.62.0 16.9.0 GitLab Runner
gitlab/gitlab-runner 0.61.3 16.8.1 GitLab Runner
gitlab/gitlab-runner 0.61.2 16.8.0 GitLab Runner
...
```
## Configuring GitLab Runner using the Helm Chart
## Configuring GitLab Runner using the Helm Chart
Create a `values.yaml` file for your GitLab Runner configuration. See
Store your GitLab Runner configuration changes in `values.yaml`. For help configuring this file, see:
[Values Files](https://helm.sh/docs/chart_template_guide/values_files/) in the Helm documentation
for information on how your values file overrides the defaults.
The default configuration is always available in the
- The default [`values.yaml`](https://gitlab.com/gitlab-org/charts/gitlab-runner/blob/main/values.yaml)
[`values.yaml`](https://gitlab.com/gitlab-org/charts/gitlab-runner/blob/main/values.yaml)
configuration in the chart repository.
in the chart repository.
- The Helm documentation for [Values Files](https://helm.sh/docs/chart_template_guide/values_files/), which explains
 
how your values file overrides the default values.
### Required configuration
### Required configuration
@@ -135,12 +150,6 @@ For GitLab Runner to function, your configuration file **must** specify the foll
@@ -135,12 +150,6 @@ For GitLab Runner to function, your configuration file **must** specify the foll
- The authentication token you obtain when you [create a runner in the GitLab UI](https://docs.gitlab.com/ee/ci/runners/runners_scope.html#create-an-instance-runner-with-a-runner-authentication-token).
- The authentication token you obtain when you [create a runner in the GitLab UI](https://docs.gitlab.com/ee/ci/runners/runners_scope.html#create-an-instance-runner-with-a-runner-authentication-token).
- Set the token directly or [store it in a secret](#store-registration-tokens-or-runner-tokens-in-secrets).
- Set the token directly or [store it in a secret](#store-registration-tokens-or-runner-tokens-in-secrets).
\- or -
- `runnerRegistrationToken` ([deprecated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/102681) in GitLab 15.6):
- The registration token [retrieved from your GitLab instance](https://docs.gitlab.com/ee/ci/runners/).
- Set the token directly or [store it in a secret](#store-registration-tokens-or-runner-tokens-in-secrets).
Unless you need to add more configuration, you are
Unless you need to add more configuration, you are
ready to [install GitLab Runner](#installing-gitlab-runner-using-the-helm-chart).
ready to [install GitLab Runner](#installing-gitlab-runner-using-the-helm-chart).
@@ -627,21 +636,3 @@ runners:
@@ -627,21 +636,3 @@ runners:
[runners.kubernetes]
[runners.kubernetes]
helper_image_flavor = "ubi-fips"
helper_image_flavor = "ubi-fips"
```
```
## Uninstalling GitLab Runner using the Helm Chart
Before uninstalling GitLab Runner, pause the runner in GitLab and ensure any jobs have completed.
Pausing the runner prevents problems arising with the jobs, such as
[authorization errors when they complete](../faq/index.md#helm-chart-error--unauthorized).
To uninstall the GitLab Runner Chart, run the following:
```shell
helm delete --namespace <NAMESPACE> <RELEASE-NAME>
```
Where:
- `<NAMESPACE>` is the Kubernetes namespace where GitLab Runner is installed.
- `<RELEASE-NAME>` is the name you gave the chart when installing it.
In the [Installing GitLab Runner using the Helm Chart](#installing-gitlab-runner-using-the-helm-chart) section, we called it `gitlab-runner`.
Loading