Skip to content

pg_hardstorage_standby.md

Latest commit

 

History

History
61 lines (46 loc) · 3.73 KB

pg_hardstorage_standby.md

File metadata and controls

61 lines (46 loc) · 3.73 KB
Raw
title pg hardstorage standby
description CLI reference for the pg hardstorage standby command.
tags
cli
reference

pg_hardstorage standby

Hot-standby restore — read-only replica fed entirely from the backup pipeline

Synopsis

Manage hot-standby PostgreSQL instances fed by the backup pipeline.

A standby is a configured PGDATA dir with standby.signal + restore_command pointing at our 'wal fetch' shim. PG starts in recovery mode, applies the restored backup, and continuously pulls new WAL from the repository — without touching the source PG.

v0.1 provisions the data dir; the operator starts PG via systemd or pg_ctl. The Result body emits the recommended invocation.

The state file lives under paths.State()/standbys.json — same back-compat commitment (24-month) as the manifest schema.

Options

  -h, --help   help for standby

Options inherited from parent commands

      --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)

SEE ALSO