Resources / Scenario

Scenario

An incident kept as a permanent test (spec 0047 section 6.4): a small reference to the recorded slice of the object graph on the failing Intent's dependency path, with its provider read-backs and probe results and every secret stripped. The slice itself is a compressed document in the platform bucket, never state in the store.

Overview

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

Minimal example

apiVersion: platform.etorm.com/v1alpha1
kind: Scenario
metadata:
  name: example
spec:
  incidentRef:
    name: "<name>"
  intent: "<intent>"
  dedupKey: "<dedupKey>"
  blob:
    bucket: "<bucket>"
    key: "<key>"
    sha256: "<sha256>"
    bytes: 1

Spec

FieldTypeRequiredDefaultAllowedDescription
incidentRefobjectyesThe first Incident that made this scenario.
incidentRef.namestringyesName of the Incident.
incidentRef.clusterstring"platform"Its cluster.
intentstringyesup to 63 charactersThe Intent that failed.
dedupKeystringyesup to 64 charactersThe failing link plus the sorted kinds and reasons of the probable causes, hashed: the same cause is one scenario however many incidents it opens.
expectstring (one of)"expected-failing"pass, expected-failingexpected-failing while the incident is open (it is replayed and reported, and blocks no release); pass once it is fixed.
blobobjectyesWhere the recorded slice is.
blob.bucketstringyesThe platform bucket.
blob.keystringyesThe object key.
blob.sha256stringyesDigest of the stored (compressed) bytes.
blob.bytesintegeryesat most 1048576Size of the stored bytes (at most 1 MiB).
blob.encodingstring (one of)"deflate"deflateHow the JSON document is compressed.

Status

FieldTypeRequiredDefaultAllowedDescription
statestring (one of)Open, FixedOpen while the incident is open; Fixed once it has resolved.
incidentslist of stringEvery later incident with the same key.
fixedBystringThe commit of the active release when the incident resolved.
fixedAtintegerUnix time it was fixed.
conditionslist of objectReady (the slice is stored).
conditions[].typestringReady.
conditions[].statusstringTrue, False or Unknown.

Columns in listings

ColumnFrom
Intent.spec.intent
Expect.spec.expect
State.status.state
Fixed-By.status.fixedBy

All resources