# Driver `task.acme` **Minimal configlet:** [task#1] type = acme **Minimal setup command:** om test/svc/foo set --kw="type=acme" **Supported keywords:** - blocking_post_provision - blocking_post_run - blocking_post_unprovision - blocking_pre_provision - blocking_pre_run - blocking_pre_unprovision - check - comment - confirmation - directory - disable - domains_from - domains_to - email - encap - install - log - max_parallel - monitor - on - on_error - optional - pace - pg_blkio_weight - pg_cpu_burst - pg_cpu_quota - pg_cpu_shares - pg_cpus - pg_mem_high - pg_mem_limit - pg_mem_oom_control - pg_mem_swappiness - pg_mems - pg_pids_max - pg_vmem_limit - post_provision - post_run - post_unprovision - pre_provision - pre_run - pre_unprovision - provision - provision_requires - retcodes - run_requires - run_timeout - schedule - secs - shared - snooze - standby - stat_timeout - subset - tags - timeout - type - unprovision - unprovision_requires - webroot ## Keyword `blocking_post_provision` required: false scopable: true rbac: Triggers require the root grant. **Description:** A command or script to execute after the resource `provision` action. Errors interrupt the action. This trigger is only executed on leaders. ## Keyword `blocking_post_run` required: false scopable: true rbac: Triggers require the root grant. **Description:** A command or script to execute after the resource `run` action. Errors interrupt the action. ## Keyword `blocking_post_unprovision` required: false scopable: true rbac: Triggers require the root grant. **Description:** A command or script to execute after the resource `unprovision` action. Errors interrupt the action. This trigger is only executed on leaders. ## Keyword `blocking_pre_provision` required: false scopable: true rbac: Triggers require the root grant. **Description:** A command or script to execute before the resource `provision` action. Errors interrupt the action. ## Keyword `blocking_pre_run` required: false scopable: true rbac: Triggers require the root grant. **Description:** A command or script to execute before the resource `run` action. Errors interrupt the action. ## Keyword `blocking_pre_unprovision` required: false scopable: true rbac: Triggers require the root grant. **Description:** A command or script to execute before the resource `unprovision` action. Errors interrupt the action. ## Keyword `check` required: false scopable: true candidates: last_run, last_run_warn, **Example:** check=last_run **Description:** If set to `last_run`, the last run retcode is used to report a task resource status. If set to `last_run_warn`, the last run error retcode is displayed as a resource warning. If not set (default), the status of a task is always n/a. ## Keyword `comment` required: false scopable: false **Description:** A free form text describing the role of the object, of the node, or of the section it is set in. The keyword is accepted in any section, so the DEFAULT section can document a configuration as a whole, and a resource, pool, heartbeat, array or network section can document itself. The agent does not interpret the value. ## Keyword `confirmation` required: false scopable: false convert: bool **Description:** If set to `true`, ask for an interactive confirmation to run the task. This flag can be used for dangerous tasks like data restoration. ## Keyword `directory` required: false scopable: true **Example:** directory=letsencrypt **Description:** The ACME directory the secs of the domains obtain their certificate from, written as their `acme.directory`: `letsencrypt`, `letsencrypt-staging`, or the url of a directory. A change applies to every sec of the domains at the next run, which obtains their certificates again from the new directory. Without it, the certificates of the domains are generated, self-signed. ## Keyword `disable` required: false scopable: true convert: bool **Description:** A disabled resource will be ignored on `start`, `stop`, `provision` and `unprovision` actions. A disabled resource status is `n/a`. If set in the `DEFAULT` section of an object, the object is disabled and ignores `start`, `stop`, `shutdown`, `provision` and `unprovision` actions. These actions immediately return success. `om disable` sets `DEFAULT.disable=true`. `om enable` sets `DEFAULT.disable=false`. > **Note**: The `enable` and `disable` actions preserve the individual resource `disable` state. ## Keyword `domains_from` required: false scopable: true **Example:** domains_from=volume#1:/haproxy/conf.d/*.cfg **Description:** The files whose names are the domains to obtain a certificate for: a directory in a volume or a filesystem of the service, named as `webroot` is, and a file name pattern holding one `*`, the part of a name it matches being a domain. e.g. `volume#1:/haproxy/conf.d/*.cfg` reads the domain `www.example.com` from the file `conf.d/www.example.com.cfg`, as the configuration of a proxy routing the domain. A name whose part is no lowercase domain, as `README` or `tcp-smtp.cfg`, names none. At each run, for each domain: * a domain resolving to an address of an ip resource of the service gets a sec, `domains_to` naming it, created with the `directory` and the `email` of the task, and its certificate is obtained, and renewed when due. * a domain resolving elsewhere, or not yet, is pending: it gets no sec, its certificate would not be obtained, and the sec it has is kept, so a dns record going astray for a while does not take its certificate away. The run fails, saying which domains are pending. * the sec of a domain no file names any longer is deleted, on every node. A run creates 10 secs at most: the certificates obtained are installed, and an install running the task, as `on = FileInstalled`, creates the next ones. Nothing is deleted when the directory can not be read. The secs renewed, the ones of the domains and the ones `secs` names, share one account at each directory: a directory limits the accounts an address registers. The first one to need it registers it, and the others take it. ## Keyword `domains_to` required: false scopable: true **Example:** domains_to=./sec/{name}-* **Description:** The secs of the domains `domains_from` reads, named by a pattern holding one `*`, which the domain replaces: `./sec/{name}-*` names the sec of the domain `www.example.com` `/sec/-www.example.com`. A name longer than an object name may be keeps the beginning of the domain, and a hash of it. The secs are in the namespace of the service. The task creates and deletes the ones it created only, marked with an `acme_owner` key naming the task, and tells the domain of a sec by its `cn`: another sec the pattern matches is left as it is. An install line naming the same pattern installs the certificate of each, as `/haproxy/certs/*.pem from ./sec/{name}-* key fullpem`. ## Keyword `email` required: false scopable: true **Example:** email=admin@example.com **Description:** The contact of the account at the ACME directory the secs of the domains share, written as their `email`, which the directory may write to about the account and its certificates. An account without one is valid all the same. ## Keyword `encap` required: false scopable: false convert: bool **Description:** Set to `true` to ignore this resource in the nodes context and consider it in the encapnodes context. The resource is thus handled by agents deployed in the service containers. ## Keyword `install` required: false scopable: true convert: list **Example:** install=fs#1 **Description:** The volumes and filesystems whose files the task installs again before its own work, as the `install` action does for them: `fs#1 volume#data`. A host task installing files needs no `command`. The files rendered from a template are rendered from what the node knows at the time, and the install publishes a `FileInstalled` event for the ones it wrote. With `on`, the files follow what the events say changed, and the tasks on `FileInstalled` have what reads them read them again: [task#refresh] type = host install = fs#1 on = NetworkPeersUpdated [task#load_all] type = host container = container#swanctl command = swanctl --load-all on = FileInstalled,rid=fs#1 [fs#1] install = /swanctl.conf from ./cfg/{name} key swanctl.conf template The install takes the lock of the object, as the install action does. It writes only in the volumes and filesystems of the object, from the install lines they declare, so a task of any type may ask for it. A failed install is a failed run, the task's own work not done. ## Keyword `log` required: false scopable: true default: false convert: bool **Description:** Log the task outputs in the object logs, and log its scheduled runs as a run asked by a user is. The daemon scheduler logs the runs of the jobs it starts only when they ask it, so a scheduled run of a task with `log = false` leaves no trace in the journal but its status and its exit code. ## Keyword `max_parallel` required: false scopable: true default: 1 convert: int **Example:** max_parallel=2 **Description:** Support limited, concurrent runs of tasks. The task#xx.max_parallel=2 setting limits the number of concurrent task runs to 2. The default value is 1, ensuring backward compatibility. The run count is determined based on PID files created in the `/run/` directories. The PID file is normally removed when the task execution ends, but if the executor dies abruptly (e.g., due to a SIGKILL), the stale PID file is not considered when computing the resource status. It is removed before the count check of the next run. Staleness is evaluated using the condition: (PID file mtime < process birth time). A new status log message may appear to indicate that the maximum concurrency limit has been reached. ## Keyword `monitor` required: false scopable: true convert: bool **Description:** A resource with `monitor=true` will trigger the `monitor_action` (crash or reboot the node, freezestop or switch the service) if: * The resource is `down`. * The instance has `local_expect=started` in its daemon monitor data, which means the daemon considers this instance is and should remain started. * All restart tentatives failed. ## Keyword `on` required: false scopable: true convert: list **Example:** on=NetworkPeersUpdated,name=backend1 **Description:** The events of the node running the task, each one an event kind and the values of the fields of the event it requires, as in `om node events --filter`: `NetworkPeersUpdated` runs it when the peers of any network of the node changed, `NetworkPeersUpdated,name=backend1` when the ones of backend1 did. The kinds are: * `FileInstalled`: an install of a resource of the object wrote files, or removed the files of keys gone, by a start, a provision, a task or a change of a key. It is not published for an install finding its files up to date. Its fields are `node`, `path` and `rid`, the resource, and the events of the other objects are not the task's. * `NetworkPeersUpdated`: a node joined or left a network, the address of a node changed, or the tunnel to it. Its fields are `node` and `name`, the network. The runs are paced by `pace`, and require what the scheduled runs require: the instance provisioned, and `run_requires`. They run whether the instance is frozen or not, as the scheduled runs do. A task installing again the files rendered from the networks with `install` has them follow the networks: [task#refresh] type = host install = fs#1 on = NetworkPeersUpdated ## Keyword `on_error` required: false scopable: true **Example:** on_error=/srv/{name}/data/scripts/task_on_error.sh **Description:** A command to execute on `run` action if `command` returned an error. ## Keyword `optional` required: false scopable: true convert: bool **Description:** Action errors on optional resources are logged but do not interrupt the action sequence. The status of optional resources is not included in the instance availability status but is considered in the overall status. The status of task and sync resources is always included in the overall status, regardless of whether they are marked as optional. Resources tagged as `noaction` are considered optional by default. Dump filesystems are a typical use case for optional=true. ## Keyword `pace` required: false scopable: true default: @10s **Example:** pace=@30s backoff @1m **Description:** The pace of the runs the `on` events ask for, `@[ backoff @]`, written as the interval of a schedule. The task runs at the first event, then once at most each interval: the events coming during an interval run it once at its end. With `backoff`, each interval ending with such a run doubles the next one, up to ``, and each interval passing without an event halves it back, down to ``: `@30s backoff @1m` runs at most each 30s, and at most each minute while the events keep coming faster. ## Keyword `pg_blkio_weight` required: false scopable: true **Example:** pg_blkio_weight=50 **Description:** Block IO relative weight. Value: between `10` and `1000`. The kernel default is `100`. Setting this keyword to `default` puts the capping back where a node that never capped anything leaves it. Removing the keyword does not: what was written stays written, whether om wrote it or something else did. ## Keyword `pg_cpu_burst` required: false scopable: true **Example:** pg_cpu_burst=20% **Description:** The cpu time the group banks under its quota, and spends above it. It is the time the processes of the group may bank while under their `pg_cpu_quota`, and spend above it in a short spike, in the notation of `pg_cpu_quota`: `20%` lets the group run a fifth of a cpu above its quota during a period, out of what it left unused before. It serves a latency-sensitive service capped tightly: a request arriving after an idle spell is served at the speed of the burst, rather than throttled for the rest of the period. Over a longer time the group still uses no more than its quota. It needs `pg_cpu_quota`, and cannot exceed it: the kernel refuses a burst larger than the quota. Only the unified cgroup hierarchy has it. Setting this keyword to `default` puts the capping back where a node that never capped anything leaves it. Removing the keyword does not: what was written stays written, whether om wrote it or something else did. ## Keyword `pg_cpu_quota` required: false scopable: true **Example:** pg_cpu_quota=50%@all **Description:** The percentage of cpu time the processes of the group may use. Accepted expressions: * `50%` Half of one cpu. * `50%@all` Half of every cpu the node has. * `10%@2` A tenth of two cpus. Unlike `pg_cpu_shares`, which only arbitrates when the node is cpu-bound, a quota caps the group whether or not the node is busy. Setting this keyword to `default` puts the capping back where a node that never capped anything leaves it. Removing the keyword does not: what was written stays written, whether om wrote it or something else did. ## Keyword `pg_cpu_shares` required: false scopable: true convert: size **Example:** pg_cpu_shares=512 **Description:** The share of cpu the group gets when the node is cpu-bound. The share is relative to the other groups. The actual percentile depends on the shares allowed to the other services. Unset, the kernel default is used, which usually is 1024 shares. Setting this keyword to `default` puts the capping back where a node that never capped anything leaves it. Removing the keyword does not: what was written stays written, whether om wrote it or something else did. ## Keyword `pg_cpus` required: false scopable: true depends: create_pg=true **Example:** pg_cpus=0-2 **Description:** The cpus the processes of the group may run on. Cpus are specified as list or range : `0,1,2` or `0-2`. Setting this keyword to `default` puts the capping back where a node that never capped anything leaves it. Removing the keyword does not: what was written stays written, whether om wrote it or something else did. ## Keyword `pg_mem_high` required: false scopable: true convert: size **Example:** pg_mem_high=384m **Description:** The memory past which the kernel throttles the group, in bytes. Past it, the kernel slows the processes of the group down, reclaiming their memory and throttling their allocations. Unlike `pg_mem_limit`, reaching it does not wake the Out-Of-Memory killer: a group above it keeps running, slower, while the kernel reclaims. Set below `pg_mem_limit`, it gives a process growing too much the time to be noticed, or to shrink, before it is killed. It is a soft limit, so it is not what a memory claim counts: the claim counts `pg_mem_limit`. Only the unified cgroup hierarchy has it. Setting this keyword to `default` puts the capping back where a node that never capped anything leaves it. Removing the keyword does not: what was written stays written, whether om wrote it or something else did. ## Keyword `pg_mem_limit` required: false scopable: true convert: size **Example:** pg_mem_limit=512m **Description:** The memory the processes of the group may use, in bytes. The Out-Of-Memory killer is triggered in case of tresspassing. Setting this keyword to `default` puts the capping back where a node that never capped anything leaves it. Removing the keyword does not: what was written stays written, whether om wrote it or something else did. ## Keyword `pg_mem_oom_control` required: false scopable: true **Example:** pg_mem_oom_control=1 **Description:** Whether the Out of Memory killer runs for the group: 0 enables it. It is a flag (0 or 1) enabling or disabling the Out of Memory killer for the processes of the group. * If enabled (0), tasks that attempt to consume more memory than they are allowed are immediately killed by the OOM killer. * If disabled (1), tasks are allowed to continue to try allocating memory, stressing the system. The OOM killer is enabled by default in every cgroup using the memory controller. This keyword caps nothing on a node holding the unified cgroup hierarchy, which has no `memory.oom_control`: that file is of the v1 hierarchy. Setting it there is warned about, and ignored. ## Keyword `pg_mem_swappiness` required: false scopable: true **Example:** pg_mem_swappiness=40 **Description:** Set a swappiness percentile value for the process group. This keyword caps nothing on a node holding the unified cgroup hierarchy, which has no `memory.swappiness`: that file is of the v1 hierarchy. Setting it there is warned about, and ignored. ## Keyword `pg_mems` required: false scopable: true **Example:** pg_mems=0-2 **Description:** The memory nodes the processes of the group may allocate from. Memory nodes are specified as list or range : `0,1,2` or `0-2`. Setting this keyword to `default` puts the capping back where a node that never capped anything leaves it. Removing the keyword does not: what was written stays written, whether om wrote it or something else did. ## Keyword `pg_pids_max` required: false scopable: true **Example:** pg_pids_max=512 **Description:** The most processes and threads the group may run at once. A fork beyond it fails in the process that asked for it, and nothing else of the node is touched: it is what keeps a runaway fork loop from exhausting the process table of the node. Setting this keyword to `default` puts the capping back where a node that never capped anything leaves it. Removing the keyword does not: what was written stays written, whether om wrote it or something else did. ## Keyword `pg_vmem_limit` required: false scopable: true convert: size **Example:** pg_vmem_limit=1g **Description:** The memory plus swap the processes of the group may use, in bytes. The Out-Of-Memory killer is triggered in case of tresspassing. The specified value must be greater than `pg_mem_limit`. Setting this keyword to `default` puts the capping back where a node that never capped anything leaves it. Removing the keyword does not: what was written stays written, whether om wrote it or something else did. ## Keyword `post_provision` required: false scopable: true rbac: Triggers require the root grant. **Description:** A command or script to execute after the resource `provision` action. Errors do not interrupt the action. This trigger is only executed on leaders. ## Keyword `post_run` required: false scopable: true rbac: Triggers require the root grant. **Description:** A command or script to execute after the resource `run` action. Errors do not interrupt the action. ## Keyword `post_unprovision` required: false scopable: true rbac: Triggers require the root grant. **Description:** A command or script to execute after the resource `unprovision` action. Errors do not interrupt the action. This trigger is only executed on leaders. ## Keyword `pre_provision` required: false scopable: true rbac: Triggers require the root grant. **Description:** A command or script to execute before the resource `provision` action. Errors do not interrupt the action. ## Keyword `pre_run` required: false scopable: true rbac: Triggers require the root grant. **Description:** A command or script to execute before the resource `run` action. Errors do not interrupt the action. ## Keyword `pre_unprovision` required: false scopable: true rbac: Triggers require the root grant. **Description:** A command or script to execute before the resource `unprovision` action. Errors do not interrupt the action. ## Keyword `provision` required: false scopable: false default: true convert: bool **Description:** Set to `false` to ignore the `provision` and `unprovision` actions on the resource. > **Warning**: `provision` and `unprovision` use data-destructive operations like formatting. It is recommended to set `provision=false` on long-lived critical objects, to force administrators to remove this setting when they really want to destroy data. ## Keyword `provision_requires` required: false scopable: false **Example:** provision_requires=ip#0 fs#0(down,stdby down) **Description:** A whitespace-separated list of conditions to meet to accept a 'provision' action. A condition is expressed as `(,...)`. If states are omitted, `up,stdby up` is used as the default expected states. ## Keyword `retcodes` required: false scopable: true default: 0:up 1:down **Example:** retcodes=0:up 1:down 3:warn 4: n/a 5:undef **Description:** The whitespace-separated list of `:`. All undefined retcodes are mapped to the `warn` status. Valid `` are: * `up` * `down` * `warn` * `n/a` * `undef` ## Keyword `run_requires` required: false scopable: false **Example:** run_requires=ip#0 fs#0(down,stdby down) **Description:** A whitespace-separated list of conditions to meet to accept a 'run' action. A condition is expressed as `(,...)`. If states are omitted, `up,stdby up` is used as the default expected states. ## Keyword `run_timeout` required: false scopable: true convert: duration **Example:** run_timeout=1m30s **Description:** Wait for `` before declaring the action a failure. Takes precedence over `timeout`. ## Keyword `schedule` required: false scopable: true **Example:** schedule=00:00-01:00 mon **Description:** Set the task `run` schedule. See `usr/share/doc/opensvc/schedule` for the schedule syntax reference. ## Keyword `secs` required: false scopable: true convert: list **Example:** secs=web ./sec/api ns2/sec/shared ./sec/web-* **Description:** The secs whose certificates the task renews, when due: the certificate of a sec naming an `acme.directory` is obtained from that ACME directory, the certificate of another sec is generated as `certificate create` does, self-signed or signed by its `ca`. A sec is named as an install line names a store: `web` and `./sec/web` are secs of the namespace of the service, `ns2/sec/web` a sec of another namespace, which must share it with this one, its `share` keyword naming this namespace or `*`. A name holding a `*` names the secs matching it, the `*` matching one character or more, as `./sec/web-*`: the secs there are when the task runs, as the ones a service creates and deletes. A pattern matching none names none, and leaves out the secs of another namespace not shared with this one, where a sec named that does not exist, or is not shared, fails the task. The volumes installing the renewed keys get the new ones, and the signals of their install lines are sent, on every node running them. The secs are optional when `domains_from` names the domains to obtain the certificates of. ## Keyword `shared` required: false scopable: true convert: bool **Description:** If `true`, the resource will be considered shared during provision and unprovision actions. A shared resource driver can implement a different behaviour depending on weither it is run from the leader instance, or not: * When `--leader` is set, the driver creates and configures the system objects. For example the disk.disk driver allocates a SAN disk and discover its block devices. * When `--leader` is not set, the driver does not redo the actions already done by the leader, but may do some. For example, the disk.disk driver skips the SAN disk allocation, but discovers the block devices. The daemon takes care of setting the `--leader` flags on the commands it submits during deploy, purge, provision and unprovision orchestrations. > **Warning**: If admins want to submit `--local` provision or unprovision commands themselves, they have to set the `--leader` flag correctly. Flex objects usually don't use shared resources. But if they do, only the flex primary gets `--leader` commands. > **Warning**: All resources depending on a shared resource must also be flagged as shared. ## Keyword `snooze` required: false scopable: true convert: duration **Example:** snooze=10m **Description:** Snooze the service before running the task, so if the command is cause a status degradation the user can decide to snooze alarms for the duration set as value. ## Keyword `standby` required: false scopable: true convert: bool **Description:** If `true`, always start the resource, even on non-started instances. The daemon is responsible for starting standby resources. A resource can be set standby on a subset of nodes using keyword scoping. A typical use-case is a synchronized filesystem on non-shared disks. The remote filesystem must be mounted to not overflow the underlying filesystem. > **Warning**: In most situation, don't set shared resources standby, a non-clustered fs on shared disks for example. ## Keyword `stat_timeout` required: false scopable: true convert: duration **Description:** The fs resources status evaluation includes a stat syscall test. This keyword defines the maximum wait time for those stat calls to respond. When expired, the resource status is degraded is to warn, which can trigger a monitor action (reboot or crash the node) if the resource is monitored. ## Keyword `subset` required: false scopable: true **Description:** The name of the subset this resource is assigned to. Resources of a same driver group and a same subset are ordered and acted upon together, and are configured as a whole in a `[subset#:]` section, or in a less precise `[subset#]` one. That section accepts `parallel`, to act on the members concurrently rather than one after the other, and the `pg_*` keywords, to place the members in their own process group. ## Keyword `tags` required: false scopable: true convert: set **Description:** A whitespace-separated list of tags. Tags can be used for resource selection by tag. Some tags can influence the driver behaviour: * `noaction` Skip any state changing action on the resource and imply `optional=true`. * `nostatus` Force the status `n/a`. ## Keyword `timeout` required: false scopable: true convert: duration **Example:** timeout=5m **Description:** Wait for `` before declaring the task `run` action a failure. If no timeout is set, the agent waits indefinitely for the task command to exit. ## Keyword `type` required: false scopable: false rbac: Requires the root grant, except for the values oci, docker, podman, acme. **Description:** The resource driver name. ## Keyword `unprovision` required: false scopable: false default: true convert: bool **Description:** Set to `false` to ignore the `unprovision` action on the resource. > **Warning**: `unprovision` use data-destructive operations like formatting. It is recommended to set `provision=false` on long-lived critical objects, to force administrators to remove this setting when they really want to destroy data. ## Keyword `unprovision_requires` required: false scopable: false **Example:** unprovision_requires=ip#0 fs#0(down,stdby down) **Description:** A whitespace-separated list of conditions to meet to accept a 'unprovision' action. A condition is expressed as `(,...)`. If states are omitted, `up,stdby up` is used as the default expected states. ## Keyword `webroot` required: false scopable: true **Example:** webroot=volume#1:/haproxy/acme-challenges **Description:** Where the http-01 challenge token of an ACME certificate is written: a directory the http server of the domains serves `/.well-known/acme-challenge/` from, in a volume or a filesystem of the service. It is named as the other paths of a service are, `volume#1:/haproxy/acme-challenges` in the resource `volume#1`, or `/` in a vol of the namespace. A path of the node is refused. The token is written under `.well-known/acme-challenge/` in that directory, and never outside the volume or filesystem, whatever it holds. The task runs where the service runs, so the http server it writes the token for is the one the domains reach. When empty, the `acme.webroot` of the sec is used, a host path its root administrator set.