Skip to content
StratumStratum Docs

Substrate component compatibility matrix (detected vs supported versions).

GET
/v1/admin/substrate/compatibility
Code sample: Shell / cURL
curl --request GET \
  --url https://stratum.example.com/v1/admin/substrate/compatibility \
  --header 'Authorization: Bearer <token>'

Bootstrap-admin endpoint returning the compatibility matrix for this node: each substrate component’s detected version vs the version this Stratum build was tested against, plus the cross-component constraints — notably the OVN central / host ovn-controller major.minor match, whose mismatch silently breaks bridged floating-IP traffic.

Components Stratum ships as pinned containers (postgres, openbao, ovn-central) are reported from the embedded image pins; host-side components (ovs, ovn-controller) are probed at runtime. Probes are defensive — an unreachable version is reported as detected: null with a soft status, never an error.

stratumctl admin doctor renders this; the UI renders it as a compatibility panel. The top-level report is the answering node’s live matrix; adds nodes[] (every cluster node’s last-sampled matrix) + fleetOverallStatus so operators see per-node host version skew..

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Compatibility matrix for this node.

Media typeapplication/json
object
stratumVersion
required

The Stratum build whose embedded baseline this matrix was evaluated against.

string
overallStatus
required

Worst status across all components and constraints (of the ANSWERING node’s report).

string
Allowed values: ok warn unsupported
components
required
Array<object>
object
id
required

Component id.

string
class
required

shipped = Stratum ships it as a pinned container (drift impossible unless a quadlet is hand-edited), so it is ok by construction. host = host-side, range-checked + probed at runtime.

string
Allowed values: shipped host
detected
required

Detected version, or null when the probe was unreachable or unparseable.

string
nullable
supported
required

The supported version for a component — a pinned ref (shipped) or a range (host).

object
pinned

Pinned image ref, for shipped components.

string
range

Supported version range, e.g. >=25.03 <26.00, for host components.

string
testedAgainst

The version the smokes actually tested against, when narrower than the range.

string
status
required
string
Allowed values: ok warn unsupported
note

Human-readable detail when status is not ok.

string
source
required

How the version was obtained (image-pin or host-probe).

string
constraints
required
Array<object>
object
id
required
string
rule
required

The constraint expression.

string
status
required
string
Allowed values: ok warn unsupported
note

Human-readable detail when status is not ok.

string
fleetOverallStatus

Worst status across the answering node’s report AND every sampled node. Absent when no per-node samples are available.

string
Allowed values: ok warn unsupported
nodes

Per-node compatibility across the fleet. The top-level fields above are the ANSWERING node’s live report (unchanged, for backward compatibility); this array carries every cluster node’s last-sampled report keyed by nodeId, so the UI can render a component x node matrix and surface host version skew — notably an OVN central/controller major.minor mismatch on one node, which silently breaks bridged floating-IP traffic there. Empty on a single-node install or before the first sample tick.

Array<object>

One cluster node’s compatibility matrix + when it was sampled.

object
nodeId
required

The node this report was sampled on.

string
sampledAt
required

When this node last sampled its matrix; UIs should flag stale nodes.

string format: date-time
stratumVersion
required
string
overallStatus
required
string
Allowed values: ok warn unsupported
components
required
Array<object>
object
id
required

Component id.

string
class
required

shipped = Stratum ships it as a pinned container (drift impossible unless a quadlet is hand-edited), so it is ok by construction. host = host-side, range-checked + probed at runtime.

string
Allowed values: shipped host
detected
required

Detected version, or null when the probe was unreachable or unparseable.

string
nullable
supported
required

The supported version for a component — a pinned ref (shipped) or a range (host).

object
pinned

Pinned image ref, for shipped components.

string
range

Supported version range, e.g. >=25.03 <26.00, for host components.

string
testedAgainst

The version the smokes actually tested against, when narrower than the range.

string
status
required
string
Allowed values: ok warn unsupported
note

Human-readable detail when status is not ok.

string
source
required

How the version was obtained (image-pin or host-probe).

string
constraints
required
Array<object>
object
id
required
string
rule
required

The constraint expression.

string
status
required
string
Allowed values: ok warn unsupported
note

Human-readable detail when status is not ok.

string

Example 

{
  "overallStatus": "ok",
  "components": [
    {
      "id": "ovn-controller",
      "class": "shipped",
      "status": "ok"
    }
  ],
  "constraints": [
    {
      "id": "ovn-central-controller-match",
      "rule": "ovn-central.major_minor == ovn-controller.major_minor",
      "status": "ok"
    }
  ],
  "fleetOverallStatus": "ok",
  "nodes": [
    {
      "overallStatus": "ok",
      "components": [
        {
          "id": "ovn-controller",
          "class": "shipped",
          "status": "ok"
        }
      ],
      "constraints": [
        {
          "id": "ovn-central-controller-match",
          "rule": "ovn-central.major_minor == ovn-controller.major_minor",
          "status": "ok"
        }
      ]
    }
  ]
}

403

Section titled “403”

Authenticated but not authorized.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object
key
additional properties
any

Example 

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}