Skip to content
RunningLake
Company Console ↗ Request early access
Contents: Reference

RUNNING

Queue

A Queue as RunningLake's configuration repository declares it, at queues/<name>.yaml. Generated from the Go types the control plane decodes this file into, so it checks the shape the gate reads — field names and types, and which fields may exist. The gate also applies rules no schema can express — required fields inside spec among them — so a file this schema accepts can still be refused by `rl diff`. Take #/properties/spec for the spec alone.

File: queues/<name>.yaml

Fields

FieldTypeRequiredMeaning
apiVersion string Yes

The config schema's version, which is independent of the HTTP API's (rule unsupported-api-version).

Values: runninglake.io/v1alpha1
kind string Yes

The kind this file declares. A kind that disagrees with the file's path is refused (rule kind-mismatch).

Values: Queue
metadata object Yes
No description
metadata.name string Yes

The resource's name, which is also its path segment. It must be the name this file's path gives it (rule name-mismatch).
metadata.labels map of string No
No description
metadata.annotations map of string No
No description
spec object No
No description
spec.team string No

The team this queue is for, as a label recorded with the queue. It is not a membership and is not sent to the plane.
spec.nominalCpu string No

The CPU quota of this queue, as a Kubernetes quantity such as "8". Required with nominalMemory (rule queue-floor-required). Applied to a plane whose release supports queues; it is a quota in the plane's scheduler and does not itself provision machines.
spec.nominalMemory string No

The memory quota of this queue, as a Kubernetes quantity such as "32Gi". Required with nominalCpu (rule queue-floor-required).
spec.borrowingCpu string No

The most CPU this queue may borrow from other queues in the plane, as a Kubernetes quantity. Leave it out to set no limit of its own.
spec.borrowingMemory string No

The most memory this queue may borrow from other queues in the plane, as a Kubernetes quantity. Leave it out to set no limit of its own.
spec.monthlyCapUsd number No

The monthly cap for this queue in US dollars. Leave it out for no cap; 0 is a cap of zero, and the two are different values. Recorded with the queue; nothing enforces it yet.

A nested field is written with its parents, spec.a.b; an item of a list is [] and a value of a map is *. Required means the parent object must carry the field; the rules a schema cannot express, such as a field that is required only inside spec, are checked by rl diff.

The schema

This page is read from the kind’s published schema, at https://runninglake.com/schema/v1alpha1/queue.json. An editor that follows it checks a file of this kind as you type. To see the fields of a kind’s spec from the command line, run rl schema with the kind’s name: it works offline and prints what the gate accepts. The command reference has the rest.

All kinds