RUNNING

Environment

A Environment as RunningLake's configuration repository declares it, at environments/<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: environments/<name>.yaml

Fields

Field	Type	Required	Meaning
`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: `Environment`
`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.isProduction`	boolean	No	No description
`spec.changePolicy`	string	No	How a change reaches this environment: direct (committed when it is submitted), pr (through a pull request) or review (committed after an approval in RunningLake); rule change-policy-invalid refuses any other word. Recorded in the file; nothing reads this field yet — the policy that applies is the environment's own, set when it is created and changed in the console or the API.
`spec.requireApproval`	boolean	No	Recorded; nothing reads it yet. The approval RunningLake records today is the review change policy's (changePolicy: review), given before the commit.
`spec.dataPlane`	string	No	No description

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/environment.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