RUNNING

JobLogPolicy

A JobLogPolicy as RunningLake's configuration repository declares it, at logs/policy.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: logs/policy.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: `JobLogPolicy`
`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	JobLogPolicySpec is how long a project keeps its job logs: its runs' and queries' logs. One per project, named default, at logs/policy.yaml. A plane is designed to move those logs from its system bucket into the bucket where it holds the project's data, and to keep them there; both buckets are in your account on a plane in your own account, and in ours on a plane we host. Recorded and checked here; nothing applies the period yet, and no plane keeps job logs yet.
`spec.retentionDays`	integer	No	RetentionDays is how long job logs are kept: 7, 30, 90 or 365 days. Default 90. An environment may set its own. Making it longer needs an owner or admin to approve, even in an environment that otherwise applies changes straight away; making it shorter in the project's own file does not. An environment's own period is judged without sight of the project's, so setting one for the first time asks for approval unless it is 7 days. A project of an organisation on the trial is refused 365 days when the change is planned. Nothing applies 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/joblogpolicy.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