Skip to content
StratumStratum Docs

What an upgrade to a release would do.

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

The plan, computed from the release’s signed manifest against what each node reports it runs; nothing changes. Per node: the kind (containers, host or os, the largest the diff touches), what restarts, whether the node reboots and how many VMs stop for about how long. Then where the backup goes, how the upgrade could be undone, the schema levels, and every precheck with blocking true when one failed. The upgrade’s prechecking step runs the same checks. Install-scope; gates on upgrade:DescribeUpgrade.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
release
string

The release, found in a verified medium, on the node, or in the release mirror’s index.

source
string

A release mirror URL, or a release directory under the import root.

mode
string
Allowed values: now stage-only

Responses

Section titled “Responses”

200

Section titled “200”

The plan.

Media typeapplication/json

What an upgrade to a release would do, and every reason it would be refused. kind is the largest of the nodes’ kinds; empty when every node already runs the release.

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

Example 

{
  "sourceKind": "media",
  "kind": "",
  "nodes": [
    {
      "kind": "",
      "reboot": "none"
    }
  ],
  "rebootReason": "security",
  "backup": {
    "location": "node"
  },
  "componentChanges": [
    {
      "kind": "image"
    }
  ],
  "componentsFrom": "release",
  "prechecks": [
    {
      "status": "pass"
    }
  ]
}

400

Section titled “400”

Bad request.

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

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