Deprecation - Configuration fields in GitLab Runner Helm Chart
For guidance on the overall deprecations, removals and breaking changes workflow, please visit Breaking changes, deprecations, and removing features
Deprecation Summary
In GitLab 13.6, the release of the Allow user to specify any runner configuration in the runner helm chart feature meant that we deprecated values in the Helm Chart configuration that were specific to Runner. These fields are deprecated and will be removed in v1.0 of the Runner Helm Chart.
| Field name | Description |
|---|---|
| image: | Define the GitLab Runner Image. Usage of a single URL is deprecated |
| rbac.resources: | Define specific rbac permissions |
| rbac.verbs: | Define specific rbac permissions |
| runners.image: | Default container image to use for builds when none is specified |
| runners.imagePullSecrets: | Specify one or more imagePullSecrets |
| runners.imagePullPolicy: | Specify the image pull policy: never, if-not-present, always. The cluster default will be used if not set. |
| runners.requestConcurrency: | Defines number of concurrent requests for new job from GitLab |
| runners.privileged: | Enable or disable the privileged flag for all containers |
| runners.namespace: | Namespace to run Kubernetes jobs in. Defaults to the namespace used for installing the Runner Manager. |
| runners.pollTimeout: | The amount of time, in seconds, that needs to pass before the runner will timeout attempting to connect to the container it has just created. |
| runners.outputLimit: | Set maximum build log size in kilobytes, by default set to 4096 (4MB). |
| runners.cache.cacheType | Cache general settings |
| runners.cache.cachePath | Cache general settings |
| runners.cache.cacheShared | Cache general settings |
| runners.cache.s3ServerAddress: | S3 settings |
| runners.cache.s3BucketLocation: | S3 settings |
| runners.cache.s3CacheInsecure: | S3 settings |
| runners.cache.gcsBucketName: | GCS settings |
| runners.builds: | (Property and all sub-properties) Build Container specific configuration |
| runners.services: | (Property and all sub-properties) Service Container specific configuration. |
| runners.helpers: | (Property and all sub-properties) Helper Container specific configuration. |
| runners.pod_security_context: | (Property and all sub-properties) Helper container security context configuration. |
| runners.serviceAccountName: | Service Account to be used for runners. |
| runners.cloneUrl: | If GitLab is not reachable through $CI_SERVER_URL. |
| runners.nodeSelector: | (Property and all sub-properties) Specify node labels for CI job pods assignment |
| runners.nodeTolerations: | (Property and all sub-properties) Specify node tolerations for CI job pods assignment. |
| runners.podLabels: | (Property and all sub-properties) Specify pod labels for CI job pods |
| runners.podAnnotations: | (Property and all sub-properties) Specify annotations for job pods. |
| runners.env: | Configure environment variables that will be injected to the pods that are created while the build is running. |
Breaking Change
Affected Topology
- GitLab SaaS
- GitLab Self-Managed
Note: The impact is specifically to those customers who self-manage runners and use the Helm chart for installing and configuring the Runner on Kubernetes.
Affected Tier
- Free
- Premium
- Ultimate
Checklists
Labels
-
This issue is labeled deprecation, and with the relevant ~devops::,~group::, and~Category:labels. -
This issue is labeled breaking change if the removal of the deprecated item will be a breaking change.
Timeline
Please add links to the relevant merge requests.
- As soon as possible, but no later than the third milestone preceding the major release (for example, given the following release schedule:
14.8, 14.9, 14.10, 15.0–14.8is the third milestone preceding the major release):-
A deprecation announcement entry has been created so the deprecation will appear in release posts and on the general deprecation page. -
Documentation has been updated to mark the feature as deprecated.
-
-
On or before the major milestone: A removal entry has been created so the removal will appear on the removals by milestones page and be announced in the release post. - On the major milestone:
-
The deprecated item has been removed. -
If the removal of the deprecated item is a breaking change, the merge request is labeled breaking change.
-
Mentions
-
Your stage's stable counterparts have been @mentionedon this issue. For example, Customer Support, Customer Success (Technical Account Manager), Product Marketing Manager.- To see who the stable counterparts are for a product team visit product categories
- If there is no stable counterpart listed for Sales/CS please mention
@timtams - If there is no stable counterpart listed for Support please mention
@gitlab-com/support/managers - If there is no stable counterpart listed for Marketing please mention
@cfoster3
- If there is no stable counterpart listed for Sales/CS please mention
- To see who the stable counterparts are for a product team visit product categories
-
Your GPM has been @mentionedso that they are aware of planned deprecations. The goal is to have reviews happen at least two releases before the final removal of the feature or introduction of a breaking change.
Deprecation Milestone
15.6
Planned Removal Milestone
16.0