commit | string | yes | | length 40 to 40 | The full source commit id of this release. |
active | boolean | | false | | Whether the platform converges to this release. At most one release is active. |
repository | object | yes | | | The Forge repository whose Checks gate the release. |
repository.name | string | yes | | | Name of the Repository. |
repository.cluster | string | | "platform" | | Cluster of the repository (the platform system project by default). |
gates | list of string | | | up to 32 items | Names of the Checks that must be `success` on the commit before anything is deployed. |
components | list of object | yes | | up to 64 items | One entry per component. |
components[].name | string | yes | | length 1 to 63 | Component name, for example api, operator, auth, console. |
components[].kind | string (one of) | yes | | Worker, StaticSite, Agent, NodeImage, ComputeProgram | What kind of thing it is. |
components[].artifact | object | yes | | | The build that CI produced for this commit. |
components[].artifact.versionId | string | | | up to 128 characters | The identifier of an already uploaded version (for a Worker, the version id the build was uploaded as). Leave it out when the artifact is a bundle: the controller uploads it and records the version it made. |
components[].artifact.source | object | | | | Where CI stored the bundle (a Storage bucket). |
components[].artifact.source.project | string | | | up to 63 characters | The project of the bucket (default platform). |
components[].artifact.source.bucket | string | | | up to 63 characters | The bucket. |
components[].artifact.source.key | string | | | up to 512 characters | The object key, for example workers/status/<sha256>.json. |
components[].artifact.digest | string | | | up to 128 characters | Content digest of the artifact. |
components[].artifact.build | string | | | up to 64 characters | The build id baked into the artifact (what the component reports as running). |
components[].artifact.trustedKey | string | | | up to 64 characters | For a node image: the hex Ed25519 public key it was compiled to trust (spec 0038 section 21). |
components[].artifact.features | list of string | | | | For a node image: what its node OS can do beyond boot (live-config, spec 0038 section 5). |
components[].rollout | object | | | | How the component is rolled out. |
components[].rollout.canaryPercent | integer | | 5 | 1 to 50 | The share of traffic (or of hosts) that gets the new version first. |
components[].rollout.bakeSeconds | integer | | 600 | 0 to 86400 | How long the canary is watched before promotion. |
components[].rollout.settleSeconds | integer | | 1800 | 0 to 86400 | How long after promotion a burning objective still rolls the component back. |
components[].rollout.graceSeconds | integer | | 0 | 0 to 86400 | How long after the canary starts a failing intent is forgiven (a station image replaces a machine, which takes minutes). |
components[].rollout.requireReady | boolean | | false | | Positive evidence: promote only while the intent is Ready, move the canary back (and open an Incident) when it is not Ready by maxBakeSeconds, and, with settleIntentRef, move the component back when that intent is not Ready when the settle time ends. |
components[].rollout.maxBakeSeconds | integer | | | 0 to 604800 | With requireReady: how long the canary waits for its evidence (default four bakes, at least an hour). |
components[].rollout.settleIntentRef | object | | | | With requireReady: the intent that must be Ready when the settle time after promotion ends (the evidence of the whole fleet). |
components[].rollout.settleIntentRef.name | string | yes | | up to 63 characters | Name of an Intent in the platform project. |
components[].rollout.sloRef | object | | | | The objective watched during the bake and the settle time. |
components[].rollout.sloRef.name | string | yes | | | Name of the SLO. |
components[].rollout.intentRef | object | | | | The Intent (of the platform project) whose probes are watched during the canary and the settle time: when it was Ready as the canary started and a probe fails afterwards, the release controller rolls the component back itself, without waiting for an objective to burn. |
components[].rollout.intentRef.name | string | yes | | | Name of the Intent. |
components[].dependsOn | list of string | | | up to 16 items | Components that must be done first. |
components[].routes | list of object | | | up to 20 items | The hostnames and URL patterns that reach this Worker, as desired state (spec 0047 section 3). The controller creates what is missing, repairs what points elsewhere or was deleted by hand, and deletes only what it created itself and the release no longer lists. |
components[].routes[].kind | string (one of) | yes | | CustomDomain, Route | CustomDomain: a hostname the Worker serves, with its record and certificate managed for it. Route: a URL pattern in a zone that runs the Worker. |
components[].routes[].hostname | string | | | up to 253 characters | For a CustomDomain: the hostname, for example inference.etorm.com. |
components[].routes[].pattern | string | | | up to 253 characters | For a Route: the URL pattern, for example api.etorm.com/*. |
components[].routes[].zoneId | string | yes | | length 1 to 64 | The zone the hostname or pattern belongs to. |