mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2025-08-29 15:06:26 +02:00
Shorted generic- to gen-
This commit is contained in:
23
roles/gen-timer/README.md
Normal file
23
roles/gen-timer/README.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# Systemd Timer
|
||||
|
||||
## Description
|
||||
|
||||
This role configures a systemd timer to periodically start a corresponding service. It uses a Jinja2 template to create a timer unit file that specifies the scheduling parameters (such as OnCalendar and RandomizedDelaySec) and then restarts the timer service accordingly.
|
||||
|
||||
## Overview
|
||||
|
||||
Optimized for automated task scheduling in a [systemd](https://en.wikipedia.org/wiki/Systemd) environment, this role:
|
||||
- Generates a timer unit file for a given service (using the `service_name` variable).
|
||||
- Reloads and restarts the timer using systemd to ensure that changes take effect.
|
||||
- Supports dynamic configuration of scheduling parameters via variables like `on_calendar` and `randomized_delay_sec`.
|
||||
|
||||
## Purpose
|
||||
|
||||
The primary purpose of this role is to provide a reusable mechanism for scheduling recurring tasks on a system. By creating and managing a systemd timer unit, the role ensures that specified services are automatically started at defined intervals, enhancing system automation and reliability.
|
||||
|
||||
## Features
|
||||
|
||||
- **Dynamic Timer Configuration:** Uses a Jinja2 template to create a timer unit file based on provided variables.
|
||||
- **Automated Service Management:** Automatically reloads the systemd daemon and restarts the timer when changes are detected.
|
||||
- **Flexible Scheduling:** Supports configuration of parameters such as OnCalendar and RandomizedDelaySec for precise control over task timing.
|
||||
- **Persistent Timers:** Optionally enables persistent timer behavior to ensure missed activations are handled.
|
25
roles/gen-timer/meta/main.yml
Normal file
25
roles/gen-timer/meta/main.yml
Normal file
@@ -0,0 +1,25 @@
|
||||
---
|
||||
galaxy_info:
|
||||
author: "Kevin Veen-Birkenbach"
|
||||
description: "Configures a systemd timer to periodically start a specified service. This role automates the creation, reloading, and restarting of systemd timer units for recurring tasks."
|
||||
license: "CyMaIS NonCommercial License (CNCL)"
|
||||
license_url: "https://s.veen.world/cncl"
|
||||
company: |
|
||||
Kevin Veen-Birkenbach
|
||||
Consulting & Coaching Solutions
|
||||
https://www.veen.world
|
||||
min_ansible_version: "2.9"
|
||||
platforms:
|
||||
- name: Linux
|
||||
versions:
|
||||
- all
|
||||
galaxy_tags:
|
||||
- systemd
|
||||
- timer
|
||||
- automation
|
||||
- scheduling
|
||||
- configuration
|
||||
repository: "https://s.veen.world/cymais"
|
||||
issue_tracker_url: "https://s.veen.world/cymaisissues"
|
||||
documentation: "https://s.veen.world/cymais"
|
||||
dependencies: []
|
13
roles/gen-timer/tasks/main.yml
Normal file
13
roles/gen-timer/tasks/main.yml
Normal file
@@ -0,0 +1,13 @@
|
||||
- name: create {{service_name}}.cymais.timer
|
||||
template:
|
||||
src: dummy.timer.j2
|
||||
dest: "/etc/systemd/system/{{service_name}}.cymais.timer"
|
||||
register: dummy_timer
|
||||
|
||||
- name: "restart timer"
|
||||
systemd:
|
||||
daemon_reload: yes
|
||||
name: "{{service_name}}.cymais.timer"
|
||||
state: restarted
|
||||
enabled: yes
|
||||
when: dummy_timer.changed or activate_all_timers | bool
|
10
roles/gen-timer/templates/dummy.timer.j2
Normal file
10
roles/gen-timer/templates/dummy.timer.j2
Normal file
@@ -0,0 +1,10 @@
|
||||
[Unit]
|
||||
Description=Timer to start {{service_name}}.cymais.service
|
||||
|
||||
[Timer]
|
||||
OnCalendar={{on_calendar}}
|
||||
RandomizedDelaySec={{randomized_delay_sec}}
|
||||
Persistent={{ persistent | default('false') }}
|
||||
|
||||
[Install]
|
||||
WantedBy=timers.target
|
Reference in New Issue
Block a user