| title | pg hardstorage residency | ||
|---|---|---|---|
| description | CLI reference for the pg hardstorage residency command. | ||
| tags |
|
Data-residency pinning for a deployment
Constrain a deployment's repository to a set of allowed regions.
Match rules: case-insensitive, hyphen-aware prefix. residency=["eu"] matches eu-west-1, eu-central-1, ... residency=["eu-west-1"] matches only eu-west-1 residency=[] no constraint (default)
Storage plugins implement an optional Region() method; the fs plugin reports the empty string ("region unknown") and FAILS any non-empty residency check — local-disk repos can't enforce residency, and silently treating that as a pass would defeat the purpose.
pg_hardstorage residency [flags]
-h, --help help for residency
--airgapped airgapped: strict refuse outbound endpoints (LLM providers, sinks, OTLP collectors) outside loopback / RFC1918 / explicit airgap.allowlist. Also enabled by PG_HARDSTORAGE_AIRGAPPED=1 or airgapped: strict in the config file.
-c, --config string path to config file (default: XDG/FHS lookup)
--cpu-profile go tool pprof <path> write a pprof CPU profile to this path for the duration of the command (go tool pprof <path> to analyse). Off when empty.
--mem-profile string write a pprof heap profile to this path at command exit. Off when empty.
--no-color disable ANSI color in text output
--on-error-llm on a structured-error failure, drop into the matching LLM helper skill (auto_on_error trigger). Also enabled by PG_HARDSTORAGE_ON_ERROR_LLM=1.
--otel-endpoint string OpenTelemetry OTLP/HTTP endpoint (e.g. http://otel-collector:4318); empty disables tracing
--otel-stdout also export OpenTelemetry traces to stderr (useful for dev)
-o, --output string output format: text|json|ndjson|yaml|template|csv|markdown|html|tap|junit|pdf (default: text on TTY, json off-TTY)
--profile-port go tool pprof http://127.0.0.1:6060/debug/pprof/profile?seconds=30 if non-zero, expose net/http/pprof on 127.0.0.1:<port> for live profiling of long-running commands (e.g. go tool pprof http://127.0.0.1:6060/debug/pprof/profile?seconds=30). Off when zero.
-q, --quiet suppress non-essential output
--template string Go text/template applied when --output template (or implied if --template is set without --output)
- pg_hardstorage - PostgreSQL backup, done right.
- pg_hardstorage residency check - Verify the configured repo's region matches the deployment's residency policy
- pg_hardstorage residency clear - Remove residency constraint (allow any region)
- pg_hardstorage residency list - Show every deployment's residency policy
- pg_hardstorage residency set - Pin a deployment to one or more allowed regions