database/pgbackrest
1
0
Fork 0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2026-10-23 21:28:56 +03:00
Code Activity
Files
59bd2cd96cfba2b02b07e81ade57d9beb5f2812e
pgbackrest/build/config.yaml
David Steele 59bd2cd96c Migrate the build and documentation code from C to Python. 
The build tool in src/build becomes build/build.py with its library in build/lib, and the C part of the documentation tool in doc/src becomes doc/doc.py with its library in doc/lib. They migrate together because doc/src was built on src/build, linking its config and help parsing along with its extensions to the core types. doc.pl runs doc.py rather than building and running a C binary, and meson runs build.py for the code it generates as it builds.

The three libraries form the hierarchy the C include path did: build/lib is the base, doc/lib sits on it, and test/lib sits on both. They are implicit namespace packages so a package spans them, and a module lives in exactly one library and holds the union of what the tools need from it, since Python resolves a module name to a single file and cannot extend one the way the C included a core module and added to it. define.yaml declares which libraries each tool may import and the test runner puts only those on the path, so a test of the build library cannot reach the doc or test library any more than the build tool can.

The declarations move with the code. config.yaml, error.yaml, and postgres.yaml are now at the root of build, and help.xml becomes doc/xml/reference.xml since it is documentation that the help happens to be generated from, so the generator is told where it is rather than knowing. dist.sh moves to build as well. The documentation tool's own option declarations are gone because they existed only to generate the option parser for the C binary and doc.py parses its command line directly.

Three modules in src/build/common were never build tool code. exec, regExp, and string extend the core types for the test harness and the unit tests, which were their only users, so they move to test/src/harness. The json and xml extensions had no users outside the two tools and are removed with them, and the tests for both are trimmed to the core functions that remain.

The help unit test built its fixture by calling the generator's C functions directly, which was the last thing outside the tools that depended on them. It now runs build.py help-data to write the packed help and loads that, so it still runs against the current declarations without needing the generated C, which may not have been written when the test runs.

The manual page wrapping is a port of the wrapper the binary uses for its own help, so the manual page and pgbackrest help break lines the same way, including where a word longer than a line is left unbroken.

libyaml is no longer needed to build pgBackRest since the only thing that read yaml was the C generator. It is dropped from the development container and from every CI platform, and meson no longer looks for it. Code generation needs nothing compiled first either, so a test run no longer builds a generator before it can select the tests.

The common source list is merged into the pgbackrest source list since it existed only so the generator could be built from the same files, and the entries that were out of alphabetical order are put in order while the list is being rewritten anyway.

Every file the generator writes is byte identical to what the C wrote, for the project declarations and for the documentation's own. The documentation is checked the same way: the HTML rendered on this branch is byte identical to the HTML rendered on integration, every file of it, which exercises the whole pipeline on the real content rather than only the four files the tool writes.

Every module in both libraries is declared in define.yaml and has full line and branch coverage. The coverage list is keyed by file rather than by module name, since the same name in two languages is two files and one of them would have silently lost its requirement while both existed.

TestError becomes ToolError, since it is the error type for three tools now rather than for the harness alone.
2026-07-30 19:37:43 +07:00

2580 lines
51 KiB
YAML
Raw Blame History

####################################################################################################################################
# Configuration Definition
####################################################################################################################################
####################################################################################################################################
# Commands
#
# Define valid commands.
#
# log-file:
# Does this command log to a file? This is the default behavior, but it can be overridden in code by calling logFileInit(). The
# default is true.
#
# log-level-default:
# Defines the log level to use for default messages that are output for every command. For example, the log message that lists
# all the options passed is usually output at the info level, but that might not be appropriate for some commands, such as info,
# Allow the log level to be lowered so these common messages will not be emitted where they might be distracting.
#
# lock-required:
# Does the command require a lock? This doesn't mean a lock can't be taken explicitly later, just controls whether a lock will be
# acquired as soon as the command starts.
#
# lock-remote-required:
# Does the command require a lock on the remote? The lock will only be acquired for process id 0.
#
# lock-type:
# What type of lock is required (archive, backup, or all)?
#
# parameter-allowed
# Does the command allow parameters? If not then the config parser will automatically error out if parameters are detected. If so,
# then the command is responsible for ensuring that the parameters are valid.
####################################################################################################################################
command:
annotate:
command-role:
remote: {}
lock-remote-required: true
lock-required: true
lock-type: backup
log-file: false
archive-get:
command-role:
async: {}
local: {}
remote: {}
lock-type: archive
log-file: false
parameter-allowed: true
archive-push:
command-role:
async: {}
local: {}
remote: {}
lock-remote-required: true
lock-type: archive
log-file: false
parameter-allowed: true
backup:
command-role:
local: {}
remote: {}
lock-remote-required: true
lock-required: true
lock-type: backup
check:
command-role:
remote: {}
log-file: false
expire:
command-role:
remote: {}
lock-remote-required: true
lock-required: true
lock-type: backup
help:
log-file: false
log-level-default: DEBUG
parameter-allowed: true
info:
command-role:
remote: {}
log-file: false
log-level-default: DEBUG
manifest:
command-role:
remote: {}
internal: true
log-file: false
log-level-default: DEBUG
repo-get:
command-role:
remote: {}
log-file: false
log-level-default: DEBUG
parameter-allowed: true
repo-ls:
command-role:
remote: {}
log-file: false
log-level-default: DEBUG
parameter-allowed: true
repo-put:
command-role:
remote: {}
internal: true
log-file: false
log-level-default: DEBUG
parameter-allowed: true
repo-rm:
command-role:
remote: {}
internal: true
log-file: false
log-level-default: DEBUG
parameter-allowed: true
restore:
command-role:
local: {}
remote: {}
lock-required: true
lock-type: restore
server: {}
server-ping:
log-file: false
parameter-allowed: true
stanza-create:
command-role:
remote: {}
lock-remote-required: true
lock-required: true
lock-type: all
stanza-delete:
command-role:
remote: {}
lock-remote-required: true
lock-required: true
lock-type: all
stanza-upgrade:
command-role:
remote: {}
lock-remote-required: true
lock-required: true
lock-type: all
start: {}
stop: {}
verify:
command-role:
local: {}
remote: {}
version:
log-file: false
log-level-default: DEBUG
####################################################################################################################################
# Option Groups
#
# Options groups allow related options to be grouped together so, e.g. test and valid, operations can be run across all options in
# the group.
####################################################################################################################################
optionGroup:
pg: {}
repo: {}
####################################################################################################################################
# Options
#
# Contains the defines for options: which commands the option can/cannot be specified, for which commands it is required, default
# settings, types, ranges, whether the option may be negated, whether it has dependencies, etc. The initial section is the global
# section, meaning that the defines defined there apply to all commands listed for the option.
#
# inherit:
# Inherit all definitions for the referenced option. Any definitions can be overridden.
#
# command:
# List of commands the option can be used with. An empty hash signifies that the command does not deviate from the option
# defaults. Otherwise, overrides can be specified.
#
# If another option is referenced (e.g. command: repo-type) then the list of commands will be copied from the referenced option.
#
# Shortcuts for including multiple commands:
# +inherit: <option> - all commands from the specified option stripped of attributes
# +role: <role|any> - all commands that are valid for the role (or any role)
# -command: <command> - exclude a command (useful to trim commands from +inherit or +role)
#
# NOTE: If the option (A) has a dependency on another option (B) then the command must also be specified in the other option
# (B), else it will still error on the option (A).
#
# command-role:
# 1) Define the command roles for a command. 'main' is valid for all commands and is therefore added programmatically.
#
# 2) Define the command roles for an option. If not defined, the option will be valid for all roles of all commands for which it
# is valid. If command roles are defined for the option, then they override the roles for all commands for which the option is
# valid. 'main' must be defined explicitly in this case. For example, if an option is only valid for the 'main' role and
# the 'async' role for each command then command-role must list 'main' and 'async', meaning each command has a 'main' role
# so the option is valid for that role and for commands that have the 'async' role, it is also valid for the 'async' role of
# those commands.
#
# 3) Define the command roles for an option command override. If not defined, the option will be valid for all roles of the
# command or the roles specified by rule 2) above. 'main' must be defined explicitly in this case. If command roles are
# defined for the option command override, then they override command roles defined for the option (rule 2) above)
# and all roles defined for the command (rule 1) above).
#
# bool-like:
# Used to convert a boolean to a string or string-id type. It can be used as a boolean (e.g. --option or option=y) and the
# boolean values will be mapped to y/n. Otherwise it is used just as a string or string-id type.
#
# required:
# In global section:
# true - if the option does not have a default, then setting required in the global section means all commands listed in
# command require the user to set it.
# false - no commands listed require it as an option but it can be set. This can be overridden for individual commands by
# setting required in the command section.
# In command section:
# true - the option must be set somehow for the command, either by default or by the user, e.g.
# check:
# required: true
# false - mainly used for overriding required in the global section.
#
# default:
# Sets a default for the option for all commands if listed in the global section, or for specific commands if listed in the
# command section. All boolean types require a default.
#
# default-type:
# If 'literal' then default a string output it as-is without quoting. This allows C defines to be used as defaults.
# if 'dynamic' then default is a specially calculated value:
# bin - the value of argv[0] on execution
#
# negate:
# All config file boolean options automatically may be negated. This setting is used to maintain backward compatibility with older
# options and should not be used for new options. For instance --online would be named --offline if it were created now to avoid
# the need for negation. --no-config is another special case that would now be implemented with a separate boolean option,
# e.g. --config-ignore.
#
# reset:
# The option can be reset to default even if the default is undefined.
#
# depend:
# Specify the dependencies this option has on another option. All commands listed for this option must also be listed in the
# dependent option(s).
#
# 'default' may be specified to be set when the dependency does not resolve. This can, and probably should be, different than
# the standard default for the option.
#
# 'list' further defines the allowable settings for the depended option.
#
# allow-list:
# Lists the allowable settings for the option.
#
# internal:
# Option is used by the command internally but is not exposed in the documentation. This is useful for commands that need to know
# where they are running by looking at other options in the config. Also good for test options.
####################################################################################################################################
option:
# Command-line only options
#---------------------------------------------------------------------------------------------------------------------------------
archive-expire-before:
type: string
required: false
command:
expire: {}
command-role:
main: {}
config:
type: string
default-type: literal
default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
negate: true
config-include-path:
type: path
default-type: literal
default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
config-path:
type: path
default-type: literal
default: CFGOPTDEF_CONFIG_PATH
detail-level:
type: string-id
sequence: true
default: full
command:
info: {}
allow-list:
- full
- progress
command-role:
main: {}
dry-run:
type: boolean
default: false
command:
expire: {}
command-role:
main: {}
force:
type: boolean
default: false
command:
backup:
depend:
option: online
list:
- false
restore: {}
stanza-create:
internal: true
stanza-delete: {}
stop: {}
command-role:
main: {}
help:
type: boolean
default: false
command:
help: {}
command-role:
main: {}
oldest:
type: boolean
default: false
negate: false
command:
expire:
depend:
option: stanza
command-role:
main: {}
online:
type: boolean
default: true
negate: true
command:
backup: {}
stanza-create: {}
stanza-upgrade: {}
command-role:
main: {}
output:
type: string-id
sequence: true
default: text
command:
info: {}
repo-ls: {}
manifest: {}
verify:
default: none
allow-list:
- none
- text
version:
default: text
allow-list:
- text
- num
allow-list:
- text
- json
command-role:
main: {}
reference:
type: string
required: false
command:
manifest: {}
command-role:
main: {}
set:
type: string
required: false
command:
annotate:
required: true
expire: {}
info:
depend:
option: stanza
manifest:
default: latest
required: true
restore:
default: latest
required: true
verify: {}
command-role:
main: {}
report:
type: boolean
internal: true
default: false
command:
check: {}
command-role:
main: {}
stanza:
type: string
command:
annotate: {}
archive-get: {}
archive-push: {}
backup: {}
check:
required: false
expire: {}
info:
required: false
manifest: {}
repo-get:
required: false
internal: true
repo-ls:
required: false
internal: true
repo-put:
required: false
internal: true
repo-rm:
required: false
internal: true
restore: {}
stanza-create: {}
stanza-delete: {}
stanza-upgrade: {}
start:
required: false
stop:
required: false
verify: {}
target:
type: string
command:
restore: {}
depend:
option: type
list:
- lsn
- name
- time
- xid
command-role:
main: {}
target-action:
type: string-id
default: pause
command:
restore: {}
allow-list:
- pause
- promote
- shutdown
depend:
option: type
list:
- immediate
- lsn
- name
- time
- xid
command-role:
main: {}
target-exclusive:
type: boolean
default: false
command:
restore: {}
depend:
option: type
list:
- lsn
- time
- xid
command-role:
main: {}
target-timeline:
type: string
required: false
command:
restore: {}
depend:
option: type
list:
- default
- lsn
- name
- standby
- time
- xid
command-role:
main: {}
type:
type: string-id
command:
backup:
allow-list:
- full
- diff
- incr
default: incr
info:
required: false
allow-list:
- full
- diff
- incr
restore:
sequence: true
allow-list:
- default
- preserve
- immediate
- standby
- none
- name
- time
- lsn
- xid
default: default
command-role:
main: {}
verbose:
type: boolean
default: false
command:
verify: {}
command-role:
main: {}
version:
type: boolean
default: false
command:
help: {}
command-role:
main: {}
# Command-line only local/remote options
#---------------------------------------------------------------------------------------------------------------------------------
exec-id:
type: string
internal: true
required: false
process:
type: integer
internal: true
required: false
allow-range: [0, 1024]
command-role:
local: {}
remote: {}
lock:
type: list
internal: true
required: false
command:
annotate: {}
archive-push: {}
backup: {}
expire: {}
stanza-create: {}
stanza-delete: {}
stanza-upgrade: {}
command-role:
remote: {}
remote-type:
type: string-id
internal: true
required: false
allow-list:
- pg
- repo
command-role:
local: {}
remote: {}
# Command-line only storage options
#---------------------------------------------------------------------------------------------------------------------------------
cipher-pass:
type: string
internal: true
required: false
command:
repo-get: {}
repo-put: {}
command-role:
main: {}
filter:
type: string
required: false
command:
manifest: {}
repo-ls: {}
command-role:
main: {}
ignore-missing:
type: boolean
default: false
command:
repo-get: {}
command-role:
main: {}
raw:
type: boolean
default: false
command:
repo-get: {}
repo-put: {}
command-role:
main: {}
recurse:
type: boolean
default: false
command:
repo-ls: {}
repo-rm: {}
command-role:
main: {}
sort:
type: string-id
default: asc
sequence: true
# Keep synced with SortOrder enum
allow-list:
- none
- asc
- desc
command:
repo-ls: {}
command-role:
main: {}
# General options
#---------------------------------------------------------------------------------------------------------------------------------
allow-root:
section: global
type: boolean
default: false
command:
+role: any
restore:
default: true
archive-timeout:
section: global
type: time
default: 1m
allow-range: [100ms, 1d]
command:
archive-get: {}
archive-push: {}
backup: {}
check: {}
command-role:
main: {}
beta:
section: global
type: boolean
default: false
internal: true
beta: true
buffer-size:
section: global
type: size
default: 1MiB
allow-list:
- 16KiB
- 32KiB
- 64KiB
- 128KiB
- 256KiB
- 512KiB
- 1MiB
- 2MiB
- 4MiB
- 8MiB
- 16MiB
command:
+role: any
-command: start
-command: stop
cmd:
section: global
type: string
default-type: dynamic
default: bin
command:
+role: async
+role: local
command-role:
async: {}
main: {}
local: {}
cmd-ssh:
inherit: cmd
required: true
default-type: quote
default: ssh
command:
+role: remote
# Option is deprecated and should not be referenced outside of cfgLoadUpdateOption()
compress:
section: global
type: boolean
default: true
command:
archive-push: {}
backup: {}
command-role:
main: {}
compress-level:
section: global
type: integer
required: false
default:
- bz2: 9
- gz: 6
- lz4: 1
- zst: 3
allow-range:
- bz2: [1, 9]
- gz: [-1, 9]
- lz4: [-5, 12]
- zst: [-7, 22]
command: compress
depend:
option: compress-type
default: 0
list:
- bz2
- gz
- lz4
- zst
command-role:
async: {}
main: {}
compress-level-network:
section: global
type: integer
default: 1
allow-range: [-5, 12]
command:
+role: remote
command-role:
async: {}
main: {}
local: {}
compress-type:
section: global
type: string-id
default: gz
allow-list:
- none
- bz2
- gz
- lz4
- zst: HAVE_LIBZST
command: compress
command-role:
async: {}
main: {}
delta:
section: global
type: boolean
default: false
command:
backup: {}
restore: {}
command-role:
main: {}
io-timeout:
section: global
type: time
default: 1m
allow-range: [100ms, 1h]
command: buffer-size
job-retry:
section: global
type: integer
internal: true
default: 2
allow-range: [0, 360]
command:
+role: local
archive-get:
default: 1
archive-push:
default: 1
command-role:
async: {}
main: {}
local: {}
job-retry-interval:
inherit: job-retry
type: time
default: 15s
allow-range: [0s, 15m]
command:
+role: local
lock-path:
section: global
type: path
default: /tmp/pgbackrest
command:
annotate: {}
archive-get: {}
archive-push: {}
backup: {}
expire: {}
info: {}
restore: {}
stanza-create: {}
stanza-delete: {}
stanza-upgrade: {}
start: {}
stop: {}
neutral-umask:
section: global
type: boolean
default: true
command:
+role: any
-command: info
-command: manifest
-command: server
-command: server-ping
priority:
section: global
type: integer
required: false
allow-range: [-20, 19]
process-max:
section: global
type: integer
default: 1
allow-range: [1, 999]
command:
+role: local
command-role:
async: {}
main: {}
protocol-timeout:
section: global
type: time
default: 31m
allow-range: [100ms, 7d]
command:
+role: any
-command: start
-command: stop
-command: server-ping
spool-path:
section: global
type: path
default: /var/spool/pgbackrest
command:
archive-get:
depend:
option: archive-async
list:
- true
archive-push:
depend:
option: archive-async
list:
- true
restore:
internal: true
command-role:
async: {}
main: {}
local: {}
# TCP and socket options
#---------------------------------------------------------------------------------------------------------------------------------
sck-block:
section: global
type: boolean
default: false
internal: true
command: buffer-size
sck-keep-alive:
type: boolean
section: global
default: true
command: buffer-size
tcp-keep-alive-count:
section: global
type: integer
required: false
allow-range: [1, 32]
command: buffer-size
depend:
option: sck-keep-alive
list:
- true
tcp-keep-alive-idle:
section: global
type: integer
required: false
allow-range: [1, 3600]
command: buffer-size
depend: tcp-keep-alive-count
tcp-keep-alive-interval:
section: global
type: integer
required: false
allow-range: [1, 900]
command: buffer-size
depend: tcp-keep-alive-count
# TLS allowed ciphers
tls-cipher-12:
section: global
type: string
required: false
command: buffer-size
tls-cipher-13:
inherit: tls-cipher-12
# Logging options
#---------------------------------------------------------------------------------------------------------------------------------
log-level-console:
section: global
type: string-id
sequence: true
default: warn
# Keep synced with logLevelList array. Note that assert is missing from this list but handled in logLevelEnum().
allow-list:
- off
- error
- warn
- info
- detail
- debug
- trace
log-level-file:
inherit: log-level-console
default: info
log-level-stderr:
inherit: log-level-console
default: off
log-path:
section: global
type: path
default: /var/log/pgbackrest
log-subprocess:
section: global
type: boolean
default: false
command:
+role: async
+role: local
+role: remote
log-timestamp:
section: global
type: boolean
default: true
command: log-level-console
# Archive command options
#---------------------------------------------------------------------------------------------------------------------------------
archive-async:
section: global
type: boolean
default: false
command:
archive-get: {}
archive-push: {}
archive-get-queue-max:
section: global
type: size
default: 128MiB
allow-range: [0B, 4PiB]
command:
archive-get: {}
command-role:
async: {}
main: {}
archive-header-check:
section: global
type: boolean
default: true
command:
archive-push: {}
command-role:
main: {}
async: {}
archive-missing-retry:
section: global
type: boolean
default: true
command:
archive-get: {}
command-role:
main: {}
archive-push-batch-size:
section: global
type: size
default: 16GiB
allow-range: [1MiB, 4PiB]
command:
archive-push: {}
command-role:
async: {}
main: {}
archive-push-queue-max:
section: global
type: size
required: false
allow-range: [0B, 4PiB]
command:
archive-push: {}
command-role:
async: {}
main: {}
deprecate:
archive-queue-max: {}
# Backup command options
#---------------------------------------------------------------------------------------------------------------------------------
annotation:
section: global
type: hash
required: false
command:
annotate:
required: true
backup: {}
command-role:
main: {}
archive-check:
section: global
type: boolean
default: true
command:
archive-push: {}
backup:
depend:
option: online
default: false
list:
- true
check: {}
command-role:
async: {}
main: {}
archive-copy:
section: global
type: boolean
default: false
command:
backup:
depend:
option: archive-check
default: false
list:
- true
command-role:
main: {}
archive-mode-check:
section: global
type: boolean
default: true
command:
archive-push: {}
backup: {}
check: {}
command-role:
async: {}
main: {}
depend:
option: archive-check
default: false
list:
- true
backup-standby:
section: global
type: string-id
sequence: true
bool-like: true
default: n
allow-list:
- n
- prefer
- y
command:
backup: {}
check: {}
command-role:
main: {}
checksum-page:
section: global
type: boolean
required: false
command:
backup: {}
command-role:
main: {}
page-header-check:
section: global
type: boolean
default: true
command:
backup: {}
command-role:
main: {}
exclude:
section: global
type: list
required: false
command:
backup: {}
command-role:
main: {}
expire-auto:
section: global
type: boolean
default: true
command:
backup: {}
command-role:
main: {}
manifest-save-threshold:
section: global
type: size
default: 1GiB
allow-range: [1B, 1TiB]
command:
backup: {}
command-role:
main: {}
resume:
section: global
type: boolean
default: true
command:
backup: {}
command-role:
main: {}
start-fast:
section: global
type: boolean
default: false
command:
backup: {}
command-role:
main: {}
stop-auto:
section: global
type: boolean
default: false
internal: true
command:
backup: {}
command-role:
main: {}
# Restore command options
#---------------------------------------------------------------------------------------------------------------------------------
archive-mode:
section: global
type: string-id
sequence: true
default: preserve
allow-list:
- preserve
- off
command:
restore: {}
command-role:
main: {}
db-exclude:
section: global
type: list
required: false
command:
restore: {}
command-role:
main: {}
db-include:
section: global
type: list
required: false
command:
restore: {}
command-role:
main: {}
link-all:
section: global
type: boolean
default: false
command:
restore: {}
command-role:
main: {}
link-map:
section: global
type: hash
required: false
command:
restore: {}
command-role:
main: {}
tablespace-map:
section: global
type: hash
required: false
command:
restore: {}
command-role:
main: {}
tablespace-map-all:
section: global
type: string
required: false
command:
restore: {}
command-role:
main: {}
recovery-option:
section: global
type: hash
required: false
command:
restore: {}
command-role:
main: {}
depend:
option: type
list:
- default
- immediate
- lsn
- name
- time
- standby
- xid
# Server command options
#---------------------------------------------------------------------------------------------------------------------------------
tls-server-ca-file:
section: global
type: path
command:
server: {}
tls-server-cert-file:
section: global
type: path
command:
server: {}
tls-server-key-file:
section: global
type: path
command:
server: {}
tls-server-auth:
section: global
type: hash
command:
server: {}
tls-server-address:
section: global
type: string
default: localhost
command:
server: {}
server-ping: {}
tls-server-port:
section: global
type: integer
default: 8432
allow-range: [1, 65535]
command:
server: {}
server-ping: {}
# PostgreSQL common options
#---------------------------------------------------------------------------------------------------------------------------------
pg:
type: integer
internal: true
required: false
allow-range: [1, 256]
command:
backup:
command-role:
local: {}
manifest:
command-role:
main: {}
pg-path:
section: stanza
group: pg
type: path
command:
archive-get: {}
archive-push:
required: false
backup: {}
check:
depend:
option: stanza
manifest:
required: false
restore: {}
stanza-create: {}
stanza-delete: {}
stanza-upgrade: {}
deprecate:
db-path: {}
db?-path: {}
# PostgreSQL host options
#---------------------------------------------------------------------------------------------------------------------------------
pg-local:
section: stanza
group: pg
type: boolean
internal: true
default: false
command:
+inherit: pg-path
archive-get:
internal: true
archive-push:
internal: true
restore:
internal: true
command-role:
async: {}
main: {}
local: {}
pg-host:
section: stanza
group: pg
type: string
required: false
command: pg-local
command-role:
async: {}
main: {}
local: {}
depend:
option: pg-local
list:
- false
deprecate:
db-host: {}
db?-host: {}
pg-host-type:
section: global
group: pg
type: string-id
default: ssh
allow-list:
- ssh
- tls
command:
+inherit: pg-host
-command: archive-get
-command: archive-push
-command: restore
command-role:
async: {}
main: {}
local: {}
depend:
option: pg-host
pg-host-cert-file:
section: global
group: pg
type: string
command: pg-host-type
command-role:
async: {}
main: {}
local: {}
depend:
option: pg-host-type
list:
- tls
pg-host-key-file:
inherit: pg-host-cert-file
pg-host-ca-file:
inherit: pg-host-cert-file
required: false
pg-host-ca-path:
inherit: pg-host-cert-file
required: false
pg-host-cmd:
section: stanza
group: pg
type: string
default-type: dynamic
default: bin
command: pg-host-type
command-role:
async: {}
main: {}
local: {}
depend:
option: pg-host-type
list:
- ssh
deprecate:
db-cmd: {}
db?-cmd: {}
pg-host-config:
section: stanza
group: pg
type: path
default-type: literal
default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
command: pg-host-type
command-role:
async: {}
main: {}
local: {}
depend:
option: pg-host
deprecate:
db-config: {}
db?-config: {}
pg-host-config-include-path:
inherit: pg-host-config
type: path
default-type: literal
default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
required: true
pg-host-config-path:
inherit: pg-host-config
type: path
default-type: literal
default: CFGOPTDEF_CONFIG_PATH
required: true
pg-host-port:
inherit: pg-host-cmd
type: integer
default-type: quote
default: ~
required: false
allow-range: [0, 65535]
default:
- tls: 8432
depend:
option: pg-host-type
list:
- ssh
- tls
deprecate:
db-ssh-port: {}
db?-ssh-port: {}
pg-host-user:
inherit: pg-host-cmd
default-type: quote
default: postgres
required: false
depend:
option: pg-host-type
list:
- ssh
deprecate:
db-user: {}
db?-user: {}
# PostgreSQL connection options (directly to PostgreSQL not the host)
#---------------------------------------------------------------------------------------------------------------------------------
pg-database:
section: stanza
group: pg
type: string
command:
backup: {}
check: {}
stanza-create: {}
stanza-delete: {}
stanza-upgrade: {}
default: postgres
depend:
option: pg-path
db-timeout:
section: global
type: time
default: 30m
allow-range: [100ms, 7d]
command: pg-database
pg-port:
section: stanza
group: pg
type: integer
default: 5432
allow-range: [0, 65535]
command: pg-database
depend: pg-database
deprecate:
db-port: {}
db?-port: {}
# Despite the name this option needs to be string type rather than path to allow abstract sockets beginning with @
pg-socket-path:
section: stanza
group: pg
type: string
required: false
command: pg-database
depend: pg-database
deprecate:
db-socket-path: {}
db?-socket-path: {}
pg-user:
section: stanza
group: pg
type: string
required: false
command: pg-database
depend: pg-database
pg-version-force:
section: stanza
type: string
required: false
command:
archive-get: {}
archive-push: {}
backup: {}
check: {}
manifest: {}
restore: {}
stanza-create: {}
stanza-delete: {}
stanza-upgrade: {}
verify: {}
# Repository common options
#---------------------------------------------------------------------------------------------------------------------------------
repo:
type: integer
required: false
allow-range: [1, 256]
command:
annotate: {}
archive-get: {}
archive-push:
command-role:
remote: {}
backup: {}
check:
command-role:
remote: {}
expire: {}
info: {}
manifest: {}
repo-get: {}
repo-ls: {}
repo-put: {}
repo-rm: {}
restore: {}
stanza-create:
command-role:
remote: {}
stanza-delete: {}
stanza-upgrade:
command-role:
remote: {}
verify: {}
repo-type:
section: global
group: repo
type: string-id
default: posix
allow-list:
- azure
- cifs
- gcs
- posix
- s3
- sftp: HAVE_LIBSSH2
command:
+inherit: repo
deprecate:
repo-type: {}
repo-path:
section: global
group: repo
type: path
default: /var/lib/pgbackrest
command: repo-type
deprecate:
repo-path: {}
repo-cipher-type:
section: global
type: string-id
group: repo
default: none
allow-list:
- none
- aes-256-cbc
command: repo-type
deprecate:
repo-cipher-type: {}
repo-cipher-pass:
section: global
type: string
secure: true
command: repo-type
depend:
option: repo-cipher-type
list:
- aes-256-cbc
group: repo
deprecate:
repo-cipher-pass: {}
repo-hardlink:
section: global
group: repo
type: boolean
default: false
command:
backup: {}
command-role:
main: {}
depend:
option: repo-bundle
default: false
list:
- false
deprecate:
hardlink: {}
repo-symlink:
section: global
group: repo
type: boolean
default: true
command:
backup: {}
expire: {}
command-role:
main: {}
depend:
option: repo-type
default: false
list:
- posix
repo-target-time:
section: global
type: string
required: false
command:
archive-get: {}
info: {}
manifest: {}
repo-get: {}
repo-ls: {}
restore: {}
verify: {}
command-role:
async: {}
main: {}
local: {}
# Repository retention options
#---------------------------------------------------------------------------------------------------------------------------------
repo-retention-full-type:
section: global
group: repo
type: string-id
sequence: true
default: count
allow-list:
- count
- time
command:
backup: {}
expire: {}
command-role:
main: {}
repo-retention-full:
section: global
group: repo
type: integer
required: false
allow-range: [1, 9999999]
command: repo-retention-full-type
command-role:
main: {}
deprecate:
retention-full: {}
repo-retention-diff:
section: global
group: repo
type: integer
required: false
allow-range: [1, 9999999]
command:
backup: {}
expire: {}
command-role:
main: {}
deprecate:
retention-diff: {}
repo-retention-archive-type:
section: global
type: string-id
group: repo
default: full
allow-list:
- full
- diff
- incr
command:
backup: {}
expire: {}
command-role:
main: {}
deprecate:
retention-archive-type: {}
repo-retention-archive:
section: global
group: repo
type: integer
required: false
allow-range: [1, 9999999]
command:
backup: {}
expire: {}
command-role:
main: {}
deprecate:
retention-archive: {}
repo-retention-history:
section: global
group: repo
type: integer
required: false
allow-range: [0, 9999999]
command:
backup: {}
expire: {}
command-role:
main: {}
# Repository bundle and block options
#---------------------------------------------------------------------------------------------------------------------------------
repo-bundle:
section: global
group: repo
type: boolean
default: false
command:
backup: {}
command-role:
main: {}
repo-bundle-size:
section: global
group: repo
type: size
default: 20MiB
allow-range: [1MiB, 1PiB]
command:
backup: {}
command-role:
main: {}
depend:
option: repo-bundle
list:
- true
repo-bundle-limit:
inherit: repo-bundle-size
default: 2MiB
allow-range: [8KiB, 1PiB]
repo-block:
section: global
group: repo
type: boolean
default: false
command:
backup: {}
command-role:
main: {}
depend:
option: repo-bundle
default: false
list:
- true
repo-block-size-map:
section: global
group: repo
type: hash
required: false
internal: true
command: repo-block
command-role:
main: {}
depend:
option: repo-block
list:
- true
repo-block-age-map:
inherit: repo-block-size-map
repo-block-checksum-size-map:
inherit: repo-block-size-map
repo-block-size-super:
section: global
group: repo
type: size
default: 256KiB
allow-range: [32KiB, 16MiB]
internal: true
command: repo-block
command-role:
main: {}
depend:
option: repo-block
list:
- true
repo-block-size-super-full:
inherit: repo-block-size-super
default: 1MiB
# Repository host options
#---------------------------------------------------------------------------------------------------------------------------------
repo-local:
section: global
group: repo
type: boolean
internal: true
default: false
command:
+inherit: repo
command-role:
async: {}
main: {}
local: {}
repo-host:
section: global
group: repo
type: string
required: false
command: repo-local
command-role:
async: {}
main: {}
local: {}
depend:
option: repo-local
list:
- false
deprecate:
backup-host: {}
repo-host-type:
section: global
group: repo
type: string-id
default: ssh
allow-list:
- ssh
- tls
command: repo-local
command-role:
async: {}
main: {}
local: {}
depend:
option: repo-host
repo-host-cert-file:
section: global
group: repo
type: string
command: repo-local
command-role:
async: {}
main: {}
local: {}
depend:
option: repo-host-type
list:
- tls
repo-host-key-file:
inherit: repo-host-cert-file
repo-host-ca-file:
inherit: repo-host-cert-file
required: false
repo-host-ca-path:
inherit: repo-host-cert-file
required: false
repo-host-cmd:
section: global
group: repo
type: string
default-type: dynamic
default: bin
command: repo-local
command-role:
async: {}
main: {}
local: {}
depend:
option: repo-host-type
list:
- ssh
deprecate:
backup-cmd: {}
repo-host-config:
section: global
group: repo
type: string
command: repo-host-cmd
command-role:
async: {}
main: {}
local: {}
default-type: literal
default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
depend:
option: repo-host
deprecate:
backup-config: {}
repo-host-config-include-path:
inherit: repo-host-config
type: path
default-type: literal
default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
repo-host-config-path:
inherit: repo-host-config
type: path
default-type: literal
default: CFGOPTDEF_CONFIG_PATH
repo-host-port:
section: global
group: repo
type: integer
required: false
allow-range: [0, 65535]
default:
- tls: 8432
depend:
option: repo-host-type
list:
- ssh
- tls
command: repo-host-cmd
command-role:
async: {}
main: {}
local: {}
deprecate:
backup-ssh-port: {}
repo-host-user:
section: global
group: repo
type: string
required: false
command: repo-host-cmd
command-role:
async: {}
main: {}
local: {}
default: pgbackrest
depend:
option: repo-host-type
list:
- ssh
deprecate:
backup-user: {}
# Repository common storage options
#---------------------------------------------------------------------------------------------------------------------------------
repo-storage-verify-tls:
section: global
group: repo
type: boolean
default: true
command: repo-type
depend:
option: repo-type
list:
- azure
- gcs
- s3
deprecate:
repo-s3-verify-ssl: {}
repo?-azure-verify-tls: {}
repo?-s3-verify-ssl: {}
repo?-s3-verify-tls: {}
repo-storage-ca-file:
section: global
group: repo
type: string
required: false
command: repo-type
depend: repo-storage-verify-tls
deprecate:
repo-s3-ca-file: {}
repo?-azure-ca-file: {}
repo?-s3-ca-file: {}
repo-storage-ca-path:
inherit: repo-storage-ca-file
type: path
deprecate:
repo-s3-ca-path: {}
repo?-azure-ca-path: {}
repo?-s3-ca-path: {}
repo-storage-host:
section: global
group: repo
type: string
required: false
command: repo-type
depend:
option: repo-type
list:
- azure
- s3
deprecate:
repo-s3-host: {}
repo?-azure-host: {}
repo?-s3-host: {}
repo-storage-port:
section: global
group: repo
type: integer
default: 443
allow-range: [1, 65535]
command: repo-type
depend: repo-storage-host
deprecate:
repo?-azure-port: {}
repo?-s3-port: {}
repo-storage-tag:
section: global
group: repo
type: hash
required: false
command: repo-type
depend:
option: repo-type
list:
- azure
- gcs
- s3
repo-storage-prefetch:
section: global
group: repo
type: integer
default: 3
allow-range: [0, 1024]
command: repo-type
depend:
option: repo-type
list:
- azure
- gcs
- s3
repo-storage-read-over:
section: global
group: repo
type: size
default: 64KiB
allow-range: [0B, 1MiB]
command: repo-type
depend:
option: repo-type
list:
- azure
- gcs
- s3
repo-storage-upload-chunk-size:
section: global
group: repo
type: size
default:
- azure: 4MiB
- gcs: 4MiB
- s3: 5MiB
allow-range:
- azure: [4MiB, 1GiB]
- gcs: [4MiB, 1GiB]
- s3: [5MiB, 1GiB]
command: repo-type
depend:
option: repo-type
list:
- azure
- gcs
- s3
# Repository Azure storage options
#---------------------------------------------------------------------------------------------------------------------------------
repo-azure-account:
section: global
type: string
group: repo
secure: true
command: repo-type
depend:
option: repo-type
list:
- azure
repo-azure-container:
section: global
type: string
group: repo
command: repo-type
depend: repo-azure-account
repo-azure-endpoint:
inherit: repo-azure-account
default: blob.core.windows.net
repo-azure-key:
inherit: repo-azure-account
required: false
depend:
option: repo-azure-key-type
list:
- shared
- sas
repo-azure-key-type:
inherit: repo-azure-container
type: string-id
sequence: true
default: shared
# Keep synced StorageAzureKeyType enum
allow-list:
- shared
- sas
- auto
repo-azure-uri-style:
section: global
group: repo
type: string-id
sequence: true
default: host
# Keep synced StorageAzureUriStyle enum
allow-list:
- host
- path
command: repo-type
depend: repo-azure-account
# Repository GCS storage options
#---------------------------------------------------------------------------------------------------------------------------------
repo-gcs-bucket:
section: global
type: string
group: repo
command: repo-type
depend:
option: repo-gcs-key-type
repo-gcs-endpoint:
section: global
type: string
group: repo
default: storage.googleapis.com
command: repo-type
depend: repo-gcs-bucket
repo-gcs-key-type:
section: global
type: string-id
sequence: true
group: repo
default: service
# Keep synced StorageGcsKeyType enum
allow-list:
- service
- token
- auto
command: repo-type
depend:
option: repo-type
list:
- gcs
repo-gcs-key:
section: global
type: string
group: repo
secure: true
command: repo-type
depend:
option: repo-gcs-key-type
list:
- service
- token
repo-gcs-user-project:
section: global
type: string
group: repo
required: false
command: repo-type
# Repository S3 storage options
#---------------------------------------------------------------------------------------------------------------------------------
repo-s3-bucket:
section: global
group: repo
type: string
command: repo-type
depend:
option: repo-type
list:
- s3
deprecate:
repo-s3-bucket: {}
repo-s3-endpoint:
inherit: repo-s3-bucket
deprecate:
repo-s3-endpoint: {}
repo-s3-key-type:
inherit: repo-s3-bucket
type: string-id
sequence: true
default: shared
# Keep synced with StorageS3KeyType enum
allow-list:
- shared
- auto
- web-id
- pod-id
- process
repo-s3-key:
section: global
group: repo
type: string
secure: true
command: repo-type
depend:
option: repo-s3-key-type
list:
- shared
deprecate:
repo-s3-key: {}
repo-s3-key-secret:
inherit: repo-s3-key
deprecate:
repo-s3-key-secret: {}
repo-s3-kms-key-id:
inherit: repo-s3-bucket
required: false
repo-s3-sse-customer-key:
inherit: repo-s3-bucket
required: false
secure: true
repo-s3-region:
inherit: repo-s3-bucket
deprecate:
repo-s3-region: {}
repo-s3-role:
inherit: repo-s3-bucket
required: false
depend:
option: repo-s3-key-type
list:
- auto
repo-s3-process-cmd:
inherit: repo-s3-bucket
type: list
depend:
option: repo-s3-key-type
list:
- process
repo-s3-token:
inherit: repo-s3-key
required: false
command: repo-type
repo-s3-requester-pays:
section: global
group: repo
type: boolean
default: false
command: repo-type
depend:
option: repo-type
list:
- s3
repo-s3-service:
inherit: repo-s3-bucket
default: s3
required: false
repo-s3-sts-host:
inherit: repo-s3-bucket
default: sts.amazonaws.com
depend:
option: repo-s3-key-type
list:
- web-id
repo-s3-uri-style:
section: global
group: repo
type: string-id
sequence: true
default: host
# Keep synced with StorageS3UriStyle enum
allow-list:
- host
- path
command: repo-type
depend: repo-s3-bucket
# Repository SFTP storage options
#---------------------------------------------------------------------------------------------------------------------------------
repo-sftp-host:
section: global
group: repo
type: string
command: repo-type
depend:
option: repo-type
list:
- sftp
repo-sftp-host-fingerprint:
section: global
group: repo
type: string
required: false
command: repo-type
depend:
option: repo-sftp-host-key-check-type
list:
- fingerprint
- strict
repo-sftp-host-key-check-type:
section: global
group: repo
type: string-id
default: strict
allow-list:
- accept-new
- fingerprint
- none
- strict
command: repo-type
depend: repo-sftp-host
repo-sftp-host-key-hash-type:
section: global
group: repo
type: string-id
allow-list:
- md5
- sha1
- sha256
command: repo-type
depend: repo-sftp-host
repo-sftp-host-port:
section: global
group: repo
type: integer
default: 22
allow-range: [1, 65535]
command: repo-type
depend: repo-sftp-host
repo-sftp-host-user:
section: global
group: repo
type: string
command: repo-type
depend: repo-sftp-host
repo-sftp-known-host:
section: global
group: repo
type: list
required: false
command: repo-type
depend:
option: repo-sftp-host-key-check-type
list:
- accept-new
- strict
repo-sftp-private-key-file:
section: global
group: repo
type: string
command: repo-type
depend: repo-sftp-host
repo-sftp-private-key-passphrase:
section: global
group: repo
type: string
required: false
secure: true
command: repo-type
depend: repo-sftp-host
repo-sftp-public-key-file:
section: global
group: repo
type: string
required: false
command: repo-type
depend: repo-sftp-host
View Git Blame Copy Permalink