Skip to content

Commit 091a8fe

Browse files
Filip AleksicRoshni Sarangadharan
Filip Aleksic
authored and
Roshni Sarangadharan
committed
Remove outdated mentions
1 parent 73b5da1 commit 091a8fe

File tree

16 files changed

+42
-211
lines changed

16 files changed

+42
-211
lines changed

config.toml.example

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,31 @@ concurrent = 4
22

33
[[runners]]
44
name = "shell"
5-
url = "https://CI/"
5+
url = "https://gitlab.com/"
66
token = "TOKEN"
77
limit = 2
88
executor = "shell"
99
builds_dir = ""
1010
shell = "bash"
1111

1212
[[runners]]
13-
name = "ruby-2.7-docker"
14-
url = "https://CI/"
13+
name = "ruby-3.1-docker"
14+
url = "https://gitlab.com/"
1515
token = "TOKEN"
1616
limit = 0
1717
executor = "docker"
1818
builds_dir = ""
1919
[runners.docker]
2020
host = ""
21-
image = "ruby:2.7"
21+
image = "ruby:3.1"
2222
privileged = false
2323
disable_cache = false
2424
cache_dir = ""
2525

2626

2727
[[runners]]
2828
name = "production-server"
29-
url = "https://CI/"
29+
url = "https://gitlab.com/"
3030
token = "TOKEN"
3131
limit = 0
3232
executor = "ssh"

docs/commands/_index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ USAGE:
157157
gitlab-runner [global options] command [command options] [arguments...]
158158
159159
VERSION:
160-
16.5.0 (853330f9)
160+
17.10.1 (ef334dcc)
161161
162162
AUTHOR:
163163
GitLab Inc. <[email protected]>
@@ -176,12 +176,15 @@ COMMANDS:
176176
run-single start single runner
177177
unregister unregister specific runner
178178
verify verify all registered runners
179+
wrapper start multi runner service wrapped with gRPC manager server
180+
fleeting manage fleeting plugins
179181
artifacts-downloader download and extract build artifacts (internal)
180182
artifacts-uploader create and upload build artifacts (internal)
181183
cache-archiver create and upload cache artifacts (internal)
182184
cache-extractor download and extract cache artifacts (internal)
183185
cache-init changed permissions for cache paths (internal)
184186
health-check check health for a specific address
187+
proxy-exec execute internal commands (internal)
185188
read-logs reads job logs from a file, used by kubernetes executor (internal)
186189
help, h Shows a list of commands or help for one command
187190

docs/configuration/advanced-configuration.md

Lines changed: 6 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -267,8 +267,8 @@ Example:
267267

268268
```toml
269269
[[runners]]
270-
name = "ruby-3.3-docker"
271-
url = "https://CI/"
270+
name = "example-runner"
271+
url = "http://gitlab.example.com/"
272272
token = "TOKEN"
273273
limit = 0
274274
executor = "docker"
@@ -353,8 +353,8 @@ CI/CD jobs run locally on the host machine when configured to use the shell exec
353353
| ----- | ----------- |
354354
| `bash` | Generate Bash (Bourne-shell) script. All commands executed in Bash context. Default for all Unix systems. |
355355
| `sh` | Generate Sh (Bourne-shell) script. All commands executed in Sh context. The fallback for `bash` for all Unix systems. |
356-
| `powershell` | Generate PowerShell script. All commands are executed in PowerShell Desktop context. In GitLab Runner 12.0-13.12, this is the default for Windows. |
357-
| `pwsh` | Generate PowerShell script. All commands are executed in PowerShell Core context. In GitLab Runner 14.0 and later, this is the default for Windows. |
356+
| `powershell` | Generate PowerShell script. All commands are executed in PowerShell Desktop context. |
357+
| `pwsh` | Generate PowerShell script. All commands are executed in PowerShell Core context. This is the default shell for Windows. |
358358

359359
When the `shell` option is set to `bash` or `sh`, Bash's [ANSI-C quoting](https://www.gnu.org/software/bash/manual/html_node/ANSI_002dC-Quoting.html) is used
360360
to shell escape job scripts.
@@ -658,12 +658,6 @@ The `start_type` parameter determines the graphical front end used when starting
658658

659659
## Overriding the base VM image
660660

661-
{{< history >}}
662-
663-
- Introduced in GitLab Runner 14.2.
664-
665-
{{< /history >}}
666-
667661
For both the Parallels and VirtualBox executors, you can override the base VM name specified by `base_name`.
668662
To do this, use the [image](https://docs.gitlab.com/ci/yaml/#image) parameter in the `.gitlab-ci.yml` file.
669663

@@ -1404,12 +1398,6 @@ If you use ADC, be sure that the service account that you use has the `iam.servi
14041398

14051399
### The `[runners.cache.azure]` section
14061400

1407-
{{< history >}}
1408-
1409-
- Introduced in GitLab Runner 13.4.0.
1410-
1411-
{{< /history >}}
1412-
14131401
The following parameters define native support for Azure Blob Storage. To learn more, view the
14141402
[Azure Blob Storage documentation](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction).
14151403
While S3 and GCS use the word `bucket` for a collection of objects, Azure uses the word
@@ -1500,12 +1488,6 @@ For more details, see [issue 38330](https://gitlab.com/gitlab-org/gitlab-runner/
15001488

15011489
## The `[runners.kubernetes]` section
15021490

1503-
{{< history >}}
1504-
1505-
- Introduced in GitLab Runner v1.6.0.
1506-
1507-
{{< /history >}}
1508-
15091491
The following table lists configuration parameters available for the Kubernetes executor.
15101492
For more parameters, see the [documentation for the Kubernetes executor](../executors/kubernetes/_index.md).
15111493

@@ -1661,7 +1643,7 @@ One of the main reasons for providing these images is that GitLab Runner is usin
16611643
API that is expected to be the same in both binaries.
16621644

16631645
By default, GitLab Runner references a `registry.gitlab.com/gitlab-org/gitlab-runner/gitlab-runner-helper:XYZ` image, where `XYZ` is based
1664-
on the GitLab Runner architecture and Git revision. In GitLab Runner 11.3 and later, you can define the
1646+
on the GitLab Runner architecture and Git revision. You can define the
16651647
image version by using one of the
16661648
[version variables](https://gitlab.com/gitlab-org/gitlab-runner/blob/main/common/version.go#L48-49):
16671649

@@ -1679,8 +1661,7 @@ which is based on its compilation data. After updating GitLab Runner to a new ve
16791661
Runner tries to download the proper image. The image should be uploaded to the registry
16801662
before upgrading GitLab Runner, otherwise the jobs start failing with a "No such image" error.
16811663

1682-
In GitLab Runner 13.2 and later, the helper image is tagged by
1683-
`$CI_RUNNER_VERSION` in addition to `$CI_RUNNER_REVISION`. Both tags are
1664+
The helper image is tagged by `$CI_RUNNER_VERSION` in addition to `$CI_RUNNER_REVISION`. Both tags are
16841665
valid and point to the same image.
16851666

16861667
```toml

docs/configuration/autoscale.md

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,6 @@ title: Docker Machine Executor autoscale configuration
1212

1313
{{< /details >}}
1414

15-
{{< history >}}
16-
17-
- The autoscale feature was introduced in GitLab Runner 1.1.0.
18-
19-
{{< /history >}}
20-
2115
{{< alert type="note" >}}
2216

2317
The Docker Machine executor was deprecated in GitLab 17.5 and is scheduled for removal in GitLab 20.0 (May 2027).
@@ -222,12 +216,7 @@ We say that each machine that does not run a job is in idle state. When
222216
GitLab Runner is in autoscale mode, it monitors all machines and ensures that
223217
there is always an `IdleCount` of machines in idle state.
224218

225-
{{< alert type="note" >}}
226-
227-
In GitLab Runner 14.5 we've added the `IdleScaleFactor` and `IdleCountMin` settings which change this
228-
behavior a little. Refer to [the dedicated section](#the-idlescalefactor-strategy) for more details.
229-
230-
{{< /alert >}}
219+
For more information, see [the dedicated section](#the-idlescalefactor-strategy).
231220

232221
If there is an insufficient number of idle machines, GitLab Runner
233222
starts provisioning new machines, subject to the `MaxGrowthRate` limit.
@@ -371,12 +360,6 @@ In the worst case scenario, you can't have 10 idle machines, but only 5, because
371360

372361
## The `IdleScaleFactor` strategy
373362

374-
{{< history >}}
375-
376-
- Introduced as experimental feature in [GitLab Runner 14.6](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/3179).
377-
378-
{{< /history >}}
379-
380363
The `IdleCount` parameter defines a static number of idle machines that runner should sustain.
381364
The value you assign depends on your use case.
382365

docs/configuration/feature-flags.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ in the [Runner configuration](advanced-configuration.md):
125125
```toml
126126
[[runners]]
127127
name = "example-runner"
128-
url = "https://gitlab.example.com/"
128+
url = "https://gitlab.com/"
129129
token = "TOKEN"
130130
limit = 0
131131
executor = "docker"
@@ -145,7 +145,7 @@ they don't deal with how the job is executed.
145145
```toml
146146
[[runners]]
147147
name = "example-runner"
148-
url = "https://gitlab.example.com/"
148+
url = "https://gitlab.com/"
149149
token = "TOKEN"
150150
executor = "docker"
151151
[runners.feature_flags]

docs/executors/custom.md

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,6 @@ title: The Custom executor
1212

1313
{{< /details >}}
1414

15-
{{< history >}}
16-
17-
- [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/2885) in GitLab Runner 12.1
18-
19-
{{< /history >}}
20-
2115
GitLab Runner provides the Custom executor for environments that it
2216
doesn't support natively. For example, `LXD` or `Libvirt`.
2317

@@ -117,12 +111,6 @@ The stages run in the following sequence:
117111

118112
### Services
119113

120-
{{< history >}}
121-
122-
- [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/4358) in GitLab Runner 13.6
123-
124-
{{< /history >}}
125-
126114
[Services](https://docs.gitlab.com/ci/services/) are exposed as a JSON array
127115
as `CUSTOM_ENV_CI_JOB_SERVICES`.
128116

@@ -305,12 +293,6 @@ order:
305293
1. `upload_artifacts_on_success` OR `upload_artifacts_on_failure`
306294
1. `cleanup_file_variables`
307295

308-
{{< alert type="note" >}}
309-
310-
In GitLab Runner 14.0 and later, `build_script` is replaced with `step_script`. For more information, see [issue 26426](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/26426).
311-
312-
{{< /alert >}}
313-
314296
For each stage mentioned above, the `run_exec` executable is
315297
executed with:
316298

@@ -374,7 +356,6 @@ what the main goal of that script is.
374356
| `restore_cache` | Extract the cache if any are defined. This expects the `gitlab-runner` binary is available in `$PATH`. |
375357
| `download_artifacts` | Download artifacts, if any are defined. This expects `gitlab-runner` binary is available in `$PATH`. |
376358
| `step_*` | Generated by GitLab. A set of scripts to execute. It may never be sent to the custom executor. It may have multiple steps, like `step_release` and `step_accessibility`. This can be a feature from the `.gitlab-ci.yml` file. |
377-
| `build_script` | A combination of [`before_script`](https://docs.gitlab.com/ci/yaml/#before_script-and-after_script) and [`script`](https://docs.gitlab.com/ci/yaml/#script). In GitLab Runner 14.0 and later, `build_script` is replaced with `step_script`. For more information, see [this issue](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/26426). |
378359
| `after_script` | [`after_script`](https://docs.gitlab.com/ci/yaml/#before_script-and-after_script) defined from the job. This script is always called even if any of the previous steps failed. |
379360
| `archive_cache` | Creates an archive of all the cache, if any are defined. Only executed when `build_script` was successful. |
380361
| `archive_cache_on_failure` | Creates an archive of all the cache, if any are defined. Only executed when `build_script` fails. |

docs/executors/custom_examples/libvirt.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,6 @@ Using [libvirt](https://libvirt.org/), the Custom executor driver will
1616
create a new disk and VM for every job it executes, after which the disk
1717
and VM will be deleted.
1818

19-
This example is inspired by a Community Contribution
20-
[!464](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/464)
21-
to add libvirt as a GitLab Runner executor.
22-
2319
This document does not try to explain how to set up libvirt, since it's
2420
out of scope. However, this driver was tested using
2521
[GCP Nested Virtualization](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview),
@@ -39,11 +35,11 @@ every build. In the following example,
3935
create a disk VM image.
4036

4137
```shell
42-
virt-builder debian-11 \
38+
virt-builder debian-12 \
4339
--size 8G \
4440
--output /var/lib/libvirt/images/gitlab-runner-base.qcow2 \
4541
--format qcow2 \
46-
--hostname gitlab-runner-bullseye \
42+
--hostname gitlab-runner-bookworm \
4743
--network \
4844
--install curl \
4945
--run-command 'curl -L "https://packages.gitlab.com/install/repositories/runner/gitlab-runner/script.deb.sh" | bash' \

docs/executors/custom_examples/lxd.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ up afterwards.
1818
This example uses a bash script for each stage. You can specify your
1919
own image, which is exposed as
2020
[CI_JOB_IMAGE](https://docs.gitlab.com/ci/variables/predefined_variables/).
21-
This example uses the `ubuntu:18.04` image for simplicity. If you
21+
This example uses the `ubuntu:22.04` image for simplicity. If you
2222
want to support multiple images, you would have to modify the executor.
2323

2424
These scripts have the following prerequisites:
@@ -31,7 +31,7 @@ These scripts have the following prerequisites:
3131
```toml
3232
[[runners]]
3333
name = "lxd-driver"
34-
url = "https://www.gitlab.com"
34+
url = "https://gitlab.example.com"
3535
token = "xxxxxxxxxxx"
3636
executor = "custom"
3737
builds_dir = "/builds"
@@ -93,7 +93,7 @@ start_container () {
9393
# user to specify the image. The rest of the script assumes that
9494
# you are running on an ubuntu image so modifications might be
9595
# required.
96-
lxc launch ubuntu:18.04 "$CONTAINER_ID"
96+
lxc launch ubuntu:22.04 "$CONTAINER_ID"
9797

9898
# Wait for container to start, we are using systemd to check this,
9999
# for the sake of brevity.

docs/executors/docker.md

Lines changed: 2 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -564,12 +564,6 @@ By default, the Docker executor stores builds and caches in the following direct
564564

565565
## Clear the Docker cache
566566

567-
{{< history >}}
568-
569-
- Introduced in GitLab Runner 13.9, [all created runner resources cleaned up](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/2310).
570-
571-
{{< /history >}}
572-
573567
Use [`clear-docker-cache`](https://gitlab.com/gitlab-org/gitlab-runner/blob/main/packaging/root/usr/share/gitlab-runner/clear-docker-cache) to remove unused containers and volumes created by the runner.
574568

575569
For a list of options, run the script with the `help` option:
@@ -1050,12 +1044,6 @@ Set the `never` policy in the `config.toml`:
10501044

10511045
### Set multiple pull policies
10521046

1053-
{{< history >}}
1054-
1055-
- [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/26558) in GitLab Runner 13.8.
1056-
1057-
{{< /history >}}
1058-
10591047
You can list multiple pull policies to execute if a pull fails. The runner processes pull policies
10601048
in the order listed until a pull attempt is successful or the list is exhausted. For example, if a
10611049
runner uses the `always` pull policy and the registry is not available, you can add the `if-not-present`
@@ -1110,7 +1098,7 @@ For example, to allow only the `always` and `if-not-present` pull policies, add
11101098
|-----------------------------|------------------------------|
11111099
| `Pulling docker image registry.tld/my/image:latest ... ERROR: Build failed: Error: image registry.tld/my/image:latest not found` | The runner cannot find the image. Displays when the `always` pull policy is set |
11121100
| `Pulling docker image local_image:latest ... ERROR: Build failed: Error: image local_image:latest not found` | The image was built locally and doesn't exist in any public or default Docker registry. Displays when the `always` pull policy is set. |
1113-
| `Pulling docker image registry.tld/my/image:latest ... WARNING: Cannot pull the latest version of image registry.tld/my/image:latest : Error: image registry.tld/my/image:latest not found WARNING: Locally found image will be used instead.` | The runner has used a local image instead of pulling an image. Displays when the `always` pull policy is set in only [GitLab Runner 1.8 and earlier](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/1905). |
1101+
| `Pulling docker image registry.tld/my/image:latest ... WARNING: Cannot pull the latest version of image registry.tld/my/image:latest : Error: image registry.tld/my/image:latest not found WARNING: Locally found image will be used instead.` | The runner has used a local image instead of pulling an image. |
11141102
| `Pulling docker image local_image:latest ... ERROR: Build failed: Error: image local_image:latest not found` | The image cannot be found locally. Displays when the `never` pull policy is set. |
11151103
| `WARNING: Failed to pull image with policy "always": Error response from daemon: received unexpected HTTP status: 502 Bad Gateway (docker.go:143:0s) Attempt #2: Trying "if-not-present" pull policy Using locally found image version due to "if-not-present" pull policy`| The runner failed to pull an image and attempts to pull an image by using the next listed pull policy. Displays when multiple pull policies are set. |
11161104

@@ -1132,24 +1120,12 @@ but only takes effect if specifically the Docker pull fails initially.
11321120

11331121
## Use Windows containers
11341122

1135-
{{< history >}}
1136-
1137-
- [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/535) in GitLab Runner 11.11.
1138-
1139-
{{< /history >}}
1140-
11411123
To use Windows containers with the Docker executor, note the following
11421124
information about limitations, supported Windows versions, and
11431125
configuring a Windows Docker executor.
11441126

11451127
### Nanoserver support
11461128

1147-
{{< history >}}
1148-
1149-
- [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/2492) in GitLab Runner 13.6.
1150-
1151-
{{< /history >}}
1152-
11531129
With the support for PowerShell Core introduced in the Windows helper image, it is now possible to leverage
11541130
the `nanoserver` variants for the helper image.
11551131

@@ -1256,8 +1232,7 @@ section.
12561232

12571233
### Services
12581234

1259-
In [GitLab Runner 12.9 and later](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/1042),
1260-
you can use [services](https://docs.gitlab.com/ci/services/) by
1235+
You can use [services](https://docs.gitlab.com/ci/services/) by
12611236
enabling [a network for each job](#create-a-network-for-each-job).
12621237

12631238
## Native Step Runner Integration

0 commit comments

Comments
 (0)