Environment Variables ¶

All configuration values can be overridden with environment variables.

Naming convention ¶

Environment variables use the SLURMQ_ prefix with double underscores for nesting:

SLURMQ_<KEY>
SLURMQ_<SECTION>__<KEY>

Variable	Description	Example
`SLURMQ_CONFIG`	Path to config file	`/etc/slurmq/config.toml`
`SLURMQ_DEFAULT_CLUSTER`	Default cluster name	`stella`

Variable	Description	Default
`SLURMQ_MONITORING__CHECK_INTERVAL_MINUTES`	Check interval	`30`
`SLURMQ_MONITORING__WARNING_THRESHOLD`	Warn at this %	`0.8`
`SLURMQ_MONITORING__CRITICAL_THRESHOLD`	Critical at this %	`1.0`

Variable	Description	Default
`SLURMQ_ENFORCEMENT__ENABLED`	Enable enforcement	`false`
`SLURMQ_ENFORCEMENT__DRY_RUN`	Preview mode	`true`
`SLURMQ_ENFORCEMENT__GRACE_PERIOD_HOURS`	Warning window	`24`
`SLURMQ_ENFORCEMENT__CANCEL_ORDER`	`lifo` or `fifo`	`lifo`

Variable	Description	Default
`SLURMQ_DISPLAY__COLOR`	Enable colors	`true`
`SLURMQ_DISPLAY__OUTPUT_FORMAT`	`rich`, `plain`, `json`	`rich`
`NO_COLOR`	Disable colors (standard)	-

export SLURMQ_DEFAULT_CLUSTER=stellar
slurmq check

export NO_COLOR=1
slurmq check

export SLURMQ_CONFIG=/etc/slurmq/production.toml
slurmq check

export SLURMQ_ENFORCEMENT__ENABLED=true
export SLURMQ_ENFORCEMENT__DRY_RUN=false
slurmq monitor --once --enforce

Environment variables override config file values:

For boolean environment variables, these values are truthy:

Everything else is falsy.