product | string | yes | | up to 128 characters | The product in plain words, for example `code.etorm.com serves the Forge web UI`. |
evidenceOnly | boolean | | false | | The Intent is evidence for a release (its canary or fleet objective), not a product: its links are judged but never repaired and never open an Incident of their own. |
sloRef | object | | | | The objective that measures this product (an SLO of the same cluster). |
sloRef.name | string | yes | | length 1 to 63 | Name of the SLO. |
requirements | list of object | yes | | up to 32 items | The links, in order from the outside in. The first one that is not met is the failing link. |
requirements[].name | string | yes | | length 1 to 63 | Name of the link, shown in the chain. |
requirements[].resource | object | | | | A resource that must be Ready (condition Ready true, or phase Ready, Running or Active). |
requirements[].resource.group | string | yes | | | API group of the resource (empty for the core group). |
requirements[].resource.version | string | yes | | | API version. |
requirements[].resource.plural | string | yes | | | Plural resource name. |
requirements[].resource.name | string | yes | | | Object name. |
requirements[].resource.cluster | string | | "root" | | Logical cluster of the object (default root). |
requirements[].resource.condition | string | | | up to 63 characters | The condition that must be True instead of Ready (for example a station's FabricHealthy, spec 0038 section 22); empty: Ready. |
requirements[].probe | object | | | | A public URL that must answer as expected, probed from the platform. |
requirements[].probe.url | string | yes | | up to 512 characters | The address to request with GET. |
requirements[].probe.expectCode | integer | | 200 | 100 to 599 | The HTTP status the answer must have. |
requirements[].probe.expectText | string | | | up to 256 characters | Text the body must contain (empty: any body). |
requirements[].probe.git | object | | | | Probe a real Git fetch of the repository at `url` (the address of the repository, `https://host/<workspace>/<repository>.git`) instead of a GET: list the refs, then fetch `ref` at `depth` and require a pack. `expectCode` and `expectText` do not apply. |
requirements[].probe.git.ref | string | | "refs/heads/main" | up to 256 characters | The ref to fetch. |
requirements[].probe.git.depth | integer | | 1 | 1 to 100 | How many commits of history to fetch. |
requirements[].probe.expectBuild | string (one of) | | | release | For a Git probe: the build named in the advertisement (`agent=etorm-git/<build>`) must be the build of the newest Ready release; a Ready release answered by another build fails the link. |
requirements[].probe.auth | string (one of) | | | platform, probe | `platform`: the probe is made with the platform's own credential; `probe`: with the platform probe identity's token (spec 0047 section 2.4). Only to the platform's own names; the host decides. |
requirements[].probe.maxSeconds | integer | | | 1 to 90 | The probe is met only if it took no longer than this (a Git probe: default 30; a work probe: default 10). |
requirements[].probe.whenReady | object | | | | A work probe's precondition: an object the probe itself needs (its own endpoint, for example). While it is missing or not Ready the link is shown with cause probe-not-ready and the service is not judged, whatever the order in which the pieces appear. |
requirements[].probe.whenReady.group | string | yes | | | API group. |
requirements[].probe.whenReady.version | string | yes | | | API version. |
requirements[].probe.whenReady.plural | string | yes | | | Plural resource name. |
requirements[].probe.whenReady.cluster | string | | | | Its project (default root). |
requirements[].probe.whenReady.name | string | yes | | | Its name. |
requirements[].probe.everySeconds | integer | | | 30 to 86400 | A met work probe runs again at most this often (default 300); a failing one runs every pass. |
requirements[].probe.steps | list of object | | | up to 8 items | A work probe (spec 0047 section 2.4): the service's real job as ordered requests, each with its expected answer; the first that fails names the link's failure. `{nonce}` (new each run) and `{nowMs}` are replaced in `url` and `body`. `url` above is then only the link's label. |
requirements[].probe.steps[].method | string (one of) | | "GET" | GET, POST, PUT, DELETE | The request method. |
requirements[].probe.steps[].url | string | yes | | up to 512 characters | The address of the request (a platform name). |
requirements[].probe.steps[].body | string | | | up to 4096 characters | The request body (never a secret: it is readable in this object). |
requirements[].probe.steps[].contentType | string | | | up to 100 characters | The body's type (default application/json). |
requirements[].probe.steps[].expectCode | integer | | 200 | 100 to 599 | The status the answer must have. |
requirements[].probe.steps[].expectCodes | list of integer | | | up to 4 items | Any of these statuses is good (instead of expectCode). |
requirements[].probe.steps[].expectText | string | | | up to 256 characters | Text the answer must contain (`{nonce}` allowed). |
requirements[].probe.via | list of string | | | up to 2 items | The paths the probe takes: `edge` (the public name, through whatever fronts it: the default) and `origin` (each origin address straight, with the name as SNI and Host). With both, a failure is named by where it is: `edge-to-origin`, `origin-down` or `origin-saturated` (spec 0047 section 2.3). |
requirements[].probe.burst | integer | | | 0 to 64 | With `via` origin: open this many parallel connections to each origin that answers and require all of them to be accepted (0: none). |
requirements[].probe.endpointRef | object | | | | The PublicEndpoint whose DNSRecords are the origin addresses (with `via` origin). |
requirements[].probe.endpointRef.name | string | | | | Name of the PublicEndpoint (root cluster). |
requirements[].probe.origins | list of string | | | up to 8 items | Origin addresses given outright, in addition to those of `endpointRef`. |
requirements[].probe.originPort | integer | | | 1 to 65535 | The origin's port (default: the URL's). |
requirements[].remediation | list of object | | | up to 8 items | The repair of this link, as an ordered list of bounded actions (spec 0047 section 6, link remediation). While this link is the failing one for two minutes, the first action runs; if the link is not met after its settle time, the next runs. The order of the actions not yet tried follows what has helped this link before. When none is left an incident labelled needs-code is opened. |
requirements[].remediation[].action | string (one of) | yes | | RollbackRelease, RedeployComponent, ResetDurableObject, ApplyDeclared, ReplaceNode, FailoverDNS, RestartPlacement, RerunBootstrapRequest, RotateNow, RederiveListenerTarget, RestartProcess, RaiseFuel, ReplaceGitProcess, RestoreIngressAffinity, RestartLogShipper | Which action (the list is closed, as for a Remediation). |
requirements[].remediation[].params | object (free-form) | | | | Parameters the action's owner defines. |
requirements[].remediation[].settleSeconds | integer | | 120 | 0 to 86400 | How long the link has to become met after the action before the next one runs. |
requirements[].remediation[].onCause | string | | | up to 63 characters | For a probe with several paths: run this step only while the link fails for this cause (`edge-to-origin`, `origin-down`, `origin-saturated`). Empty: for every cause. |
requirements[].remediation[].mode | string (one of) | | "apply" | apply, plan | plan only records what would run. |
requirements[].remediation[].budget | object | | | | At most this many runs of this step in the window. |
requirements[].remediation[].budget.max | integer | | 1 | at least 1 | Runs allowed. |
requirements[].remediation[].budget.windowSeconds | integer | | 3600 | at least 60 | The window. |