Using

• Bootstrap
  • The bootstrap section
  • The externalClusters section
    • Password files
  • Bootstrap an empty cluster (initdb )
    • Passing Options to initdb
    • Executing Queries After Initialization
    • Compatibility Features
  • Bootstrap from another cluster
    • Bootstrap from a backup (recovery )
    • Bootstrap from a live cluster (pg_basebackup )
    • Requirements
    • About the replication user
    • Username/Password authentication
    • TLS certificate authentication
    • Configure the application database
    • Current limitations
• Image Catalog
  • Catalog scoping
  • Catalog structure
  • Configuration examples
    • Defining a catalog
    • Referencing a Catalog in a Cluster
  • Image Catalog with Image Volume Extensions
  • EDB CloudNativePG Cluster Catalogs
    • Version Compatibility
    • Installation and Usage
    • Example: Using a Catalog in a Cluster
• Importing Postgres databases
  • How it works
  • The microservice type
  • The monolith type
  • A practical example
  • Import optimizations
  • Customizing pg_dump and pg_restore behavior
    • Stage-Specific pg_restore options
  • Online Import and Upgrades
• Security
  • Code
  • Container
    • Guidelines and Frameworks for Container Security
  • Cluster
    • Role Based Access Control (RBAC)
    • Deployments and ClusterRole Resources
    • Why Are ClusterRole Permissions Needed?
    • Calls to the API server made by the instance manager
    • Pod Security Policies
    • Restricting Pod access using AppArmor
    • Network Policies
    • Exposed Ports
    • PostgreSQL
    • Storage
• Postgres Instance Manager
  • Startup Probe
    • Startup Probe Strategy
  • Liveness Probe
    • Primary Isolation
  • Readiness Probe
    • Readiness Probe Strategy
  • Shutdown control
    • Shutdown of the primary during a switchover
  • Failover
  • Disk Full Failure
• Scheduling
  • Pod Affinity and Anti-Affinity
    • Requiring Pod Anti-Affinity
    • Topology Considerations
    • Disabling Anti-Affinity Policies
    • Fine-Grained Control with Custom Rules
  • Node selection through nodeSelector
  • Tolerations
  • Isolating PostgreSQL workloads
• Resource management
• Failure Modes
  • Self-Healing
    • Primary Failure
    • Standby Failure
  • Manual Intervention
    • Disabling Reconciliation
• Rolling updates
  • Automated updates (unsupervised )
  • Manual updates (supervised )
• Replication
  • Application-level replication
  • A very mature technology
  • Streaming replication support
    • Continuous backup integration
  • Synchronous Replication
    • Quorum-based Synchronous Replication
    • Example
    • Migrating from Deprecated Synchronous Replication Implementation
    • Priority-based Synchronous Replication
    • Controlling synchronous_standby_names Content
    • Examples
    • Data Durability and Synchronous Replication
    • Required Data Durability
    • Preferred Data Durability
  • Synchronous Replication (Deprecated)
    • Select nodes for synchronous replication
  • Replication slots
    • Replication slots for High Availability
    • User-Defined Replication slots
    • Synchronization frequency
    • Logical Decoding Slot Synchronization
    • Behavior on PostgreSQL 17 and later
    • Behavior on PostgreSQL 16 and earlier
    • Capping the WAL size retained for replication slots
    • Monitoring replication slots
• Logical Replication
  • Publications
    • Fine-grained control over publication tables
    • Required Fields in the Publication Manifest
    • Reconciliation and Status
    • Removing a publication
  • Subscriptions
    • Required Fields in the Subscription Manifest
    • Reconciliation and Status
    • Removing a Subscription
    • Resilience to Failovers
  • Limitations
    • Addressing Schema Replication
    • Handling Sequences
  • Example of live migration and major Postgres upgrade with logical replication
    • Step 1: Setting Up the Publisher (freddie )
    • Step 2: Setting Up the Subscriber (king )
• Backup
  • Main Concepts
    • WAL archive
    • Cold and Hot backups
  • Comparing Available Backup Options: Object Stores vs Volume Snapshots
    • Object Store–Based Backups
    • Volume Snapshots
    • Choosing Between the Two
    • Comparison Summary
  • Scheduled Backups
    • Cron Schedule
    • Backup Frequency and RTO
    • Immediate Backup
    • Pause Scheduled Backups
    • Backup Owner Reference (.spec.backupOwnerReference )
  • On-Demand Backups
    • Example: Requesting an On-Demand Backup
    • Monitoring Backup Progress
  • Backup Methods
  • Backup from a Standby
    • How It Works
    • Forcing Backup on the Primary
    • Overriding the Cluster-Wide Target
  • Retention Policies
• Recovery
  • Recovery from an Object Store with the Barman Cloud Plugin
  • Recovery from VolumeSnapshot Objects
  • Additional Considerations
  • Point in time recovery (PITR)
    • PITR from an object store
    • Point-in-Time Recovery (PITR) from VolumeSnapshot Objects
    • Recovery targets
  • Configure the application database
  • How recovery works under the hood
  • Restoring into a Cluster with a Backup Section
• WAL archiving
  • Plugin-Based Architecture
  • Supported Plugins
  • Deprecation Notice: Native Barman Cloud
  • About the archive timeout
• Service management
  • Disabling Default Services
  • Adding Your Own Services
    • About Exposing Postgres Services
• PostgreSQL Role management
  • Password management
    • Password expiry, VALID UNTIL
    • Password hashed
    • Safety when transmitting cleartext passwords
  • Unrealizable role configurations
  • Status of managed roles
    • cluster-example-with-roles.yaml
• PostgreSQL Database management
  • Key Concepts
    • Scope of Management
    • Declarative Database Manifest
    • Required Fields in the Database Manifest
  • Reserved Database Names
  • Reconciliation and Status
  • Deleting a Database
    • Deleting via delete Reclaim Policy
    • Declaratively Setting ensure: absent
  • Managing Extensions in a Database
  • Managing Schemas in a Database
  • Managing Foreign Data Wrappers (FDWs) in a Database
    • Managing Foreign Servers in a Database
  • Limitations and Caveats
    • Renaming a database
    • Creating vs. Altering a Database
    • Replica Clusters
    • Conflict Resolution
    • Postgres Version Differences
    • Manual Changes
• Tablespaces
  • Declarative tablespaces
  • Using declarative tablespaces
  • Storage classes and tablespaces
  • Tablespace ownership
  • Backup and recovery
  • Replica clusters
  • Temporary tablespaces
  • kubectl plugin support
  • Limitations
    • cluster-example-with-tablespaces.yaml
• Storage
  • Backup and recovery
  • Benchmarking EDB Postgres® AI for CloudNativePG™ Cluster
  • Persistent Volume Claim (PVC)
  • Configuration via a storage class
  • Configuration via a PVC template
  • Volume for WAL
  • Volumes for tablespaces
  • Volume expansion
    • Using the volume expansion Kubernetes feature
    • Re-creating storage
  • Static provisioning of persistent volumes
  • Block storage considerations (Ceph/Longhorn)
• Labels and Annotations
  • Predefined labels
  • Predefined annotations
  • Prerequisites
  • Defining cluster’s metadata
  • Current limitations
• Monitoring
  • Monitoring Instances
    • Output caching
    • Monitoring with the Prometheus operator
    • Creating a PodMonitor
    • Enabling TLS on the Metrics Port
    • Predefined set of metrics
    • User defined metrics
    • Example of a user defined metric
    • Example of a user defined metric with predicate query
    • Example of a user defined metric running on multiple databases
    • Structure of a user defined metric
    • Output of a user defined metric
    • Default set of metrics
    • Differences with the Prometheus Postgres exporter
  • Monitoring the EDB Postgres® AI for CloudNativePG™ Cluster operator
    • Monitoring the operator with Prometheus
    • Enabling TLS for operator metrics
  • How to inspect the exported metrics
    • Using port forwarding
    • Using curl
  • Auxiliary resources
  • Monitoring on OpenShift
    • default-monitoring.yaml
• Logging
  • Cluster Logs
  • Operator Logs
  • PostgreSQL Logs
  • PGAudit Logs
  • EDB Audit logs
  • Other Logs
• Certificates
  • Operator-Managed Mode
    • Server certificates
    • Server CA secret
    • Server TLS secret
    • Server alternative DNS names
    • Client certificates
    • Client CA secret
    • Client streaming_replica certificate
  • User-provided certificates mode
    • Server certificates
    • Example
    • Cert-manager example
    • Client certificate
    • Customizing the streaming_replica client certificate
    • Cert-manager example
    • cluster-example-cert-manager.yaml
• Client TLS/SSL connections
  • Issuing a new certificate
  • Testing the connection via a TLS certificate
  • About TLS protocol versions
    • cluster-example-pg-hba.yaml
• Connecting from an application
  • DNS resolution
  • Environment variables
  • Secrets
• Connection Pooling
  • Architecture
  • Quick start
  • Pooler resource lifecycle
  • Security
    • Certificates
  • Authentication
    • Default authentication method
    • SQL instructions
    • Custom authentication method
  • Pod templates
    • Key requirements
    • Examples
    • High availability with pod anti-affinity
    • Custom image and resource limits
  • Service Template
  • High availability (HA)
  • PgBouncer configuration options
  • Monitoring
    • Deprecation of Automatic PodMonitor Creation
  • Logging
  • Pausing connections
  • Limitations
    • Single PostgreSQL cluster
    • Controlled configurability
• Replica clusters
  • Basic Concepts
    • About PostgreSQL Roles
    • Bootstrapping a Replica Cluster
    • Configuring Replication
    • Defining an External Cluster
    • Backup and Symmetric Architectures
    • Distributed Architecture Flexibility
  • Setting Up a Replica Cluster
  • Distributed Topology
    • Planning for a Distributed PostgreSQL Database
    • Demoting a Primary to a Replica Cluster
    • Promoting a Replica to a Primary Cluster
  • Standalone Replica Clusters
    • Main Differences with Distributed Topology
    • Example of Standalone Replica Cluster using pg_basebackup
    • Example of Standalone Replica Cluster from an object store
    • Example using a Volume Snapshot
  • Delayed replicas
• Kubernetes upgrade and maintenance
  • Importance of Regular Updates
  • Maintenance Operations in a Cluster
  • Temporary PostgreSQL Cluster Degradation
  • Pod Disruption Budgets
  • PostgreSQL Clusters used for Development or Testing
  • Node Maintenance Window
    • Single instance clusters with reusePVC set to false
• PostgreSQL upgrades
  • Minor Version Upgrades
    • Upgrading a Minor Version in EDB Postgres® AI for CloudNativePG™ Cluster
  • Major Version Upgrades
  • Offline In-Place Major Upgrades
    • Upgrade Process
    • Post-Upgrade Actions
    • Backup and WAL Archive Considerations
    • Example: Manual archive path separation with the Barman Cloud plugin
    • Example: Performing a Major Upgrade
    • Upgrade Process
• EDB Postgres® AI for CloudNativePG™ Cluster Plugin
  • Install
    • Via the installation script
    • Using the Debian or RedHat packages
    • Debian packages
    • RPM packages
    • Supported Architectures
    • Configuring auto-completion
  • Use
    • Generation of installation manifests
    • Status
    • Promote
    • Certificates
    • Restart
    • Reload
    • Maintenance
    • Report
    • report Operator
    • report Cluster
    • Logs
    • Cluster logs
    • Pretty
    • Destroy
    • Cluster hibernation
    • Benchmarking the database with pgbench
    • Benchmarking the storage with fio
    • Requesting a new physical backup
    • Launching psql
    • Using pgAdmin4 for evaluation/demonstration purposes only
    • Logical Replication Publications
    • Creating a new publication
    • Dropping a publication
    • Logical Replication Subscriptions
    • Creating a new subscription
    • Dropping a subscription
    • Synchronizing sequences
  • Integration with K9s
  • Permissions required by the plugin
    • Role examples
• Automated failover
  • RTO and RPO impact
  • Delayed failover
  • Failover Quorum (Quorum-based Failover)
    • How it works
    • Quorum Failover Example Scenarios
    • Scenario 1: Three-node cluster, failing pod(s)
    • Scenario 2: Three-node cluster, network partition
    • Scenario 3: Five-node cluster, network partition
    • Scenario 4: Three-node cluster with remote synchronous replicas
    • Scenario 5: Three-node cluster, preferred data durability, network partition
• Fencing
  • How to fence instances
  • How to lift fencing
  • How fencing works
• Declarative hibernation
  • Hibernation
  • Rehydration
• PostGIS
  • Basic concepts about a PostGIS cluster
  • Create a new PostgreSQL cluster with PostGIS
• Container Image Requirements
  • Image Tag Requirements
• Image Volume Extensions
  • Official Extension Images and Catalogs
  • Benefits
  • Requirements
  • How it works
    • Configuration Source and Precedence
    • Mounting and PostgreSQL Configuration
    • Installation in a Database
  • Adding an Extension to a Postgres Cluster
    • Via an Image Catalog (Recommended)
    • Directly in the Cluster
    • Verifying Extension Status
  • Removing an Extension from a PostgreSQL Cluster
  • Advanced Topics
    • Setting Custom Paths
    • Multi-extension Images
    • Including System Libraries
    • Including external binaries
    • Environment variables for extensions
    • Dynamic Placeholder Expansion
    • Precedence and Conflict Resolution
  • Image Specifications
• Custom Pod Controller
  • PVC resizing
  • Primary Instances versus Replicas
  • Coherence of PVCs
  • Local storage, remote storage, and database size
• Networking
  • Cross-namespace network policy for the operator
  • Cross-cluster networking
    • networkpolicy-example.yaml
• Benchmarking
  • pgbench
  • fio