Skip to content

Commit 332aa83

Browse files
authored
Update install_circleci_runner.md
1 parent b8358c3 commit 332aa83

1 file changed

Lines changed: 23 additions & 21 deletions

File tree

content/learning-paths/servers-and-cloud-computing/circleci-gcp/install_circleci_runner.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,64 +8,66 @@ layout: learningpathall
88

99
## Install CircleCI Machine Runner on SUSE Arm64
1010

11-
This guide explains how to install and configure the **CircleCI Machine Runner** on a **GCP SUSE Arm64 virtual machine**.
12-
This setup allows your self-hosted environment to execute CircleCI jobs targeting Arm64 architecture.
11+
This section explains how to install and configure the CircleCI Machine Runner on a SUSE Linux Arm64 virtual machine running on Google Cloud C4A (Axion). By installing this runner, you enable your own VM to execute CircleCI Arm-native jobs.
1312

1413
### Add CircleCI Package Repository
1514

16-
SUSE is an RPM-based distribution, so first add the official CircleCI repository:
15+
Because SUSE is an RPM-based Linux distribution, you first need to add the official CircleCI package repository from PackageCloud:
1716

1817
```console
1918
curl -s https://packagecloud.io/install/repositories/circleci/runner/script.rpm.sh?any=true | sudo bash
2019
```
20+
This command automatically detects your distribution and adds the appropriate repository configuration for SUSE-based systems.
21+
2122
### Install the CircleCI Runner
22-
Create a symlink for `adduser` as the Circle CI runner script assumes Ubuntu/Debian as your OS:
23+
Before installation, create a symbolic link for `adduser`. The CircleCI runner installation script is primarily built for Debian/Ubuntu systems, which use the `adduser` command. SUSE uses `useradd` instead.
2324

2425
```bash
2526
sudo ln -s /usr/sbin/useradd /usr/sbin/adduser
2627
```
2728

28-
Install the pre-built CircleCI runner package:
29+
Now install the CircleCI runner package:
2930

3031
```console
3132
sudo zypper install -y circleci-runner
3233
```
3334
### Prepare User and Permissions
34-
Before starting the runner, ensure the required user, group, and directory permissions are properly set up:
35-
36-
```console
37-
# Create a symlink for adduser (required on SUSE)
38-
sudo ln -s /usr/sbin/useradd /usr/sbin/adduser
35+
Before starting the CircleCI runner, ensure the correct user, group, and directory permissions are in place. These steps ensure the runner operates securely and has proper access to its configuration and work directories.
3936

40-
# Create CircleCI system user and group
37+
Create CircleCI system user and group:
38+
```bash
4139
sudo useradd -m -r circleci
4240
sudo groupadd --system circleci
43-
44-
# Set up CircleCI directories and permissions
41+
```
42+
Set up CircleCI directories and permissions:
43+
```bash
4544
sudo mkdir -p /var/lib/circleci
4645
sudo chown -R circleci:circleci /var/lib/circleci
4746
sudo chown -R circleci:circleci /etc/circleci-runner
48-
49-
# Reload systemd and restart the runner service
47+
```
48+
Reload systemd and restart the runner service:
49+
```bash
5050
sudo systemctl daemon-reload
5151
sudo systemctl restart circleci-runner
52-
53-
# Verify service status
52+
```
53+
Verify service status:
54+
```bash
5455
sudo systemctl status circleci-runner
5556
```
5657

5758
### Configure the Runner Token
5859

59-
Replace the authentication token in the runner configuration file.
60-
Use the token obtained from your Resource Class in the CircleCI Dashboard.
60+
Now, configure the authentication token that connects your runner to CircleCI.
61+
Use the token generated earlier from your Resource Class in the CircleCI dashboard.
6162

6263
```console
6364
export RUNNER_AUTH_TOKEN="AUTH_TOKEN "
6465
sudo sed -i "s/<< AUTH_TOKEN >>/$RUNNER_AUTH_TOKEN/g" /etc/circleci-runner/circleci-runner-config.yaml
6566
```
67+
Replace AUTH_TOKEN with the actual token copied from the CircleCI dashboard.
6668

6769
### Enable and Start the Runner
68-
Enable the CircleCI runner service to start automatically and verify it’s running:
70+
Enable the CircleCI service to start automatically at boot, then start and verify the runner:
6971

7072
```console
7173
sudo systemctl enable circleci-runner
@@ -90,6 +92,6 @@ Oct 09 11:15:03 lpprojectsusearm64 circleci-runner[10150]: 11:15:03 6f109 46.059
9092
Oct 09 11:15:03 lpprojectsusearm64 circleci-runner[10150]: 11:15:03 6f109 46.119ms claim app.loop_name=claim: mode=agent res>
9193
Oct 09 11:15:03 lpprojectsusearm64 circleci-runner[10150]: 11:15:03 6f109 46.144ms worker loop: claim: app.backoff_ms=5000 a>
9294
```
93-
Also, you can verify it from the dashboard:
95+
You can also confirm that your runner is connected and active by visiting the Self-Hosted Runners page in the CircleCI web dashboard.
9496

9597
![Self-Hosted Runners alt-text#center](images/dashboard.png "Figure 1: Self-Hosted Runners ")

0 commit comments

Comments
 (0)