Skip to content
API Reference

Operator Command Reference

Version: unreleased · Docs: 3c6ab9f2Download Markdown

Use the signed operator supplied for your release. Commands below are generated from its argument definitions; their presence does not certify a customer release. Global --state-dir defaults to /var/lib/redbelt and comes before the command. Exit code 0 means the command completed its stated responsibility; 2 reports an invalid input, blocked prerequisite or operation failure.

profiles, preflight, configuration show/validate/diff, secret status, and recovery plan inspect state. setup, enroll, installation, configuration apply, secret rotation, update planning/application, and recovery staging write state or contact authenticated services. Update application can stop workloads and require downtime. Configuration application renders settings; it does not establish activation. Recovery planning/staging and operator recovery do not perform a full application restore.

Installation keys use a hidden prompt or protected standard input. Keep configuration, backup access and recovery files private. Do not put credential values in arguments. Reserved placeholder commands are excluded from this reference.

usage: redbeltctl [-h] [--state-dir STATE_DIR]
{profiles,preflight,enroll,setup,install,config,secrets,status,docs,update,restore} ...
positional arguments:
{profiles,preflight,enroll,setup,install,config,secrets,status,docs,update,restore}
enroll Persist and enroll an installer identity before
database startup
setup Enroll and install using customer settings and a
signed channel release
docs Read a verified public documentation bundle locally
restore Plan recovery from independently trusted backup
metadata
options:
-h, --help show this help message and exit
--state-dir STATE_DIR
usage: redbeltctl profiles [-h] {list,show} ...
positional arguments:
{list,show}
options:
-h, --help show this help message and exit
usage: redbeltctl profiles list [-h]
options:
-h, --help show this help message and exit
usage: redbeltctl profiles show [-h] profile
positional arguments:
profile
options:
-h, --help show this help message and exit
usage: redbeltctl preflight [-h] --spec SPEC
options:
-h, --help show this help message and exit
--spec SPEC
usage: redbeltctl enroll [-h] --spec SPEC [--key-stdin]
options:
-h, --help show this help message and exit
--spec SPEC
--key-stdin Read the installation key from standard input
usage: redbeltctl setup [-h] --config CONFIG [--key-stdin]
options:
-h, --help show this help message and exit
--config CONFIG Private customer configuration JSON without image digests
--key-stdin
usage: redbeltctl install [-h] --spec SPEC [--apply] [--namespace NAMESPACE]
[--release-manifest RELEASE_MANIFEST]
[--artifact-directory ARTIFACT_DIRECTORY]
options:
-h, --help show this help message and exit
--spec SPEC
--apply
--namespace NAMESPACE
Must match the explicit installation target
--release-manifest RELEASE_MANIFEST
Private signed release manifest for customer
installation
--artifact-directory ARTIFACT_DIRECTORY
Cache containing the signed installation-config and
chart
usage: redbeltctl config [-h] {show,validate,diff,apply} ...
positional arguments:
{show,validate,diff,apply}
options:
-h, --help show this help message and exit
usage: redbeltctl config show [-h] [--effective]
options:
-h, --help show this help message and exit
--effective
usage: redbeltctl config validate [-h] file
positional arguments:
file
options:
-h, --help show this help message and exit
usage: redbeltctl config diff [-h] file
positional arguments:
file
options:
-h, --help show this help message and exit
usage: redbeltctl config apply [-h] file
positional arguments:
file
options:
-h, --help show this help message and exit
usage: redbeltctl secrets [-h] {status,rotate} ...
positional arguments:
{status,rotate}
options:
-h, --help show this help message and exit
usage: redbeltctl secrets status [-h]
options:
-h, --help show this help message and exit
usage: redbeltctl secrets rotate [-h] secret_class
positional arguments:
secret_class
options:
-h, --help show this help message and exit
usage: redbeltctl status [-h]
options:
-h, --help show this help message and exit
usage: redbeltctl docs [-h] --directory DIRECTORY [--port PORT] {serve}
positional arguments:
{serve}
options:
-h, --help show this help message and exit
--directory DIRECTORY
--port PORT
usage: redbeltctl update [-h] [--backup-storage BACKUP_STORAGE]
[--manifest MANIFEST] [--release-id RELEASE_ID]
[--idempotency-key IDEMPOTENCY_KEY]
[--artifact-directory ARTIFACT_DIRECTORY]
{check,plan,apply}
positional arguments:
{check,plan,apply}
options:
-h, --help show this help message and exit
--backup-storage BACKUP_STORAGE
Private JSON with pinned restic binary, repository ID
and access
--manifest MANIFEST Private signed release manifest file for update
planning
--release-id RELEASE_ID
Exact release requested by the operator
--idempotency-key IDEMPOTENCY_KEY
Stable UUID for this update request
--artifact-directory ARTIFACT_DIRECTORY
Verify cached artifact files against the signed
manifest
usage: redbeltctl restore [-h] {plan,stage,operator} ...
positional arguments:
{plan,stage,operator}
plan Verify metadata without accessing storage or a target
stage Retrieve and verify exports without importing or
activating services
operator Restore configuration and identity into private
inactive staging
options:
-h, --help show this help message and exit
usage: redbeltctl restore plan [-h] --manifest MANIFEST
--public-key PUBLIC_KEY
--deployment-id DEPLOYMENT_ID
--generation-id GENERATION_ID
options:
-h, --help show this help message and exit
--manifest MANIFEST
--public-key PUBLIC_KEY
Independent base64 Ed25519 recovery public-key file
--deployment-id DEPLOYMENT_ID
--generation-id GENERATION_ID
usage: redbeltctl restore stage [-h] --manifest MANIFEST
--public-key PUBLIC_KEY
--deployment-id DEPLOYMENT_ID
--generation-id GENERATION_ID
--storage STORAGE --staging-dir STAGING_DIR
options:
-h, --help show this help message and exit
--manifest MANIFEST
--public-key PUBLIC_KEY
Independent base64 Ed25519 recovery public-key file
--deployment-id DEPLOYMENT_ID
--generation-id GENERATION_ID
--storage STORAGE Private JSON storage access configuration
--staging-dir STAGING_DIR
Absolute, new or previously owned staging root
usage: redbeltctl restore operator [-h] --manifest MANIFEST
--public-key PUBLIC_KEY
--deployment-id DEPLOYMENT_ID
--generation-id GENERATION_ID
--exports-directory EXPORTS_DIRECTORY
--output-directory OUTPUT_DIRECTORY
options:
-h, --help show this help message and exit
--manifest MANIFEST
--public-key PUBLIC_KEY
Independent base64 Ed25519 recovery public-key file
--deployment-id DEPLOYMENT_ID
--generation-id GENERATION_ID
--exports-directory EXPORTS_DIRECTORY
--output-directory OUTPUT_DIRECTORY

Related: installation, configuration, updates, and recovery.