Label reference
Sablier discovers and manages your workloads through these sablier.* labels. Each label is documented below with its type, the version it was introduced in, and any provider-specific behaviour. See the compatibility matrix for an at-a-glance provider grid.
Applying labels
Attach the labels to the workload Sablier should manage. The mechanism differs per provider; the per-label notes below call out any provider-specific form.
services:
whoami:
image: containous/whoami
labels:
sablier.enable: "true"
sablier.group: "my-group"Labels
| Label | Description |
|---|---|
sablier.enable | Opts the instance into Sablier management. |
sablier.group | Assigns the instance to one or more named groups. |
sablier.ready-after | The minimum settling delay after the instance first reports ready before Sablier treats it as ready. |
sablier.ready-on-start | Treats the instance as ready as soon as the start is dispatched, skipping the health check. |
sablier.running-hours | A daily keep-warm window in local time. |
sablier.running-days | Restricts the sablier.running-hours window to specific weekdays. |
sablier.anti-affinity | Lists the group names this instance backs off from; it is forced idle while any listed group has an active session. |
sablier.idle.replicas | The replica count when idle. |
sablier.idle.cpu | The CPU limit applied when the session expires. |
sablier.idle.memory | The memory limit applied when the session expires. |
sablier.active.replicas | The replica count restored when a new session is requested. |
sablier.active.cpu | The CPU limit restored when a new session is requested. |
sablier.active.memory | The memory limit restored when a new session is requested. |
sablier.idle.blkio-weight | The relative block I/O scheduling weight applied when idle. |
sablier.active.blkio-weight | The relative block I/O scheduling weight restored when active. |
sablier.idle.blkio-weight-device | The per-device I/O scheduling weight applied when idle. |
sablier.active.blkio-weight-device | The per-device I/O scheduling weight restored when active. |
sablier.idle.blkio-device-read-bps | The per-device read throughput limit applied when idle (Docker byte units, e.g. 10m = 10 MB/s). |
sablier.active.blkio-device-read-bps | The per-device read throughput limit restored when active. |
sablier.idle.blkio-device-write-bps | The per-device write throughput limit applied when idle. |
sablier.active.blkio-device-write-bps | The per-device write throughput limit restored when active. |
sablier.idle.blkio-device-read-iops | The per-device read IOPS limit applied when idle. |
sablier.active.blkio-device-read-iops | The per-device read IOPS limit restored when active. |
sablier.idle.blkio-device-write-iops | The per-device write IOPS limit applied when idle. |
sablier.active.blkio-device-write-iops | The per-device write IOPS limit restored when active. |
sablier.enable
Opts the instance into Sablier management. Any value other than true is ignored.
Example: "true"
sablier tag instead.sablier.group
Assigns the instance to one or more named groups. A session for any of its groups starts the instance.
Example: "team-a,team-b"
sablier-group-<name> tag per group.sablier.ready-after
The minimum settling delay after the instance first reports ready before Sablier treats it as ready.
Example: "30s"
sablier.ready-on-start
Treats the instance as ready as soon as the start is dispatched, skipping the health check.
Example: "true"
sablier.running-hours
A daily keep-warm window in local time. Overnight windows like 22:00-06:00 span midnight.
Example: "09:00-18:00"
sablier.running-days
Restricts the sablier.running-hours window to specific weekdays.
Example: "Mon,Tue,Wed,Thu,Fri"
sablier.anti-affinity
Lists the group names this instance backs off from; it is forced idle while any listed group has an active session.
Example: "streaming"
sablier.idle.replicas
The replica count when idle. 0 stops the workload; 1 or more keeps it running with optional resource throttling.
Example: "1"
sablier.idle.cpu
The CPU limit applied when the session expires. Requires sablier.idle.replicas >= 1.
Example: "0.1"
100m). Not supported on Proxmox LXC.sablier.idle.memory
The memory limit applied when the session expires. Requires sablier.idle.replicas >= 1.
Example: "128m"
128Mi). Not supported on Proxmox LXC.sablier.active.replicas
The replica count restored when a new session is requested.
Example: "2"
sablier.active.cpu
The CPU limit restored when a new session is requested.
Example: "2.0"
2000m). Not supported on Proxmox LXC.sablier.active.memory
The memory limit restored when a new session is requested.
Example: "512m"
512Mi). Not supported on Proxmox LXC.sablier.idle.blkio-weight
The relative block I/O scheduling weight applied when idle.
Example: "100"
sablier.active.blkio-weight
The relative block I/O scheduling weight restored when active.
Example: "500"
sablier.idle.blkio-weight-device
The per-device I/O scheduling weight applied when idle.
Example: "/dev/sda:100"
sablier.active.blkio-weight-device
The per-device I/O scheduling weight restored when active.
Example: "/dev/sda:500"
sablier.idle.blkio-device-read-bps
The per-device read throughput limit applied when idle (Docker byte units, e.g. 10m = 10 MB/s).
Example: "/dev/sda:10m"
sablier.active.blkio-device-read-bps
The per-device read throughput limit restored when active.
Example: "/dev/sda:100m"
sablier.idle.blkio-device-write-bps
The per-device write throughput limit applied when idle.
Example: "/dev/sda:10m"
sablier.active.blkio-device-write-bps
The per-device write throughput limit restored when active.
Example: "/dev/sda:100m"
sablier.idle.blkio-device-read-iops
The per-device read IOPS limit applied when idle.
Example: "/dev/sda:100"
sablier.active.blkio-device-read-iops
The per-device read IOPS limit restored when active.
Example: "/dev/sda:1000"
sablier.idle.blkio-device-write-iops
The per-device write IOPS limit applied when idle.
Example: "/dev/sda:100"
sablier.active.blkio-device-write-iops
The per-device write IOPS limit restored when active.
Example: "/dev/sda:1000"