r/ouranos
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: rewrite README with structured overview and quick start guide

Browse Source 
Replaces the minimal project description with a comprehensive README
including a component overview table, quick start instructions, common
Ansible operations, and links to detailed documentation. Aligns with
Red Panda Approval™ standards.
This commit is contained in:
Robert
2026-03-03 12:49:06 +00:00
parent c7be03a743
commit b4d60f2f38
219 changed files with 34586 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
ansible/gitea_runner/config.yaml Normal file
View File

@@ -0,0 +1,110 @@
# Gitea Act Runner configuration
# Managed by Ansible - edit this file, then re-run the playbook.
log:
# The level of logging, can be trace, debug, info, warn, error, fatal
level: info
runner:
# Where to store the registration result.
file: .runner
# Execute how many tasks concurrently at the same time.
capacity: 1
# Extra environment variables to run jobs.
envs:
A_TEST_ENV_NAME_1: a_test_env_value_1
A_TEST_ENV_NAME_2: a_test_env_value_2
# Extra environment variables to run jobs from a file.
# It will be ignored if it's empty or the file doesn't exist.
env_file: .env
# The timeout for a job to be finished.
# Please note that the Gitea instance also has a timeout (3h by default) for the job.
# So the job could be stopped by the Gitea instance if it's timeout is shorter than this.
timeout: 3h
# The timeout for the runner to wait for running jobs to finish when shutting down.
# Any running jobs that haven't finished after this timeout will be cancelled.
shutdown_timeout: 0s
# Whether skip verifying the TLS certificate of the Gitea instance.
insecure: false
# The timeout for fetching the job from the Gitea instance.
fetch_timeout: 5s
# The interval for fetching the job from the Gitea instance.
fetch_interval: 2s
# The github_mirror of a runner is used to specify the mirror address of the github that pulls the action repository.
# It works when something like `uses: actions/checkout@v4` is used and DEFAULT_ACTIONS_URL is set to github,
# and github_mirror is not empty. In this case,
# it replaces https://github.com with the value here, which is useful for some special network environments.
github_mirror: ''
# The labels of a runner are used to determine which jobs the runner can run, and how to run them.
# Like: "macos-arm64:host" or "ubuntu-latest:docker://docker.gitea.com/runner-images:ubuntu-latest"
# Find more images provided by Gitea at https://gitea.com/docker.gitea.com/runner-images .
# 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.
labels:
- "ubuntu-latest:docker://docker.gitea.com/runner-images:ubuntu-latest"
- "ubuntu-24.04:docker://docker.gitea.com/runner-images:ubuntu-24.04"
- "ubuntu-22.04:docker://docker.gitea.com/runner-images:ubuntu-22.04"
- "ubuntu-20.04:docker://docker.gitea.com/runner-images:ubuntu-20.04"
- "node-24:docker://node:24-bookworm"
cache:
# Enable cache server to use actions/cache.
enabled: true
# The directory to store the cache data.
# If it's empty, the cache data will be stored in $HOME/.cache/actcache.
dir: ""
# The host of the cache server.
# It's not for the address to listen, but the address to connect from job containers.
# So 0.0.0.0 is a bad choice, leave it empty to detect automatically.
host: ""
# The port of the cache server.
# 0 means to use a random available port.
port: 0
# The external cache server URL. Valid only when enable is true.
# If it's specified, act_runner will use this URL as the ACTIONS_CACHE_URL rather than start a server by itself.
# The URL should generally end with "/".
external_server: ""
container:
# Specifies the network to which the container will connect.
# Could be host, bridge or the name of a custom network.
# If it's empty, act_runner will create a network automatically.
network: ""
# Whether to use privileged mode or not when launching task containers (privileged mode is required for Docker-in-Docker).
privileged: false
# And other options to be used when the container is started (eg, --add-host=my.gitea.url:host-gateway).
options:
# The parent directory of a job's working directory.
# NOTE: There is no need to add the first '/' of the path as act_runner will add it automatically.
# If the path starts with '/', the '/' will be trimmed.
# For example, if the parent directory is /path/to/my/dir, workdir_parent should be path/to/my/dir
# If it's empty, /workspace will be used.
workdir_parent:
# Volumes (including bind mounts) can be mounted to containers. Glob syntax is supported, see https://github.com/gobwas/glob
# You can specify multiple volumes. If the sequence is empty, no volumes can be mounted.
# For example, if you only allow containers to mount the `data` volume and all the json files in `/src`, you should change the config to:
# valid_volumes:
# - data
# - /src/*.json
# If you want to allow any volume, please use the following configuration:
# valid_volumes:
# - '**'
valid_volumes: []
# overrides the docker client host with the specified one.
# If it's empty, act_runner will find an available docker host automatically.
# If it's "-", act_runner will find an available docker host automatically, but the docker host won't be mounted to the job containers and service containers.
# If it's not empty or "-", the specified docker host will be used. An error will be returned if it doesn't work.
docker_host: ""
# Pull docker image(s) even if already present
force_pull: true
# Rebuild docker image(s) even if already present
force_rebuild: false
# Always require a reachable docker daemon, even if not required by act_runner
require_docker: false
# Timeout to wait for the docker daemon to be reachable, if docker is required by require_docker or act_runner
docker_timeout: 0s
host:
# The parent directory of a job's working directory.
# If it's empty, $HOME/.cache/act/ will be used.
workdir_parent:

157
ansible/gitea_runner/deploy.yml Normal file
View File

@@ -0,0 +1,157 @@
---
- name: Deploy Gitea Runner
hosts: ubuntu
become: true
tasks:
- name: Check if host has gitea_runner service
ansible.builtin.set_fact:
has_gitea_runner_service: "{{ 'gitea_runner' in services }}"
- name: Skip hosts without gitea_runner service
ansible.builtin.meta: end_host
when: not has_gitea_runner_service
# =========================================================================
# Service Account
# =========================================================================
- name: Create gitea-runner system group
ansible.builtin.group:
name: gitea-runner
system: true
state: present
- name: Create gitea-runner system user
ansible.builtin.user:
name: gitea-runner
group: gitea-runner
groups: docker
append: true
system: true
shell: /bin/bash
home: /srv/gitea-runner
create_home: true
comment: "Gitea Act Runner"
# =========================================================================
# Binary Installation
# =========================================================================
- name: Ensure /usr/local/bin directory exists
ansible.builtin.file:
path: /usr/local/bin
state: directory
mode: '0755'
owner: root
group: root
- name: Check current act_runner version
ansible.builtin.command: /usr/local/bin/act_runner --version
register: act_runner_current_version
changed_when: false
failed_when: false
- name: Download act_runner binary
ansible.builtin.get_url:
url: "https://gitea.com/gitea/act_runner/releases/download/v{{ act_runner_version }}/act_runner-{{ act_runner_version }}-linux-amd64"
dest: /usr/local/bin/act_runner
mode: '0755'
owner: root
group: root
force: true
when: act_runner_current_version.rc != 0 or act_runner_version not in (act_runner_current_version.stdout | default(''))
notify: restart gitea-runner
# =========================================================================
# Configuration
# =========================================================================
- name: Copy runner config
ansible.builtin.copy:
src: config.yaml
dest: /srv/gitea-runner/config.yaml
owner: gitea-runner
group: gitea-runner
mode: '0644'
notify: restart gitea-runner
# =========================================================================
# Systemd Service
# =========================================================================
- name: Template gitea-runner systemd service
ansible.builtin.template:
src: gitea-runner.service.j2
dest: /etc/systemd/system/gitea-runner.service
owner: root
group: root
mode: '0644'
notify: restart gitea-runner
- name: Check if runner is registered
ansible.builtin.stat:
path: /srv/gitea-runner/.runner
register: runner_registration
# =========================================================================
# Registration
# =========================================================================
- name: Prompt for registration token
ansible.builtin.pause:
prompt: |
Gitea runner registration required.
Get token from: {{ gitea_runner_instance_url }}/-/admin/runners
Enter registration token
register: runner_token
when:
- not runner_registration.stat.exists
- registration_token is not defined
- name: Set registration token from prompt or variable
ansible.builtin.set_fact:
runner_registration_token: "{{ registration_token | default(runner_token.user_input) }}"
when: not runner_registration.stat.exists
- name: Register runner with Gitea instance
ansible.builtin.shell:
cmd: >
sudo -u gitea-runner
/usr/local/bin/act_runner register
--instance {{ gitea_runner_instance_url }}
--token {{ runner_registration_token }}
--name {{ gitea_runner_name }}
--no-interactive
args:
creates: /srv/gitea-runner/.runner
chdir: /srv/gitea-runner
when: not runner_registration.stat.exists
# =========================================================================
# Service Management
# =========================================================================
- name: Enable gitea-runner service
ansible.builtin.systemd:
name: gitea-runner
enabled: true
daemon_reload: true
- name: Start gitea-runner service
ansible.builtin.systemd:
name: gitea-runner
state: started
# ===========================================================================
# Handlers
# ===========================================================================
handlers:
- name: restart gitea-runner
ansible.builtin.systemd:
name: gitea-runner
state: restarted
daemon_reload: true

17
ansible/gitea_runner/gitea-runner.service.j2 Normal file
View File

@@ -0,0 +1,17 @@
[Unit]
Description=Gitea Runner
After=network.target docker.service
Requires=docker.service
[Service]
Type=simple
User=gitea-runner
Group=gitea-runner
WorkingDirectory=/srv/gitea-runner
ExecStart=/usr/local/bin/act_runner daemon --config /srv/gitea-runner/config.yaml
Restart=on-failure
RestartSec=10
Environment=HOME=/srv/gitea-runner
[Install]
WantedBy=multi-user.target