task.host

Minimal configlet:

[task#1]
type = host

Minimal setup command:

om test/svc/foo set --kw="type=host"

blocking_post_provision

required:    false
scopable:    true

A command or script to execute after the resource provision action.

Errors interrupt the action.

This trigger is only executed on leaders.

blocking_post_run

required:    false
scopable:    true

A command or script to execute after the resource run action.

Errors interrupt the action.

blocking_post_unprovision

required:    false
scopable:    true

A command or script to execute after the resource unprovision action.

Errors interrupt the action.

This trigger is only executed on leaders.

blocking_pre_provision

required:    false
scopable:    true

A command or script to execute before the resource provision action.

Errors interrupt the action.

blocking_pre_run

required:    false
scopable:    true

A command or script to execute before the resource run action.

Errors interrupt the action.

blocking_pre_unprovision

required:    false
scopable:    true

A command or script to execute before the resource unprovision action.

Errors interrupt the action.

check

required:    false
scopable:    true
candidates:  last_run, last_run_warn, 

Example:

check=last_run

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.

command

required:    false
scopable:    true

The shlex expression of the command to execute on run actions.

comment

required:    false
scopable:    false

Comments help the users understand the role of the object and its resources.

configs_environment

required:    false
scopable:    true
convert:     shlex

Example:

configs_environment=PORT=http/port webapp/app1* {name}/* {name}-debug/settings

A whitespace-separated list of <var>=<cfg name>/<key path> or <cfg name>/<key matcher>.

If the cfg or config key doesn’t exist then start and stop actions on the resource will fail with a non 0 exit code.

A shell expression splitter is applied, so double quotes can be around <cfg name>/<key path> only or whole <var>=<cfg name>/<key path>.

Example with,

• <ns>/cfg/nginx a config having a user key with value user1.

• <ns>/cfg/cfg1 a config having a key1 key with value val1.

configs_environment = NGINX_USER=nginx/user cfg1/* creates the following variables in the process execution environment:

NGINX_USER=user1
key1=val1

confirmation

required:    false
scopable:    false
convert:     bool

If set to true, ask for an interactive confirmation to run the task.

This flag can be used for dangerous tasks like data restoration.

cwd

required:    false
scopable:    true

Change the working directory to the specified location instead of the default <pathtmp>.

disable

required:    false
scopable:    true
convert:     bool

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 <path> disable sets DEFAULT.disable=true.

om <path> enable sets DEFAULT.disable=false.

Note: The enable and disable actions preserve the individual resource disable state.

encap

required:    false
scopable:    false
convert:     bool

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.

environment

required:    false
scopable:    true
convert:     shlex

Example:

environment=CRT=cert1/server.crt PEM=cert1/server.pem

A whitespace-separated list of <var>=<value>.

A shell expression spliter is applied, so double quotes can be around <value> only or whole <var>=<value>.

group

required:    false
scopable:    true

If the binary is owned by the root user, run it as the specified group instead of root.

limit_as

required:    false
scopable:    true
convert:     size

The limit on the total virtual memory that can be in use by a process (unit bytes) (same as limit_vmem).

When both limit_vmem and limit_as is used, the max value is chosen.

limit_core

required:    false
scopable:    true
convert:     size

The limit on the largest core dump size that can be produced (unit byte).

limit_cpu

required:    false
scopable:    true
convert:     duration

Example:

limit_cpu=30s

The limit on CPU time (duration).

limit_data

required:    false
scopable:    true
convert:     size

The limit on the data segment size of a process (unit byte).

limit_fsize

required:    false
scopable:    true
convert:     size

The limit on the largest file that can be created (unit byte).

limit_memlock

required:    false
scopable:    true
convert:     size

The limit on how much memory a process can lock with mlock(2) (unit byte, no solaris support).

limit_nofile

required:    false
scopable:    true
convert:     size

The limit on the number files a process can have open at once.

limit_nproc

required:    false
scopable:    true
convert:     size

The limit on the number of processes this user can have at one time, no solaris support.

limit_rss

required:    false
scopable:    true
convert:     size

The limit on the total physical memory that can be in use by a process (unit byte, no solaris support).

limit_stack

required:    false
scopable:    true
convert:     size

The limit on the stack size of a process (unit bytes).

limit_vmem

required:    false
scopable:    true
convert:     size

The limit on the total virtual memory that can be in use by a process (unit bytes).

log

required:    false
scopable:    true
default:     true
convert:     bool

Log the task outputs in the service log.

max_parallel

required:    false
scopable:    true
default:     1
convert:     int

Example:

max_parallel=2

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.

monitor

required:    false
scopable:    true
convert:     bool

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.

on_error

required:    false
scopable:    true

Example:

on_error=/srv/{name}/data/scripts/task_on_error.sh

A command to execute on run action if command returned an error.

optional

required:    false
scopable:    true
convert:     bool

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.

post_provision

required:    false
scopable:    true

A command or script to execute after the resource provision action.

Errors do not interrupt the action.

This trigger is only executed on leaders.

post_run

required:    false
scopable:    true

A command or script to execute after the resource provision action.

Errors do not interrupt the action.

This trigger is only executed on leaders.

post_unprovision

required:    false
scopable:    true

A command or script to execute after the resource provision action.

Errors do not interrupt the action.

This trigger is only executed on leaders.

pre_provision

required:    false
scopable:    true

A command or script to execute after the resource provision action.

Errors do not interrupt the action.

This trigger is only executed on leaders.

pre_run

required:    false
scopable:    true

A command or script to execute after the resource provision action.

Errors do not interrupt the action.

This trigger is only executed on leaders.

pre_unprovision

required:    false
scopable:    true

A command or script to execute after the resource provision action.

Errors do not interrupt the action.

This trigger is only executed on leaders.

provision

required:    false
scopable:    false
default:     true
convert:     bool

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.

provision_requires

required:    false
scopable:    false

Example:

provision_requires=ip#0 fs#0(down,stdby down)

A whitespace-separated list of conditions to meet to accept a ‘provision’ action.

A condition is expressed as <rid>(<state>,...).

If states are omitted, up,stdby up is used as the default expected states.

retcodes

required:    false
scopable:    true
default:     0:up 1:down

Example:

retcodes=0:up 1:down 3:warn 4: n/a 5:undef

The whitespace-separated list of <retcode>:<status name>.

All undefined retcodes are mapped to the warn status.

Valid <status names> are:

• up
• down
• warn
• n/a
• undef

run_requires

required:    false
scopable:    false

Example:

run_requires=ip#0 fs#0(down,stdby down)

A whitespace-separated list of conditions to meet to accept a ‘run’ action.

A condition is expressed as <rid>(<state>,...).

If states are omitted, up,stdby up is used as the default expected states.

run_timeout

required:    false
scopable:    true
convert:     duration

Example:

run_timeout=1m30s

Wait for <duration> before declaring the action a failure.

Takes precedence over timeout.

schedule

required:    false
scopable:    true

Example:

schedule=00:00-01:00 mon

Set the task run schedule.

See usr/share/doc/opensvc/schedule for the schedule syntax reference.

secrets_environment

required:    false
scopable:    true
convert:     shlex

Example:

secrets_environment=CRT=cert1/server.pem sec1/*

A whitespace-separated list of <var>=<sec name>/<key path> or <sec name>/<key matcher>.

If the sec or secret key doesn’t exist then start and stop actions on the resource will fail with a non 0 exit code.

A shell expression splitter is applied, so double quotes can be around <sec name>/<key path> only or whole <var>=<sec name>/<key path>.

Example with,

• <ns>/sec/cert1 a secret having a server.pem key with value mycrt.

• <ns>/sec/sec1 a secret having a key1 key with value val1.

secrets_environment = CRT=cert1/server.pem sec1/* creates the following variables in the process execution environment:

CRT=mycrt
key1=val1

shared

required:    false
scopable:    true
convert:     bool

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.

snooze

required:    false
scopable:    true
convert:     duration

Example:

snooze=10m

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.

standby

required:    false
scopable:    true
convert:     bool

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.

stop

required:    false
scopable:    true

• true

  Execute the script command with stop argument on stop action.

• false

  Do nothing on stop action.

• <shlex expression>

  Execute this command on stop action.

stop_timeout

required:    false
scopable:    true
convert:     duration

Example:

stop_timeout=180

Wait for <duration> before declaring the app launcher stop action a failure.

Takes precedence over timeout.

If neither timeout nor stop_timeout is set, the agent waits indefinitely for the app launcher to return.

A timeout can be coupled with optional=true to not abort a service instance stop when an app launcher did not return.

subset

required:    false
scopable:    true

A command or script to execute after the resource provision action.

Errors do not interrupt the action.

This trigger is only executed on leaders.

tags

required:    false
scopable:    true
convert:     set

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.

timeout

required:    false
scopable:    true
convert:     duration

Example:

timeout=5m

Wait for <duration> before declaring the task run action a failure.

If no timeout is set, the agent waits indefinitely for the task command to exit.

umask

required:    false
scopable:    true
convert:     umask

Example:

umask=022

The umask to set for the application process.

unprovision

required:    false
scopable:    false
default:     true
convert:     bool

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.

unprovision_requires

required:    false
scopable:    false

Example:

unprovision_requires=ip#0 fs#0(down,stdby down)

A whitespace-separated list of conditions to meet to accept a ‘unprovision’ action.

A condition is expressed as <rid>(<state>,...).

If states are omitted, up,stdby up is used as the default expected states.

user

required:    false
scopable:    true

If the binary is owned by the root user, run it as the specified user instead of root.