Skip to content

Commit 9c48de3

Browse files
update machine runner docs to use 3 instead of 3.0 (#9317)
* update machine runner docs to use 3 instead of 3.0 * fix linting errors * fix lint errors --------- Co-authored-by: Rosie Yohannan <[email protected]>
1 parent 63d0d1f commit 9c48de3

18 files changed

+113
-109
lines changed

jekyll/_cci2/install-machine-runner-3-on-docker.adoc

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@ contentTags:
44
- Cloud
55
- Server v4.4+
66
---
7-
= Install machine runner 3.0 on Docker
7+
= Install machine runner 3 on Docker
88
:page-layout: classic-docs
99
:page-description: Instructions on how to install CircleCI's self-hosted machine runner (3.0) on Docker.
1010
:icons: font
1111
:experimental:
1212
:machine:
1313
:docker:
1414

15-
This page describes how to install CircleCI's machine runner 3.0 with the Docker executor. If you are looking to set up self-hosted runners in a private Kubernetes cluster, visit the <<container-runner-installation#,Container runner>> page.
15+
This page describes how to install CircleCI's machine runner 3 with the Docker executor. If you are looking to set up self-hosted runners in a private Kubernetes cluster, visit the <<container-runner-installation#,Container runner>> page.
1616

1717
[NOTE]
1818
====
19-
xref:container-runner#[Container runner] is the **recommended method** for self-hosted runner Docker installation. The instructions on this page are for a simple Docker setup using machine runner 3.0.
19+
xref:container-runner#[Container runner] is the **recommended method** for self-hosted runner Docker installation. The instructions on this page are for a simple Docker setup using machine runner 3.
2020
21-
Container runner is the recommended approach for running containerized jobs on self-hosted runners. Container runner offers the ability to seamlessly define, publish, and use custom Docker images during job execution, as well as the ability to manage dependencies or libraries through custom Docker images instead of enumerating dependencies as part of `steps` in the `.circleci/config.yml` file.
21+
Container runner is the recommended approach for running containerized jobs on self-hosted runners. Container runner offers the ability to seamlessly define, publish, and use custom Docker images during job execution. Container runner also h as the ability to manage dependencies or libraries through custom Docker images instead of enumerating dependencies as part of `steps` in the `.circleci/config.yml` file.
2222
====
2323

2424
[#machine-approach-with-docker]
@@ -46,7 +46,7 @@ include::../_includes/partials/runner/terms.adoc[]
4646

4747
include::../_includes/partials/runner/install-with-cli-steps.adoc[]
4848

49-
=== 2. Create a Dockerfile that extends the machine runner 3.0 image
49+
=== 2. Create a Dockerfile that extends the machine runner 3 image
5050

5151
Create a `Dockerfile.runner.extended` file. In this example, Python 3 is installed on top of the base image.
5252

@@ -106,16 +106,16 @@ docker stop <container-name>; docker rm <container-name>;
106106
[#migrating-from-launch-agent]
107107
=== Migrating from launch agent
108108

109-
NOTE: In machine runner 3.0, the environment variable name prefix has changed from `LAUNCH_AGENT_` to `CIRCLECI_RUNNER_`.
109+
NOTE: In machine runner 3, the environment variable name prefix has changed from `LAUNCH_AGENT_` to `CIRCLECI_RUNNER_`.
110110

111-
To migrate from launch agent to machine runner 3.0 on Docker, stop and remove the launch agent containers and replace them with machine runner 3.0 containers, using the commands described above.
111+
To migrate from launch agent to machine runner 3 on Docker, stop and remove the launch agent containers and replace them with machine runner 3 containers. The commands described above can be used to accomplish this.
112112

113113
include::../_includes/partials/runner/machine-runner-example.adoc[]
114114

115115
[#additional-resources]
116116
== Additional resources
117117

118-
- xref:install-machine-runner-3-on-linux.adoc[Machine runner 3.0 Linux package installation]
119-
- xref:install-machine-runner-3-on-macos.adoc[Machine runner 3.0 macOS Homebrew installation]
120-
- xref:install-machine-runner-3-on-windows.adoc[Machine runner 3.0 Windows installation]
121-
- xref:machine-runner-3-configuration-reference.adoc[Machine runner 3.0 configuration reference]
118+
- xref:install-machine-runner-3-on-linux.adoc[Machine runner 3 Linux package installation]
119+
- xref:install-machine-runner-3-on-macos.adoc[Machine runner 3 macOS Homebrew installation]
120+
- xref:install-machine-runner-3-on-windows.adoc[Machine runner 3 Windows installation]
121+
- xref:machine-runner-3-configuration-reference.adoc[Machine runner 3 configuration reference]

jekyll/_cci2/install-machine-runner-3-on-linux.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ contentTags:
44
- Cloud
55
- Server v4.4+
66
---
7-
= Install machine runner 3.0 on Linux
7+
= Install machine runner 3 on Linux
88
:page-layout: classic-docs
99
:page-description: Instructions on how to install CircleCI's self-hosted machine runner (3.0) on Linux.
1010
:icons: font
1111
:experimental:
1212
:machine:
1313
:linux:
1414

15-
This page describes how to install CircleCI's machine runner 3.0 on Linux.
15+
This page describes how to install CircleCI's machine runner 3 on Linux.
1616

1717
[#prerequisites]
1818
== Prerequisites
@@ -78,8 +78,8 @@ Refer to the <<troubleshoot-self-hosted-runner#machine-runner,Troubleshoot Machi
7878
[#additional-resources]
7979
== Additional resources
8080

81-
- xref:install-machine-runner-3-on-macos.adoc[Machine runner 3.0 macOS Homebrew installation]
82-
- xref:install-machine-runner-3-on-windows.adoc[Machine runner 3.0 Windows installation]
83-
- xref:install-machine-runner-3-on-docker.adoc[Machine runner 3.0 Docker installation]
84-
- xref:machine-runner-3-manual-installation.adoc[Manual installation for machine runner 3.0]
85-
- xref:machine-runner-3-configuration-reference.adoc[Machine runner 3.0 configuration reference]
81+
- xref:install-machine-runner-3-on-macos.adoc[Machine runner 3 macOS Homebrew installation]
82+
- xref:install-machine-runner-3-on-windows.adoc[Machine runner 3 Windows installation]
83+
- xref:install-machine-runner-3-on-docker.adoc[Machine runner 3 Docker installation]
84+
- xref:machine-runner-3-manual-installation.adoc[Manual installation for machine runner 3]
85+
- xref:machine-runner-3-configuration-reference.adoc[Machine runner 3 configuration reference]

jekyll/_cci2/install-machine-runner-3-on-macos.adoc

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ contentTags:
44
- Cloud
55
- Server v4.4+
66
---
7-
= Install machine runner 3.0 on macOS
7+
= Install machine runner 3 on macOS
88
:page-layout: classic-docs
99
:page-description: Instructions on how to install CircleCI's self-hosted machine runner (3.0) on macOS.
1010
:icons: font
1111
:experimental:
1212
:machine:
1313
:macOS:
1414

15-
This page describes how to install CircleCI's machine runner 3.0 on macOS.
15+
This page describes how to install CircleCI's machine runner 3 on macOS.
1616

1717
[#prerequisites]
1818
== Prerequisites
@@ -115,7 +115,7 @@ api:
115115
mv /Library/Preferences/com.circleci.runner/launch-agent-config.yaml $HOME/Library/Preferences/com.circleci.runner/config.yaml
116116
----
117117
118-
After copying the file, you may remove the logging block to send logs to the default location for machine runner 3.0 (specified below):
118+
After copying the file, you may remove the logging block to send logs to the default location for machine runner 3 (specified below):
119119
120120
[,yaml]
121121
----
@@ -154,9 +154,9 @@ sudo xattr -r -d com.apple.quarantine "$(brew --prefix)/bin/circleci-runner"
154154
----
155155

156156
[#start-macos-machine-runner]
157-
== 4. Start macOS machine runner 3.0
157+
== 4. Start macOS machine runner 3
158158

159-
To start the macOS machine runner 3.0 for the first time, you will need to bootstrap the service. Depending on whether you are using a GUI or non-GUI session (for example, when remotely tunneling into the machine), the commands to bootstrap the service will differ:
159+
To start the macOS machine runner 3 for the first time, you will need to bootstrap the service. Depending on whether you are using a GUI or non-GUI session (for example, when remotely tunneling into the machine), the commands to bootstrap the service will differ:
160160

161161
[.tab.startdomain.GUI_domain]
162162
--
@@ -205,7 +205,7 @@ launchctl print user/$(id -u)/com.circleci.runner
205205
include::../_includes/partials/runner/machine-runner-example.adoc[]
206206

207207
[#stop-macos-machine-runner]
208-
== Stop macOS machine runner 3.0
208+
== Stop macOS machine runner 3
209209

210210
To stop the machine runner service, run the following command to disable the machine runner service, depending on the service target used in the previous step:
211211

@@ -227,8 +227,8 @@ launchctl disable user/$(id -u)/com.circleci.runner
227227
--
228228

229229
[#uninstall-machine-runner-macos]
230-
== Uninstall machine runner 3.0 on macOS
231-
To uninstall machine runner 3.0 from your macOS device, follow these steps.
230+
== Uninstall machine runner 3 on macOS
231+
To uninstall machine runner 3 from your macOS device, follow these steps.
232232

233233
. Stop the machine runner service by using the following command to disable it, depending on the service target used during installation:
234234
+
@@ -286,8 +286,8 @@ $HOME/Library/Logs/com.circleci.runner/runner.log
286286
[#additional-resources]
287287
== Additional resources
288288

289-
- xref:machine-runner-3-manual-installation.adoc[Manual installation for machine runner 3.0]
290-
- xref:install-machine-runner-3-on-linux.adoc[Machine runner 3.0 Linux package installation]
291-
- xref:install-machine-runner-3-on-windows.adoc[Machine runner 3.0 Windows installation]
292-
- xref:install-machine-runner-3-on-docker.adoc[Machine runner 3.0 Docker installation]
293-
- xref:machine-runner-3-configuration-reference.adoc[Machine runner 3.0 configuration reference]
289+
- xref:machine-runner-3-manual-installation.adoc[Manual installation for machine runner 3]
290+
- xref:install-machine-runner-3-on-linux.adoc[Machine runner 3 Linux package installation]
291+
- xref:install-machine-runner-3-on-windows.adoc[Machine runner 3 Windows installation]
292+
- xref:install-machine-runner-3-on-docker.adoc[Machine runner 3 Docker installation]
293+
- xref:machine-runner-3-configuration-reference.adoc[Machine runner 3 configuration reference]

jekyll/_cci2/install-machine-runner-3-on-windows.adoc

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ contentTags:
44
- Cloud
55
- Server v4.4+
66
---
7-
= Install machine runner 3.0 on Windows
7+
= Install machine runner 3 on Windows
88
:page-layout: classic-docs
9-
:page-description: Instructions on how to install CircleCI's machine runner 3.0 on Windows.
9+
:page-description: Instructions on how to install CircleCI's machine runner 3 on Windows.
1010
:icons: font
1111
:experimental:
1212
:machine:
1313
:windows:
1414

15-
This page describes how to install CircleCI's machine runner 3.0 on Windows. This has been tested for Windows Server 2016, 2019, and 2022 in Datacenter Edition. Other Server SKUs with Desktop Experience and Remote Desktop Services (RDS) should also work.
15+
This page describes how to install CircleCI's machine runner 3 on Windows. This has been tested for Windows Server 2016, 2019, and 2022 in Datacenter Edition. Other Server SKUs with Desktop Experience and Remote Desktop Services (RDS) should also work.
1616

1717
This page walks you through installing a machine runner and its dependencies (for example, Chocolatey, Git, and Gzip) on your Windows Server.
1818

@@ -54,7 +54,7 @@ include::../_includes/partials/runner/install-with-cli-steps.adoc[]
5454
[#installation-steps]
5555
== 2. Machine runner installation on Windows
5656

57-
. Download the https://github.com/CircleCI-Public/runner-installation-files/tree/main/windows-install/circleci-runner[`Install-CircleCIRunner.ps1` script] from GitHub to an easily accessible location.
57+
. Download the https://github.com/CircleCI-Public/runner-installation-files/tree/main/windows-install/circleci-runner[`Install-CircleCIRunner.ps1` script] from GitHub to an accessible location.
5858

5959
. Open PowerShell as an administrator and navigate to the directory where you placed the script file.
6060

@@ -79,7 +79,7 @@ include::../_includes/partials/runner/machine-runner-example.adoc[]
7979

8080
Uninstalling machine runners will prepare the system for installation again.
8181

82-
. Download the https://github.com/CircleCI-Public/runner-installation-files/tree/main/windows-install/circleci-runner[`Uninstall-CircleCIRunner.ps1` script] from GitHub to an easily accessible location.
82+
. Download the https://github.com/CircleCI-Public/runner-installation-files/tree/main/windows-install/circleci-runner[`Uninstall-CircleCIRunner.ps1` script] from GitHub to an accessible location.
8383
. Open PowerShell as an administrator and navigate to the directory where you placed the script file.
8484

8585
. Run the following in your PowerShell:
@@ -92,7 +92,7 @@ Uninstalling machine runners will prepare the system for installation again.
9292
[#continuous-mode-vs.-single-task-mode-for-windows-self-hosted-runners]
9393
== Continuous mode vs. single task mode for Windows self-hosted runners
9494

95-
By default, Windows machine runners run in xref:machine-runner-3-configuration-reference.adoc#runner-mode[single-task mode] in order to ensure high reliability of the underlying technology that the self-hosted runner uses to execute jobs. This is the **recommended mode** for Windows machine runners.
95+
By default, Windows machine runners run in xref:machine-runner-3-configuration-reference.adoc#runner-mode[single-task mode] in order to ensure high reliability of the underlying technology that the self-hosted runner uses to execute jobs. Single-task mode is the **recommended mode** for Windows machine runners.
9696

9797
A Windows machine runner *can* be run in `continuous` mode. However, doing so eliminates the guarantee of a clean job environment. This may translate into jobs not executing as expected, and job failure.
9898

@@ -104,8 +104,8 @@ Refer to the <<troubleshoot-self-hosted-runner#machine-runner,Troubleshoot Machi
104104
[#additional-resources]
105105
== Additional resources
106106

107-
- xref:machine-runner-3-manual-installation-on-windows.adoc[Manual installation for machine runner 3.0 on Windows]
108-
- xref:install-machine-runner-3-on-linux.adoc[Machine runner 3.0 Linux package installation]
109-
- xref:install-machine-runner-3-on-macos.adoc[Machine runner 3.0 macOS Homebrew installation]
110-
- xref:install-machine-runner-3-on-docker.adoc[Machine runner 3.0 Docker installation]
111-
- xref:machine-runner-3-configuration-reference.adoc[Machine runner 3.0 configuration reference]
107+
- xref:machine-runner-3-manual-installation-on-windows.adoc[Manual installation for machine runner 3 on Windows]
108+
- xref:install-machine-runner-3-on-linux.adoc[Machine runner 3 Linux package installation]
109+
- xref:install-machine-runner-3-on-macos.adoc[Machine runner 3 macOS Homebrew installation]
110+
- xref:install-machine-runner-3-on-docker.adoc[Machine runner 3 Docker installation]
111+
- xref:machine-runner-3-configuration-reference.adoc[Machine runner 3 configuration reference]

jekyll/_cci2/machine-runner-3-configuration-reference.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ contentTags:
44
- Cloud
55
- Server v4.4+
66
---
7-
= Machine runner 3.0 configuration reference
7+
= Machine runner 3 configuration reference
88
:page-layout: classic-docs
99
:page-liquid:
1010
:icons: font
@@ -51,7 +51,7 @@ The URL will be pointing to `https://runner.circleci.com` by default. It should
5151

5252
`$CIRCLECI_RUNNER_NAME`
5353

54-
`RUNNER_NAME` is a unique name of your choosing assigned to this particular machine runner. CircleCI recommends using the hostname of the machine so that it can be used to identify the agent when viewing statuses and job results in the UI on the CircleCI web app. The only special characters accepted in `RUNNER_NAME` are `. () - _`.
54+
`RUNNER_NAME` is a unique name of your choosing assigned to this particular machine runner. CircleCI recommends using the hostname of the machine so that it can be used to identify the agent when viewing statuses and job results in the CircleCI web app. The only special characters accepted in `RUNNER_NAME` are `. () - _`.
5555

5656

5757
[#logging-level]
@@ -284,7 +284,7 @@ runner:
284284
[#customizing-job-timeouts-and-drain-timeouts]
285285
==== Customizing job timeouts and drain timeouts
286286

287-
If you would like to customize the job timeout setting, you can “drain” the job by sending the machine runner a termination (TERM) signal, which then causes the machine runner to attempt to gracefully shutdown. When this TERM signal is received, the machine runner enters _draining_ mode, preventing the machine runner from accepting any new jobs, but still allowing any current active job to be completed. At the end of _draining_, the machine runner then signals the task-agent to cancel any active job (by sending it a TERM signal).
287+
If you would like to customize the job timeout setting, you can “drain” the job by sending the machine runner a termination (TERM) signal. This causes the machine runner to attempt to gracefully shutdown. When this TERM signal is received, the machine runner enters _draining_ mode. This prevents the machine runner from accepting any new jobs, but still allows any current active job to be completed. At the end of _draining_, the machine runner then signals the task-agent to cancel any active job (by sending it a TERM signal).
288288

289289
NOTE: If the task-agent does not exit a brief period after the TERM, the machine runner will manually kill it by sending it a KILL signal.
290290

jekyll/_cci2/machine-runner-3-manual-installation-on-windows.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ contentTags:
44
- Cloud
55
- Server v4.4+
66
---
7-
= Machine runner 3.0 manual installation for Windows
7+
= Machine runner 3 manual installation for Windows
88
:page-layout: classic-docs
9-
:page-description: Instructions on how to manually install CircleCI's self-hosted machine runner 3.0 on Windows.
9+
:page-description: Instructions on how to manually install CircleCI's self-hosted machine runner 3 on Windows.
1010
:icons: font
1111
:machine:
1212
:Windows:
1313

14-
This page describes how to manually install CircleCI's machine runner 3.0 on Windows Server.
14+
This page describes how to manually install CircleCI's machine runner 3 on Windows Server.
1515

1616
[#prerequisites]
1717
== Prerequisites
@@ -90,8 +90,8 @@ logging:
9090
[#additional-resources]
9191
== Additional resources
9292

93-
- xref:install-machine-runner-3-on-windows.adoc[Machine runner 3.0 Windows installation]
94-
- xref:install-machine-runner-3-on-linux.adoc[Machine runner 3.0 Linux package installation]
95-
- xref:install-machine-runner-3-on-macos.adoc[Machine runner 3.0 macOS Homebrew installation]
96-
- xref:install-machine-runner-3-on-docker.adoc[Machine runner 3.0 Docker installation]
97-
- xref:machine-runner-3-configuration-reference.adoc[Machine runner 3.0 configuration reference]
93+
- xref:install-machine-runner-3-on-windows.adoc[Machine runner 3 Windows installation]
94+
- xref:install-machine-runner-3-on-linux.adoc[Machine runner 3 Linux package installation]
95+
- xref:install-machine-runner-3-on-macos.adoc[Machine runner 3 macOS Homebrew installation]
96+
- xref:install-machine-runner-3-on-docker.adoc[Machine runner 3 Docker installation]
97+
- xref:machine-runner-3-configuration-reference.adoc[Machine runner 3 configuration reference]

0 commit comments

Comments
 (0)