Skip to content
API Reference

Operate and Configure Redbelt

Version: unreleased · Docs: 3c6ab9f2Download Markdown

Use the operator and documentation matching the installed release. Keep /var/lib/redbelt and its secrets private and backed up under administrator custody.

Terminal window
redbeltctl --state-dir /var/lib/redbelt status
redbeltctl --state-dir /var/lib/redbelt config show
redbeltctl --state-dir /var/lib/redbelt config show --effective
redbeltctl --state-dir /var/lib/redbelt secrets status

status reports saved configuration and the operation journal; it does not replace application readiness checks. config show redacts configuration. --effective reads the saved rendered configuration and fails if it has not been rendered. Secret status reports presence, not values or provider validity.

  1. Prepare the candidate installation specification privately.
  2. Validate it and compare it with the installed configuration:
Terminal window
redbeltctl --state-dir /var/lib/redbelt config validate /etc/redbelt/candidate.yaml
redbeltctl --state-dir /var/lib/redbelt config diff /etc/redbelt/candidate.yaml
  1. Review the target, provider references and resource changes. Resolve validation failures first.
  2. During the approved maintenance window, render the approved configuration:
Terminal window
redbeltctl --state-dir /var/lib/redbelt config apply /etc/redbelt/candidate.yaml

config apply writes rendered configuration and an audit record. Its activation: reconcile/restart result means activation still requires the deployment’s supported reconciliation/restart procedure. Do not describe rendered settings as active until readiness and the relevant feature checks pass. It cannot replace a signed installed release with different image pins.

Generated secret classes can have a supported rotation command; provisioner-owned credentials must be changed through their owning system. Encryption-key rotation requires a versioned keyring and cannot be performed by overwriting the existing key. Review the command reference before rotating anything.

Keep the operator journal, enrollment identity and recovery keys in protected custody. Do not send raw secrets or private support files through public documentation links. Use the authenticated Admin pages for product model/provider setup and review deployment settings.

Read release-matched documentation locally

Section titled “Read release-matched documentation locally”

Releases with a documentation artifact stage HTML, Markdown, images and local search under STATE_DIR/releases/RELEASE_CONTENT_SHA256/docs. Installation and updates verify that artifact against the signed release and its product version. The previous release’s copy stays available at its own path.

Terminal window
redbeltctl docs serve --directory /var/lib/redbelt/releases/RELEASE_CONTENT_SHA256/docs --port 4381

Replace the release hash with content_sha256 from the installed release receipt in your operator state directory. Open http://127.0.0.1:4381/ on the same machine. The reader binds only to loopback and serves the verified public inventory. Search and downloaded Markdown use local files; product execution and licensing can still require network access. Older releases without this artifact do not have a matching local bundle.