Releases: EnterpriseDB/kubectl-cnp
Release list
v1.23.6
Release Date: December 23, 2024
!!! Warning This is the final release in the 1.23.x series. Users are strongly encouraged to upgrade to a newer minor version, as 1.23 is no longer supported.
Enhancements
- Enable customization of startup, liveness, and readiness probes through the
.spec.probesstanza. (#6266) - Add the
k8s.enterprisedb.io/userTypelabel to secrets generated for predefined users, specificallysuperuserandapp. (#4392) - Improved validation for the
spec.schedulefield in ScheduledBackups, raising warnings for potential misconfigurations. (#5396) cnpplugin:- Honor the
User-Agentheader in HTTP requests with the API server. (#6153)
- Honor the
Bug Fixes
- Ensure the former primary flushes its WAL file queue to the archive before re-synchronizing as a replica, reducing recovery times and enhancing data consistency during failovers. (#6141)
- Clean the WAL volume along with the
PGDATAvolume during bootstrap. (#6265) - Update the operator to set the cluster phase to
Unrecoverablewhen all previously generatedPersistentVolumeClaimsare missing. (#6170) - Fix the parsing of the
synchronous_standby_namesGUC when.spec.postgresql.synchronous.methodis set tofirst. (#5955) - Resolved a potential race condition when patching certain conditions in CRD statuses, improving reliability in concurrent updates. (#6328)
- Correct role changes to apply at the transaction level instead of the database context. (#6064)
- Remove the
primary_slot_namedefinition from theoverride.conffile on the primary to ensure it is always empty. (#6219) - Configure libpq environment variables, including
PGHOST, in PgBouncer pods to enable seamless access to thepgbouncervirtual database usingpsqlfrom within the container. (#6247) - Remove unnecessary updates to the Cluster status when verifying changes in the image catalog. (#6277)
- Prevent panic during recovery from an external server without proper backup configuration. (#6300)
- Resolved a key collision issue in structured logs, where the name field was inconsistently used to log two distinct values. (#6324)
- Ensure proper quoting of the inRoles field in SQL statements to prevent syntax errors in generated SQL during role management. (#6346)
cnpplugin:- Ensure the
kubectlcontext is properly passed in thepsqlcommand. (#6257) - Avoid displaying physical backups block when empty with
statuscommand. (#5998)
- Ensure the
v1.23.5
Release date: Oct 18, 2024
Enhancements:
- Remove the use of
pg_database_sizefrom the status probe, as it caused high resource utilization by scanning the entirePGDATAdirectory to compute database sizes. Thekubectl statusplugin will now rely onduto provide detailed size information retrieval (#5689). - Add the ability to configure the
full_page_writesparameter in PostgreSQL. This setting defaults toon, in line with PostgreSQL's recommendations (#5516). - Plugin:
- Add the
logs prettycommand in thecnpplugin to read a log stream from standard input and output a human-readable format, with options to filter log entries (#5770) - Enhance the
statuscommand by allowing multiple-voptions to increase verbosity for more detailed output (#5765). - Add support for specifying a custom Docker image using the
--imageflag in thepgadmin4plugin command, giving users control over the Docker image used for pgAdmin4 deployments (#5515).
- Add the
Fixes:
- Resolve an issue with concurrent status updates when demoting a primary to a designated primary, ensuring smoother transitions during cluster role changes (#5755).
- Ensure that replica PodDisruptionBudgets (PDB) are removed when scaling down to two instances, enabling easier maintenance on the node hosting the replica (#5487).
- Prioritize full rollout over inplace restarts (#5407).
- Fix an issue that could lead to double failover in cases of lost connectivity (#5788).
- Correctly set the
TMPDIRandPSQL_HISTORYenvironment variables for pods and jobs, improving temporary file and history management (#5503). - Plugin:
- Resolve a race condition in the
logs clustercommand (#5775). - Display the
potentialsync status in thestatusplugin (#5533). - Fix the issue where pods deployed by the
pgadmin4command didn’t have a writable home directory (#5800).
- Resolve a race condition in the
Supported versions
- PostgreSQL 17 (PostgreSQL 17.0 is the default image)
v1.23.4
Release date: Aug 22, 2024
Enhancements:
cnpplugin updates:- Enhance the
install generatecommand by adding a--control-planeoption, allowing deployment of the operator on control-plane nodes by setting node affinity and tolerations (#5271). - Enhance the
destroycommand to delete also any job related to the target instance (#5298).
- Enhance the
Fixes:
- Synchronous replication self-healing checks now exclude terminated pods, focusing only on active and functional pods (#5210).
- The instance manager will now terminate all existing operator-related replication connections following a role change in a replica cluster (#5209).
- Allow setting
smartShutdownTimeoutto zero, enabling immediate fast shutdown and bypassing the smart shutdown process when required (#5347).
v1.23.3
Release date: Jul 29, 2024
Enhancements:
- Add transparent support for PostgreSQL 17's
allow_alter_systemparameter, enabling or disabling theALTER SYSTEMcommand through the.spec.postgresql.enableAlterSystemoption (#4921). - Introduce the
reconcilePodSpecannotation on theClusterandPoolerresources to control the restart of pods following a change in the Pod specification (#5069). - Support the new metrics introduced in PgBouncer 1.23 in the
Poolermetrics collector (#5044).
Fixes:
- Enhance the mechanism for detecting Pods that have been terminated but not deleted during an eviction process, and extend the cleanup process during maintenance windows to include unschedulable Pods when the
reusePVCflag is set to false (#2056). - Disable
pg_rewindexecution for newly created replicas that employ VolumeSnapshot during bootstrapping to avoid introducing a new shutdown checkpoint entry in the WAL files. This ensures that replicas can reconnect to the primary without issues, which would otherwise be hindered by the additional checkpoint entry (#5081). - Gracefully handle failures during the initialization of a new instance. Any remaining data from the failed initialization is now either removed or, if it's a valid PostgreSQL data directory, moved to a backup location to avoid possible data loss (#5112).
- Enhance the robustness of the immediate backups reconciler by implementing retry logic upon initial backup failure (#4982).
- Wait for the
postmasterto shut down before starting it again (#4938). - Ensure that the
Poolerservice template can override the default service (#4846). - Exclude immutable databases from
pg_databasemetric monitoring and alerting processes (#4980). - Removed unnecessary permissions from the operator service account (#4911).
- Fix cluster role permissions for
ClusterImageCatalogs(#5034). - Ensure the operator initiates a rollout of the
Poolerinstance when the operator image is upgraded (#5006) - Address race condition causing the readiness probe to incorrectly show "not ready" after a PostgreSQL restart, even when the
postmasterwas accessible (#4920). - Prevent reconciliation of resources that aren't owned by a
Pooler(#4967). - Renew the certificates managed by the operator when the DNS Subject Alternative Names (SANs) are updated (#3269, #3319).
- Set PVC default
AccessModesin the template only when unspecified (#4845). - Gracefully handle unsatisfiable backup schedule (#5109).
cnpplugin:- Properly handle errors during the
statuscommand execution. - Support TLS in the
statuscommand (#4915).
- Properly handle errors during the
v1.23.2
Release date: Jun 12, 2024
Enhancements:
-
Enabled configuration of standby-sensitive parameters during recovery using a physical backup (#4564)
-
Enabled the configuration of the liveness probe timeout via the
.spec.livenessProbeTimeoutoption (#4719) -
cnpplugin forkubectl:- Enhanced support for ANSI colors in the plugin by adding the
--coloroption, which acceptsalways,never, andauto(default) as values (#4775) - The plugin is now available on Homebrew for macOS users (#4602)
- Enhanced support for ANSI colors in the plugin by adding the
Fixes:
-
Prevented fenced instances from entering an unnecessary loop and consuming all available CPU (#4625)
-
Resolved an issue where the instance manager on the primary would indefinitely wait for the instance to start after encountering a failure following a stop operation (#4434)
-
Fixed an issue where the interaction between
hot_standby_feedbackand managed cluster-level replication slots was preventing the autovacuum from operating correctly; this issue was causing disk space to remain occupied by dead tuples (#4811) -
Fixed a panic in the backup controller that occurred when pod container statuses were missing (#4765)
-
Prevented unnecessary shutdown of the instance manager (#4670)
-
Prevented unnecessary reloads of PostgreSQL configuration when unchanged (#4531)
-
Prevented unnecessary reloads of the ident map by ensuring a consistent and unique method of writing its content (#4648)
-
Avoided conflicts during phase registration by patching the status of the resource instead of updating it (#4637)
-
Implemented a timeout when restarting PostgreSQL and lifting fencing (#4504)
-
Ensured that a replica cluster is restarted after promotion to properly set the archive mode (#4399)
-
Removed an unneeded concurrent keep-alive routine that was causing random failures in volume snapshot backups (#4768)
-
Ensured correct parsing of the additional rows field returned when the
pgaudit.log_rowsoption was enabled, preventing audit logs from being incorrectly routed to the normal log stream (#4394) -
cnpplugin forkubectl:- Resolved an issue with listing PDBs using the
cnp statuscommand (#4530)
- Resolved an issue with listing PDBs using the
Changes
- Default operand image set to PostgreSQL 16.3 (#4584)
- Removed all RBAC requirements on namespace objects (#4753)
v1.23.0
Release date: Apr 24, 2024
!!! Important "Important changes to Community Supported Versions" We've updated our support policy to streamline our focus on one supported minor release at a time, rather than two. Additionally, we've extended the supplementary support period for the previous minor release to 3 months.
Features:
- PostgreSQL Image Catalogs: Introduced
ClusterImageCatalogandImageCatalogCRDs to manage operand container images based on PostgreSQL major version. This is facilitated through theCluster's.spec.imageCatalogRef stanza. This feature provides an alternative to the imageName option and will eventually replace it as the default method to define operand container images. - User-Defined Replication Slots: Enhanced the synchronization of physical replication slots to cover user-defined replication slots on the primary, via the newly introduced stanza
replicationSlots.synchronizeReplicas. - Configuration of Pod Disruption Budgets (PDB): Introduced the
.spec.enablePDBfield to disable PDBs on the primary instance, allowing proper eviction of the pod during maintenance operations. This is particularly useful for single-instance deployments. This feature is intended to replace the node maintenance window feature.
Enhancements:
- Users now have the capability to transition an existing cluster into replica mode, simplifying cross-datacenter switchover operations (#4261)
- Users can now customize the connection pooler service, including its type, labels, and annotations (#3384)
- Users can now configure the
wal_log_hintsPostgreSQL parameter (#4218) (#4218) - Fully Qualified Domain Names (FQDN) in URIs for automatically generated secrets (#4095)
- Cleanup of instance Pods not owned by the Cluster during Cluster restore (#4141)
- Command output of the plugin’s
statuscommand to show the status of PDBs (#4319) - Error detection when invoking
barman-cloud-wal-restoreinrecoverybootstrap (#4101)
Fixes:
- Ensured that before a switchover, the elected replica is in streaming replication (#4288)
- Correctly handle parsing errors of instances' LSN when sorting them (#4283)
- Recreate the primary Pod if there are no healthy standbys available to promote (#4132)
- Cleanup
PGDATAin case of failure of the restore job (#4151) - Reload certificates on configuration update (#3705)
cnpplugin forkubectl:- Improve the arguments handling of
destroy,fencing, andpromoteplugin commands (#4280) - Correctly handle the percentage of the backup progress in
cnp status(#4131) - Gracefully handle databases with no sequences in
sync-sequencescommand (#4346)
- Improve the arguments handling of
Changes:
- Operator images are now based on
gcr.io/distroless/static-debian12:nonroot(#4201) - The Grafana dashboard now resides at https://github.com/cloudnative-pg/grafana-dashboards (#4154)
v1.22.11
Release date: Jul 25, 2025
In memory of DJ Walker-Morgan.
!!! Warning This is expected to be the last release in the 1.22.x series. Users are strongly encouraged to upgrade to a newer minor version, as 1.24 is no longer supported.
Changes
- Removed
386and ARM (v5/v6/v7) architectures from thecnpplugin build matrix, reducing the number of published binaries (#7648).
Enhancements
-
Improved validation of
shared_buffersby correctly consideringHugePagessettings, ensuring accurate memory configuration checks (#7864). -
Set
oom_score_adjfor PostgreSQL worker processes to improve prioritization during out-of-memory situations (#7891). -
Added the
systemIDfield and related condition in theClusterstatus to track the PostgreSQL system identifier. (#7717).
Fixes
- Added a mutex in the connection pooler to protect concurrent access to the connections map, improving stability in high-concurrency environments (#7804).
v1.22.10
Release date: May 23, 2025
Enhancements
-
Implemented the
k8s.enterprisedb.io/validationannotation, enabling users to disable the validation webhook on EDB Postgres for Kubernetes-managed resources. Use with caution, as this allows unrestricted changes. (#7196) -
Added support for collecting
pg_stat_walmetrics in PostgreSQL 18. (#7005) -
Added support for LZ4, XZ, and Zstandard compression methods when archiving WAL files via Barman Cloud (deprecated). (#7151)
Security
- Set
imagePullPolicytoAlwaysfor the operator deployment to ensure that images are always pulled from the registry, reducing the risk of using outdated or potentially unsafe local images. (#7250)
Fixes
-
Fixed native replication slot synchronization and logical replication failover for PostgreSQL 17 by appending the
dbnameparameter toprimary_conninfoin replica configurations (#7298). -
Improved backup efficiency by introducing a fail-fast mechanism in WAL archiving, allowing quicker detection of unexpected primary demotion and avoiding unnecessary retries (#7483).
-
Fixed an off-by-one error in parallel WAL archiving that could cause one extra worker process to be spawned beyond the requested number (#7389).
-
Resolved a race condition that caused the operator to perform two switchovers when updating the PostgreSQL configuration. (#6991)
-
Corrected the
PodMonitorconfiguration by adjusting thematchLabelsscope for the targeted pooler and cluster pods. Previously, thematchLabelswere too broad, inadvertently inheriting labels from the cluster and leading to data collection from unintended targets. (#7063) -
Added a webhook warning for clusters with a missing unit (e.g., MB, GB) in the
shared_buffersconfiguration. This will become an error in future releases. Users should update their configurations to include explicit units (e.g.,512MBinstead of512). (#7160) -
cnpplugin:- Ensured that the primary Pod is recreated during an imperative restart when
primaryUpdateMethodis set torestart, aligning its definition with the replicas. (#7122)
- Ensured that the primary Pod is recreated during an imperative restart when
Changes
-
Updated the default PostgreSQL version to 17.5 for new cluster definitions. (#7556)
-
Updated the default PgBouncer version to 1.24.1 for new
Poolerdeployments (#7399).
v1.22.9
Release Date: March 4, 2025
Enhancements
- Introduced a startup probe for the operator to enhance reliability and prevent premature liveness probe failures during initialization. (#7008)
- Added support for using the
-rservice with the Pooler. (#6868) - Introduced an optional
--ttlflag for thepgbenchplugin, enabling automatic deletion of completed jobs after a user-defined duration. (#6701) - Updated the default PostgreSQL version to 17.4 for new cluster definitions. (#6960)
Security
- The operator image build process has been enhanced to strengthen security and transparency. Images are now signed with
cosign, and OCI attestations are generated, incorporating the Software Bill of Materials (SBOM) and provenance data. Additionally, OCI annotations have been added to improve traceability and ensure the integrity of the images.
Bug Fixes
- Fixed inconsistent behavior in default probe knob values when
.spec.probesis defined, ensuring users can override all settings, includingfailureThreshold. If unspecified in the startup probe,failureThresholdis now correctly derived from.spec.startupDelay / periodSeconds(default:10, now overridable). The same logic applies to liveness probes via.spec.livenessProbeTimeout. (#6656) - Fixed an issue where WAL metrics were unavailable after an instance restart until a configuration change was applied. (#6816)
- Fixed an issue in monolithic database import where role import was skipped if no roles were specified. (#6646)
- Added support for new metrics introduced in PgBouncer 1.24. (#6630)
- Improved handling of replication-sensitive parameter reductions by ensuring timely reconciliation after primary server restarts. (#6440)
- Ensured
override.confis consistently included inpostgresql.confduring replica cluster bootstrapping, preventing replication failures due to missing configuration settings. (#6808) - Ensured
override.confis correctly initialized before invokingpg_rewindto prevent failures during primary role changes. (#6670) - Enhanced webhook responses to return both warnings and errors when applicable, improving diagnostic accuracy. (#6579)
- Ensured the operator version is correctly reconciled. (#6496)
- Improved PostgreSQL version detection by using a more precise check of the data directory. (#6659)
- Volume Snapshot Backups:
- Fixed an issue where unused backup connections were not properly cleaned up. (#6882)
- Ensured the instance manager closes stale PostgreSQL connections left by failed volume snapshot backups. (#6879)
- Prevented the operator from starting a new volume snapshot backup while another is already in progress. (#6890)
cnpplugin:- Restored functionality of the
promoteplugin command. (#6476) - Enhanced
kubectl cnp report --logs <cluster>to collect logs from all containers, including sidecars. (#6636) - Ensured
pgbenchjobs can run when aClusteruses anImageCatalog. (#6868)
- Restored functionality of the
Technical Enhancements
- Added support for Kubernetes
client-gen, enabling automated generation of Go clients for all EDB Postgres for Kubernetes CRDs. (#6695)
v1.22.8
Release Date: December 23, 2024
!!! Warning A new LTS release, version 1.25.0, is now available! Please note that support for 1.22 will officially end on July 2025. We recommend starting your upgrade planning now to transition smoothly to the 1.25 LTS release.
Enhancements
- Enable customization of startup, liveness, and readiness probes through the
.spec.probesstanza. (#6266) - Add the
cnpg.io/userTypelabel to secrets generated for predefined users, specificallysuperuserandapp. (#4392) - Improved validation for the
spec.schedulefield in ScheduledBackups, raising warnings for potential misconfigurations. (#5396) cnpgplugin:- Honor the
User-Agentheader in HTTP requests with the API server. (#6153)
- Honor the
Bug Fixes
- Ensure the former primary flushes its WAL file queue to the archive before re-synchronizing as a replica, reducing recovery times and enhancing data consistency during failovers. (#6141)
- Clean the WAL volume along with the
PGDATAvolume during bootstrap. (#6265) - Update the operator to set the cluster phase to
Unrecoverablewhen all previously generatedPersistentVolumeClaimsare missing. (#6170) - Fix the parsing of the
synchronous_standby_namesGUC when.spec.postgresql.synchronous.methodis set tofirst. (#5955) - Resolved a potential race condition when patching certain conditions in CRD statuses, improving reliability in concurrent updates. (#6328)
- Correct role changes to apply at the transaction level instead of the database context. (#6064)
- Remove the
primary_slot_namedefinition from theoverride.conffile on the primary to ensure it is always empty. (#6219) - Configure libpq environment variables, including
PGHOST, in PgBouncer pods to enable seamless access to thepgbouncervirtual database usingpsqlfrom within the container. (#6247) - Prevent panic during recovery from an external server without proper backup configuration. (#6300)
- Resolved a key collision issue in structured logs, where the name field was inconsistently used to log two distinct values. (#6324)
- Ensure proper quoting of the inRoles field in SQL statements to prevent syntax errors in generated SQL during role management. (#6346)
cnpgplugin:- Ensure the
kubectlcontext is properly passed in thepsqlcommand. (#6257) - Avoid displaying physical backups block when empty with
statuscommand. (#5998)
- Ensure the