Resources / PlatformTopology

PlatformTopology

The stable shape of the platform (spec 0047 section 3): which components exist, which hostnames reach each, what each depends on and how each is rolled out. It does not change with a commit; a PlatformRelease only says which build of each component is wanted, and the release controller merges the topology into every release, so every platform hostname is desired state.

Overview

APIplatform.etorm.com/v1alpha1
Resourceplatformtopologies (cluster-scoped inside its cluster)
Short namestopology
Available inthe platform only
Statuswritten by a controller through /status

Minimal example

apiVersion: platform.etorm.com/v1alpha1
kind: PlatformTopology
metadata:
  name: example
spec:
  components:
  - name: "<name>"

Spec

FieldTypeRequiredDefaultAllowedDescription
bypassRouteslist of objectup to 50 itemsPublic names served by something other than a Worker (a station behind the zone's proxy): a route with no Worker takes the name out of every broader Worker route of the zone (the most specific route wins), so a wildcard route of a site Worker does not answer for it. The controller creates what is missing, adopts an existing route with the same pattern and no Worker, and deletes only the ones it created and the topology no longer lists.
bypassRoutes[].patternstringyeslength 3 to 253The URL pattern, for example code.etorm.com/*.
bypassRoutes[].zoneIdstringyeslength 1 to 64The zone the pattern belongs to.
queueslist of stringup to 64 itemsThe queues of the account the platform needs. Each is read back every pass and made when it is missing; a queue nobody lists is never touched.
componentslist of objectyesup to 128 itemsOne entry per component of the platform.
components[].namestringyeslength 1 to 63Component name, as in a release (for a Worker, the script is etorm-<name>).
components[].kindstring (one of)"Worker"Worker, StaticSite, Agent, NodeImage, ComputeProgramWhat kind of thing it is.
components[].statelessOkbooleanfalseAn explicit mark that the component's stateful objects hold nothing that cannot be lost (a cache, a view rebuilt from elsewhere): only then may ResetDurableObject wipe them. Absent means false: nothing is marked.
components[].durableObjectslist of stringup to 16 itemsThe classes of the component's stateful objects, for ResetDurableObject.
components[].dependsOnlist of stringup to 16 itemsComponents that must be done first.
components[].rolloutobjectHow the component is rolled out, unless the release says otherwise.
components[].rollout.canaryPercentinteger1 to 50The share of traffic that gets the new version first.
components[].rollout.bakeSecondsinteger0 to 86400How long the canary is watched before promotion.
components[].rollout.settleSecondsinteger0 to 86400How long after promotion a burning objective still rolls the component back.
components[].rollout.graceSecondsinteger0 to 86400How long after the canary starts a failing intent is forgiven.
components[].rollout.requireReadybooleanPromote only while the intent is Ready; move back and open an Incident when it never is.
components[].rollout.maxBakeSecondsinteger0 to 604800With requireReady: how long the canary waits for its evidence.
components[].rollout.settleIntentRefobjectWith requireReady: the intent that must be Ready when the settle time ends.
components[].rollout.settleIntentRef.namestringyesup to 63 charactersName of an Intent in the platform project.
components[].rollout.sloRefobjectThe objective watched during the bake and the settle time.
components[].rollout.sloRef.namestringyesName of the SLO.
components[].rollout.intentRefobjectThe 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.namestringyesName of the Intent.
components[].routeslist of objectup to 20 itemsThe hostnames and URL patterns that reach this component.
components[].routes[].kindstring (one of)yesCustomDomain, RouteCustomDomain: a hostname the Worker serves. Route: a URL pattern in a zone that runs the Worker.
components[].routes[].hostnamestringup to 253 charactersFor a CustomDomain: the hostname.
components[].routes[].patternstringup to 253 charactersFor a Route: the URL pattern.
components[].routes[].zoneIdstringyeslength 1 to 64The zone the name belongs to.

Status

FieldTypeRequiredDefaultAllowedDescription
observedGenerationintegerThe generation of the spec this status describes.
bypassRouteslist of objectThe bypass routes this controller created or adopted: what it may delete.
bypassRoutes[].keystringroute:<pattern>@<zone>.
bypassRoutes[].idstringThe provider's identifier.
durableObjectClassesobject (free-form)Per component, the classes of its stateful objects as the provider holds them.
componentRoutesobjectThe routes of the topology's Workers this controller created or adopted, by component name: what it may repair or delete.
conditionslist of objectReady, Degraded and TopologyDrift.
conditions[].typestringReady or Degraded.
conditions[].statusstringTrue, False or Unknown.

All resources