CloudNativePG

CloudNativePG
View page source

CloudNativePG

Introduction
- Supported Kubernetes distributions
- Container images
  - Operator
  - Operands
- Main features
- About this guide
Before you start
- Kubernetes terminology
- PostgreSQL terminology
- Cloud terminology
- What to do next
Use cases
- Case 1: Applications inside Kubernetes
- Case 2: Applications outside Kubernetes
Architecture
- Synchronizing the state
- Kubernetes architecture
- PostgreSQL architecture
  - Read-write workloads
  - Read-only workloads
- Deployments across Kubernetes clusters
Installation and upgrades
- Installation on Kubernetes
- Details about the deployment
- Upgrades
Quickstart
- Part 1: Setup the local Kubernetes playground
  - Minikube
  - Kind
- Part 2: Install CloudNativePG
- Part 3: Deploy a PostgreSQL cluster
- Part 4: Monitor clusters with Prometheus and Grafana
Image Catalog
- CloudNativePG Catalogs
Bootstrap
- The bootstrap section
- The externalClusters section
  - Password files
- Bootstrap an empty cluster (initdb )
  - Passing Options to initdb
  - Executing Queries After Initialization
- Bootstrap from another 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
- Cluster
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
- 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
- Synchronous Replication (Deprecated)
  - Select nodes for synchronous replication
- Replication slots
Logical Replication
- Publications
- Subscriptions
- 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
- Scheduled Backups
- On-Demand Backups
  - Example: Requesting an On-Demand Backup
  - Monitoring Backup Progress
- Backup Methods
- Backup from a Standby
- Retention Policies
WAL archiving
- Plugin-Based Architecture
- Supported Plugins
- Deprecation Notice: Native Barman Cloud
- About the archive timeout
Recovery
- Recovery from an Object Store with the Barman Cloud Plugin
- Recovery from VolumeSnapshot Objects
- Recovery from a Backup object
- Additional Considerations
- Point in time recovery (PITR)
- Configure the application database
- How recovery works under the hood
- Restoring into a Cluster with a Backup Section
Service management
- Disabling Default Services
- Adding Your Own Services
  - About Exposing Postgres Services
PostgreSQL Configuration
- The postgresql section
- The pg_hba section
  - LDAP Configuration
- The pg_ident section
- Changing configuration
- Enabling ALTER SYSTEM
- Dynamic Shared Memory settings
  - POSIX shared memory
  - System V shared memory
- Fixed parameters
PostgreSQL Role management
- Password management
  - Password expiry, VALID UNTIL
  - Password hashed
- Unrealizable role configurations
- Status of managed roles
PostgreSQL Database management
- Scope of Management
- Declarative Database Manifest
- Required Fields in the Database Manifest
- Deleting via delete Reclaim Policy
- Declaratively Setting ensure: absent
- 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
Operator configuration
- Available options
- Defining an operator config map
- Defining an operator secret
- Restarting the operator to reload configs
- Profiling tools
Instance Pod configuration
- Projected volumes
- Ephemeral volumes
  - Volume Claim Template for Temporary Storage
  - Volume for shared memory
- Environment variables
Storage
- Backup and recovery
- Benchmarking CloudNativePG
- Encryption at rest
- 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
- Monitoring the CloudNativePG operator
  - Monitoring the operator with Prometheus
  - Enabling TLS for operator metrics
- How to inspect the exported metrics
  - Using port forwarding
  - Using curl
- Auxiliary resources
Logging
- Cluster Logs
- Operator Logs
- PostgreSQL Logs
- PGAudit Logs
- Other Logs
Certificates
- Operator-Managed Mode
- User-provided certificates mode
Client TLS/SSL connections
- Issuing a new certificate
- Testing the connection via a TLS certificate
- About TLS protocol versions
Connecting from an application
- DNS resolution
- Environment variables
- Secrets
Connection Pooling
- Architecture
- Quick start
- Pooler resource lifecycle
- Security
  - Certificates
- Authentication
- Pod templates
- 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
- Setting Up a Replica Cluster
- Distributed Topology
- Standalone Replica Clusters
- 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 CloudNativePG
- Major Version Upgrades
- Offline In-Place Major Upgrades
Kubectl Plugin
- Install
- Use
- Integration with K9s
- Permissions required by the plugin
  - Role examples
Automated failover
- RTO and RPO impact
- Delayed failover
- Failover Quorum (Quorum-based Failover)
Troubleshooting
- Before you start
  - Kubernetes environment
  - Useful utilities
- First steps
- Are there backups?
- Emergency backup
- Logs
- Operator information
  - Gather more information about the operator
- Cluster information
- Pod information
  - Gather and filter extra information about PostgreSQL pods
- Backup information
- Storage information
- Node information
- Conditions
  - How to wait for a particular condition
- Networking
- PostgreSQL core dumps
- Visualizing and Analyzing Profiling Data
  - Example
  - Troubleshooting
- Some known issues
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
End-to-End Tests
Container Image Requirements
- Image Tag Requirements
Image Volume Extensions
- Benefits
- Requirements
- How it works
- How to add a new extension
  - Adding a new extension to a Cluster resource
  - Adding a new extension to a Database resource
- Advanced Topics
- Image Specifications
- Caveats
CNPG-I
- Why CNPG-I?
- Registering a plugin
- Using a plugin
- Community plugins
Operator capability levels
- Level 1: Basic install
- Level 2: Seamless upgrades
- Level 3: Full lifecycle
- Level 4: Deep insights
- Level 5: Auto pilot
  - Automated failover for self-healing
  - Automated recreation of a standby
Custom Pod Controller
- PVC resizing
- Primary Instances versus Replicas
- Coherence of PVCs
- Local storage, remote storage, and database size
Examples
- Basics
- Security
- Backups
- Replica clusters
- PostGIS
- Managed roles
- Managed services
- Declarative tablespaces
- Pooler configuration
- Logical replication via declarative Publication and Subscription objects
- Declarative management of Postgres databases
Networking
- Cross-namespace network policy for the operator
- Cross-cluster networking
Benchmarking
- pgbench
- fio
Frequently Asked Questions (FAQ)
- Running PostgreSQL in Kubernetes
- High availability
API Reference
- Packages
- postgresql.cnpg.io/v1
Supported releases
- Support Policy
- Naming Scheme
- Support status of CloudNativePG releases
  - Supported PostgreSQL versions
- Upcoming releases
- Old releases
- What we mean by support
Preview Versions
- Purpose of Release Candidates
- Community Involvement
- Usage Advisory
- Current Preview Version
Release notes
- Release notes for CloudNativePG 1.28
  - Version 1.28.0
- Release notes for CloudNativePG 1.27
- Release notes for CloudNativePG 1.26
- Release notes Old
- EDB Cloud-Native PostgreSQL
CNCF Projects
- External Secrets
- Cilium
Appendixes
- Appendix C - Common object stores for backups
- Appendix B - Backup on object stores
- Appendix A - Backup on volume snapshots

Next

© Copyright Cloud Native Computing Foundation.