10000 Merge pull request #7528 from circleci/DOCTEAM-823_runner_m1_install · marcoderama/circleci-docs@746f7b2 · GitHub
[go: up one dir, main page]
Skip to content

Commit 746f7b2

Browse files
kbatuigaskbatuigas
authored
Merge pull request circleci#7528 from circleci/DOCTEAM-823_runner_m1_install
Troubleshooting runner install on M1 macOS
2 parents c847010 + b64b14c commit 746f7b2

5 files changed

+28
-6
lines changed

‎jekyll/_cci2/container-runner-installation.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ This page describes how to install CircleCI's container runner.
1717

1818
{% include snippets/runner-platform-prerequisites.adoc %}
1919

20+
[#installation-instructions]
2021
== Installation instructions
2122

2223
1. Add the container runner Helm repo by running `helm repo add container-agent https://packagecloud.io/circleci/container-agent/helm`
@@ -66,6 +67,12 @@ workflows:
6667

6768
CAUTION: **Do not** use an existing job that uses <<building-docker-images#,setup_remote_docker>> (see <<container-runner#building-container-images,Building container images>> for more information).
6869

70+
[#troubleshooting]
71+
== Troubleshooting
72+
73+
Refer to the <<troubleshoot-self-hosted-runner#troubleshoot-container-runner,Troubleshoot Container Runner section>> of the Troubleshoot Self-hosted Runner guide if you encounter issues installing or running container runner.
74+
75+
[#additional-resources]
6976
== Additional resources
7077

7178
- xref:container-runner.adoc[Container runner reference guide]

‎jekyll/_cci2/runner-installation-linux.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -246,3 +246,8 @@ You can also see the logs for the system by running:
246246
```shell
247247
journalctl -u circleci
248248
```
249+
250+
[#troubleshooting]
251+
== Troubleshooting
252+
253+
Refer to the <<troubleshoot-self-hosted-runner#troubleshoot-machine-runner,Troubleshoot Machine Runner section>> of the Troubleshoot Self-hosted Runner guide if you encounter issues installing or running machine runner on Linux.

‎jekyll/_cci2/runner-installation-mac.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Copy the following to the new `/Library/LaunchDaemons/com.circleci.runner.plist`
116116
<string>com.circleci.runner</string>
117117

118118
<key>Program</key>
119-
<string>/var/opt/circleci/circleci-launch-agent</string>
119+
<string>/opt/circleci/circleci-launch-agent</string>
120120

121121
<key>ProgramArguments</key>
122122
<array>
@@ -174,3 +174,8 @@ sudo launchctl unload '/Library/LaunchDaemons/com.circleci.runner.plist'
174174
== Verify the service is running
175175

176176
Open the pre-installed macOS application *Console*. In this application, you can view the logs for the CircleCI agent under *Log Reports*. Look for the logs called `com.circleci.runner.log` in the list. You can also find this file by navigating to *Library > Logs*.
177+
178+
[#troubleshooting]
179+
== Troubleshooting
180+
181+
Refer to the <<troubleshoot-self-hosted-runner#troubleshoot-machine-runner,Troubleshoot Machine Runner section>> of the Troubleshoot Self-hosted Runner guide if you encounter issues installing or running machine runner on macOS.

‎jekyll/_cci2/runner-installation-windows.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,3 +67,8 @@ Uninstalling machine runners will prepare the system for installation again.
6767
By default, Windows machine runners run in <<runner-config-reference#runner-mode,single task mode>> in order to ensure high reliablity of the underlying technology that the self-hosted runner uses to execute jobs. This is the **recommended mode** for Windows machine runners.
6868

6969
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.
70+
71+
[#troubleshooting]
72+
== Troubleshooting
73+
74+
Refer to the <<troubleshoot-self-hosted-runner#troubleshoot-machine-runner,Troubleshoot Machine Runner section>> of the Troubleshoot Self-hosted Runner guide if you encounter issues installing or running machine runner on Windows.

‎jekyll/_cci2/troubleshoot-self-hosted-runner.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ contentTags:
1212

1313
This page describes errors and troubleshooting mehtods for container and machine runners.
1414

15-
[#troubleshooting-container-runner]
16-
== Troubleshooting container runner
15+
[#troubleshoot-container-runner]
16+
== Troubleshoot container runner
1717

1818
The following are errors you could encounter using container runner.
1919

@@ -109,11 +109,11 @@ The following are errors you could encounter using machine runner.
109109
[#i-installed-my-first-self-hosted-runner-on-macOS-and-the-job-is-stuck-in-preparing-environment-but-there-are-no-errors-what-should-i-do]
110110
=== I installed my first self-hosted runner on macOS and the job is stuck in "Preparing Environment", but there are no errors, what should I do?
111111

112-
Try running the following two commands:
112+
In some cases, you may need to update the execution permission for the launch-agent so it is executable by root. Try running the following two commands:
113113

114114
```bash
115-
sudo chmod +x /var/opt/circleci/circleci-launch-agent
116-
sudo /var/opt/circleci/circleci-launch-agent --config=/Library/Preferences/com.circleci.runner/launch-agent-config.yaml
115+
sudo chmod +x /opt/circleci/circleci-launch-agent
116+
sudo /opt/circleci/circleci-launch-agent --config=/Library/Preferences/com.circleci.runner/launch-agent-config.yaml
117117
```
118118
Cancel the job and rerun it. If your job is still not running, file a https://support.circleci.com/hc/en-us[support ticket].
119119

0 commit comments

Comments
 (0)
0