-
Notifications
You must be signed in to change notification settings - Fork 39
Expand file tree
/
Copy pathindex.html
More file actions
2615 lines (2591 loc) · 91.2 KB
/
index.html
File metadata and controls
2615 lines (2591 loc) · 91.2 KB
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
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="The CloudNativePG Contributors" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>API Reference - CloudNativePG</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.7.3/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "API Reference";
var mkdocs_page_input_path = "api_reference.md";
var mkdocs_page_url = null;
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.7.3/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> CloudNativePG
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">CloudNativePG</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../before_you_start/">Before You Start</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../use_cases/">Use cases</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../architecture/">Architecture</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../installation_upgrade/">Installation and upgrades</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../quickstart/">Quickstart</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../bootstrap/">Bootstrap</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security/">Security</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../instance_manager/">Postgres instance manager</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../scheduling/">Scheduling</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../resource_management/">Resource management</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../failure_modes/">Failure Modes</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../rolling_update/">Rolling Updates</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../replication/">Replication</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../backup_recovery/">Backup and Recovery</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../postgresql_conf/">PostgreSQL Configuration</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../operator_conf/">Operator configuration</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../storage/">Storage</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../labels_annotations/">Labels and annotations</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../monitoring/">Monitoring</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../logging/">Logging</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../certificates/">Certificates</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../ssl_connections/">Client TLS/SSL Connections</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../applications/">Connecting from an application</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../connection_pooling/">Connection Pooling</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../replica_cluster/">Replica clusters</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../kubernetes_upgrade/">Kubernetes Upgrade</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../expose_pg_services/">Exposing Postgres Services</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../cnpg-plugin/">CloudNativePG Plugin</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../failover/">Automated failover</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../troubleshooting/">Troubleshooting</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../fencing/">Fencing</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../postgis/">PostGIS</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../e2e/">End-to-End Tests</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../container_images/">Container Image Requirements</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../operator_capability_levels/">Operator Capability Levels</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../samples/">Examples</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../commercial_support/">Commercial support</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../faq/">Frequently Asked Questions (FAQ)</a>
</li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">API Reference</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#affinityconfiguration">AffinityConfiguration</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#azurecredentials">AzureCredentials</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#backup">Backup</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#backupconfiguration">BackupConfiguration</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#backuplist">BackupList</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#backupsource">BackupSource</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#backupspec">BackupSpec</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#backupstatus">BackupStatus</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#barmanobjectstoreconfiguration">BarmanObjectStoreConfiguration</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#bootstrapconfiguration">BootstrapConfiguration</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#bootstrapinitdb">BootstrapInitDB</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#bootstrappgbasebackup">BootstrapPgBaseBackup</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#bootstraprecovery">BootstrapRecovery</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#certificatesconfiguration">CertificatesConfiguration</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#certificatesstatus">CertificatesStatus</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#cluster">Cluster</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#clustercondition">ClusterCondition</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#clusterlist">ClusterList</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#clusterspec">ClusterSpec</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#clusterstatus">ClusterStatus</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#configmapkeyselector">ConfigMapKeySelector</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#configmapresourceversion">ConfigMapResourceVersion</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#databackupconfiguration">DataBackupConfiguration</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#embeddedobjectmetadata">EmbeddedObjectMetadata</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#externalcluster">ExternalCluster</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#googlecredentials">GoogleCredentials</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#instanceid">InstanceID</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#ldapbindasauth">LDAPBindAsAuth</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#ldapbindsearchauth">LDAPBindSearchAuth</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#ldapconfig">LDAPConfig</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#localobjectreference">LocalObjectReference</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#monitoringconfiguration">MonitoringConfiguration</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#nodemaintenancewindow">NodeMaintenanceWindow</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pgbouncerintegrationstatus">PgBouncerIntegrationStatus</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pgbouncersecrets">PgBouncerSecrets</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pgbouncerspec">PgBouncerSpec</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#podmeta">PodMeta</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#podtemplatespec">PodTemplateSpec</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pooler">Pooler</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#poolerintegrations">PoolerIntegrations</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#poolerlist">PoolerList</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#poolersecrets">PoolerSecrets</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#poolerspec">PoolerSpec</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#poolerstatus">PoolerStatus</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#postgresconfiguration">PostgresConfiguration</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#recoverytarget">RecoveryTarget</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#replicaclusterconfiguration">ReplicaClusterConfiguration</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#rollingupdatestatus">RollingUpdateStatus</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#s3credentials">S3Credentials</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#scheduledbackup">ScheduledBackup</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#scheduledbackuplist">ScheduledBackupList</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#scheduledbackupspec">ScheduledBackupSpec</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#scheduledbackupstatus">ScheduledBackupStatus</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#secretkeyselector">SecretKeySelector</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#secretversion">SecretVersion</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#secretsresourceversion">SecretsResourceVersion</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#storageconfiguration">StorageConfiguration</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#walbackupconfiguration">WalBackupConfiguration</a>
</li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../supported_releases/">Supported releases</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../release_notes/">Release notes</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">CloudNativePG</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> »</li><li>API Reference</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="api-reference">API Reference</h1>
<p>CloudNativePG extends the Kubernetes API defining the following
custom resources:</p>
<ul>
<li><a href="#backup">Backup</a></li>
<li><a href="#cluster">Cluster</a></li>
<li><a href="#pooler">Pooler</a></li>
<li><a href="#scheduledbackup">ScheduledBackup</a></li>
</ul>
<p>All the resources are defined in the <code>postgresql.cnpg.io/v1</code>
API.</p>
<p>Please refer to the <a href="../samples/">"Configuration Samples" page</a>" of the
documentation for examples of usage.</p>
<p>Below you will find a description of the defined resources:</p>
<!-- Everything from now on is generated via `make apidoc` -->
<ul>
<li><a href="#AffinityConfiguration">AffinityConfiguration</a></li>
<li><a href="#AzureCredentials">AzureCredentials</a></li>
<li><a href="#Backup">Backup</a></li>
<li><a href="#BackupConfiguration">BackupConfiguration</a></li>
<li><a href="#BackupList">BackupList</a></li>
<li><a href="#BackupSource">BackupSource</a></li>
<li><a href="#BackupSpec">BackupSpec</a></li>
<li><a href="#BackupStatus">BackupStatus</a></li>
<li><a href="#BarmanObjectStoreConfiguration">BarmanObjectStoreConfiguration</a></li>
<li><a href="#BootstrapConfiguration">BootstrapConfiguration</a></li>
<li><a href="#BootstrapInitDB">BootstrapInitDB</a></li>
<li><a href="#BootstrapPgBaseBackup">BootstrapPgBaseBackup</a></li>
<li><a href="#BootstrapRecovery">BootstrapRecovery</a></li>
<li><a href="#CertificatesConfiguration">CertificatesConfiguration</a></li>
<li><a href="#CertificatesStatus">CertificatesStatus</a></li>
<li><a href="#Cluster">Cluster</a></li>
<li><a href="#ClusterCondition">ClusterCondition</a></li>
<li><a href="#ClusterList">ClusterList</a></li>
<li><a href="#ClusterSpec">ClusterSpec</a></li>
<li><a href="#ClusterStatus">ClusterStatus</a></li>
<li><a href="#ConfigMapKeySelector">ConfigMapKeySelector</a></li>
<li><a href="#ConfigMapResourceVersion">ConfigMapResourceVersion</a></li>
<li><a href="#DataBackupConfiguration">DataBackupConfiguration</a></li>
<li><a href="#EmbeddedObjectMetadata">EmbeddedObjectMetadata</a></li>
<li><a href="#ExternalCluster">ExternalCluster</a></li>
<li><a href="#GoogleCredentials">GoogleCredentials</a></li>
<li><a href="#InstanceID">InstanceID</a></li>
<li><a href="#LDAPBindAsAuth">LDAPBindAsAuth</a></li>
<li><a href="#LDAPBindSearchAuth">LDAPBindSearchAuth</a></li>
<li><a href="#LDAPConfig">LDAPConfig</a></li>
<li><a href="#LocalObjectReference">LocalObjectReference</a></li>
<li><a href="#MonitoringConfiguration">MonitoringConfiguration</a></li>
<li><a href="#NodeMaintenanceWindow">NodeMaintenanceWindow</a></li>
<li><a href="#PgBouncerIntegrationStatus">PgBouncerIntegrationStatus</a></li>
<li><a href="#PgBouncerSecrets">PgBouncerSecrets</a></li>
<li><a href="#PgBouncerSpec">PgBouncerSpec</a></li>
<li><a href="#PodMeta">PodMeta</a></li>
<li><a href="#PodTemplateSpec">PodTemplateSpec</a></li>
<li><a href="#Pooler">Pooler</a></li>
<li><a href="#PoolerIntegrations">PoolerIntegrations</a></li>
<li><a href="#PoolerList">PoolerList</a></li>
<li><a href="#PoolerSecrets">PoolerSecrets</a></li>
<li><a href="#PoolerSpec">PoolerSpec</a></li>
<li><a href="#PoolerStatus">PoolerStatus</a></li>
<li><a href="#PostgresConfiguration">PostgresConfiguration</a></li>
<li><a href="#RecoveryTarget">RecoveryTarget</a></li>
<li><a href="#ReplicaClusterConfiguration">ReplicaClusterConfiguration</a></li>
<li><a href="#RollingUpdateStatus">RollingUpdateStatus</a></li>
<li><a href="#S3Credentials">S3Credentials</a></li>
<li><a href="#ScheduledBackup">ScheduledBackup</a></li>
<li><a href="#ScheduledBackupList">ScheduledBackupList</a></li>
<li><a href="#ScheduledBackupSpec">ScheduledBackupSpec</a></li>
<li><a href="#ScheduledBackupStatus">ScheduledBackupStatus</a></li>
<li><a href="#SecretKeySelector">SecretKeySelector</a></li>
<li><a href="#SecretVersion">SecretVersion</a></li>
<li><a href="#SecretsResourceVersion">SecretsResourceVersion</a></li>
<li><a href="#StorageConfiguration">StorageConfiguration</a></li>
<li><a href="#WalBackupConfiguration">WalBackupConfiguration</a></li>
</ul>
<p><a id='AffinityConfiguration'></a></p>
<h2 id="affinityconfiguration">AffinityConfiguration</h2>
<p>AffinityConfiguration contains the info we need to create the affinity rules for Pods</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>enablePodAntiAffinity</code></td>
<td>Activates anti-affinity for the pods. The operator will define pods anti-affinity unless this field is explicitly set to false</td>
<td>*bool</td>
</tr>
<tr>
<td><code>topologyKey</code></td>
<td>TopologyKey to use for anti-affinity configuration. See k8s documentation for more info on that - <em>mandatory</em></td>
<td>string</td>
</tr>
<tr>
<td><code>nodeSelector</code></td>
<td>NodeSelector is map of key-value pairs used to define the nodes on which the pods can run. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/</td>
<td>map[string]string</td>
</tr>
<tr>
<td><code>tolerations</code></td>
<td>Tolerations is a list of Tolerations that should be set for all the pods, in order to allow them to run on tainted nodes. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/</td>
<td>[]corev1.Toleration</td>
</tr>
<tr>
<td><code>podAntiAffinityType</code></td>
<td>PodAntiAffinityType allows the user to decide whether pod anti-affinity between cluster instance has to be considered a strong requirement during scheduling or not. Allowed values are: "preferred" (default if empty) or "required". Setting it to "required", could lead to instances remaining pending until new kubernetes nodes are added if all the existing nodes don't match the required pod anti-affinity rule. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity</td>
<td>string</td>
</tr>
<tr>
<td><code>additionalPodAntiAffinity</code></td>
<td>AdditionalPodAntiAffinity allows to specify pod anti-affinity terms to be added to the ones generated by the operator if EnablePodAntiAffinity is set to true (default) or to be used exclusively if set to false.</td>
<td>*corev1.PodAntiAffinity</td>
</tr>
<tr>
<td><code>additionalPodAffinity</code></td>
<td>AdditionalPodAffinity allows to specify pod affinity terms to be passed to all the cluster's pods.</td>
<td>*corev1.PodAffinity</td>
</tr>
</tbody>
</table>
<p><a id='AzureCredentials'></a></p>
<h2 id="azurecredentials">AzureCredentials</h2>
<p>AzureCredentials is the type for the credentials to be used to upload files to Azure Blob Storage. The connection string contains every needed information. If the connection string is not specified, we'll need the storage account name and also one (and only one) of:</p>
<ul>
<li>storageKey - storageSasToken</li>
</ul>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>connectionString</code></td>
<td>The connection string to be used</td>
<td><a href="#SecretKeySelector">*SecretKeySelector</a></td>
</tr>
<tr>
<td><code>storageAccount</code></td>
<td>The storage account where to upload data</td>
<td><a href="#SecretKeySelector">*SecretKeySelector</a></td>
</tr>
<tr>
<td><code>storageKey</code></td>
<td>The storage account key to be used in conjunction with the storage account name</td>
<td><a href="#SecretKeySelector">*SecretKeySelector</a></td>
</tr>
<tr>
<td><code>storageSasToken</code></td>
<td>A shared-access-signature to be used in conjunction with the storage account name</td>
<td><a href="#SecretKeySelector">*SecretKeySelector</a></td>
</tr>
</tbody>
</table>
<p><a id='Backup'></a></p>
<h2 id="backup">Backup</h2>
<p>Backup is the Schema for the backups API</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>metadata</code></td>
<td></td>
<td><a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#objectmeta-v1-meta">metav1.ObjectMeta</a></td>
</tr>
<tr>
<td><code>spec</code></td>
<td>Specification of the desired behavior of the backup. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status</td>
<td><a href="#BackupSpec">BackupSpec</a></td>
</tr>
<tr>
<td><code>status</code></td>
<td>Most recently observed status of the backup. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status</td>
<td><a href="#BackupStatus">BackupStatus</a></td>
</tr>
</tbody>
</table>
<p><a id='BackupConfiguration'></a></p>
<h2 id="backupconfiguration">BackupConfiguration</h2>
<p>BackupConfiguration defines how the backup of the cluster are taken. Currently the only supported backup method is barmanObjectStore. For details and examples refer to the Backup and Recovery section of the documentation</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>barmanObjectStore</code></td>
<td>The configuration for the barman-cloud tool suite</td>
<td><a href="#BarmanObjectStoreConfiguration">*BarmanObjectStoreConfiguration</a></td>
</tr>
<tr>
<td><code>retentionPolicy</code></td>
<td>RetentionPolicy is the retention policy to be used for backups and WALs (i.e. '60d'). The retention policy is expressed in the form of <code>XXu</code> where <code>XX</code> is a positive integer and <code>u</code> is in <code>[dwm]</code> - days, weeks, months.</td>
<td>string</td>
</tr>
</tbody>
</table>
<p><a id='BackupList'></a></p>
<h2 id="backuplist">BackupList</h2>
<p>BackupList contains a list of Backup</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>metadata</code></td>
<td>Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds</td>
<td><a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#listmeta-v1-meta">metav1.ListMeta</a></td>
</tr>
<tr>
<td><code>items</code></td>
<td>List of backups - <em>mandatory</em></td>
<td><a href="#Backup">[]Backup</a></td>
</tr>
</tbody>
</table>
<p><a id='BackupSource'></a></p>
<h2 id="backupsource">BackupSource</h2>
<p>BackupSource contains the backup we need to restore from, plus some information that could be needed to correctly restore it.</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>endpointCA</code></td>
<td>EndpointCA store the CA bundle of the barman endpoint. Useful when using self-signed certificates to avoid errors with certificate issuer and barman-cloud-wal-archive.</td>
<td><a href="#SecretKeySelector">*SecretKeySelector</a></td>
</tr>
</tbody>
</table>
<p><a id='BackupSpec'></a></p>
<h2 id="backupspec">BackupSpec</h2>
<p>BackupSpec defines the desired state of Backup</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>cluster</code></td>
<td>The cluster to backup</td>
<td><a href="#LocalObjectReference">LocalObjectReference</a></td>
</tr>
</tbody>
</table>
<p><a id='BackupStatus'></a></p>
<h2 id="backupstatus">BackupStatus</h2>
<p>BackupStatus defines the observed state of Backup</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>s3Credentials</code></td>
<td>The credentials to be used to upload data to S3</td>
<td><a href="#S3Credentials">*S3Credentials</a></td>
</tr>
<tr>
<td><code>azureCredentials</code></td>
<td>The credentials to be used to upload data to Azure Blob Storage</td>
<td><a href="#AzureCredentials">*AzureCredentials</a></td>
</tr>
<tr>
<td><code>googleCredentials</code></td>
<td>The credentials to use to upload data to Google Cloud Storage</td>
<td><a href="#GoogleCredentials">*GoogleCredentials</a></td>
</tr>
<tr>
<td><code>endpointCA</code></td>
<td>EndpointCA store the CA bundle of the barman endpoint. Useful when using self-signed certificates to avoid errors with certificate issuer and barman-cloud-wal-archive.</td>
<td><a href="#SecretKeySelector">*SecretKeySelector</a></td>
</tr>
<tr>
<td><code>endpointURL</code></td>
<td>Endpoint to be used to upload data to the cloud, overriding the automatic endpoint discovery</td>
<td>string</td>
</tr>
<tr>
<td><code>destinationPath</code></td>
<td>The path where to store the backup (i.e. s3://bucket/path/to/folder) this path, with different destination folders, will be used for WALs and for data - <em>mandatory</em></td>
<td>string</td>
</tr>
<tr>
<td><code>serverName</code></td>
<td>The server name on S3, the cluster name is used if this parameter is omitted</td>
<td>string</td>
</tr>
<tr>
<td><code>encryption</code></td>
<td>Encryption method required to S3 API</td>
<td>string</td>
</tr>
<tr>
<td><code>backupId</code></td>
<td>The ID of the Barman backup</td>
<td>string</td>
</tr>
<tr>
<td><code>phase</code></td>
<td>The last backup status</td>
<td>BackupPhase</td>
</tr>
<tr>
<td><code>startedAt</code></td>
<td>When the backup was started</td>
<td><a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#time-v1-meta">*metav1.Time</a></td>
</tr>
<tr>
<td><code>stoppedAt</code></td>
<td>When the backup was terminated</td>
<td><a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#time-v1-meta">*metav1.Time</a></td>
</tr>
<tr>
<td><code>beginWal</code></td>
<td>The starting WAL</td>
<td>string</td>
</tr>
<tr>
<td><code>endWal</code></td>
<td>The ending WAL</td>
<td>string</td>
</tr>
<tr>
<td><code>beginLSN</code></td>
<td>The starting xlog</td>
<td>string</td>
</tr>
<tr>
<td><code>endLSN</code></td>
<td>The ending xlog</td>
<td>string</td>
</tr>
<tr>
<td><code>error</code></td>
<td>The detected error</td>
<td>string</td>
</tr>
<tr>
<td><code>commandOutput</code></td>
<td>Unused. Retained for compatibility with old versions.</td>
<td>string</td>
</tr>
<tr>
<td><code>commandError</code></td>
<td>The backup command output in case of error</td>
<td>string</td>
</tr>
<tr>
<td><code>instanceID</code></td>
<td>Information to identify the instance where the backup has been taken from</td>
<td><a href="#InstanceID">*InstanceID</a></td>
</tr>
</tbody>
</table>
<p><a id='BarmanObjectStoreConfiguration'></a></p>
<h2 id="barmanobjectstoreconfiguration">BarmanObjectStoreConfiguration</h2>
<p>BarmanObjectStoreConfiguration contains the backup configuration using Barman against an S3-compatible object storage</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>s3Credentials</code></td>
<td>The credentials to use to upload data to S3</td>
<td><a href="#S3Credentials">*S3Credentials</a></td>
</tr>
<tr>
<td><code>azureCredentials</code></td>
<td>The credentials to use to upload data to Azure Blob Storage</td>
<td><a href="#AzureCredentials">*AzureCredentials</a></td>
</tr>
<tr>
<td><code>googleCredentials</code></td>
<td>The credentials to use to upload data to Google Cloud Storage</td>
<td><a href="#GoogleCredentials">*GoogleCredentials</a></td>
</tr>
<tr>
<td><code>endpointURL</code></td>
<td>Endpoint to be used to upload data to the cloud, overriding the automatic endpoint discovery</td>
<td>string</td>
</tr>
<tr>
<td><code>endpointCA</code></td>
<td>EndpointCA store the CA bundle of the barman endpoint. Useful when using self-signed certificates to avoid errors with certificate issuer and barman-cloud-wal-archive</td>
<td><a href="#SecretKeySelector">*SecretKeySelector</a></td>
</tr>
<tr>
<td><code>destinationPath</code></td>
<td>The path where to store the backup (i.e. s3://bucket/path/to/folder) this path, with different destination folders, will be used for WALs and for data - <em>mandatory</em></td>
<td>string</td>
</tr>
<tr>
<td><code>serverName</code></td>
<td>The server name on S3, the cluster name is used if this parameter is omitted</td>
<td>string</td>
</tr>
<tr>
<td><code>wal</code></td>
<td>The configuration for the backup of the WAL stream. When not defined, WAL files will be stored uncompressed and may be unencrypted in the object store, according to the bucket default policy.</td>
<td><a href="#WalBackupConfiguration">*WalBackupConfiguration</a></td>
</tr>
<tr>
<td><code>data</code></td>
<td>The configuration to be used to backup the data files When not defined, base backups files will be stored uncompressed and may be unencrypted in the object store, according to the bucket default policy.</td>
<td><a href="#DataBackupConfiguration">*DataBackupConfiguration</a></td>
</tr>
<tr>
<td><code>tags</code></td>
<td>Tags is a list of key value pairs that will be passed to the Barman --tags option.</td>
<td>map[string]string</td>
</tr>
<tr>
<td><code>historyTags</code></td>
<td>HistoryTags is a list of key value pairs that will be passed to the Barman --history-tags option.</td>
<td>map[string]string</td>
</tr>
</tbody>
</table>
<p><a id='BootstrapConfiguration'></a></p>
<h2 id="bootstrapconfiguration">BootstrapConfiguration</h2>
<p>BootstrapConfiguration contains information about how to create the PostgreSQL cluster. Only a single bootstrap method can be defined among the supported ones. <code>initdb</code> will be used as the bootstrap method if left unspecified. Refer to the Bootstrap page of the documentation for more information.</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>initdb</code></td>
<td>Bootstrap the cluster via initdb</td>
<td><a href="#BootstrapInitDB">*BootstrapInitDB</a></td>
</tr>
<tr>
<td><code>recovery</code></td>
<td>Bootstrap the cluster from a backup</td>
<td><a href="#BootstrapRecovery">*BootstrapRecovery</a></td>
</tr>
<tr>
<td><code>pg_basebackup</code></td>
<td>Bootstrap the cluster taking a physical backup of another compatible PostgreSQL instance</td>
<td><a href="#BootstrapPgBaseBackup">*BootstrapPgBaseBackup</a></td>
</tr>
</tbody>
</table>
<p><a id='BootstrapInitDB'></a></p>
<h2 id="bootstrapinitdb">BootstrapInitDB</h2>
<p>BootstrapInitDB is the configuration of the bootstrap process when initdb is used Refer to the Bootstrap page of the documentation for more information.</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>database</code></td>
<td>Name of the database used by the application. Default: <code>app</code>. - <em>mandatory</em></td>
<td>string</td>
</tr>
<tr>
<td><code>owner</code></td>
<td>Name of the owner of the database in the instance to be used by applications. Defaults to the value of the <code>database</code> key. - <em>mandatory</em></td>
<td>string</td>
</tr>
<tr>
<td><code>secret</code></td>
<td>Name of the secret containing the initial credentials for the owner of the user database. If empty a new secret will be created from scratch</td>
<td><a href="#LocalObjectReference">*LocalObjectReference</a></td>
</tr>
<tr>
<td><code>options</code></td>
<td>The list of options that must be passed to initdb when creating the cluster. Deprecated: This could lead to inconsistent configurations, please use the explicit provided parameters instead. If defined, explicit values will be ignored.</td>
<td>[]string</td>
</tr>
<tr>
<td><code>dataChecksums</code></td>
<td>Whether the <code>-k</code> option should be passed to initdb, enabling checksums on data pages (default: <code>false</code>)</td>
<td>*bool</td>
</tr>
<tr>
<td><code>encoding</code></td>
<td>The value to be passed as option <code>--encoding</code> for initdb (default:<code>UTF8</code>)</td>
<td>string</td>
</tr>
<tr>
<td><code>localeCollate</code></td>
<td>The value to be passed as option <code>--lc-collate</code> for initdb (default:<code>C</code>)</td>
<td>string</td>
</tr>
<tr>
<td><code>localeCType</code></td>
<td>The value to be passed as option <code>--lc-ctype</code> for initdb (default:<code>C</code>)</td>
<td>string</td>
</tr>
<tr>
<td><code>walSegmentSize</code></td>
<td>The value in megabytes (1 to 1024) to be passed to the <code>--wal-segsize</code> option for initdb (default: empty, resulting in PostgreSQL default: 16MB)</td>
<td>int</td>
</tr>
<tr>
<td><code>postInitSQL</code></td>
<td>List of SQL queries to be executed as a superuser immediately after the cluster has been created - to be used with extreme care (by default empty)</td>
<td>[]string</td>
</tr>
<tr>
<td><code>postInitApplicationSQL</code></td>
<td>List of SQL queries to be executed as a superuser in the application database right after is created - to be used with extreme care (by default empty)</td>
<td>[]string</td>
</tr>
<tr>
<td><code>postInitTemplateSQL</code></td>
<td>List of SQL queries to be executed as a superuser in the <code>template1</code> after the cluster has been created - to be used with extreme care (by default empty)</td>
<td>[]string</td>
</tr>
</tbody>
</table>
<p><a id='BootstrapPgBaseBackup'></a></p>
<h2 id="bootstrappgbasebackup">BootstrapPgBaseBackup</h2>
<p>BootstrapPgBaseBackup contains the configuration required to take a physical backup of an existing PostgreSQL cluster</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>source</code></td>
<td>The name of the server of which we need to take a physical backup - <em>mandatory</em></td>
<td>string</td>
</tr>
</tbody>
</table>
<p><a id='BootstrapRecovery'></a></p>
<h2 id="bootstraprecovery">BootstrapRecovery</h2>
<p>BootstrapRecovery contains the configuration required to restore the backup with the specified name and, after having changed the password with the one chosen for the superuser, will use it to bootstrap a full cluster cloning all the instances from the restored primary. Refer to the Bootstrap page of the documentation for more information.</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>backup</code></td>
<td>The backup we need to restore</td>
<td><a href="#BackupSource">*BackupSource</a></td>
</tr>
<tr>
<td><code>source</code></td>
<td>The external cluster whose backup we will restore. This is also used as the name of the folder under which the backup is stored, so it must be set to the name of the source cluster</td>
<td>string</td>
</tr>
<tr>
<td><code>recoveryTarget</code></td>
<td>By default, the recovery process applies all the available WAL files in the archive (full recovery). However, you can also end the recovery as soon as a consistent state is reached or recover to a point-in-time (PITR) by specifying a <code>RecoveryTarget</code> object, as expected by PostgreSQL (i.e., timestamp, transaction Id, LSN, ...). More info: https://www.postgresql.org/docs/current/runtime-config-wal.html#RUNTIME-CONFIG-WAL-RECOVERY-TARGET</td>
<td><a href="#RecoveryTarget">*RecoveryTarget</a></td>
</tr>
</tbody>
</table>
<p><a id='CertificatesConfiguration'></a></p>
<h2 id="certificatesconfiguration">CertificatesConfiguration</h2>
<p>CertificatesConfiguration contains the needed configurations to handle server certificates.</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>serverCASecret</code></td>
<td>The secret containing the Server CA certificate. If not defined, a new secret will be created with a self-signed CA and will be used to generate the TLS certificate ServerTLSSecret.<br /> <br /> Contains:<br /> <br /> - <code>ca.crt</code>: CA that should be used to validate the server certificate, used as <code>sslrootcert</code> in client connection strings.<br /> - <code>ca.key</code>: key used to generate Server SSL certs, if ServerTLSSecret is provided, this can be omitted.<br /></td>
<td>string</td>
</tr>
<tr>
<td><code>serverTLSSecret</code></td>
<td>The secret of type kubernetes.io/tls containing the server TLS certificate and key that will be set as <code>ssl_cert_file</code> and <code>ssl_key_file</code> so that clients can connect to postgres securely. If not defined, ServerCASecret must provide also <code>ca.key</code> and a new secret will be created using the provided CA.</td>
<td>string</td>
</tr>
<tr>
<td><code>replicationTLSSecret</code></td>
<td>The secret of type kubernetes.io/tls containing the client certificate to authenticate as the <code>streaming_replica</code> user. If not defined, ClientCASecret must provide also <code>ca.key</code>, and a new secret will be created using the provided CA.</td>
<td>string</td>
</tr>
<tr>
<td><code>clientCASecret</code></td>
<td>The secret containing the Client CA certificate. If not defined, a new secret will be created with a self-signed CA and will be used to generate all the client certificates.<br /> <br /> Contains:<br /> <br /> - <code>ca.crt</code>: CA that should be used to validate the client certificates, used as <code>ssl_ca_file</code> of all the instances.<br /> - <code>ca.key</code>: key used to generate client certificates, if ReplicationTLSSecret is provided, this can be omitted.<br /></td>
<td>string</td>
</tr>
<tr>
<td><code>serverAltDNSNames</code></td>
<td>The list of the server alternative DNS names to be added to the generated server TLS certificates, when required.</td>
<td>[]string</td>
</tr>
</tbody>