You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: jekyll/_cci2/install-machine-runner-3-on-docker.adoc
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -4,21 +4,21 @@ contentTags:
4
4
- Cloud
5
5
- Server v4.4+
6
6
---
7
-
= Install machine runner 3.0 on Docker
7
+
= Install machine runner 3 on Docker
8
8
:page-layout: classic-docs
9
9
:page-description: Instructions on how to install CircleCI's self-hosted machine runner (3.0) on Docker.
10
10
:icons: font
11
11
:experimental:
12
12
:machine:
13
13
:docker:
14
14
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.
16
16
17
17
[NOTE]
18
18
====
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.
20
20
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.
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_`.
110
110
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.
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:
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:
Copy file name to clipboardExpand all lines: jekyll/_cci2/install-machine-runner-3-on-windows.adoc
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -4,15 +4,15 @@ contentTags:
4
4
- Cloud
5
5
- Server v4.4+
6
6
---
7
-
= Install machine runner 3.0 on Windows
7
+
= Install machine runner 3 on Windows
8
8
: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.
10
10
:icons: font
11
11
:experimental:
12
12
:machine:
13
13
:windows:
14
14
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.
16
16
17
17
This page walks you through installing a machine runner and its dependencies (for example, Chocolatey, Git, and Gzip) on your Windows Server.
. 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.
58
58
59
59
. Open PowerShell as an administrator and navigate to the directory where you placed the script file.
Uninstalling machine runners will prepare the system for installation again.
81
81
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.
83
83
. Open PowerShell as an administrator and navigate to the directory where you placed the script file.
84
84
85
85
. Run the following in your PowerShell:
@@ -92,7 +92,7 @@ Uninstalling machine runners will prepare the system for installation again.
== Continuous mode vs. single task mode for Windows self-hosted runners
94
94
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.
96
96
97
97
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.
98
98
@@ -104,8 +104,8 @@ Refer to the <<troubleshoot-self-hosted-runner#machine-runner,Troubleshoot Machi
104
104
[#additional-resources]
105
105
== Additional resources
106
106
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]
Copy file name to clipboardExpand all lines: jekyll/_cci2/machine-runner-3-configuration-reference.adoc
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ contentTags:
4
4
- Cloud
5
5
- Server v4.4+
6
6
---
7
-
= Machine runner 3.0 configuration reference
7
+
= Machine runner 3 configuration reference
8
8
:page-layout: classic-docs
9
9
:page-liquid:
10
10
:icons: font
@@ -51,7 +51,7 @@ The URL will be pointing to `https://runner.circleci.com` by default. It should
51
51
52
52
`$CIRCLECI_RUNNER_NAME`
53
53
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 `. () - _`.
55
55
56
56
57
57
[#logging-level]
@@ -284,7 +284,7 @@ runner:
284
284
[#customizing-job-timeouts-and-drain-timeouts]
285
285
==== Customizing job timeouts and drain timeouts
286
286
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).
288
288
289
289
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.
0 commit comments