From 108260b8f54d66175ff741797fb15afeb635c3a8 Mon Sep 17 00:00:00 2001 From: Jacob Rahme Date: Tue, 1 Apr 2025 09:35:54 -0400 Subject: [PATCH 1/3] update machine runner docs to use 3 instead of 3.0 --- .../install-machine-runner-3-on-docker.adoc | 20 +++++++------- .../install-machine-runner-3-on-linux.adoc | 14 +++++----- .../install-machine-runner-3-on-macos.adoc | 26 +++++++++---------- .../install-machine-runner-3-on-windows.adoc | 16 ++++++------ ...hine-runner-3-configuration-reference.adoc | 2 +- ...nner-3-manual-installation-on-windows.adoc | 16 ++++++------ .../machine-runner-3-manual-installation.adoc | 20 +++++++------- ...ch-agent-to-machine-runner-3-on-linux.adoc | 14 +++++----- ...ch-agent-to-machine-runner-3-on-macos.adoc | 14 +++++----- ...-agent-to-machine-runner-3-on-windows.adoc | 16 ++++++------ jekyll/_cci2/runner-concepts.adoc | 2 +- jekyll/_cci2/runner-installation-linux.adoc | 2 +- jekyll/_cci2/runner-installation-mac.adoc | 2 +- jekyll/_cci2/runner-installation-windows.adoc | 2 +- .../server/v4.4/overview/release-notes.adoc | 2 +- jekyll/_cci2/ssh-access-jobs.adoc | 2 +- jekyll/_data/sidenav.yml | 10 +++---- 17 files changed, 90 insertions(+), 90 deletions(-) diff --git a/jekyll/_cci2/install-machine-runner-3-on-docker.adoc b/jekyll/_cci2/install-machine-runner-3-on-docker.adoc index 4a2f8f098a..7e78ff16a3 100644 --- a/jekyll/_cci2/install-machine-runner-3-on-docker.adoc +++ b/jekyll/_cci2/install-machine-runner-3-on-docker.adoc @@ -4,7 +4,7 @@ contentTags: - Cloud - Server v4.4+ --- -= Install machine runner 3.0 on Docker += Install machine runner 3 on Docker :page-layout: classic-docs :page-description: Instructions on how to install CircleCI's self-hosted machine runner (3.0) on Docker. :icons: font @@ -12,11 +12,11 @@ contentTags: :machine: :docker: -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 <> page. +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 <> page. [NOTE] ==== -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. +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. 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. ==== @@ -46,7 +46,7 @@ include::../_includes/snippets/runner/terms.adoc[] include::../_includes/snippets/runner/install-with-cli-steps.adoc[] -=== 2. Create a Dockerfile that extends the machine runner 3.0 image +=== 2. Create a Dockerfile that extends the machine runner 3 image Create a `Dockerfile.runner.extended` file. In this example, Python 3 is installed on top of the base image. @@ -106,16 +106,16 @@ docker stop ; docker rm ; [#migrating-from-launch-agent] === Migrating from launch agent -NOTE: In machine runner 3.0, the environment variable name prefix has changed from `LAUNCH_AGENT_` to `CIRCLECI_RUNNER_`. +NOTE: In machine runner 3, the environment variable name prefix has changed from `LAUNCH_AGENT_` to `CIRCLECI_RUNNER_`. -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. +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, using the commands described above. include::../_includes/snippets/machine-runner-example.adoc[] [#additional-resources] == Additional resources -- xref:install-machine-runner-3-on-linux.adoc[Machine runner 3.0 Linux package installation] -- xref:install-machine-runner-3-on-macos.adoc[Machine runner 3.0 macOS Homebrew installation] -- xref:install-machine-runner-3-on-windows.adoc[Machine runner 3.0 Windows installation] -- xref:machine-runner-3-configuration-reference.adoc[Machine runner 3.0 configuration reference] +- xref:install-machine-runner-3-on-linux.adoc[Machine runner 3 Linux package installation] +- xref:install-machine-runner-3-on-macos.adoc[Machine runner 3 macOS Homebrew installation] +- xref:install-machine-runner-3-on-windows.adoc[Machine runner 3 Windows installation] +- xref:machine-runner-3-configuration-reference.adoc[Machine runner 3 configuration reference] diff --git a/jekyll/_cci2/install-machine-runner-3-on-linux.adoc b/jekyll/_cci2/install-machine-runner-3-on-linux.adoc index 86e4181fe9..b9c25ea382 100644 --- a/jekyll/_cci2/install-machine-runner-3-on-linux.adoc +++ b/jekyll/_cci2/install-machine-runner-3-on-linux.adoc @@ -4,7 +4,7 @@ contentTags: - Cloud - Server v4.4+ --- -= Install machine runner 3.0 on Linux += Install machine runner 3 on Linux :page-layout: classic-docs :page-description: Instructions on how to install CircleCI's self-hosted machine runner (3.0) on Linux. :icons: font @@ -12,7 +12,7 @@ contentTags: :machine: :linux: -This page describes how to install CircleCI's machine runner 3.0 on Linux. +This page describes how to install CircleCI's machine runner 3 on Linux. [#prerequisites] == Prerequisites @@ -78,8 +78,8 @@ Refer to the < Date: Tue, 1 Apr 2025 10:01:21 -0400 Subject: [PATCH 2/3] fix linting errors --- jekyll/_cci2/install-machine-runner-3-on-docker.adoc | 4 ++-- jekyll/_cci2/install-machine-runner-3-on-windows.adoc | 6 +++--- jekyll/_cci2/machine-runner-3-configuration-reference.adoc | 4 ++-- ...te-from-launch-agent-to-machine-runner-3-on-windows.adoc | 4 ++-- jekyll/_cci2/runner-concepts.adoc | 6 +++--- jekyll/_cci2/runner-installation-linux.adoc | 4 ++-- jekyll/_cci2/runner-installation-windows.adoc | 6 +++--- jekyll/_cci2/ssh-access-jobs.adoc | 6 +++--- styles/config/vocabularies/Docs/accept.txt | 1 + 9 files changed, 21 insertions(+), 20 deletions(-) diff --git a/jekyll/_cci2/install-machine-runner-3-on-docker.adoc b/jekyll/_cci2/install-machine-runner-3-on-docker.adoc index 7e78ff16a3..49fb67b4d4 100644 --- a/jekyll/_cci2/install-machine-runner-3-on-docker.adoc +++ b/jekyll/_cci2/install-machine-runner-3-on-docker.adoc @@ -18,7 +18,7 @@ This page describes how to install CircleCI's machine runner 3 with the Docker e ==== 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. -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. +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. ==== [#machine-approach-with-docker] @@ -108,7 +108,7 @@ docker stop ; docker rm ; NOTE: In machine runner 3, the environment variable name prefix has changed from `LAUNCH_AGENT_` to `CIRCLECI_RUNNER_`. -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, using the commands described above. +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 acomplish this. include::../_includes/snippets/machine-runner-example.adoc[] diff --git a/jekyll/_cci2/install-machine-runner-3-on-windows.adoc b/jekyll/_cci2/install-machine-runner-3-on-windows.adoc index 2788cd0876..62b58e81e0 100644 --- a/jekyll/_cci2/install-machine-runner-3-on-windows.adoc +++ b/jekyll/_cci2/install-machine-runner-3-on-windows.adoc @@ -54,7 +54,7 @@ include::../_includes/snippets/runner/install-with-cli-steps.adoc[] [#installation-steps] == 2. Machine runner installation on Windows -. 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. +. 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. . Open PowerShell as an administrator and navigate to the directory where you placed the script file. @@ -79,7 +79,7 @@ include::../_includes/snippets/machine-runner-example.adoc[] Uninstalling machine runners will prepare the system for installation again. -. 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. +. 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. . Open PowerShell as an administrator and navigate to the directory where you placed the script file. . 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] == Continuous mode vs. single task mode for Windows self-hosted runners -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. +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. 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. diff --git a/jekyll/_cci2/machine-runner-3-configuration-reference.adoc b/jekyll/_cci2/machine-runner-3-configuration-reference.adoc index 508df95a03..d580d659b9 100644 --- a/jekyll/_cci2/machine-runner-3-configuration-reference.adoc +++ b/jekyll/_cci2/machine-runner-3-configuration-reference.adoc @@ -51,7 +51,7 @@ The URL will be pointing to `https://runner.circleci.com` by default. It should `$CIRCLECI_RUNNER_NAME` -`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 `. () - _`. +`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 `. () - _`. [#logging-level] @@ -284,7 +284,7 @@ runner: [#customizing-job-timeouts-and-drain-timeouts] ==== Customizing job timeouts and drain timeouts -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). +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). 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. diff --git a/jekyll/_cci2/migrate-from-launch-agent-to-machine-runner-3-on-windows.adoc b/jekyll/_cci2/migrate-from-launch-agent-to-machine-runner-3-on-windows.adoc index 31b4cb04d0..2cbe50828a 100644 --- a/jekyll/_cci2/migrate-from-launch-agent-to-machine-runner-3-on-windows.adoc +++ b/jekyll/_cci2/migrate-from-launch-agent-to-machine-runner-3-on-windows.adoc @@ -22,7 +22,7 @@ Migrating from launch agent to machine runner 3 is a straightforward process. Th == 1. Uninstall launch agent The first step is to uninstall launch agent. -. Download the https://github.com/CircleCI-Public/runner-installation-files/tree/main/windows-install[`Uninstall-CircleCIRunner.ps1` script] from GitHub to an easily accessible location. +. Download the https://github.com/CircleCI-Public/runner-installation-files/tree/main/windows-install[`Uninstall-CircleCIRunner.ps1` script] from GitHub to an accessible location. . Open PowerShell as an administrator and navigate to the directory where you placed the script file. . Run the following in your PowerShell: @@ -46,7 +46,7 @@ copy "$env:ProgramFiles\CircleCI\runner-agent-config.yaml" "$desktopDir/runner-a [#install-machine-runner] == 3. Install machine runner 3 -. 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. +. 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. . Open PowerShell as an administrator and navigate to the directory where you placed the script file. diff --git a/jekyll/_cci2/runner-concepts.adoc b/jekyll/_cci2/runner-concepts.adoc index cbe8e30fa3..221a110116 100644 --- a/jekyll/_cci2/runner-concepts.adoc +++ b/jekyll/_cci2/runner-concepts.adoc @@ -39,12 +39,12 @@ The container-agent gets installed with container runner. Container-agent polls [#machine-runner-3] == Machine runner 3 -The machine runner 3 replaces launch-agent on cloud and server v4.4+, bringing improvements to network resiliency, installation, and the upgrade process. As with launch-agent, any user who is able to execute a job will be able to gain the same privileges as the task-agent, which when installed using the provided packages runs as the `circleci` user. +The machine runner 3 replaces launch-agent on cloud and server v4.4+. Bringing improvements to network resiliency, installation, and the upgrade process. As with launch-agent, any user who is able to execute a job will be able to gain the same privileges as the task-agent. When machine runner is installed using the provided packages it runs as the `circleci` user. [#launch-agent] == Launch-agent -The launch-agent manages gathering the information required to run a task with machine runner (defined as a parallel run of a job) while also downloading and launching the task-agent process. +The launch-agent manages gathering information required to run a task with machine runner (defined as a parallel run of a job) while also downloading and launching the task-agent process. The system has been designed to allow admins to configure the task-agent to run with a lower level of privileges than the launch-agent. Any user who is able to execute a job will be able to gain the same privileges as the task-agent. The launch-agent will run as `root`, but the task-agent will run as `circleci`. @@ -58,7 +58,7 @@ Rather than limit the total number of registered self-hosted runners, CircleCI's [#public-repositories] == Public repositories -CircleCI's self-hosted runners are xref:/runner-faqs.adoc#can-jobs-on-forks-of-my-OSS-project-use-my-organizations-self-hosted-runners-if-the-fork-is-not-a-part-of-my-organization[not available] for use with public projects that have the **Build forked pull requests** setting enabled. This feature is not availalbe for security reasons. A malicious actor may alter your machine or execute code on it by forking your repository, committing code, and opening a pull request. Untrusted jobs running on your CircleCI's self-hosted runner pose significant security risks for your machine and network environment, especially if your machine persists its environment between jobs. Some of the risks include: +CircleCI's self-hosted runners are xref:/runner-faqs.adoc#can-jobs-on-forks-of-my-OSS-project-use-my-organizations-self-hosted-runners-if-the-fork-is-not-a-part-of-my-organization[not available] for use with public projects that have the **Build forked pull requests** setting enabled. This feature is not available for security reasons. A malicious actor may alter your machine or execute code on it by forking your repository, committing code, and opening a pull request. Untrusted jobs running on your CircleCI's self-hosted runner pose significant security risks for your machine and network environment, especially if your machine persists its environment between jobs. Some of the risks include: * Malicious programs running on the machine * Escaping the machine's self-hosted runner sandbox diff --git a/jekyll/_cci2/runner-installation-linux.adoc b/jekyll/_cci2/runner-installation-linux.adoc index 5f37a09164..c9d00402bd 100644 --- a/jekyll/_cci2/runner-installation-linux.adoc +++ b/jekyll/_cci2/runner-installation-linux.adoc @@ -203,7 +203,7 @@ sudo chmod 755 /usr/lib/systemd/system/circleci.service You must ensure that `TimeoutStopSec` is greater than the total amount of time a task will run for, which defaults to 5 hours. -If you want to configure the CircleCI's self-hosted runner installation to start on boot, it is important to note that machine runner will attempt to consume and start jobs as soon as it starts, so it should be configured appropriately before starting. Machine runner may be configured as a service and be managed by `systemd` with the following scripts: +When running CircleCI's self-hosted runner installation to start on boot, the machine runner will attempt to consume and start jobs as soon as it starts. It should be configured appropriately before starting. Machine runner may be configured as a service and be managed by `systemd` with the following scripts: ``` [Unit] @@ -219,7 +219,7 @@ TimeoutStopSec=18300 WantedBy = multi-user.target ``` -Unlike task-agents, which use the environment of the `circleci` user, launch-agents will need to have any required environment variables (for example, proxy settings) explicitly defined in the unit configuration file. These can be set by `Environment=` or `EnvironmentFile=`. Visit the `systemd` https://www.freedesktop.org/software/systemd/man/systemd.exec.html#Environment[documentation] for more information. +Unlike task-agents, which use the environment of the `circleci` user, launch-agents need to have required environment variables (for example, proxy settings) explicitly defined in the unit configuration file. These can be set by `Environment=` or `EnvironmentFile=`. Visit the `systemd` https://www.freedesktop.org/software/systemd/man/systemd.exec.html#Environment[documentation] for more information. You can now enable the service: diff --git a/jekyll/_cci2/runner-installation-windows.adoc b/jekyll/_cci2/runner-installation-windows.adoc index 72cd5859b5..1d62e1e3e4 100644 --- a/jekyll/_cci2/runner-installation-windows.adoc +++ b/jekyll/_cci2/runner-installation-windows.adoc @@ -59,7 +59,7 @@ include::../_includes/snippets/runner/launch-agent-download.adoc[] [#installation-steps] == 3. Machine runner installation on Windows -. Download the https://github.com/CircleCI-Public/runner-installation-files/blob/main/windows-install/Install-CircleCIRunner.ps1[`Install-CircleCIRunner.ps1` script] from GitHub to an easily accessible location. +. Download the https://github.com/CircleCI-Public/runner-installation-files/blob/main/windows-install/Install-CircleCIRunner.ps1[`Install-CircleCIRunner.ps1` script] from GitHub to an accessible location. . Open PowerShell as an administrator and navigate to the directory where you placed the script file. @@ -83,7 +83,7 @@ include::../_includes/snippets/machine-runner-example.adoc[] Uninstalling machine runners will prepare the system for installation again. -. 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. +. 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. . Open PowerShell as an administrator and navigate to the directory where you placed the script file. . Run the following in your PowerShell: @@ -95,7 +95,7 @@ Uninstalling machine runners will prepare the system for installation again. [#continuous-mode-vs.-single-task-mode-for-windows-self-hosted-runners] == Continuous mode vs. single task mode for Windows self-hosted runners -By default, Windows machine runners run in <> 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. +By default, Windows machine runners run in <> 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. 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 failing. diff --git a/jekyll/_cci2/ssh-access-jobs.adoc b/jekyll/_cci2/ssh-access-jobs.adoc index dd15ec7de4..dcec25eae4 100644 --- a/jekyll/_cci2/ssh-access-jobs.adoc +++ b/jekyll/_cci2/ssh-access-jobs.adoc @@ -18,9 +18,9 @@ Troubleshoot problems in a job using *Rerun job with SSH*. Using this feature yo CircleCI gives you the option to access all jobs via SSH. Read our https://circleci.com/blog/debugging-ci-cd-pipelines-with-ssh-access/[blog post] on debugging CI/CD pipelines with SSH. -When you log in with SSH, you are running an *interactive* login shell. You may be running the command on top of the directory where the command failed the first time, or you may be running the command from the directory one level up from where the command failed (for example, `~/project/` or `~/`). Either way, you will not be initiating a clean run. You may wish to execute `pwd` or `ls` to ensure that you are in the correct directory. +When you log in with SSH, you are running an *interactive* login shell. You may be running the command on top of the directory where the command failed the first time, or from the directory one level up from where the command failed. Either way, you will not be initiating a clean run. You may wish to execute `pwd` or `ls` to ensure that you are in the correct directory. -Note that a _default_ CircleCI pipeline executes steps in a non-interactive shell. There is a possibility that running steps using an interactive login may succeed, but fail in non-interactive mode. +Note that a _default_ CircleCI pipeline executes steps in a non-interactive shell. Steps ran using an interactive login may succeed, but fail in non-interactive mode. [#steps] == Steps @@ -57,7 +57,7 @@ The job virtual machine (VM) will remain available for an SSH connection for *10 If your job has parallel steps, CircleCI launches more than one VM to perform them. You will see more than one 'Enable SSH' and 'Wait for SSH' section in the job output. -If you rerun a workflow that contains a job which was previously re-run with SSH, the new workflow will be run with SSH enabled for that job, even after SSH capability has been link:https://support.circleci.com/hc/en-us/articles/13936711308827-Disable-re-run-job-with-SSH-[disabled at the project level]. +If you rerun a workflow that contains a job which was previously re-run with SSH, the new workflow will be run with SSH enabled for that job. This is true even after SSH capability has been link:https://support.circleci.com/hc/en-us/articles/13936711308827-Disable-re-run-job-with-SSH-[disabled at the project level]. [#debugging-permission-denied-publickey] == Debugging: `permission denied (publickey)` diff --git a/styles/config/vocabularies/Docs/accept.txt b/styles/config/vocabularies/Docs/accept.txt index d18129acd2..ec07fca77c 100644 --- a/styles/config/vocabularies/Docs/accept.txt +++ b/styles/config/vocabularies/Docs/accept.txt @@ -295,6 +295,7 @@ seccomp Selenium SemVer Server Plan +SELinux \b[Ss]hellchecking\b [Ss]harded \b[Ss]ingle sign-on\b From f544780b11ffe2621740a47224f151c14ef6af23 Mon Sep 17 00:00:00 2001 From: Rosie Yohannan Date: Wed, 2 Apr 2025 13:15:34 +0100 Subject: [PATCH 3/3] fix lint errors --- jekyll/_cci2/install-machine-runner-3-on-docker.adoc | 2 +- jekyll/_cci2/runner-concepts.adoc | 7 +++++-- jekyll/_cci2/ssh-access-jobs.adoc | 2 +- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/jekyll/_cci2/install-machine-runner-3-on-docker.adoc b/jekyll/_cci2/install-machine-runner-3-on-docker.adoc index 49fb67b4d4..f4de5f06e4 100644 --- a/jekyll/_cci2/install-machine-runner-3-on-docker.adoc +++ b/jekyll/_cci2/install-machine-runner-3-on-docker.adoc @@ -108,7 +108,7 @@ docker stop ; docker rm ; NOTE: In machine runner 3, the environment variable name prefix has changed from `LAUNCH_AGENT_` to `CIRCLECI_RUNNER_`. -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 acomplish this. +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. include::../_includes/snippets/machine-runner-example.adoc[] diff --git a/jekyll/_cci2/runner-concepts.adoc b/jekyll/_cci2/runner-concepts.adoc index 221a110116..e8e7424b3b 100644 --- a/jekyll/_cci2/runner-concepts.adoc +++ b/jekyll/_cci2/runner-concepts.adoc @@ -44,7 +44,10 @@ The machine runner 3 replaces launch-agent on cloud and server v4.4+. Bringing i [#launch-agent] == Launch-agent -The launch-agent manages gathering information required to run a task with machine runner (defined as a parallel run of a job) while also downloading and launching the task-agent process. +The launch-agent handles the following: + +* Manages gathering information required to run a task with machine runner (defined as a parallel run of a job) +* Downloading and launching the task-agent process. The system has been designed to allow admins to configure the task-agent to run with a lower level of privileges than the launch-agent. Any user who is able to execute a job will be able to gain the same privileges as the task-agent. The launch-agent will run as `root`, but the task-agent will run as `circleci`. @@ -53,7 +56,7 @@ Launch-agent is currently supported on Server v4.x and v3.x. Cloud users and ser [#self-hosted-runner-concurrency] == Self-hosted runner concurrency -Rather than limit the total number of registered self-hosted runners, CircleCI's self-hosted runners are limited by the total number of self-hosted runner jobs (tasks) across your organization. +CircleCI's self-hosted runners are limited by the total number of self-hosted runner jobs (tasks) across your organization. [#public-repositories] == Public repositories diff --git a/jekyll/_cci2/ssh-access-jobs.adoc b/jekyll/_cci2/ssh-access-jobs.adoc index dcec25eae4..beb2377b4d 100644 --- a/jekyll/_cci2/ssh-access-jobs.adoc +++ b/jekyll/_cci2/ssh-access-jobs.adoc @@ -57,7 +57,7 @@ The job virtual machine (VM) will remain available for an SSH connection for *10 If your job has parallel steps, CircleCI launches more than one VM to perform them. You will see more than one 'Enable SSH' and 'Wait for SSH' section in the job output. -If you rerun a workflow that contains a job which was previously re-run with SSH, the new workflow will be run with SSH enabled for that job. This is true even after SSH capability has been link:https://support.circleci.com/hc/en-us/articles/13936711308827-Disable-re-run-job-with-SSH-[disabled at the project level]. +If you rerun a workflow containing a job that was previously re-run with SSH, the new job run will have SSH enabled. The job will have SSH enabled even if the SSH capability is link:https://support.circleci.com/hc/en-us/articles/13936711308827-Disable-re-run-job-with-SSH-[disabled at the project level]. [#debugging-permission-denied-publickey] == Debugging: `permission denied (publickey)`