Driver `subset`

Supported keywords:

comment
parallel
pg_blkio_weight
pg_cpu_quota
pg_cpu_shares
pg_cpus
pg_mem_limit
pg_mem_oom_control
pg_mem_swappiness
pg_mems
pg_vmem_limit
stat_timeout
type

Keyword `comment`

required:    false
scopable:    false
rbac:        This driver group requires the root grant.

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 `parallel`

required:    false
scopable:    true
convert:     bool
rbac:        This driver group requires the root grant.

Description:

If set to true, actions are executed in parallel on the resource of this subset.

For example, a service with:

[app#1]
start = /bin/true

[app#2]
start = /bin/true

[app#3]
start = /bin/true
subset = workers

[app#4]
start = /bin/true
subset = workers

[subset#app:workers]
parallel = true

Would have a start sequence like:

app#1 ---> app#2 -+-> app#3
                  `-> app#4

Keyword `pg_blkio_weight`

required:    false
scopable:    true
rbac:        This driver group requires the root grant.

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_quota`

required:    false
scopable:    true
rbac:        This driver group requires the root grant.

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.

Keyword `pg_cpu_shares`

required:    false
scopable:    true
convert:     size
rbac:        This driver group requires the root grant.

Example:

pg_cpu_shares=512

Description:

The kernel default value is used, which usually is 1024 shares.

In a cpu-bound situation, this setting ensures the service does not use more than its share of cpu resource. The actual percentile depends on shares allowed to other services.

Keyword `pg_cpus`

required:    false
scopable:    true
depends:     create_pg=true
rbac:        This driver group requires the root grant.

Example:

pg_cpus=0-2

Description:

Allow service process to bind only the specified cpus.

Cpus are specified as list or range : 0,1,2 or 0-2.

Keyword `pg_mem_limit`

required:    false
scopable:    true
convert:     size
rbac:        This driver group requires the root grant.

Example:

pg_mem_limit=512m

Description:

Ensures the service does not use more than specified memory (in bytes).

The Out-Of-Memory killer is triggered in case of tresspassing.

Keyword `pg_mem_oom_control`

required:    false
scopable:    true
rbac:        This driver group requires the root grant.

Example:

pg_mem_oom_control=1

Description:

A flag (0 or 1) that enables or disables 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
rbac:        This driver group requires the root grant.

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
rbac:        This driver group requires the root grant.

Example:

pg_mems=0-2

Description:

Allow service process to bind only the specified memory nodes.

Memory nodes are specified as list or range : 0,1,2 or 0-2.

Keyword `pg_vmem_limit`

required:    false
scopable:    true
convert:     size
rbac:        This driver group requires the root grant.

Example:

pg_vmem_limit=1g

Description:

Ensures the service does not use more than specified memory+swap (in bytes).

The Out-Of-Memory killer is triggered in case of tresspassing. The specified value must be greater than pg_mem_limit.

Keyword `stat_timeout`

required:    false
scopable:    true
convert:     duration
rbac:        This driver group requires the root grant.

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 `type`

required:    false
scopable:    false
rbac:        This driver group requires the root grant.

Description:

The resource driver name.

Keyboard shortcuts

OpenSVC