Skip to content
API Reference

Update a Self-Hosted Deployment

Version: unreleased · Docs: 3c6ab9f2Download Markdown

Updates are customer initiated and can require downtime. Use the operator matching your current release and confirm that the target release is approved for your deployment.

Terminal window
redbeltctl --state-dir /var/lib/redbelt update check

Read the eligibility, target and error fields. A cached release or transport success is not permission to update. An installed-release receipt is required; never manufacture one to make a legacy installation appear verified.

Obtain the verified signed target manifest and private backup-storage configuration through the authorized release/recovery process. Plan the exact target with a stable UUID supplied by your automation or administrator:

Terminal window
redbeltctl --state-dir /var/lib/redbelt update plan --manifest /private/target-release.json --release-id TARGET_RELEASE_ID --idempotency-key UPDATE_REQUEST_UUID

Replace the placeholders. Preserve that UUID for retries of this same intent. Planning does not change workloads, establish download entitlement or perform a backup. A UUID cannot be reused for a different source or target.

Confirm the backup destination, independent recovery custody and maintenance window. Then use the supported Linux update path:

Terminal window
redbeltctl --state-dir /var/lib/redbelt update apply --manifest /private/target-release.json --idempotency-key UPDATE_REQUEST_UUID --backup-storage /private/backup-storage.json

The private backup configuration contains pinned storage-tool and repository access information. Do not place it in the public docs or shell arguments as JSON. An optional --artifact-directory supplies a previously verified cache; apply repeats artifact checks.

The operator owns maintenance, checkpoints and release application. If a step fails, preserve the journal and rerun the same intent only after resolving the reported cause. Failed application verification can leave the gateway closed deliberately. Do not manually reopen traffic or downgrade the database.

Inspect status and the exact installed-release receipt through the supported operator process. Check application readiness, sign-in and a first thread. Verify the feature your change concerns before resuming normal work. Interrupted agent or workflow work retains its own recovery rules; do not assume an HTTP reconnect restarts it.

This guide describes implemented commands. Customer release certification and an immutable install/update rehearsal belong to release approval; these docs do not establish that every proposed release has passed them. Follow recovery when the operator requires inspection.