Compare commits

...

3 Commits

Author SHA1 Message Date
Lukas Greve
93561738df remove update mechanism for other distributions 2025-10-24 21:05:35 +02:00
Lukas Greve
55e7de19a4 automate the runner setup 2025-10-24 21:05:17 +02:00
Lukas Greve
a1fa40de43 update README to reflect recent changes 2025-10-24 21:04:34 +02:00
3 changed files with 83 additions and 63 deletions

View File

@@ -7,22 +7,25 @@ To deploy a Rocky Linux virtual machine, please go to [this repository](https://
## Repository Structure ## Repository Structure
``` ```
├── ansible.cfg # Ansible configuration settings ├── ansible.cfg # Ansible configuration settings
├── inventory.ini # Host inventory definition ├── inventory.ini # Host inventory definition
├── setup.yml # Main playbook for Gitea Runner configuration ├── setup.yml # Main playbook for basic system setup
├── update.yml # Playbook to ensure system is up-to-date ├── update.yml # Playbook to ensure system is up-to-date
├── runner_setup.yml # Playbook for Gitea Runner installation and configuration
``` ```
## Prerequisites ## Prerequisites
1. Ansible installed on your control machine 1. Ansible installed on your control machine
2. Access to a Rocky Linux 10 VM with IP `10.17.3.36` 2. Access to a Rocky Linux 10 VM with IP `10.17.3.250`
3. SSH key authentication configured with `~/.ssh/terraform_key` 3. SSH key authentication configured with `~/.ssh/terraform_key`
4. Root privileges or sudo access on the target VM 4. Root privileges or sudo access on the target VM
5. Gitea registration token (to be placed in runner_setup.yml)
## How to Use ## How to Use
1. **Install Ansible** (if not already installed): 1. **Install Ansible** (if not already installed):
```bash ```bash
# For CentOS/RHEL/Fedora # For CentOS/RHEL/Fedora
sudo yum install ansible sudo yum install ansible
@@ -32,36 +35,52 @@ To deploy a Rocky Linux virtual machine, please go to [this repository](https://
``` ```
2. **Ensure SSH key exists**: 2. **Ensure SSH key exists**:
```bash
```
ls ~/.ssh/terraform_key ls ~/.ssh/terraform_key
``` ```
3. **Run the playbooks**: 3. **Set registration token in runner_setup.yml**:
```bash
```
registration_token: "your_actual_token_here"
```
> Obtain the token from: https://git.phyllo.me/user/settings/actions/runners
> For a runner to have the global scope, one needs to generate a token with a Gitea superuser
4. **Run the playbooks**:
```
ansible-playbook update.yml ansible-playbook update.yml
ansible-playbook setup.yml ansible-playbook setup.yml
ansible-playbook runner_setup.yml
``` ```
## What This Does ## What This Does
This automation will: This automation will:
1. Connect to the specified Rocky Linux VM
2. Update the system packages
3. Install necessary dependencies (git)
4. Create a dedicated gitea-runner user
5. Set hostname to rocky10
6. Download and install Gitea Runner v0.2.13
7. Configure systemd service for automatic startup
8. Start the Gitea Runner service
The result is a fully configured Gitea Runner that will automatically start on system boot, ready to execute Gitea Actions workflows. - Connect to the specified Rocky Linux VM
- Update the system packages and reboot if required
- Install necessary dependencies
- Set hostname to rocky10
- Create a dedicated gitea-runner user
- Download and install Gitea Runner
- Configure systemd service for automatic startup
- Register the runner with Gitea using the provided token
- Start the Gitea Runner service
- The result is a fully configured Gitea Runner that will automatically start on system boot, ready to execute Gitea Actions workflows.
## Troubleshooting ## Troubleshooting
If you encounter issues: If you encounter issues:
- Verify SSH connectivity to the target VM - Verify SSH connectivity to the target VM
- Ensure Ansible can reach the specified IP address - Ensure Ansible can reach the specified IP address
- Check that `~/.ssh/terraform_key` has correct permissions - Check that ~/.ssh/terraform_key has correct permissions (600)
- Review output logs for specific error messages - Review output logs for specific error messages
- Make sure the registration token is valid
For additional help with Ansible configuration, consult the [official Ansible documentation](https://docs.ansible.com/ansible/latest/index.html). For additional help with Ansible configuration, consult the official Ansible documentation.

View File

@@ -1,38 +1,42 @@
--- ---
- name: Initial one-time setup - name: Initial one-time setup for the Act Runner, Gitea's Action runner
hosts: gitrunner hosts: gitrunner
become: yes become: yes
vars: vars:
runner_name: "act_runner"
gitea_runner_version: "0.2.13" gitea_runner_version: "0.2.13"
# Token has to be generated here https://git.phyllo.me/user/settings/actions/runners and paste here, like:
# registration_token: "asdlkhgalsdhlgksdahklds"
registration_token: ""
tasks: tasks:
- name: Create act runner user - name: Create act runner user
user: ansible.builtin.user:
name: "{{ runner_name }}" name: "act_runner"
system: yes system: yes
shell: /bin/bash shell: /bin/bash
home: "/var/lib/{{ runner_name }}" home: "/var/lib/act_runner"
create_home: no create_home: yes
state: present
- name: Create /etc/act_runner directory - name: Create /etc/act_runner directory
file: ansible.builtin.file:
path: /etc/"{{ runner_name }}" path: /etc/act_runner
state: directory state: directory
owner: "{{ runner_name }}" owner: "act_runner"
group: "{{ runner_name }}" group: "act_runner"
mode: '0755' mode: '0755'
- name: Install Act Runner - name: Install Act Runner
uri: ansible.builtin.get_url:
url: "https://gitea.com/gitea/act_runner/releases/download/v{{ gitea_runner_version }}/act_runner-{{ gitea_runner_version }}-linux-amd64" url: "https://gitea.com/gitea/act_runner/releases/download/v{{ gitea_runner_version }}/act_runner-{{ gitea_runner_version }}-linux-amd64"
dest: "/usr/local/bin/act-runner" dest: "/usr/local/bin/act-runner"
mode: '0755' mode: '0755'
status_code: 200 force: "{{ (ansible_facts['cmdline']['force'] is defined) | default(false) }}"
follow_redirects: all retries: 3
delay: 5
- name: Creat Act Runner configuration file
copy: - name: Create Act Runner configuration file
ansible.builtin.copy:
content: | content: |
log: log:
# The level of logging, can be trace, debug, info, warn, error, fatal # The level of logging, can be trace, debug, info, warn, error, fatal
@@ -69,7 +73,7 @@
# If it's empty when registering, it will ask for inputting labels. # If it's empty when registering, it will ask for inputting labels.
# If it's empty when execute `daemon`, will use labels in `.runner` file. # If it's empty when execute `daemon`, will use labels in `.runner` file.
labels: labels:
- "rocky-10:host:local" - "rocky-latest:host:local"
cache: cache:
# Enable cache server to use actions/cache. # Enable cache server to use actions/cache.
@@ -129,22 +133,30 @@
# If it's empty, $HOME/.cache/act/ will be used. # If it's empty, $HOME/.cache/act/ will be used.
workdir_parent: workdir_parent:
dest: /etc/act_runner/config.yaml dest: /etc/act_runner/config.yaml
mode: '0644' owner: "act_runner"
group: "act_runner"
mode: '0755'
backup: yes
- name: Register the runner with Gitea - name: Check if runner is already registered
command: > ansible.builtin.stat:
path: /var/lib/act_runner/.runner
register: runner_registered
changed_when: false
- name: Register the runner with Gitea (if not already registered)
ansible.builtin.command: >
/usr/local/bin/act-runner register /usr/local/bin/act-runner register
--no-interactive --no-interactive
--config /etc/act_runner/config.yaml --config /etc/act_runner/config.yaml
--instance https://git.phyllo.me --instance https://git.phyllo.me
--token {{ registration_token }} --token {{ registration_token }}
args: --name rl-bios-0
chdir: /var/lib/{{ runner_name }} when: not runner_registered.stat.exists
become_user: "{{ runner_name }}"
changed_when: true changed_when: true
- name: Create Act Runner service file - name: Create Act Runner service file
copy: ansible.builtin.copy:
content: | content: |
[Unit] [Unit]
Description=Gitea Actions Runner Description=Gitea Actions Runner
@@ -152,8 +164,8 @@
[Service] [Service]
Type=simple Type=simple
User={{ runner_name }} User=act_runner
ExecStart=/usr/local/bin/act_runner daemon --config /etc/act_runner/config.yaml ExecStart=/usr/local/bin/act-runner daemon --config /etc/act_runner/config.yaml
ExecReload=/bin/kill -s HUP $MAINPID ExecReload=/bin/kill -s HUP $MAINPID
WorkingDirectory=/var/lib/act_runner WorkingDirectory=/var/lib/act_runner
TimeoutSec=0 TimeoutSec=0
@@ -164,11 +176,12 @@
[Install] [Install]
WantedBy=multi-user.target WantedBy=multi-user.target
dest: /etc/systemd/system/act-runner.service dest: /etc/systemd/system/act-runner.service
mode: '0644' mode: '0755'
backup: yes
- name: Ensure act-runner service is enabled and started - name: Ensure act-runner service is enabled and started
systemd: ansible.builtin.systemd:
name: act-runner name: act-runner
enabled: yes enabled: yes
state: started state: started
daemon_reload: yes daemon_reload: yes

View File

@@ -17,21 +17,9 @@
ignore_errors: true ignore_errors: true
when: ansible_os_family == "RedHat" when: ansible_os_family == "RedHat"
- name: Check if reboot required (Debian/Ubuntu)
stat:
path: /var/run/reboot-required
register: reboot_required_file
when: ansible_os_family != "RedHat"
- name: Reboot if required (RedHat/CentOS) - name: Reboot if required (RedHat/CentOS)
reboot: reboot:
when: when:
- ansible_os_family == "RedHat" - ansible_os_family == "RedHat"
- needs_restarting_output.rc == 1 - needs_restarting_output.rc == 1
- needs_restarting_output is defined - needs_restarting_output is defined
- name: Reboot if required (Debian/Ubuntu)
reboot:
when:
- ansible_os_family != "RedHat"
- reboot_required_file.stat.exists == true