Skip to content

Prune fetched releases.

POST
/v1/admin/upgrades/prune
Code sample: Shell / cURL
curl --request POST \
--url https://stratum.example.com/v1/admin/upgrades/prune \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "dryRun": false }'

Removes, on every node, the fetched releases the cluster no longer needs (see UpgradePrune for what is kept). Records the request and returns at once (202); each node prunes on its next pass. Nodes also prune by themselves after an upgrade ends done. With dryRun it only reports (200). Refused (409 UpgradeInProgress) while an upgrade is in progress, and (409 PruneRefused) while the release the cluster runs is not known. Install-scope; gates on upgrade:PruneReleases, a dry run on upgrade:DescribeUpgrade.

Media typeapplication/json
object
dryRun

Report what would be removed, and remove nothing.

boolean

What pruning would keep and remove (dry run).

Media typeapplication/json

What pruning keeps and removes on each node. Every node keeps the release the cluster runs, the one before it (what a rollback returns to), after a failed upgrade that upgrade’s release, and the release the node was installed with. Everything else under /var/lib/stratum/upgrade goes; the images only those releases pin go on the image reaper’s next pass. Each node’s part is computed from what the node last reported.

object
dryRun
required
boolean
requestedAt

When the request was recorded; null on a dry run.

string format: date-time
nullable
keep
required

The releases every node keeps.

Array<object>
object
release
required
string
reason
required
string
Allowed values: running previous upgrade
nodes
required
Array<object>
object
nodeId
required
string
node
required
string
reportedAt

When the node reported what it stores; null when it has not.

string format: date-time
nullable
keep
required
Array<object>
object
release
required
string
reason

Why it is kept; absent for a release that is removed.

string
Allowed values: running previous upgrade install
bytes
required
integer format: int64
delete
required
Array<object>
object
release
required
string
reason

Why it is kept; absent for a release that is removed.

string
Allowed values: running previous upgrade install
bytes
required
integer format: int64
leftovers
required
Array<object>

A directory under /var/lib/stratum/upgrade.

object
path
required
string
bytes
required
integer format: int64
bytes
required

What removing frees on this node.

integer format: int64
bytes
required

What removing frees on every node together.

integer format: int64
message
required
string

Example

{
"keep": [
{
"reason": "running"
}
],
"nodes": [
{
"keep": [
{
"reason": "running"
}
],
"delete": [
{
"reason": "running"
}
],
"leftovers": [
{
"path": "os/3f1c0d77"
}
]
}
]
}

Recorded.

Media typeapplication/json

What pruning keeps and removes on each node. Every node keeps the release the cluster runs, the one before it (what a rollback returns to), after a failed upgrade that upgrade’s release, and the release the node was installed with. Everything else under /var/lib/stratum/upgrade goes; the images only those releases pin go on the image reaper’s next pass. Each node’s part is computed from what the node last reported.

object
dryRun
required
boolean
requestedAt

When the request was recorded; null on a dry run.

string format: date-time
nullable
keep
required

The releases every node keeps.

Array<object>
object
release
required
string
reason
required
string
Allowed values: running previous upgrade
nodes
required
Array<object>
object
nodeId
required
string
node
required
string
reportedAt

When the node reported what it stores; null when it has not.

string format: date-time
nullable
keep
required
Array<object>
object
release
required
string
reason

Why it is kept; absent for a release that is removed.

string
Allowed values: running previous upgrade install
bytes
required
integer format: int64
delete
required
Array<object>
object
release
required
string
reason

Why it is kept; absent for a release that is removed.

string
Allowed values: running previous upgrade install
bytes
required
integer format: int64
leftovers
required
Array<object>

A directory under /var/lib/stratum/upgrade.

object
path
required
string
bytes
required
integer format: int64
bytes
required

What removing frees on this node.

integer format: int64
bytes
required

What removing frees on every node together.

integer format: int64
message
required
string

Example

{
"keep": [
{
"reason": "running"
}
],
"nodes": [
{
"keep": [
{
"reason": "running"
}
],
"delete": [
{
"reason": "running"
}
],
"leftovers": [
{
"path": "os/3f1c0d77"
}
]
}
]
}

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

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

Conflicting state.

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

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