Skip to content

Commit 42e4887

Browse files
committed
formatting
1 parent ce1e79f commit 42e4887

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

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

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,12 @@ contentTags:
1515

1616
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.
1717

18-
[#new-recommended-method-container-runner]
19-
== Recommended method for Docker installation (container runner)
18+
[NOTE]
19+
====
20+
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.
2021
21-
The <<container-runner#,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.
22+
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.
23+
====
2224

2325
[#machine-approach-with-docker]
2426
== Machine-based approach with Docker
@@ -28,8 +30,8 @@ The <<container-runner#,container runner>> is the recommended approach for runni
2830

2931
* link:https://docs.docker.com/engine/install/[Docker]
3032

31-
[#additional-prerequisites]
32-
==== Additional prerequisites with Docker
33+
[#resource-requirements]
34+
==== Resource requirements
3335

3436
The host needs to have Docker installed. Once the `runner` container is started, the container will immediately attempt to start running jobs. The container will be reused to run more jobs indefinitely until it is stopped.
3537

@@ -68,20 +70,23 @@ docker build --file ./Dockerfile.runner.extended .
6870

6971
NOTE: The environment variable values are not available to the `docker` command, so these environment variables are not visible in `ps` output.
7072

73+
[.tab.startContainer.Cloud]
74+
--
7175
```shell
7276
CIRCLECI_RUNNER_NAME=<runner-name> CIRCLECI_RUNNER_API_AUTH_TOKEN=<runner-token> docker run --env CIRCLECI_RUNNER_NAME --env CIRCLECI_RUNNER_API_AUTH_TOKEN --name <container-name> <image-id-from-previous-step>
7377
```
78+
--
7479

75-
When the container starts, it will immediately attempt to start running jobs.
76-
77-
[#start-the-docker-container-on-server]
78-
==== Start the Docker container on server
79-
80+
[.tab.startContainer.Server]
81+
--
8082
When starting the Docker container on server, the `CIRCLECI_RUNNER_API_URL` environment variable will also need to be passed in using the `--env` flag.
8183

8284
```shell
8385
CIRCLECI_RUNNER_NAME=<runner-name> CIRCLECI_RUNNER_API_AUTH_TOKEN=<runner-token> CIRCLECI_RUNNER_API_URL=<server_host_name> docker run --env CIRCLECI_RUNNER_NAME --env CIRCLECI_RUNNER_API_AUTH_TOKEN --env CIRCLECI_RUNNER_API_URL --name <container-name> <image-id-from-previous-step>
8486
```
87+
--
88+
89+
When the container starts, it will immediately attempt to start running jobs.
8590

8691
[#stopping-the-docker-container]
8792
=== Stopping the Docker container

0 commit comments

Comments
 (0)