/
user-guide.xml
3902 lines (2953 loc) · 225 KB
/
user-guide.xml
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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE doc SYSTEM "doc.dtd">
<doc title="{[project]} User Guide" subtitle="{[user-guide-subtitle]}" cmd-line-len="85">
<description>The {[project]} User Guide demonstrates how to quickly and easily setup {[project]} for your {[postgres]} database. Step-by-step instructions lead the user through all the important features of the fastest, most reliable {[postgres]} backup and restore solution.</description>
<!-- ======================================================================================================================= -->
<variable-list>
<!-- Defined OS types -->
<variable key="os-debian">debian</variable>
<variable key="os-rhel">rhel</variable>
<!-- OS titles -->
<variable key="os-debian-title">Debian & Ubuntu</variable>
<variable key="os-rhel-title">RHEL</variable>
<!-- Base PostgreSQL versions -->
<variable key="os-debian-pg-version">12</variable>
<variable key="os-rhel-pg-version">10</variable>
<!-- User-defined package to use in documentation (use "apt" to install the current PGDG apt package) -->
<variable key="package">none</variable>
<!-- Defines the general OS type that will be used to generate commands. Also supported: rhel -->
<variable key="os-type">debian</variable>
<!-- Will encryption be used in the documentation? It can be useful for testing to omit encryption. -->
<variable key="encrypt">y</variable>
<!-- Will stress-testing be performed? -->
<variable key="stress">n</variable>
<variable key="stress-scale-table">1</variable> <!-- Tables to create * 1000 -->
<variable key="stress-scale-data">1</variable> <!-- Value passed to pgbench -s -->
<!-- Common if expressions for testing os-type -->
<variable key="os-type-is-debian">'{[os-type]}' eq '{[os-debian]}'</variable>
<variable key="os-type-is-rhel">'{[os-type]}' eq '{[os-rhel]}'</variable>
<!-- Defines the container image that will be used to build the host -->
<variable key="os-image" if="{[os-type-is-debian]}">ubuntu:18.04</variable>
<variable key="os-image" if="{[os-type-is-rhel]}">rockylinux/rockylinux:8</variable>
<variable key="user-guide-subtitle" if="{[os-type-is-debian]}">{[os-debian-title]}</variable>
<variable key="user-guide-subtitle" if="{[os-type-is-rhel]}">{[os-rhel-title]}</variable>
<variable key="user-guide-os" if="{[os-type-is-debian]}">Debian/Ubuntu</variable>
<variable key="user-guide-os" if="{[os-type-is-rhel]}">RHEL 7-8</variable>
<variable key="pgbackrest-repo-path">/pgbackrest</variable>
<!-- Path where CA certificates are installed -->
<variable key="ca-cert-path" if="{[os-type-is-debian]}">/usr/local/share/ca-certificates</variable>
<variable key="ca-cert-path" if="{[os-type-is-rhel]}">/etc/pki/ca-trust/source/anchors</variable>
<!-- Path where fake certificates are located -->
<variable key="fake-cert-path-relative">resource/fake-cert</variable>
<variable key="fake-cert-path">{[host-repo-path]}/doc/{[fake-cert-path-relative]}</variable>
<!-- Protocol type (ssh/tls) used for remotes -->
<variable key="protocol-ssh">'{[os-type]}' eq '{[os-debian]}'</variable>
<variable key="protocol-tls">'{[os-type]}' eq '{[os-rhel]}'</variable>
<!-- Path where builds are performed -->
<variable key="build-path">/build</variable>
<variable key="build-br-path">{[build-path]}/pgbackrest-release-{[version]}</variable>
<!-- PostreSQL versions to run documentation for and min/max versions represented -->
<variable key="pg-version" if="{[os-type-is-debian]}">{[os-debian-pg-version]}</variable>
<variable key="pg-version" if="{[os-type-is-rhel]}">{[os-rhel-pg-version]}</variable>
<variable key="pg-version-nodot" eval="y">my $version = '{[pg-version]}'; $version =~ s/\.//g; return $version;</variable>
<!-- WAL level should be the minimum required for replication -->
<variable key="wal-level" if="{[pg-version]} < 9.6">hot_standby</variable>
<variable key="wal-level" if="{[pg-version]} >= 9.6">replica</variable>
<variable key="pg-version-upgrade" if="{[os-type-is-debian]}">14</variable>
<variable key="pg-version-upgrade" if="{[os-type-is-rhel]}">11</variable>
<variable key="pg-version-upgrade-nodot" eval="y">my $version = '{[pg-version-upgrade]}'; $version =~ s/\.//g; return $version;</variable>
<variable key="pg-bin-path" if="{[os-type-is-debian]}">/usr/lib/postgresql/{[pg-version]}/bin</variable>
<variable key="pg-bin-path" if="{[os-type-is-rhel]}">/usr/pgsql-{[pg-version]}/bin</variable>
<variable key="pg-bin-upgrade-path" if="{[os-type-is-debian]}">/usr/lib/postgresql/{[pg-version-upgrade]}/bin</variable>
<variable key="pg-bin-upgrade-path" if="{[os-type-is-rhel]}">/usr/pgsql-{[pg-version-upgrade]}/bin</variable>
<variable key="pg-home-path" if="{[os-type-is-debian]}">/var/lib/postgresql</variable>
<variable key="pg-home-path" if="{[os-type-is-rhel]}">/var/lib/pgsql</variable>
<variable key="pg-group">postgres</variable>
<variable key="backrest-repo-path">/var/lib/pgbackrest</variable>
<variable key="backrest-repo-cipher-type">aes-256-cbc</variable>
<variable key="backrest-repo-cipher-pass">zWaf6XtpjIVZC5444yXB+cgFDFl7MxGlgkZSaoPvTGirhPygu4jOKOXf9LO4vjfO</variable>
<variable key="br-bin">/usr/bin/pgbackrest</variable>
<variable key="br-user">pgbackrest</variable>
<variable key="br-group">{[br-user]}</variable>
<variable key="br-home-path">/home/{[br-user]}</variable>
<variable key="postgres-cluster-demo">demo</variable>
<variable key="backrest-config-path">/etc/{[project-exe]}</variable>
<variable key="backrest-config-include-path">{[backrest-config-path]}/conf.d</variable>
<variable if="'{[package]}' eq 'none'" key="backrest-config-demo">{[backrest-config-path]}/{[project-exe]}.conf</variable>
<variable if="'{[package]}' ne 'none'" key="backrest-config-demo">/etc/{[project-exe]}.conf</variable>
<variable key="pg-path-default" if="{[os-type-is-debian]}">/var/lib/postgresql/[version]/[cluster]</variable>
<variable key="pg-path-default" if="{[os-type-is-rhel]}">/var/lib/pgsql/[version]/data</variable>
<variable key="pg-path" if="{[os-type-is-debian]}">/var/lib/postgresql/{[pg-version]}/{[postgres-cluster-demo]}</variable>
<variable key="pg-path" if="{[os-type-is-rhel]}">/var/lib/pgsql/{[pg-version]}/data</variable>
<variable key="pg-path-upgrade" if="{[os-type-is-debian]}">/var/lib/postgresql/{[pg-version-upgrade]}/{[postgres-cluster-demo]}</variable>
<variable key="pg-path-upgrade" if="{[os-type-is-rhel]}">/var/lib/pgsql/{[pg-version-upgrade]}/data</variable>
<variable key="spool-path">/var/spool/pgbackrest</variable>
<variable key="postgres-config-demo" if="{[os-type-is-debian]}">/etc/postgresql/{[pg-version]}/{[postgres-cluster-demo]}/postgresql.conf</variable>
<variable key="postgres-config-demo" if="{[os-type-is-rhel]}">{[pg-path]}/postgresql.conf</variable>
<variable key="postgres-config-demo-upgrade" if="{[os-type-is-debian]}">/etc/postgresql/{[pg-version-upgrade]}/{[postgres-cluster-demo]}/postgresql.conf</variable>
<variable key="postgres-config-demo-upgrade" if="{[os-type-is-rhel]}">{[pg-path-upgrade]}/postgresql.conf</variable>
<variable key="postgres-hba-demo" if="{[os-type-is-debian]}">/etc/postgresql/{[pg-version]}/{[postgres-cluster-demo]}/pg_hba.conf</variable>
<variable key="postgres-hba-demo" if="{[os-type-is-rhel]}">{[pg-path]}/pg_hba.conf</variable>
<variable key="postgres-hba-demo-upgrade" if="{[os-type-is-debian]}">/etc/postgresql/{[pg-version-upgrade]}/{[postgres-cluster-demo]}/pg_hba.conf</variable>
<variable key="postgres-hba-demo-upgrade" if="{[os-type-is-rhel]}">{[pg-path-upgrade]}/pg_hba.conf</variable>
<variable key="postgres-pgpass">{[pg-home-path]}/.pgpass</variable>
<variable key="postgres-log-demo" if="{[os-type-is-debian]}">/var/log/postgresql/postgresql-{[pg-version]}-{[postgres-cluster-demo]}.log</variable>
<variable key="postgres-log-demo" if="{[os-type-is-rhel]} && {[pg-version]} < 10">{[pg-path]}/pg_log/postgresql.log</variable>
<variable key="postgres-log-demo" if="{[os-type-is-rhel]} && {[pg-version]} >= 10">{[pg-path]}/log/postgresql.log</variable>
<variable key="postgres-log-pgstartup-demo" if="{[os-type-is-rhel]}">/var/lib/pgsql/{[pg-version]}/pgstartup.log</variable>
<variable key="pg-recovery-file-demo" if="{[pg-version]} < 12">recovery.conf</variable>
<variable key="pg-recovery-file-demo" if="{[pg-version]} >= 12">postgresql.auto.conf</variable>
<variable key="pg-recovery-path-demo">{[pg-path]}/{[pg-recovery-file-demo]}</variable>
<!-- Select correct WAL switch function based on the version of PostgreSQL -->
<variable key="pg-switch-wal" if="{[pg-version]} < 10">pg_switch_xlog</variable>
<variable key="pg-switch-wal" if="{[pg-version]} >= 10">pg_switch_wal</variable>
<!-- Azure Settings -->
<variable key="azure-image">mcr.microsoft.com/azure-storage/azurite</variable> <!-- Azurite docker image -->
<variable key="azure-all">n</variable> <!-- Build all the documentation with Azure? -->
<variable key="azure-local">y</variable>
<variable key="azure-account">pgbackrest</variable>
<variable key="azure-container">demo-container</variable>
<variable key="azure-repo">demo-repo</variable>
<variable key="azure-key-type">shared</variable>
<variable key="azure-key">YXpLZXk=</variable>
<!-- GCS Settings -->
<variable key="gcs-all">n</variable> <!-- Build all the documentation with GCS? -->
<variable key="gcs-bucket">demo-bucket</variable>
<variable key="gcs-repo">demo-repo</variable>
<variable key="gcs-key-type">service</variable>
<variable key="gcs-key">/etc/pgbackrest/gcs-key.json</variable>
<!-- S3 Settings -->
<variable key="s3-image">minio/minio:RELEASE.2022-01-28T02-28-16Z</variable> <!-- Minio docker image -->
<variable key="s3-all">n</variable> <!-- Build all the documentation with S3? -->
<variable key="s3-local">y</variable>
<variable key="s3-bucket">demo-bucket</variable>
<variable key="s3-repo">demo-repo</variable>
<variable key="s3-region">us-east-1</variable>
<variable key="s3-endpoint">s3.{[s3-region]}.amazonaws.com</variable>
<variable key="s3-key">accessKey1</variable>
<variable key="s3-key-secret">verySecretKey1</variable>
<!-- Is any object store being used to build all the documentation? -->
<variable key="object-any-all">('{[azure-all]}' eq 'y' || '{[gcs-all]}' eq 'y' || '{[s3-all]}' eq 'y')</variable>
<!-- Hosts -->
<variable key="host-image">pgbackrest/doc:{[os-type]}</variable>
<variable key="host-option">-v /sys/fs/cgroup:/sys/fs/cgroup:rw -v /tmp/$(mktemp -d):/run</variable>
<variable key="host-user" eval="y">use English; getpwuid($UID) eq 'root' ? 'vagrant' : getpwuid($UID) . ''</variable>
<variable key="host-mount">{[host-repo-path]}:{[pgbackrest-repo-path]}</variable>
<variable key="image-repo">pgbackrest/test</variable>
<variable key="host-azure-id">azure</variable>
<variable key="host-azure">azure-server</variable>
<variable key="host-s3-id">s3</variable>
<variable key="host-s3">s3-server</variable>
<variable key="host-pg1-id">pg1</variable>
<variable key="host-pg1">pg-primary</variable>
<variable key="host-pg1-user">{[host-user]}</variable>
<variable key="host-pg1-image">{[host-image]}</variable>
<variable key="host-pg1-mount">{[host-mount]}</variable>
<variable key="host-build-id">build</variable>
<variable key="host-build">build</variable>
<variable key="host-build-user">{[host-user]}</variable>
<variable key="host-build-image">{[host-image]}</variable>
<variable key="host-build-mount">{[host-mount]}</variable>
<variable key="host-pg2-id">pg2</variable>
<variable key="host-pg2">pg-standby</variable>
<variable key="host-pg2-user">{[host-pg1-user]}</variable>
<variable key="host-pg2-image">{[host-image]}</variable>
<variable key="host-pg2-mount">{[host-mount]}</variable>
<variable key="host-repo1-id">repo1</variable>
<variable key="host-repo1">repository</variable>
<variable key="host-repo1-user">{[host-user]}</variable>
<variable key="host-repo1-image">{[host-image]}</variable>
<variable key="host-repo1-mount">{[host-mount]}</variable>
<!-- Commands for various operations -->
<variable key="cmd-backup-last">pgbackrest repo-ls backup/demo --filter="(F|D|I)$" --sort=desc | head -1</variable>
<!-- Data used to demonstrate backup/restore operations -->
<variable key="test-table-data">Important Data</variable>
<!-- Database cluster commmands -->
<variable key="pg-cluster-wait">sleep 2</variable>
<variable key="pg-cluster-create" if="{[os-type-is-debian]}">pg_createcluster {[pg-version]} {[postgres-cluster-demo]}</variable>
<variable key="pg-cluster-create-upgrade" if="{[os-type-is-debian]}">pg_createcluster {[pg-version-upgrade]} {[postgres-cluster-demo]}</variable>
<variable key="pg-cluster-start" if="{[os-type-is-debian]}">pg_ctlcluster {[pg-version]} {[postgres-cluster-demo]} start</variable>
<variable key="pg-cluster-start" if="{[os-type-is-rhel]}">systemctl start postgresql-{[pg-version]}.service</variable>
<variable key="pg-cluster-start-upgrade" if="{[os-type-is-debian]}">pg_ctlcluster {[pg-version-upgrade]} {[postgres-cluster-demo]} start</variable>
<variable key="pg-cluster-start-upgrade" if="{[os-type-is-rhel]}">systemctl start postgresql-{[pg-version-upgrade]}.service</variable>
<variable key="pg-cluster-stop" if="{[os-type-is-debian]}">pg_ctlcluster {[pg-version]} {[postgres-cluster-demo]} stop</variable>
<variable key="pg-cluster-stop" if="{[os-type-is-rhel]}">systemctl stop postgresql-{[pg-version]}.service</variable>
<variable key="pg-cluster-restart" if="{[os-type-is-debian]}">pg_ctlcluster {[pg-version]} {[postgres-cluster-demo]} restart</variable>
<variable key="pg-cluster-restart" if="{[os-type-is-rhel]}">systemctl restart postgresql-{[pg-version]}.service</variable>
<variable key="pg-cluster-reload" if="{[os-type-is-debian]}">pg_ctlcluster {[pg-version]} {[postgres-cluster-demo]} reload</variable>
<variable key="pg-cluster-reload" if="{[os-type-is-rhel]}">systemctl reload postgresql-{[pg-version]}.service</variable>
<variable key="pg-cluster-check" if="{[os-type-is-debian]}">pg_lsclusters</variable>
<variable key="pg-cluster-check" if="{[os-type-is-rhel]}">systemctl status postgresql-{[pg-version]}.service</variable>
<variable key="pg-cluster-check-upgrade" if="{[os-type-is-debian]}">pg_lsclusters</variable>
<variable key="pg-cluster-check-upgrade" if="{[os-type-is-rhel]}">systemctl status postgresql-{[pg-version-upgrade]}.service</variable>
<!-- Common commands -->
<variable key="ssh-key-install">
mkdir -p -m 700 /root/.ssh && \
echo '-----BEGIN RSA PRIVATE KEY-----' > /root/.ssh/id_rsa && \
echo 'MIICXwIBAAKBgQDR0yJsZW5d5LcqteiOtv8d+FFeFFHDPI0VTcTOdMn1iDiIP1ou' >> /root/.ssh/id_rsa && \
echo 'X3Q2OyNjsBaDbsRJd+sp9IRq1LKX3zsBcgGZANwm0zduuNEPEU94ajS/uRoejIqY' >> /root/.ssh/id_rsa && \
echo '/XkKOpnEF6ZbQ2S7TaE4sWeGLvba7kUFs0QTOO+N+nV2dMbdqZf6C8lazwIDAQAB' >> /root/.ssh/id_rsa && \
echo 'AoGBAJXa6xzrnFVmwgK5BKzYuX/YF5TPgk2j80ch0ct50buQXH/Cb0/rUH5i4jWS' >> /root/.ssh/id_rsa && \
echo 'T6Hy/DFUehnuzpvV6O9auTOhDs3BhEKFRuRLn1nBwTtZny5Hh+cw7azUCEHFCJlz' >> /root/.ssh/id_rsa && \
echo 'makCrVbgawtno6oU/pFgQm1FcxD0f+Me5ruNcLHqUZsPQwkRAkEA+8pG+ckOlz6R' >> /root/.ssh/id_rsa && \
echo 'AJLIHedmfcrEY9T7sfdo83bzMOz8H5soUUP4aOTLJYCla1LO7JdDnXMGo0KxaHBP' >> /root/.ssh/id_rsa && \
echo 'l8j5zDmVewJBANVVPDJr1w37m0FBi37QgUOAijVfLXgyPMxYp2uc9ddjncif0063' >> /root/.ssh/id_rsa && \
echo '0Wc0FQefoPszf3CDrHv/RHvhHq97jXDwTb0CQQDgH83NygoS1r57pCw9chzpG/R0' >> /root/.ssh/id_rsa && \
echo 'aMEiSPhCvz757fj+qT3aGIal2AJ7/2c/gRZvwrWNETZ3XIZOUKqIkXzJLPjBAkEA' >> /root/.ssh/id_rsa && \
echo 'wnP799W2Y8d4/+VX2pMBkF7lG7sSviHEq1sP2BZtPBRQKSQNvw3scM7XcGh/mxmY' >> /root/.ssh/id_rsa && \
echo 'yx0qpqfKa8SKbNgI1+4iXQJBAOlg8MJLwkUtrG+p8wf69oCuZsnyv0K6UMDxm6/8' >> /root/.ssh/id_rsa && \
echo 'cbvfmvODulYFaIahaqHWEZoRo5CLYZ7gN43WHPOrKxdDL78=' >> /root/.ssh/id_rsa && \
echo '-----END RSA PRIVATE KEY-----' >> /root/.ssh/id_rsa && \
echo 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDR0yJsZW5d5LcqteiOtv8d+FFeFFHDPI0VTcTOdMn1iDiIP1ouX3Q2OyNjsBaDbsRJd+sp9IRq1LKX3zsBcgGZANwm0zduuNEPEU94ajS/uRoejIqY/XkKOpnEF6ZbQ2S7TaE4sWeGLvba7kUFs0QTOO+N+nV2dMbdqZf6C8lazw== root@pgbackrest-doc' > /root/.ssh/authorized_keys && \
echo 'Host *' > /root/.ssh/config && \
echo ' StrictHostKeyChecking no' >> /root/.ssh/config && \
chmod 600 /root/.ssh/*
</variable>
<variable key="postgres-config-common-create">
echo 'listen_addresses = '\''*'\''' > /root/postgresql.common.conf && \
echo 'port = 5432' >> /root/postgresql.common.conf && \
echo 'shared_buffers = 16MB' >> /root/postgresql.common.conf && \
echo 'log_line_prefix = '\'''\''' >> /root/postgresql.common.conf && \
echo 'autovacuum = off' >> /root/postgresql.common.conf
</variable>
<variable key="copy-ca-cert">COPY {[fake-cert-path-relative]}/ca.crt {[ca-cert-path]}/pgbackrest-ca.crt</variable>
<!-- Don't allow sudo to disable core dump (suppresses errors, see https://github.com/sudo-project/sudo/issues/42) -->
<variable key="sudo-disable-core-dump">RUN echo "Set disable_coredump false" >> /etc/sudo.conf</variable>
</variable-list>
<!-- Setup hosts used to build the documentation =========================================================================== -->
<host-define if="{[os-type-is-debian]}" image="{[host-image]}" from="{[os-image]}">
{[copy-ca-cert]}
# Fix root tty
RUN sed -i 's/^mesg n/tty -s \&\& mesg n/g' /root/.profile
# Install base packages (suppress dpkg interactive output)
RUN export DEBIAN_FRONTEND=noninteractive && \
rm /etc/apt/apt.conf.d/70debconf && \
apt-get update && \
apt-get install -y --no-install-recommends sudo ssh wget vim gnupg lsb-release iputils-ping ca-certificates \
tzdata locales 2>&1
{[sudo-disable-core-dump]}
# Install CA certificate
RUN update-ca-certificates
# Install PostgreSQL
RUN RELEASE_CODENAME=`lsb_release -c | awk '{print $2}'` && \
echo 'deb http://apt.postgresql.org/pub/repos/apt/ '${RELEASE_CODENAME?}'-pgdg main' | \
tee -a /etc/apt/sources.list.d/pgdg.list && \
wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add - && \
apt-get update && \
apt-get install -y --no-install-recommends postgresql-common 2>&1 && \
sed -i 's/^\#create\_main\_cluster.*$/create\_main\_cluster \= false/' \
/etc/postgresql-common/createcluster.conf && \
apt-get install -y --no-install-recommends postgresql-{[pg-version]} postgresql-{[pg-version-upgrade]} 2>&1
# Create an ssh key for root so all hosts can ssh to each other as root
RUN \ {[ssh-key-install]}
# Create common postgresql config
RUN \ {[postgres-config-common-create]}
# Add doc user with sudo privileges
RUN adduser --disabled-password --gecos "" {[host-user]} && \
echo '%{[host-user]} ALL=(ALL) NOPASSWD: ALL' >> /etc/sudoers
# Set UTF8 encoding
RUN sed -i -e 's/# en_US.UTF-8 UTF-8/en_US.UTF-8 UTF-8/' /etc/locale.gen && \
dpkg-reconfigure --frontend=noninteractive locales && \
update-locale LANG=en_US.UTF-8
ENV LANG en_US.UTF-8
ENTRYPOINT service ssh restart && bash
</host-define>
<host-define if="{[os-type-is-rhel]}" image="{[host-image]}" from="{[os-image]}">
ENV container docker
{[copy-ca-cert]}
RUN mkdir -p /lib/systemd/system/sysinit.target.wants && \
(cd /lib/systemd/system/sysinit.target.wants/; for i in *; do [ $i == \
systemd-tmpfiles-setup.service ] || rm -f $i; done); \
rm -f /lib/systemd/system/multi-user.target.wants/*;\
rm -f /etc/systemd/system/*.wants/*;\
rm -f /lib/systemd/system/local-fs.target.wants/*; \
rm -f /lib/systemd/system/sockets.target.wants/*udev*; \
rm -f /lib/systemd/system/sockets.target.wants/*initctl*; \
rm -f /lib/systemd/system/basic.target.wants/*;\
rm -f /lib/systemd/system/anaconda.target.wants/*;
VOLUME [ "/sys/fs/cgroup" ]
# Install packages
RUN yum install -y openssh-server openssh-clients sudo wget vim openssl findutils dnf-plugins-core 2>&1
# Enable PowerTools repository (only available on RHEL8)
RUN dnf config-manager --set-enabled powertools || true
# Install CA certificate
RUN update-ca-trust extract
# Regenerate SSH keys
RUN rm -f /etc/ssh/ssh_host_rsa_key* && \
ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key && \
rm -f /etc/ssh/ssh_host_dsa_key* && \
ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key
# Install PGDG PostgreSQL repository
RUN rpm --import http://yum.postgresql.org/RPM-GPG-KEY-PGDG-10 && \
rpm -ivh https://download.postgresql.org/pub/repos/yum/reporpms/EL-8-x86_64/pgdg-redhat-repo-latest.noarch.rpm
# Disable default PostgreSQL repository
RUN command -v dnf >/dev/null 2>&1 && dnf -qy module disable postgresql || true
# Install PostgreSQL
RUN yum install -y postgresql{[pg-version-nodot]}-server postgresql{[pg-version-upgrade-nodot]}-server
# Create an ssh key for root so all hosts can ssh to each other as root
RUN \ {[ssh-key-install]}
# Create common postgresql config
RUN \ {[postgres-config-common-create]}
# Add doc user with sudo privileges
RUN adduser -n {[host-user]} && \
echo '{[host-user]} ALL=(ALL) NOPASSWD: ALL' > /etc/sudoers.d/{[host-user]}
# Enable the user session service so logons are allowed
RUN echo "[Install]" >> /usr/lib/systemd/system/systemd-user-sessions.service && \
echo "[WantedBy=default.target]" >> /usr/lib/systemd/system/systemd-user-sessions.service && \
systemctl enable systemd-user-sessions.service && \
mkdir -p /etc/systemd/system/default.target.wants && \
ln -s /usr/lib/systemd/system/systemd-user-sessions.service \
/etc/systemd/system/default.target.wants/systemd-user-sessions.service
# Set locale
RUN echo en_US.UTF-8 UTF-8 > /etc/locale.conf
# Add path to PostgreSQL
ENV PATH=/usr/pgsql-{[pg-version]}/bin:$PATH
CMD ["/usr/sbin/init"]
</host-define>
<!-- ======================================================================================================================= -->
<block-define id="setup-ssh-intro">
<p><backrest/> can use passwordless SSH to enable communication between the hosts. It is also possible to use TLS, see <link url="user-guide-rhel.html#repo-host/config">Setup TLS</link>.</p>
</block-define>
<block-define id="setup-tls">
<execute-list host="{[setup-tls-host]}">
<title>Setup pgBackRest Server</title>
<execute user="root" user-force="y" show="n">
<exe-cmd>
mkdir -p -m 770 /etc/pgbackrest/cert &&
cp {[pgbackrest-repo-path]}/doc/{[fake-cert-path-relative]}/ca.crt
/etc/pgbackrest/cert/ca.crt &&
openssl genrsa -out /etc/pgbackrest/cert/server.key 2048 2>&1 &&
chmod 600 /etc/pgbackrest/cert/server.key &&
openssl req -new -sha256 -nodes -out /etc/pgbackrest/cert/server.csr
-key /etc/pgbackrest/cert/server.key -subj "/CN={[setup-tls-host]}" 2>&1 &&
openssl x509 -req -in /etc/pgbackrest/cert/server.csr
-CA /etc/pgbackrest/cert/ca.crt
-CAkey {[pgbackrest-repo-path]}/doc/{[fake-cert-path-relative]}/ca.key -CAcreateserial
-out /etc/pgbackrest/cert/server.crt -days 9 2>&1 &&
openssl genrsa -out /etc/pgbackrest/cert/client.key 2048 2>&1 &&
chmod 600 /etc/pgbackrest/cert/client.key &&
openssl req -new -sha256 -nodes -out /etc/pgbackrest/cert/client.csr
-key /etc/pgbackrest/cert/client.key -subj "/CN=pgbackrest-client" 2>&1 &&
openssl x509 -req -in /etc/pgbackrest/cert/client.csr
-CA /etc/pgbackrest/cert/ca.crt
-CAkey {[pgbackrest-repo-path]}/doc/{[fake-cert-path-relative]}/ca.key -CAcreateserial
-out /etc/pgbackrest/cert/client.crt -days 9 2>&1 &&
chown -R {[setup-tls-user]} /etc/pgbackrest/cert
</exe-cmd>
</execute>
<execute user="root" user-force="y" show="n">
<exe-cmd>
echo '[Unit]' | tee /etc/systemd/system/pgbackrest.service &&
echo 'Description=pgBackRest Server' | tee -a /etc/systemd/system/pgbackrest.service &&
echo 'After=network.target' | tee -a /etc/systemd/system/pgbackrest.service &&
echo 'StartLimitIntervalSec=0' | tee -a /etc/systemd/system/pgbackrest.service &&
echo '' | tee -a /etc/systemd/system/pgbackrest.service &&
echo '[Service]' | tee -a /etc/systemd/system/pgbackrest.service &&
echo 'Type=simple' | tee -a /etc/systemd/system/pgbackrest.service &&
echo 'Restart=always' | tee -a /etc/systemd/system/pgbackrest.service &&
echo 'RestartSec=1' | tee -a /etc/systemd/system/pgbackrest.service &&
echo 'User={[setup-tls-user]}' | tee -a /etc/systemd/system/pgbackrest.service &&
echo 'ExecStart=/usr/bin/pgbackrest server' | tee -a /etc/systemd/system/pgbackrest.service &&
echo 'ExecStartPost=/bin/sleep 3' | tee -a /etc/systemd/system/pgbackrest.service &&
echo 'ExecStartPost=/bin/bash -c "[ ! -z $MAINPID ]"' | tee -a /etc/systemd/system/pgbackrest.service &&
echo 'ExecReload=kill -HUP $MAINPID' | tee -a /etc/systemd/system/pgbackrest.service &&
echo '' | tee -a /etc/systemd/system/pgbackrest.service &&
echo '[Install]' | tee -a /etc/systemd/system/pgbackrest.service &&
echo 'WantedBy=multi-user.target' | tee -a /etc/systemd/system/pgbackrest.service
</exe-cmd>
</execute>
<execute user="root" output="y">
<exe-cmd>cat /etc/systemd/system/pgbackrest.service</exe-cmd>
</execute>
<execute user="root">
<exe-cmd>systemctl enable pgbackrest</exe-cmd>
<exe-cmd-extra>2>&1</exe-cmd-extra>
</execute>
<execute user="root">
<exe-cmd>systemctl start pgbackrest</exe-cmd>
</execute>
</execute-list>
</block-define>
<block-define id="setup-ssh">
<execute-list host="{[setup-ssh-host]}">
<title>Create <host>{[setup-ssh-host]}</host> host key pair</title>
<execute user="{[setup-ssh-user]}">
<exe-cmd>mkdir -m 750 -p {[setup-ssh-user-home-path]}/.ssh</exe-cmd>
</execute>
<execute user="{[setup-ssh-user]}">
<exe-cmd>ssh-keygen -f {[setup-ssh-user-home-path]}/.ssh/id_rsa
-t rsa -b 4096 -N ""</exe-cmd>
</execute>
</execute-list>
<p>Exchange keys between <host>{[host-repo1]}</host> and <host>{[setup-ssh-host]}</host>.</p>
<execute-list host="{[host-repo1]}">
<title>Copy <host>{[setup-ssh-host]}</host> public key to <host>{[host-repo1]}</host></title>
<execute user="root" err-suppress="y" user-force="y">
<exe-cmd>
(echo -n 'no-agent-forwarding,no-X11-forwarding,no-port-forwarding,' &&
echo -n 'command="{[br-bin]} ${SSH_ORIGINAL_COMMAND#* }" ' &&
sudo ssh root@{[setup-ssh-host]} cat {[setup-ssh-user-home-path]}/.ssh/id_rsa.pub) |
sudo -u pgbackrest tee -a {[br-home-path]}/.ssh/authorized_keys
</exe-cmd>
</execute>
</execute-list>
<execute-list host="{[setup-ssh-host]}">
<title>Copy <host>{[host-repo1]}</host> public key to <host>{[setup-ssh-host]}</host></title>
<execute user="root" err-suppress="y" user-force="y">
<exe-cmd>
(echo -n 'no-agent-forwarding,no-X11-forwarding,no-port-forwarding,' &&
echo -n 'command="{[br-bin]} ${SSH_ORIGINAL_COMMAND#* }" ' &&
sudo ssh root@{[host-repo1]} cat {[br-home-path]}/.ssh/id_rsa.pub) |
sudo -u {[setup-ssh-user]} tee -a {[setup-ssh-user-home-path]}/.ssh/authorized_keys
</exe-cmd>
</execute>
</execute-list>
<p>Test that connections can be made from <host>{[host-repo1]}</host> to <host>{[setup-ssh-host]}</host> and vice versa.</p>
<execute-list host="{[host-repo1]}">
<title>Test connection from <host>{[host-repo1]}</host> to <host>{[setup-ssh-host]}</host></title>
<execute user="{[br-user]}" err-suppress="y">
<exe-cmd>ssh {[setup-ssh-user]}@{[setup-ssh-host]}</exe-cmd>
<exe-cmd-extra>-o StrictHostKeyChecking=no</exe-cmd-extra>
</execute>
</execute-list>
<execute-list host="{[setup-ssh-host]}">
<title>Test connection from <host>{[setup-ssh-host]}</host> to <host>{[host-repo1]}</host></title>
<execute user="{[setup-ssh-user]}" err-suppress="y">
<exe-cmd>ssh pgbackrest@{[host-repo1]}</exe-cmd>
<exe-cmd-extra>-o StrictHostKeyChecking=no</exe-cmd-extra>
</execute>
</execute-list>
</block-define>
<!-- ======================================================================================================================= -->
<block-define if="'{[package]}' eq 'none'" id="br-install">
<p><backrest/> needs to be installed from a package or installed manually as shown here.</p>
<execute-list host="{[br-install-host]}">
<title>Install dependencies</title>
<execute if="{[os-type-is-debian]}" user="root" pre="y">
<exe-cmd>
apt-get install postgresql-client libxml2</exe-cmd>
<exe-cmd-extra>-y 2>&1</exe-cmd-extra>
</execute>
<execute if="{[os-type-is-rhel]}" user="root" pre="y">
<exe-cmd>
yum install postgresql-libs
</exe-cmd>
<exe-cmd-extra>-y 2>&1</exe-cmd-extra>
</execute>
</execute-list>
<execute-list host="{[br-install-host]}">
<title>Copy <backrest/> binary from build host</title>
<execute user="root">
<exe-cmd>scp {[host-build]}:{[build-br-path]}/src/pgbackrest /usr/bin</exe-cmd>
<exe-cmd-extra>2>&1</exe-cmd-extra>
</execute>
<execute user="root">
<exe-cmd>chmod 755 /usr/bin/pgbackrest</exe-cmd>
</execute>
</execute-list>
<p><backrest/> requires log and configuration directories and a configuration file.</p>
<execute-list host="{[br-install-host]}">
<title>Create <backrest/> configuration file and directories</title>
<execute user="root">
<exe-cmd>mkdir -p -m 770 /var/log/pgbackrest</exe-cmd>
</execute>
<execute user="root">
<exe-cmd>chown {[br-install-user]}:{[br-install-group]} /var/log/pgbackrest</exe-cmd>
</execute>
<execute user="root">
<exe-cmd>mkdir -p {[backrest-config-path]}</exe-cmd>
</execute>
<execute user="root">
<exe-cmd>mkdir -p {[backrest-config-include-path]}</exe-cmd>
</execute>
<execute user="root">
<exe-cmd>touch {[backrest-config-demo]}</exe-cmd>
</execute>
<execute user="root">
<exe-cmd>chmod 640 {[backrest-config-demo]}</exe-cmd>
</execute>
<execute user="root">
<exe-cmd>chown {[br-install-user]}:{[br-install-group]} {[backrest-config-demo]}</exe-cmd>
</execute>
</execute-list>
</block-define>
<block-define if="'{[package]}' ne 'none'" id="br-install">
<execute-list host="{[br-install-host]}">
<title>Install <backrest/> from package</title>
<execute if="{[os-type-is-debian]} && '{[package]}' ne 'apt'" user="root" err-suppress="y" show="n">
<exe-cmd>dpkg -i {[pgbackrest-repo-path]}/{[package]}</exe-cmd>
<exe-cmd-extra> 2>&1</exe-cmd-extra>
</execute>
<execute if="{[os-type-is-debian]} && '{[package]}' ne 'apt'" user="root" show="n">
<exe-cmd>apt-get -y install -f</exe-cmd>
<exe-cmd-extra>-y 2>&1</exe-cmd-extra>
</execute>
<execute if="{[os-type-is-debian]} && '{[package]}' ne 'apt'" user="root" skip="y">
<exe-cmd>apt-get install pgbackrest</exe-cmd>
</execute>
<execute if="{[os-type-is-debian]} && '{[package]}' eq 'apt'" user="root" show="n">
<exe-cmd>apt-get update</exe-cmd>
</execute>
<execute if="{[os-type-is-debian]} && '{[package]}' eq 'apt'" user="root" show="y">
<exe-cmd>apt-get install pgbackrest</exe-cmd>
<exe-cmd-extra>-y 2>&1</exe-cmd-extra>
</execute>
<execute if="{[os-type-is-rhel]} && '{[package]}' ne 'yum'" user="root" show="n">
<exe-cmd>yum -y install {[pgbackrest-repo-path]}/{[package]}</exe-cmd>
<exe-cmd-extra>-y 2>&1</exe-cmd-extra>
</execute>
<execute if="{[os-type-is-rhel]} && '{[package]}' ne 'yum'" user="root" skip="y">
<exe-cmd>yum install pgbackrest</exe-cmd>
</execute>
<execute if="{[os-type-is-rhel]} && '{[package]}' eq 'yum'" user="root">
<exe-cmd>yum install pgbackrest</exe-cmd>
<exe-cmd-extra>-y 2>&1</exe-cmd-extra>
</execute>
</execute-list>
<execute-list if="'{[br-install-user]}' ne 'postgres'" host="{[br-install-host]}">
<title>Update permissions on configuration file and directories</title>
<execute user="root">
<exe-cmd>chown {[br-install-user]}:{[br-install-group]} /var/log/pgbackrest</exe-cmd>
</execute>
<execute user="root">
<exe-cmd>chown {[br-install-user]}:{[br-install-group]} {[backrest-config-demo]}</exe-cmd>
</execute>
</execute-list>
</block-define>
<block-define id="br-install-repo">
<execute-list if="'{[package]}' eq 'none'" host="{[br-install-host]}">
<title>Create the <backrest/> repository</title>
<execute user="root">
<exe-cmd>mkdir -p {[backrest-repo-path]}</exe-cmd>
</execute>
<execute user="root">
<exe-cmd>chmod 750 {[backrest-repo-path]}</exe-cmd>
</execute>
<execute user="root">
<exe-cmd>chown {[br-install-user]}:{[br-install-group]} {[backrest-repo-path]}</exe-cmd>
</execute>
</execute-list>
<execute-list if="'{[package]}' ne 'none' && '{[br-install-user]}' ne 'postgres'" host="{[br-install-host]}">
<title>Update permissions on the <backrest/> repository</title>
<execute user="root">
<exe-cmd>chown {[br-install-user]}:{[br-install-group]} {[backrest-repo-path]}</exe-cmd>
</execute>
</execute-list>
</block-define>
<!-- ======================================================================================================================= -->
<block-define id="azure-setup">
<p><backrest/> supports locating repositories in <proper>Azure-compatible</proper> object stores. The container used to store the repository must be created in advance &mdash; <backrest/> will not do it automatically. The repository can be located in the container root (<path>/</path>) but it's usually best to place it in a subpath so object store logs or other data can also be stored in the container without conflicts.</p>
<backrest-config host="{[azure-setup-host]}" file="{[backrest-config-demo]}" owner="{[azure-setup-config-owner]}">
<title>Configure <proper>Azure</proper></title>
<backrest-config-option section="global" key="repo{[azure-setup-repo-id]}-type">azure</backrest-config-option>
<backrest-config-option section="global" key="repo{[azure-setup-repo-id]}-path">/{[azure-repo]}</backrest-config-option>
<backrest-config-option section="global" key="repo{[azure-setup-repo-id]}-azure-account">{[azure-account]}</backrest-config-option>
<backrest-config-option if="'{[azure-key-type]}' ne 'shared'" section="global" key="repo{[azure-setup-repo-id]}-azure-key-type">{[azure-key-type]}</backrest-config-option>
<backrest-config-option section="global" key="repo{[azure-setup-repo-id]}-azure-key">{[azure-key]}</backrest-config-option>
<backrest-config-option section="global" key="repo{[azure-setup-repo-id]}-azure-container">{[azure-container]}</backrest-config-option>
<backrest-config-option if="'{[azure-all]}' ne 'y'" section="global" key="repo{[azure-setup-repo-id]}-retention-full">4</backrest-config-option>
<backrest-config-option section="global" key="process-max">4</backrest-config-option>
</backrest-config>
<execute-list if="'{[azure-local]}' eq 'y'" host="{[azure-setup-host]}" show="n">
<title>Create the container</title>
<!-- Set host entries to redirect to local azure server -->
<execute user="root" user-force="y" show="n">
<exe-cmd>echo "{[host-azure-ip]} pgbackrest.blob.core.windows.net" | tee -a /etc/hosts</exe-cmd>
</execute>
<execute user="{[azure-setup-user]}" if="'{[azure-setup-create-container]}' eq 'y'" show='n'>
<exe-cmd>{[project-exe]} --repo={[azure-setup-repo-id]} repo-create</exe-cmd>
</execute>
</execute-list>
<p>Shared access signatures may be used by setting the <br-option>repo{[azure-setup-repo-id]}-azure-key-type</br-option> option to <id>sas</id> and the <br-option>repo{[azure-setup-repo-id]}-azure-key</br-option> option to the shared access signature token.</p>
</block-define>
<!-- ======================================================================================================================= -->
<block-define id="gcs-setup">
<p><backrest/> supports locating repositories in <proper>GCS-compatible</proper> object stores. The bucket used to store the repository must be created in advance &mdash; <backrest/> will not do it automatically. The repository can be located in the bucket root (<path>/</path>) but it's usually best to place it in a subpath so object store logs or other data can also be stored in the bucket without conflicts.</p>
<backrest-config host="{[gcs-setup-host]}" file="{[backrest-config-demo]}" owner="{[gcs-setup-config-owner]}">
<title>Configure <proper>GCS</proper></title>
<backrest-config-option section="global" key="repo{[gcs-setup-repo-id]}-type">gcs</backrest-config-option>
<backrest-config-option section="global" key="repo{[gcs-setup-repo-id]}-path">/{[gcs-repo]}</backrest-config-option>
<backrest-config-option if="'{[gcs-key-type]}' ne 'service'" section="global" key="repo{[gcs-setup-repo-id]}-gcs-key-type">{[gcs-key-type]}</backrest-config-option>
<backrest-config-option section="global" key="repo{[gcs-setup-repo-id]}-gcs-key">{[gcs-key]}</backrest-config-option>
<backrest-config-option section="global" key="repo{[gcs-setup-repo-id]}-gcs-bucket">{[gcs-bucket]}</backrest-config-option>
<backrest-config-option section="global" key="process-max">4</backrest-config-option>
</backrest-config>
<p>When running in <proper>GCE</proper> set <br-option>repo{[gcs-setup-repo-id]}-gcs-key-type=auto</br-option> to automatically authenticate using the instance service account.</p>
</block-define>
<!-- ======================================================================================================================= -->
<block-define id="s3-setup">
<p><backrest/> supports locating repositories in <proper>S3-compatible</proper> object stores. The bucket used to store the repository must be created in advance &mdash; <backrest/> will not do it automatically. The repository can be located in the bucket root (<path>/</path>) but it's usually best to place it in a subpath so object store logs or other data can also be stored in the bucket without conflicts.</p>
<backrest-config host="{[s3-setup-host]}" file="{[backrest-config-demo]}" owner="{[s3-setup-config-owner]}">
<title>Configure <proper>S3</proper></title>
<backrest-config-option section="global" key="repo{[s3-setup-repo-id]}-type">s3</backrest-config-option>
<backrest-config-option section="global" key="repo{[s3-setup-repo-id]}-path">/{[s3-repo]}</backrest-config-option>
<backrest-config-option section="global" key="repo{[s3-setup-repo-id]}-s3-key">{[s3-key]}</backrest-config-option>
<backrest-config-option section="global" key="repo{[s3-setup-repo-id]}-s3-key-secret">{[s3-key-secret]}</backrest-config-option>
<backrest-config-option section="global" key="repo{[s3-setup-repo-id]}-s3-bucket">{[s3-bucket]}</backrest-config-option>
<backrest-config-option section="global" key="repo{[s3-setup-repo-id]}-s3-endpoint">{[s3-endpoint]}</backrest-config-option>
<backrest-config-option section="global" key="repo{[s3-setup-repo-id]}-s3-region">{[s3-region]}</backrest-config-option>
<backrest-config-option if="'{[s3-all]}' ne 'y'" section="global" key="repo{[s3-setup-repo-id]}-retention-full">4</backrest-config-option>
<backrest-config-option section="global" key="process-max">4</backrest-config-option>
</backrest-config>
<execute-list if="'{[s3-local]}' eq 'y'" host="{[s3-setup-host]}" show="n">
<title>Create the bucket</title>
<!-- Set host entries to redirect AWS to local s3 server -->
<execute user="root" user-force="y" show="n">
<exe-cmd>echo "{[host-s3-ip]} {[s3-bucket]}.{[s3-endpoint]} {[s3-endpoint]}" | tee -a /etc/hosts</exe-cmd>
</execute>
<execute user="{[s3-setup-user]}" if="'{[s3-setup-create-bucket]}' eq 'y'" show='n'>
<exe-cmd>{[project-exe]} --repo={[s3-setup-repo-id]} repo-create</exe-cmd>
</execute>
</execute-list>
<admonition type="note">The region and endpoint will need to be configured to where the bucket is located. The values given here are for the <id>{[s3-region]}</id> region.</admonition>
</block-define>
<!-- ======================================================================================================================= -->
<section id="introduction">
<title>Introduction</title>
<!-- Create Azure server first to allow it time to boot before being used -->
<host-add if="'{[azure-local]}' eq 'y'" id="{[host-azure-id]}" name="{[host-azure]}" user="root" image="{[azure-image]}" os="{[os-type]}" option="-m 128m -v {[fake-cert-path]}/azure-server.crt:/root/public.crt:ro -v {[fake-cert-path]}/azure-server.key:/root/private.key:ro -e AZURITE_ACCOUNTS='{[azure-account]}:{[azure-key]}'" param="azurite-blob --blobPort 443 --blobHost 0.0.0.0 --cert=/root/public.crt --key=/root/private.key" update-hosts="n"/>
<!-- Create S3 server first to allow it time to boot before being used -->
<host-add if="'{[s3-local]}' eq 'y'" id="{[host-s3-id]}" name="{[host-s3]}" user="root" image="{[s3-image]}" os="{[os-type]}" option="-m 128m -v {[fake-cert-path]}/s3-server.crt:/root/.minio/certs/public.crt:ro -v {[fake-cert-path]}/s3-server.key:/root/.minio/certs/private.key:ro -e MINIO_REGION={[s3-region]} -e MINIO_DOMAIN={[s3-endpoint]} -e MINIO_BROWSER=off -e MINIO_ACCESS_KEY={[s3-key]} -e MINIO_SECRET_KEY={[s3-key-secret]}" param="server /data --address :443" update-hosts="n"/>
<p>This user guide is intended to be followed sequentially from beginning to end &mdash; each section depends on the last. For example, the <link section="/restore">Restore</link> section relies on setup that is performed in the <link section="/quickstart">Quick Start</link> section. Once <backrest/> is up and running then skipping around is possible but following the user guide in order is recommended the first time through.</p>
<p>Although the examples in this guide are targeted at <proper>{[user-guide-os]}</proper> and <postgres/> {[pg-version]}, it should be fairly easy to apply the examples to any Unix distribution and <postgres/> version. The only OS-specific commands are those to create, start, stop, and drop <postgres/> clusters. The <backrest/> commands will be the same on any Unix system though the location of the executable may vary. While <backrest/> strives to operate consistently across versions of <postgres/>, there are subtle differences between versions of <postgres/> that may show up in this guide when illustrating certain examples, e.g. <postgres/> path/file names and settings.</p>
<p>Configuration information and documentation for PostgreSQL can be found in the <postgres/> <link url='http://www.postgresql.org/docs/{[pg-version]}/static/index.html'>Manual</link>.</p>
<p>A somewhat novel approach is taken to documentation in this user guide. Each command is run on a virtual machine when the documentation is built from the XML source. This means you can have a high confidence that the commands work correctly in the order presented. Output is captured and displayed below the command when appropriate. If the output is not included it is because it was deemed not relevant or was considered a distraction from the narrative.</p>
<p>All commands are intended to be run as an unprivileged user that has sudo privileges for both the <user>root</user> and <user>postgres</user> users. It's also possible to run the commands directly as their respective users without modification and in that case the <cmd>sudo</cmd> commands can be stripped off.</p>
</section>
<!-- ======================================================================================================================= -->
<section id="concept">
<title>Concepts</title>
<p>The following concepts are defined as they are relevant to <backrest/>, <postgres/>, and this user guide.</p>
<!-- =================================================================================================================== -->
<section id="backup">
<title>Backup</title>
<p>A backup is a consistent copy of a database cluster that can be restored to recover from a hardware failure, to perform Point-In-Time Recovery, or to bring up a new standby.</p>
<p><b>Full Backup</b>: <backrest/> copies the entire contents of the database cluster to the backup. The first backup of the database cluster is always a Full Backup. <backrest/> is always able to restore a full backup directly. The full backup does not depend on any files outside of the full backup for consistency.</p>
<p><b>Differential Backup</b>: <backrest/> copies only those database cluster files that have changed since the last full backup. <backrest/> restores a differential backup by copying all of the files in the chosen differential backup and the appropriate unchanged files from the previous full backup. The advantage of a differential backup is that it requires less disk space than a full backup, however, the differential backup and the full backup must both be valid to restore the differential backup.</p>
<p><b>Incremental Backup</b>: <backrest/> copies only those database cluster files that have changed since the last backup (which can be another incremental backup, a differential backup, or a full backup). As an incremental backup only includes those files changed since the prior backup, they are generally much smaller than full or differential backups. As with the differential backup, the incremental backup depends on other backups to be valid to restore the incremental backup. Since the incremental backup includes only those files since the last backup, all prior incremental backups back to the prior differential, the prior differential backup, and the prior full backup must all be valid to perform a restore of the incremental backup. If no differential backup exists then all prior incremental backups back to the prior full backup, which must exist, and the full backup itself must be valid to restore the incremental backup.</p>
</section>
<!-- =================================================================================================================== -->
<section id="restore">
<title>Restore</title>
<p>A restore is the act of copying a backup to a system where it will be started as a live database cluster. A restore requires the backup files and one or more WAL segments in order to work correctly.</p>
</section>
<!-- =================================================================================================================== -->
<section id="wal">
<title>Write Ahead Log (WAL)</title>
<p>WAL is the mechanism that <postgres/> uses to ensure that no committed changes are lost. Transactions are written sequentially to the WAL and a transaction is considered to be committed when those writes are flushed to disk. Afterwards, a background process writes the changes into the main database cluster files (also known as the heap). In the event of a crash, the WAL is replayed to make the database consistent.</p>
<p>WAL is conceptually infinite but in practice is broken up into individual 16MB files called segments. WAL segments follow the naming convention <id>0000000100000A1E000000FE</id> where the first 8 hexadecimal digits represent the timeline and the next 16 digits are the logical sequence number (LSN).</p>
</section>
<!-- =================================================================================================================== -->
<section id="encryption">
<title>Encryption</title>
<p>Encryption is the process of converting data into a format that is unrecognizable unless the appropriate password (also referred to as passphrase) is provided.</p>
<p><backrest/> will encrypt the repository based on a user-provided password, thereby preventing unauthorized access to data stored within the repository.</p>
</section>
</section>
<!-- ======================================================================================================================= -->
<section id="upgrading">
<title>Upgrading {[project]}</title>
<!-- =================================================================================================================== -->
<section id="v1-v2">
<title>Upgrading {[project]} from v1 to v2</title>
<p>Upgrading from <proper>v1</proper> to <proper>v2</proper> is fairly straight-forward. The repository format has not changed and all non-deprecated options from <proper>v1</proper> are accepted, so for most installations it is simply a matter of installing the new version.</p>
<p>However, there are a few caveats:</p>
<list>
<list-item>The deprecated <br-option>thread-max</br-option> option is no longer valid. Use <br-option>process-max</br-option> instead.</list-item>
<list-item>The deprecated <br-option>archive-max-mb</br-option> option is no longer valid. This has been replaced with the <br-option>archive-push-queue-max</br-option> option which has different semantics.</list-item>
<list-item>The default for the <br-option>backup-user</br-option> option has changed from <id>backrest</id> to <id>pgbackrest</id>.</list-item>
<list-item>In <proper>v2.02</proper> the default location of the <backrest/> configuration file has changed from <file>/etc/pgbackrest.conf</file> to <file>/etc/pgbackrest/pgbackrest.conf</file>. If <file>/etc/pgbackrest/pgbackrest.conf</file> does not exist, the <file>/etc/pgbackrest.conf</file> file will be loaded instead, if it exists.</list-item>
</list>
<p>Many option names have changed to improve consistency although the old names from <proper>v1</proper> are still accepted. In general, <id>db-*</id> options have been renamed to <id>pg-*</id> and <id>backup-*</id>/<id>retention-*</id> options have been renamed to <id>repo-*</id> when appropriate.</p>
<p><postgres/> and repository options must be indexed when using the new names introduced in <proper>v2</proper>, e.g. <br-option>pg1-host</br-option>, <br-option>pg1-path</br-option>, <br-option>repo1-path</br-option>, <br-option>repo1-type</br-option>, etc.</p>
</section>
</section>
<!-- ======================================================================================================================= -->
<section if="'{[package]}' eq 'none'" id="build">
<title>Build</title>
<p if="{[os-type-is-debian]}">{[user-guide-os]} packages for <backrest/> are available at <link url="https://www.postgresql.org/download/linux/ubuntu/">apt.postgresql.org</link>. If they are not provided for your distribution/version it is easy to download the source and install manually.</p>
<p if="{[os-type-is-rhel]}">{[user-guide-os]} packages for <backrest/> are available from <link url="{[crunchy-url-base]}">Crunchy Data</link> or <link url="http://yum.postgresql.org">yum.postgresql.org</link>, but it is also easy to download the source and install manually.</p>
<host-add id="{[host-build-id]}" name="{[host-build]}" user="{[host-build-user]}" image="{[host-build-image]}" os="{[os-type]}" mount="{[host-build-mount]}" option="-m 256m {[host-option]}"/>
<p>When building from source it is best to use a build host rather than building on production. Many of the tools required for the build should generally not be installed in production. <backrest/> consists of a single executable so it is easy to copy to a new host once it is built.</p>
<execute-list host="{[host-build]}">
<title>Download version <id>{[version]}</id> of <backrest/> to <path>{[build-path]}</path> path</title>
<!-- This is shown to the user but never actually run for the very good reason that the release is not available before the documentation is built -->
<execute skip="y">
<exe-cmd>mkdir -p {[build-path]}</exe-cmd>
</execute>
<execute skip="y">
<exe-cmd>
wget -q -O -
{[github-url-release]}/{[version]}.tar.gz |
tar zx -C {[build-path]}
</exe-cmd>
</execute>
<!-- These commands simulate what the command above would do if it could be run -->
<execute user="root" show="n">
<exe-cmd>mkdir -p {[build-br-path]}</exe-cmd>
</execute>
<execute user="root" show="n">
<exe-cmd>cp -r {[pgbackrest-repo-path]}/src {[build-br-path]}</exe-cmd>
</execute>
<execute user="root" show="n">
<exe-cmd>chown -R {[host-build-user]} {[build-br-path]}</exe-cmd>
</execute>
</execute-list>
<execute-list host="{[host-build]}">
<title>Install build dependencies</title>
<execute if="{[os-type-is-debian]}" user="root" show="n" pre="y">
<exe-cmd>apt-get update</exe-cmd>
</execute>
<execute if="{[os-type-is-debian]}" user="root" pre="y">
<exe-cmd>
apt-get install make gcc libpq-dev libssl-dev libxml2-dev pkg-config
liblz4-dev libzstd-dev libbz2-dev libz-dev libyaml-dev
</exe-cmd>
<exe-cmd-extra>-y 2>&1</exe-cmd-extra>
</execute>
<execute if="{[os-type-is-rhel]}" user="root" pre="y">
<exe-cmd>
yum install make gcc postgresql{[pg-version-nodot]}-devel
openssl-devel libxml2-devel lz4-devel libzstd-devel bzip2-devel libyaml-devel
</exe-cmd>
<exe-cmd-extra>-y 2>&1</exe-cmd-extra>
</execute>
</execute-list>
<execute-list host="{[host-build]}">
<title>Configure and compile <backrest/></title>
<execute>
<exe-cmd>cd {[build-br-path]}/src && ./configure && make</exe-cmd>
<exe-cmd-extra>-j 4</exe-cmd-extra>
</execute>
</execute-list>
</section>
<!-- ======================================================================================================================= -->
<section id="installation">
<title>Installation</title>
<p>A new host named <host>{[host-pg1]}</host> is created to contain the demo cluster and run <backrest/> examples.</p>
<host-add id="{[host-pg1-id]}" name="{[host-pg1]}" user="{[host-pg1-user]}" image="{[host-pg1-image]}" os="{[os-type]}" mount="{[host-pg1-mount]}" option="-m 512m {[host-option]}"/>
<!-- <execute-list if="{[pg-version]} >= 11" host="{[host-pg1]}">
<title>Create <user>{[br-user]}</user> user</title>
<execute if="{[os-type-is-debian]}" user="root">
<exe-cmd>adduser {[dash]}-ingroup {[pg-group]} {[dash]}-disabled-password {[dash]}-gecos "" {[br-user]}</exe-cmd>
</execute>
<execute if="{[os-type-is-rhel]}" user="root">
<exe-cmd>adduser -g{[pg-group]} -n {[br-user]}</exe-cmd>
</execute>
</execute-list> -->
<block id="br-install">
<block-variable-replace key="br-install-host">{[host-pg1]}</block-variable-replace>
<block-variable-replace key="br-install-user">postgres</block-variable-replace>
<block-variable-replace key="br-install-group">postgres</block-variable-replace>
</block>
<p><backrest/> should now be properly installed but it is best to check. If any dependencies were missed then you will get an error when running <backrest/> from the command line.</p>
<execute-list host="{[host-pg1]}">
<title>Make sure the installation worked</title>
<execute user="postgres" output="y" filter="n">
<exe-cmd>{[project-exe]}</exe-cmd>
</execute>
</execute-list>
</section>
<!-- ======================================================================================================================= -->
<section id="quickstart">
<title>Quick Start</title>
<p>The Quick Start section will cover basic configuration of <backrest/> and <postgres/> and introduce the <cmd>backup</cmd>, <cmd>restore</cmd>, and <cmd>info</cmd> commands.</p>
<!-- =================================================================================================================== -->
<section id="setup-demo-cluster">
<title>Setup Demo Cluster</title>
<p>Creating the demo cluster is optional but is strongly recommended, especially for new users, since the example commands in the user guide reference the demo cluster; the examples assume the demo cluster is running on the default port (i.e. 5432). The cluster will not be started until a later section because there is still some configuration to do.</p>
<execute-list host="{[host-pg1]}">
<title>Create the demo cluster</title>
<execute user="postgres">
<exe-cmd>
{[pg-bin-path]}/initdb
-D {[pg-path]} -k -A peer
</exe-cmd>
</execute>
<execute if="{[os-type-is-debian]}" user="root" output="y" filter="n">
<exe-cmd>{[pg-cluster-create]}</exe-cmd>
</execute>
<execute user="root" show="n" user-force="y">
<exe-cmd>cat /root/postgresql.common.conf >> {[postgres-config-demo]}</exe-cmd>