You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/releases.rst
+92Lines changed: 92 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,6 +3,98 @@
3
3
Release notes
4
4
=============
5
5
6
+
Version 4.0.0
7
+
-------------
8
+
9
+
Released 2024-08-29
10
+
11
+
.. warning::
12
+
- This version completes work on getting rid of the "master" term, in favor of "primary". This means a couple of breaking changes, please read the release notes carefully. Upgrading to the Patroni 4+ will work reliably only if you run Patroni 3.1.0 or newer. Upgrading from an older version directly to 4+ is possible but may lead to unexpected behavior if the primary fails while the rest of the nodes are running on other Patroni versions.
13
+
14
+
15
+
**Breaking changes**
16
+
17
+
- The following breaking changes were introduced when getting rid of the non-inclusive "master" term in the Patroni code:
18
+
19
+
- On Kubernetes, Patroni by default will set ``role`` label to ``primary``. In case if you want to keep the old behavior and avoid downtime or lengthy complex migrations, you can configure parameters ``kubernetes.leader_label_value`` and ``kubernetes.standby_leader_label_value`` to ``master``. Read more :ref:`here <kubernetes_role_values>`.
20
+
- Patroni role is written to DCS as ``primary`` instead of ``master``.
21
+
- Patroni role returned by Patroni REST API has been changed from ``master`` to ``primary``.
22
+
- Patroni REST API no longer accepts ``role=master`` in requests to ``/switchover``, ``/failover``, ``/restart`` endpoints.
23
+
- ``/metrics`` REST API endpoint will no longer report ``patroni_master`` metric.
24
+
- ``patronictl`` no longer accepts ``--master`` option for any command. ``--leader`` or ``--primary`` options should be used instead.
25
+
- ``no_master`` option in the declarative configuration of custom replica creation methods is no longer treated as a special option, please use ``no_leader`` instead.
- All callback scripts are executed with ``role=primary`` option passed instead of ``role=master``.
29
+
30
+
- ``patronictl failover`` does not accept ``--leader`` option that was deprecated since Patroni 3.2.0.
31
+
32
+
- User creation functionality (``bootstrap.users`` configuration section) deprecated since Patroni 3.2.0 has been removed.
33
+
34
+
35
+
**New features**
36
+
37
+
- Quorum-based failover (Ants Aasma, Alexander Kukushkin)
38
+
39
+
The feature implements quorum-based synchronous replication (available from PostgreSQL v10) which helps to reduce worst-case latencies, even during normal operation, as a higher latency of replicating to one standby can be compensated by other standbys. Patroni implements additional safeguards to prevent any user-visible data loss by choosing a failover candidate based on the latest transaction received.
40
+
41
+
- Register Citus secondaries in ``pg_dist_node`` (Alexander Kukushkin)
42
+
43
+
Patroni now maintains the list of nodes with ``role==replica``, ``state==running`` and without ``noloadbalance`` :ref:`tag <tags_settings>` in ``pg_dist_node``.
44
+
45
+
- Configurable retention of members' replication slots (Alexander Kukushkin)
46
+
47
+
Implements support of ``member_slots_ttl`` global configuration parameter that controls for how long member replication slots should be kept around when the member key is absent.
48
+
49
+
- Make permissions of log files created by Patroni configurable (Alexander Kukushkin)
50
+
51
+
Allows to set specific permissions for log files created by Patroni. If not specified, permissions are set based on the current ``umask`` value.
52
+
53
+
- Compatibility with PostgreSQL 17 beta3 (Alexander Kukushkin)
54
+
55
+
GUC's validator rules were extended. Patroni handles all the new auxiliary backends during shutdown and sets ``dbname`` in ``primary_conninfo``, as it is required for logical replication slots synchronization.
56
+
57
+
- Implement ``--ignore-listen-port`` option for Patroni config validation (Sahil Naphade)
58
+
59
+
Make it possible to ignore already bound ports when running ``patroni --validate-config``.
60
+
61
+
62
+
**Improvements**
63
+
64
+
- Make ``wal_log_hints`` configurable (Paul_Kim)
65
+
66
+
Allows to avoid the overhead of ``wal_log_hints`` configuration being enabled in case ``use_pg_rewind`` is set to ``off``.
67
+
68
+
- Log ``pg_basebackup`` command in ``DEBUG`` level (Waynerv)
69
+
70
+
Facilitates failed initialization debugging.
71
+
72
+
73
+
**Bugfixes**
74
+
75
+
- Advance permanent slots for cascading nodes while in failsafe (Alexander Kukushkin)
76
+
77
+
Ensure that slots for cascading replicas are properly advanced on the primary when failsafe mode is activated. It is done by extending replicas response on ``POST /failsafe`` REST API request with their ``xlog_location``.
78
+
79
+
- Don't let the current node be chosen as synchronous (Alexander Kukushkin)
80
+
81
+
There may be "something" streaming from the current primary node with ``application_name`` that matches the name of the current primary. Patroni was not properly handling this situation, which could end up in the primary being declared as a synchronous node and consequently was blocking switchovers.
82
+
83
+
- Ignore ``restapi.allowlist_include_members`` for POST /failsafe (Alexander Kukushkin)
84
+
85
+
- Improve GUCs validation (Polina Bungina)
86
+
87
+
Due to additional validation through running ``postgres --describe-config`` command, it was previously not possible to set GUCs not listed there through Patroni configuration. This limitation is now removed.
88
+
89
+
- Add line with ``localhost`` to ``.pgpass`` file when unix sockets are detected (Alexander Kukushkin)
90
+
91
+
Patroni will add an additional line to ``.pgpass`` file if ``host`` parameter specified starts with ``/`` character. This allows to cover a corner case when ``host`` matches the default socket directory path.
92
+
93
+
- Fix logging issues (Waynerv)
94
+
95
+
Defined proper request URL in failsafe handling logs and fixed the order of timestamps in postmaster check log.
0 commit comments