forked from Controls/gitea-pages
51 lines
1.7 KiB
ReStructuredText
51 lines
1.7 KiB
ReStructuredText
``profile::custom_timers``
|
|
==========================
|
|
|
|
This profile is a defined type to define systemd timers together with the corresponding service.
|
|
|
|
The resources are defined using the ``systemd::service`` and ``system::service``.
|
|
The service is defined as type simple and it it has dependency (``Wants`` and ``After``) from
|
|
the ``network-online.target``.
|
|
|
|
|
|
The defined type is used from ``role::base`` to create the resources
|
|
defined in the ``base::timers`` hiera hash.
|
|
|
|
Parameters
|
|
----------
|
|
|
|
=============================== ======== ================================================
|
|
**Name** **Type** **Default**
|
|
------------------------------- -------- ------------------------------------------------
|
|
description String
|
|
command String
|
|
on_calendar String
|
|
timer_options Hash {}
|
|
service_options Hash {}
|
|
=============================== ======== ================================================
|
|
|
|
|
|
``description``
|
|
~~~~~~~~~~~~~~~
|
|
|
|
Human-oriented description of the service and timer.
|
|
|
|
``command``
|
|
~~~~~~~~~~~
|
|
|
|
Path to the command to invoke into the service. It should be an absolute path
|
|
and a check is performed against this.
|
|
|
|
``on_calendar``
|
|
~~~~~~~~~~~~~~~
|
|
The definition of the timer execution time. See `OnCalendar` on :manpage:`systemd.timer(5)`.
|
|
|
|
``timer_options``
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
Additional options for the ``[Timer]`` section of the timer unit file, see :manpage:`systemd.timer(5)`.
|
|
|
|
``service_options``
|
|
~~~~~~~~~~~~~~~~~~~
|
|
Additional options for the ``[Service]`` section of the timer related service unit file, see :manpage:`systemd.service(5)`.
|