diff --git a/jekyll/_cci2/install-machine-runner-3-on-docker.adoc b/jekyll/_cci2/install-machine-runner-3-on-docker.adoc index c8dbabb9e1..a7aea19d49 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,13 +12,13 @@ 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. +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] @@ -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. The commands described above can be used to accomplish this. include::../_includes/snippets/runner/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 eadf66304a..6028ac0191 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 <> 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/server/v4.4/overview/release-notes.adoc b/jekyll/_cci2/server/v4.4/overview/release-notes.adoc index 0eb26429ef..6bb72c9ff4 100644 --- a/jekyll/_cci2/server/v4.4/overview/release-notes.adoc +++ b/jekyll/_cci2/server/v4.4/overview/release-notes.adoc @@ -19,7 +19,7 @@ noindex: true The v4.4 release introduces the following feature enhancements: * xref:../../../openid-connect-tokens#[OpenID Connect tokens]: CircleCI provides OpenID Connect ID (OIDC) tokens in environment variables. A job can be configured to use these tokens to access compatible cloud services without long-lived credentials being stored in CircleCI. -* link:https://circleci.com/changelog/machine-runner-3-0-released/[Machine runner 3.0]: Improved setup, usability and maintainability. +* link:https://circleci.com/changelog/machine-runner-3-0-released/[Machine runner 3]: Improved setup, usability and maintainability. * xref:../../../container-runner-installation#enable-rerun-job-with-ssh[Rerun job with SSH option for container runners], in open preview. For a full list of fixes, changes, new features and known issues, follow the links to individual change log posts below. diff --git a/jekyll/_cci2/ssh-access-jobs.adoc b/jekyll/_cci2/ssh-access-jobs.adoc index b57ed1ed9d..beb2377b4d 100644 --- a/jekyll/_cci2/ssh-access-jobs.adoc +++ b/jekyll/_cci2/ssh-access-jobs.adoc @@ -18,16 +18,16 @@ 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 NOTE: The steps described in this section apply to all CircleCI accounts. If you are using Bitbucket Cloud, or your account is integrated through the GitHub OAuth app, you can add an SSH key to your VCS account (https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/[GitHub] or https://confluence.atlassian.com/bitbucket/set-up-an-ssh-key-728138079.html[Bitbucket]) rather than in the CircleCI app under https://app.circleci.com/settings/user/job-ssh-keys[User Settings] if you prefer. -NOTE: **Using self-hosted runners?** To use SSH reruns with CircleCI runners you will first need to enable the SSH rerun feature. Refer to the xref:machine-runner-3-configuration-reference#runner-ssh-advertise-addr[Machine runner 3.0] or xref:container-runner-installation#enable-rerun-job-with-ssh[Container runner] pages for steps. +NOTE: **Using self-hosted runners?** To use SSH reruns with CircleCI runners you will first need to enable the SSH rerun feature. Refer to the xref:machine-runner-3-configuration-reference#runner-ssh-advertise-addr[Machine runner 3] or xref:container-runner-installation#enable-rerun-job-with-ssh[Container runner] pages for steps. . If you have not already done so, add an SSH key to your link:https://app.circleci.com/settings/user/job-ssh-keys[User Settings]. This key will be used to connect to container or VM that is running your job. @@ -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 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)` diff --git a/jekyll/_data/sidenav.yml b/jekyll/_data/sidenav.yml index 04f07da931..9dab0b7c44 100644 --- a/jekyll/_data/sidenav.yml +++ b/jekyll/_data/sidenav.yml @@ -274,7 +274,7 @@ en: link: container-runner-performance-benchmarks - name: Container runner reference link: container-runner - - name: Machine runner 3.0 + - name: Machine runner 3 children: - name: Install on Linux link: install-machine-runner-3-on-linux @@ -288,13 +288,13 @@ en: link: machine-runner-3-manual-installation - name: Manual install on Windows link: machine-runner-3-manual-installation-on-windows - - name: Migrate from launch agent to machine runner 3.0 on Linux + - name: Migrate from launch agent to machine runner 3 on Linux link: migrate-from-launch-agent-to-machine-runner-3-on-linux - - name: Migrate from launch agent to machine runner 3.0 on macOS + - name: Migrate from launch agent to machine runner 3 on macOS link: migrate-from-launch-agent-to-machine-runner-3-on-macos - - name: Migrate from launch agent to machine runner 3.0 on Windows + - name: Migrate from launch agent to machine runner 3 on Windows link: migrate-from-launch-agent-to-machine-runner-3-on-windows - - name: Machine runner 3.0 configuration reference + - name: Machine runner 3 configuration reference link: machine-runner-3-configuration-reference - name: Machine runner children: 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