Cancel an upgrade that has not taken its backup.
curl --request POST \ --url https://stratum.example.com/v1/admin/upgrades/example/cancel \ --header 'Authorization: Bearer <token>'Until backing_up, nothing that runs has changed: the upgrade ends as
canceled, and what the nodes fetched stays there for a later upgrade.
Refused (409) from the backup on. Install-scope; gates on
upgrade:CancelUpgrade.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Responses
Section titled “Responses”Canceled.
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
The largest kind of the nodes, once prechecked; empty before.
What the upgrade is doing or waiting for.
Why it failed.
The last restart or reboot it caused; settling starts again from it.
object
node: on the node, with no backup target set. target: the backup target.
The bundle on the node.
Encrypted to the backup recipient; otherwise readable by root only.
object
The release key that signed the manifest.
What the operator will see, in a sentence or two.
One node’s part of a plan.
object
What restarts, in order.
object
Os, kernel, kernelArgs, hostBinaries, sysext:
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.
The vulnerabilities the OS change fixes, with rebootReason security.
The upgrade’s steps, in order.
object
object
The previous OS stays bootable.
The old control plane cannot run on the new schema; going back means a restore.
object
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).
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
The images.yaml service name, or the package name.
What runs now, for reading - an image’s version and short digest, a package’s [epoch:]version-release.
What the release pins, in the same form.
Exact - the digest, or name-epoch:version-release.arch; empty when not known.
Exact, as fromId.
What the component changes were compared with, or why they could not be.
object
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.
A precheck failed; the upgrade would be refused.
One node’s part of an upgrade.
object
rolled_back: the node switched itself back to the release it ran before.
The node’s current host-helper intent.
The steps of the current intent, in order.
The release the node ran before.
The instances that ran on the node when it rebooted; verify waits for each to run again.
One step of the node’s host-helper for its current part of the upgrade.
object
restore runs first in a rollback that restores the pre-upgrade backup; switch-sysext switches the system extensions (kind host).
What the step found or did.
Units the restart step still has to restart.
Units the restart step restarted onto their pin, or switch-sysext restarted.
Units the restore step stopped; the step that renders the release’s pins starts them again.
The system extensions the switch-sysext step switched.
The release the cluster ran when the upgrade was requested; what rolling it back returns to.
For a rollback, the upgrade it undoes.
For a rollback, whether it restores the undone upgrade’s pre-upgrade backup.
The rollback that undid this upgrade.
When a failed upgrade’s findings were acknowledged.
Example
{ "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" } ] } ]}Authenticated but not authorized.
object
The findings of a rejected IAM policy document (custom and resource policies).
One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.
object
The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.
Index of the statement at fault; -1 for the document as a whole.
The offending action, where one is at fault (ACTION_NOT_APPLICABLE).
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.
One field’s problem, the stage-2 installer API’s shape.
field is the field’s path, message what is wrong with it.
object
The field’s path, e.g. links[0].interface, disks[1].confirm,
mgmt.address or role; empty for the whole request.
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
Example
{ "issues": [ { "code": "ACTION_NOT_APPLICABLE", "action": "compute:CreateVpc" } ]}Resource not found.
object
The findings of a rejected IAM policy document (custom and resource policies).
One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.
object
The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.
Index of the statement at fault; -1 for the document as a whole.
The offending action, where one is at fault (ACTION_NOT_APPLICABLE).
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.
One field’s problem, the stage-2 installer API’s shape.
field is the field’s path, message what is wrong with it.
object
The field’s path, e.g. links[0].interface, disks[1].confirm,
mgmt.address or role; empty for the whole request.
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
Example
{ "issues": [ { "code": "ACTION_NOT_APPLICABLE", "action": "compute:CreateVpc" } ]}Conflicting state.
object
The findings of a rejected IAM policy document (custom and resource policies).
One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.
object
The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.
Index of the statement at fault; -1 for the document as a whole.
The offending action, where one is at fault (ACTION_NOT_APPLICABLE).
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.
One field’s problem, the stage-2 installer API’s shape.
field is the field’s path, message what is wrong with it.
object
The field’s path, e.g. links[0].interface, disks[1].confirm,
mgmt.address or role; empty for the whole request.
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
Example
{ "issues": [ { "code": "ACTION_NOT_APPLICABLE", "action": "compute:CreateVpc" } ]}Upstream temporarily unavailable (driver / scheduler / dependency).
object
The findings of a rejected IAM policy document (custom and resource policies).
One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.
object
The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.
Index of the statement at fault; -1 for the document as a whole.
The offending action, where one is at fault (ACTION_NOT_APPLICABLE).
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.
One field’s problem, the stage-2 installer API’s shape.
field is the field’s path, message what is wrong with it.
object
The field’s path, e.g. links[0].interface, disks[1].confirm,
mgmt.address or role; empty for the whole request.
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
Example
{ "issues": [ { "code": "ACTION_NOT_APPLICABLE", "action": "compute:CreateVpc" } ]}