Skip to content
StratumStratum Docs

The upgrades, newest first.

GET
/v1/admin/upgrades
Code sample: Shell / cURL
curl --request GET \
  --url 'https://stratum.example.com/v1/admin/upgrades?limit=50' \
  --header 'Authorization: Bearer <token>'

Every upgrade recorded, the one in progress first when there is one. An upgrade in progress carries what each node’s host-helper reported for its current step. Install-scope; gates on upgrade:DescribeUpgrade.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 50 >= 1 <= 200

Responses

Section titled “Responses”

200

Section titled “200”

The upgrades.

Media typeapplication/json
object
items
required
Array<object>

An upgrade and how far it got: planned, prechecking, fetching, staged (stage-only, waiting for apply), backing_up, rolling, verifying, then done, failed or canceled. writeFreeze is true from the backup until the end: changes through the API answer 503 UPGRADE_IN_PROGRESS. A rollback is an upgrade to the release the cluster ran before, naming the upgrade it undoes in rollbackOf.

object
id
required
string
release
required
string
mode
required
string
Allowed values: now stage-only
state
required
string
Allowed values: planned prechecking fetching staged backing_up rolling verifying done failed canceled
kind
required

The largest kind of the nodes, once prechecked; empty before.

string
Allowed values: "" containers host os
source
required
string
manifestDigest
required
string
message
required

What the upgrade is doing or waiting for.

string
error
required

Why it failed.

string
requestedBy
required
string
requestedAt
required
string format: date-time
appliedBy
string
appliedAt
string format: date-time
nullable
stateSince
required
string format: date-time
finishedAt
string format: date-time
nullable
updatedAt
required
string format: date-time
writeFreeze
required
boolean
freezeAt
string format: date-time
nullable
restartedAt

The last restart or reboot it caused; settling starts again from it.

string format: date-time
nullable
backup
object
location

node: on the node, with no backup target set. target: the backup target.

string
Allowed values: node target
path

The bundle on the node.

string
sizeBytes
integer format: int64
sha256
string
encrypted
required

Encrypted to the backup recipient; otherwise readable by root only.

boolean
recoveryPointId
string
requestedAt
string format: date-time
takenAt
string format: date-time
plan
object
release
required
string
commit
string
manifestDigest
string
keyId

The release key that signed the manifest.

string
source
string
sourceKind
string
Allowed values: media fetched path mirror
kind
required
string
Allowed values: "" containers host os
impact
required

What the operator will see, in a sentence or two.

string
nodes
required
Array<object>

One node’s part of a plan.

object
nodeId
required
string
name
string
kind
required
string
Allowed values: "" containers host os
reboot
required
string
Allowed values: none soft full
rebootReason
string
restarts
required

What restarts, in order.

Array<string>
changes
required
Array<object>
object
what
required

Os, kernel, kernelArgs, hostBinaries, sysext: or pin:.

string
from
required
string
to
required
string
restarts
required
boolean
runningInstances
required
integer
instancesStop
required
boolean
downtimeMinutes
required
integer
impact
required
string
rebootReason

security when the release’s OS change fixes a vulnerability and a node reboots for it; absent otherwise. A staged upgrade waiting to reboot for it raises NodeRebootPending as a warning, and the node-reboot-pending alarm after 7 days.

string
Allowed values: security
cves

The vulnerabilities the OS change fixes, with rebootReason security.

Array<string>
steps
required

The upgrade’s steps, in order.

Array<string>
backup
required
object
location
required
string
Allowed values: node target
path
string
encrypted
required
boolean
detail
required
string
rollback
required
object
osRollback
required

The previous OS stays bootable.

boolean
restoreOnly
required

The old control plane cannot run on the new schema; going back means a restore.

boolean
detail
required
string
schema
required
object
current
required
integer
target
required
integer
readableBy
required
integer
readable
required
boolean
componentChanges

The pinned components the upgrade changes: the target release’s component list against the running release’s (componentsFrom release), or, for a running release built before the lists, against what a node reports (nodes: its image pins and the host packages it lists). Empty when nothing changes or nothing could be compared (none).

Array<object>

One pinned component the upgrade changes: a container image (by digest) or a host package (by NEVRA). from is empty for a component the running release does not have, to for one the target drops.

object
kind
required
string
Allowed values: image package
name
required

The images.yaml service name, or the package name.

string
from
required

What runs now, for reading - an image’s version and short digest, a package’s [epoch:]version-release.

string
to
required

What the release pins, in the same form.

string
fromId
required

Exact - the digest, or name-epoch:version-release.arch; empty when not known.

string
toId
required

Exact, as fromId.

string
componentsFrom
string
Allowed values: release nodes none
componentsNote

What the component changes were compared with, or why they could not be.

string
prechecks
required
Array<object>
object
name
required

Release, version, upgrade-path, upgrade, cluster-shutdown, readiness, schema, node, components, release-differs, space or backup-space. upgrade-path fails a known-broken upgrade, or one that skips a required stop, and says the way round it.

string
status
required
string
Allowed values: pass warn fail
message
required
string
nodeId
string
blocking
required

A precheck failed; the upgrade would be refused.

boolean
generatedAt
required
string format: date-time
nodes
required
Array<object>

One node’s part of an upgrade.

object
nodeId
required
string
name
string
kind
required
string
Allowed values: containers host os
state
required

rolled_back: the node switched itself back to the release it ran before.

string
Allowed values: pending fetching fetched restarting switching rebooting converging verified failed rolled_back
phase

The node’s current host-helper intent.

string
Allowed values: fetch roll post-boot
generation
integer format: int64
steps
required

The steps of the current intent, in order.

Array<string>
message
string
rebootMode
string
Allowed values: soft full
fromRelease

The release the node ran before.

string
stoppedInstances
required

The instances that ran on the node when it rebooted; verify waits for each to run again.

Array<string>
startedAt
string format: date-time
finishedAt
string format: date-time
hostState
string
Allowed values: running done failed rolled_back dropped
hostSteps
required
Array<object>

One step of the node’s host-helper for its current part of the upgrade.

object
name
required

restore runs first in a rollback that restores the pre-upgrade backup; switch-sysext switches the system extensions (kind host).

string
Allowed values: restore fetch restart switch-binaries switch-sysext render switch-os reboot update-bootloader
state
required
string
Allowed values: pending running done failed rolled_back
attempts
required
integer
startedAt
string format: date-time
finishedAt
string format: date-time
error
string
detail

What the step found or did.

string
commit
string
osDigest
string
rebootMode
string
Allowed values: soft full
rebootReason
string
rebootedAt
string format: date-time
units

Units the restart step still has to restart.

Array<string>
restarted

Units the restart step restarted onto their pin, or switch-sysext restarted.

Array<string>
stopped

Units the restore step stopped; the step that renders the release’s pins starts them again.

Array<string>
extensions

The system extensions the switch-sysext step switched.

Array<string>
reportedAt
string format: date-time
fromRelease

The release the cluster ran when the upgrade was requested; what rolling it back returns to.

string
rollbackOf

For a rollback, the upgrade it undoes.

string
restore

For a rollback, whether it restores the undone upgrade’s pre-upgrade backup.

boolean
rolledBackBy

The rollback that undid this upgrade.

string
acknowledgedAt

When a failed upgrade’s findings were acknowledged.

string format: date-time
nullable
acknowledgedBy
string

Example 

{
  "items": [
    {
      "id": "upg-4k2j9x0qpa",
      "mode": "now",
      "state": "planned",
      "kind": "",
      "backup": {
        "location": "node"
      },
      "plan": {
        "sourceKind": "media",
        "kind": "",
        "nodes": [
          {
            "kind": "",
            "reboot": "none"
          }
        ],
        "rebootReason": "security",
        "backup": {
          "location": "node"
        },
        "componentChanges": [
          {
            "kind": "image"
          }
        ],
        "componentsFrom": "release",
        "prechecks": [
          {
            "status": "pass"
          }
        ]
      },
      "nodes": [
        {
          "kind": "containers",
          "state": "pending",
          "phase": "fetch",
          "rebootMode": "soft",
          "hostState": "running",
          "hostSteps": [
            {
              "name": "restore",
              "state": "pending",
              "rebootMode": "soft"
            }
          ]
        }
      ]
    }
  ]
}

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"
    }
  ]
}

503

Section titled “503”

Upstream temporarily unavailable (driver / scheduler / dependency).

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"
    }
  ]
}