forked from pgbackrest/pgbackrest
-
Notifications
You must be signed in to change notification settings - Fork 1
/
config.yaml
2573 lines (2368 loc) · 49.6 KB
/
config.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
####################################################################################################################################
# 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:
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-create:
command-role:
remote: {}
internal: true
log-file: false
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: {}
server: {}
server-ping:
log-file: false
parameter-allowed: true
stanza-create:
command-role:
remote: {}
lock-required: true
lock-type: all
stanza-delete:
command-role:
remote: {}
lock-required: true
lock-type: all
stanza-upgrade:
command-role:
remote: {}
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.
#
# 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).
#
# 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-literal:
# If the default is a string output it as-is without quoting. This allows C defines to be used as defaults.
#
# 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
#---------------------------------------------------------------------------------------------------------------------------------
config:
type: string
default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
default-literal: true
negate: true
config-include-path:
type: path
default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
default-literal: true
config-path:
type: path
default: CFGOPTDEF_CONFIG_PATH
default-literal: true
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: {}
fork:
section: global
type: string-id
allow-list:
- PostgreSQL
- GPDB
default: PostgreSQL
command:
annotate: {}
archive-get: {}
archive-push: {}
backup: {}
check: {}
expire: {}
restore: {}
stanza-create: {}
stanza-upgrade: {}
verify: {}
online:
type: boolean
default: true
negate: true
command:
backup: {}
stanza-create: {}
stanza-upgrade: {}
command-role:
main: {}
output:
type: string-id
default: text
command:
info: {}
repo-ls: {}
manifest: {}
verify:
default: none
allow-list:
- none
- text
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:
internal: true
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-create:
required: false
repo-get:
required: false
repo-ls:
required: false
repo-put:
required: false
repo-rm:
required: false
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:
allow-list:
- lsn
- name
- time
- xid
- preserve
- none
- immediate
- default
- standby
default: default
command-role:
main: {}
verbose:
type: boolean
default: false
command:
verify: {}
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:
annotate: {}
archive-get: {}
archive-push: {}
backup: {}
check: {}
info: {}
manifest: {}
repo-create: {}
repo-get: {}
repo-ls: {}
repo-put: {}
repo-rm: {}
restore: {}
stanza-create: {}
stanza-delete: {}
stanza-upgrade: {}
verify: {}
command-role:
local: {}
remote: {}
remote-type:
type: string-id
internal: true
required: false
allow-list:
- pg
- repo
command:
annotate: {}
archive-get: {}
archive-push: {}
backup: {}
check: {}
info: {}
manifest: {}
repo-create: {}
repo-get: {}
repo-ls: {}
repo-put: {}
repo-rm: {}
restore: {}
stanza-create: {}
stanza-delete: {}
stanza-upgrade: {}
verify: {}
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
allow-list:
- none
- asc
- desc
command:
repo-ls: {}
command-role:
main: {}
# General options
#---------------------------------------------------------------------------------------------------------------------------------
archive-timeout:
section: global
type: time
default: 60
allow-range: [0.1, 86400]
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:
annotate: {}
archive-get: {}
archive-push: {}
backup: {}
check: {}
expire: {}
info: {}
manifest: {}
repo-create: {}
repo-get: {}
repo-ls: {}
repo-put: {}
repo-rm: {}
restore: {}
server: {}
server-ping: {}
stanza-create: {}
stanza-delete: {}
stanza-upgrade: {}
verify: {}
cmd:
section: global
type: string
required: false
command:
archive-get: {}
archive-push: {}
backup: {}
check: {}
info: {}
manifest: {}
repo-create: {}
repo-get: {}
repo-ls: {}
repo-put: {}
repo-rm: {}
restore: {}
stanza-create: {}
stanza-delete: {}
stanza-upgrade: {}
verify: {}
command-role:
async: {}
main: {}
local: {}
cmd-ssh:
inherit: cmd
required: true
default: ssh
# 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
command: compress
command-role:
async: {}
main: {}
compress-level-network:
section: global
type: integer
default: 3
allow-range: [0, 9]
command:
annotate: {}
archive-get: {}
archive-push: {}
backup: {}
check: {}
info: {}
manifest: {}
repo-get: {}
repo-ls: {}
repo-put: {}
restore: {}
stanza-create: {}
stanza-delete: {}
stanza-upgrade: {}
verify: {}
command-role:
async: {}
main: {}
local: {}
compress-type:
section: global
type: string-id
default: gz
allow-list:
- none
- bz2
- gz
- lz4: HAVE_LIBLZ4
- zst: HAVE_LIBZST
command: compress
command-role:
async: {}
main: {}
db-timeout:
section: global
type: time
default: 1800
allow-range: [0.1, 604800]
command:
archive-get: {}
archive-push: {}
backup: {}
check: {}
repo-create: {}
repo-get: {}
repo-ls: {}
repo-put: {}
repo-rm: {}
stanza-create: {}
stanza-delete: {}
stanza-upgrade: {}
delta:
section: global
type: boolean
default: false
command:
backup: {}
restore: {}
command-role:
main: {}
io-timeout:
section: global
type: time
default: 60
allow-range: [0.1, 3600]
command: buffer-size
job-retry:
section: global
type: integer
internal: true
default: 2
allow-range: [0, 360]
command:
archive-get:
default: 1
archive-push:
default: 1
backup: {}
restore: {}
verify: {}
command-role:
async: {}
main: {}
local: {}
job-retry-interval:
inherit: job-retry
type: time
default: 15
allow-range: [0, 900]
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:
annotate: {}
archive-get: {}
archive-push: {}
backup: {}
check: {}
expire: {}
repo-create: {}
repo-get: {}
repo-ls: {}
repo-put: {}
repo-rm: {}
restore: {}
stanza-create: {}
stanza-delete: {}
stanza-upgrade: {}
start: {}
stop: {}
verify: {}
process-max:
section: global
type: integer
default: 1
allow-range: [1, 999]
command:
archive-get: {}
archive-push: {}
backup: {}
restore: {}
verify: {}
command-role:
async: {}
main: {}
protocol-timeout:
section: global
type: time
default: 1830
allow-range: [0.1, 604800]
command:
annotate: {}
archive-get: {}
archive-push: {}
backup: {}
check: {}
info: {}
manifest: {}
repo-create: {}
repo-get: {}
repo-ls: {}
repo-put: {}
repo-rm: {}
restore: {}
server: {}
stanza-create: {}
stanza-delete: {}
stanza-upgrade: {}
verify: {}
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
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-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