Skip to content

Commit fe14e86

Browse files
authored
Merge pull request #6737 from EnterpriseDB/DOCS-690-adjust-language-about-mixed-versions-redux
Changes with expanded language
2 parents 3ca9db3 + 0e50d7d commit fe14e86

File tree

5 files changed

+77
-26
lines changed

5 files changed

+77
-26
lines changed

product_docs/docs/pgd/4/upgrades/index.mdx

+12-5
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,18 @@ A rolling upgrade starts with a cluster with all nodes at a prior release,
5656
then proceeds by upgrading one node at a time to the newer release, until
5757
all nodes are at the newer release. There should never be more than two versions
5858
of any component running at the same time, which means the new upgrade must not
59-
be initiated until the previous upgrade process has fully finished on all nodes.
60-
61-
An upgrade process may take an extended period of time when the user decides
62-
caution is required to reduce business risk, though it's not recommended
63-
to run the mixed versions of the software indefinitely.
59+
be initiated until the previous upgrade process has fully finished on all nodes.
60+
61+
Where additional caution is required to reduce business risk, more time may be
62+
required to perform an upgrade. For maximum caution and to reduce the time
63+
required upgrading production systems, we suggest performing the upgrades in a
64+
separate test environment first.
65+
66+
Don't run with mixed versions of the software for any longer than is absolutely
67+
necessary to complete the upgrade. The longer you run with mixed versions, the
68+
more likely you are to encounter issues, the more difficult it is to diagnose
69+
and resolve them. We recommend upgrading in off peak hours for your business,
70+
and over a short period of time.
6471

6572
While Rolling Upgrade can be used for upgrading major version of the software
6673
it is not supported to mix PostgreSQL, EDB Postgres Extended and

product_docs/docs/pgd/5.6/planning/limitations.mdx

+28-5
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ into account when planning your deployment.
99

1010
## Nodes
1111

12-
- PGD can run hundreds of nodes, assuming adequate hardware and network. However,
12+
- PGD can run hundreds of nodes, assuming adequate hardware and network. However,
1313
for mesh-based deployments, we generally don’t recommend running more than 48
1414
nodes in one cluster. If you need extra read scalability beyond the 48-node
1515
limit, you can add subscriber-only nodes without adding connections to the
1616
mesh network.
1717

18-
- The minimum recommended number of nodes in a group is three to provide fault
18+
- The minimum recommended number of nodes in a group is three to provide fault
1919
tolerance for PGD's consensus mechanism. With just two nodes, consensus would
2020
fail if one of the nodes were unresponsive. Consensus is required for some PGD
2121
operations, such as distributed sequence generation. For more information about
@@ -76,9 +76,32 @@ and current listing.
7676

7777
## Mixed PGD versions
7878

79-
PGD was developed to [enable rolling upgrades of PGD](/pgd/latest/upgrades) by allowing mixed versions of PGD to operate during the upgrade process.
80-
We expect users to run mixed versions only during upgrades and, once an upgrade starts, that they complete that upgrade.
81-
We don't support running mixed versions of PGD except during an upgrade.
79+
While PGD was developed to [enable rolling upgrades of
80+
PGD](/pgd/latest/upgrades) by allowing mixed versions of PGD to operate during
81+
the upgrade process, we expect users to run mixed versions only during upgrades
82+
and for users to complete their upgrades as quickly as possible. We also
83+
recommend that you test any rolling upgrade process in a non-production
84+
environment before attempting it in production.
85+
86+
When a node is upgraded, it returns to the cluster and communicates with the
87+
other nodes in the cluster using the lowest version of the inter-node protocol
88+
that is supported by all the other nodes in the cluster. This means that the
89+
upgraded node will be able to communicate with all other nodes in the cluster,
90+
but it will not be able to take advantage of any new features or improvements
91+
that were introduced in the newer version of PGD.
92+
93+
That will stay the case until all nodes in the cluster have been upgraded to the
94+
same newer version. The longer you run mixed versions, the longer you will be
95+
without the benefits of the new version, and the longer you will be exposed to
96+
any potential interoperability issues that might arise from running mixed
97+
versions. Mixed version clusters are not supported for extended periods of time.
98+
99+
Therefore, once an PGD cluster upgrade has begun, you should complete the whole
100+
cluster upgrade as quickly as possible.
101+
102+
We don't support running mixed versions of PGD except during an upgrade, and we don't support clusters running mixed versions even while being upgraded, for extended periods.
103+
104+
For more information on rolling upgrades and mixed versions, see [Rolling upgrade considerations](/pgd/latest/upgrades/manual_overview#rolling-upgrade-considerations).
82105

83106
## Other limitations
84107

product_docs/docs/pgd/5.6/upgrades/manual_overview.mdx

+13-8
Original file line numberDiff line numberDiff line change
@@ -57,16 +57,21 @@ A rolling upgrade starts with a cluster with all nodes at a prior release. It
5757
then proceeds by upgrading one node at a time to the newer release, until all
5858
nodes are at the newer release. There must be no more than two versions of the
5959
software running at the same time. An upgrade must be completed, with all nodes
60-
fully upgraded, before starting another upgrade.
60+
fully upgraded, before starting another upgrade.
6161

62-
An upgrade process can take more time when
63-
caution is required to reduce business risk. However, we don't recommend
64-
running mixed versions of the software indefinitely.
62+
Where additional caution is required to reduce business risk, more time may be required to perform an upgrade.
63+
For maximum caution and to reduce the time required upgrading production systems, we suggest performing the upgrades in a separate test environment first.
6564

66-
While you can use a rolling upgrade for upgrading a major version of the software,
67-
we don't support mixing PostgreSQL, EDB Postgres Extended, and
68-
EDB Postgres Advanced Server in one cluster. So you can't use this approach
69-
to change the Postgres variant.
65+
Don't run with mixed versions of the software for any longer than is absolutely necessary to complete the upgrade.
66+
You can check on the versions in the cluster using the [`pgd show-version`](/pgd/5.6/cli/command_ref/pgd_show-version/)
67+
command. The longer you run with mixed versions, the more likely you are to
68+
encounter issues, the more difficult it is to diagnose and resolve them.
69+
We recommend upgrading in off peak hours for your business, and over a short period of time.
70+
71+
While you can use a rolling upgrade for upgrading a major version of the
72+
software, we don't support mixing PostgreSQL, EDB Postgres Extended, and EDB
73+
Postgres Advanced Server in one cluster. So you can't use this approach to
74+
change the Postgres variant.
7075

7176
!!! Warning
7277
Downgrades of EDB Postgres Distributed aren't supported. They require

product_docs/docs/pgd/5.7/planning/limitations.mdx

+17-5
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ into account when planning your deployment.
99

1010
## Nodes
1111

12-
- PGD can run hundreds of nodes, assuming adequate hardware and network. However,
12+
- PGD can run hundreds of nodes, assuming adequate hardware and network. However,
1313
for mesh-based deployments, we generally don’t recommend running more than 48
1414
nodes in one cluster. If you need extra read scalability beyond the 48-node
1515
limit, you can add subscriber-only nodes without adding connections to the
1616
mesh network.
1717

18-
- The minimum recommended number of nodes in a group is three to provide fault
18+
- The minimum recommended number of nodes in a group is three to provide fault
1919
tolerance for PGD's consensus mechanism. With just two nodes, consensus would
2020
fail if one of the nodes were unresponsive. Consensus is required for some PGD
2121
operations, such as distributed sequence generation. For more information about
@@ -76,9 +76,21 @@ and current listing.
7676

7777
## Mixed PGD versions
7878

79-
PGD was developed to [enable rolling upgrades of PGD](/pgd/latest/upgrades) by allowing mixed versions of PGD to operate during the upgrade process.
80-
We expect users to run mixed versions only during upgrades and, once an upgrade starts, that they complete that upgrade.
81-
We don't support running mixed versions of PGD except during an upgrade.
79+
While PGD was developed to [enable rolling upgrades of PGD](/pgd/latest/upgrades) by allowing mixed versions of PGD to operate during the upgrade process, we expect users to run mixed versions only during upgrades and for users to complete their upgrades as quickly as possible.
80+
We also recommend that you test any rolling upgrade process in a non-production environment before attempting it in production.
81+
82+
When a node is upgraded, it returns to the cluster and communicates with the other nodes in the cluster using the lowest version of the inter-node protocol that is supported by all the other nodes in the cluster.
83+
This means that the upgraded node will be able to communicate with all other nodes in the cluster, but it will not be able to take advantage of any new features or improvements that were introduced in the newer version of PGD.
84+
85+
That will stay the case until all nodes in the cluster have been upgraded to the same newer version.
86+
The longer you run mixed versions, the longer you will be without the benefits of the new version, and the longer you will be exposed to any potential interoperability issues that might arise from running mixed versions.
87+
Mixed version clusters are not supported for extended periods of time.
88+
89+
Therefore, once an PGD cluster upgrade has begun, you should complete the whole cluster upgrade as quickly as possible.
90+
91+
We don't support running mixed versions of PGD except during an upgrade, and we don't support clusters running mixed versions even while being upgraded, for extended periods.
92+
93+
For more information on rolling upgrades and mixed versions, see [Rolling upgrade considerations](/pgd/latest/upgrades/manual_overview#rolling-upgrade-considerations).
8294

8395
## Other limitations
8496

product_docs/docs/pgd/5.7/upgrades/manual_overview.mdx

+7-3
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,13 @@ nodes are at the newer release. There must be no more than two versions of the
5959
software running at the same time. An upgrade must be completed, with all nodes
6060
fully upgraded, before starting another upgrade.
6161

62-
An upgrade process can take more time when
63-
caution is required to reduce business risk. However, we don't recommend
64-
running mixed versions of the software indefinitely.
62+
Where additional caution is required to reduce business risk, more time may be required to perform an upgrade.
63+
For maximum caution and to reduce the time required upgrading production systems, we suggest performing the upgrades in a separate test environment first.
64+
65+
Don't run with mixed versions of the software for any longer than is absolutely necessary to complete the upgrade.
66+
You can check on the versions in the cluster using the [`pgd nodes list --versions`](/pgd/5.7/cli/command_ref/nodes/list/) command.
67+
The longer you run with mixed versions, the more likely you are to encounter issues, the more difficult it is to diagnose and resolve them.
68+
We recommend upgrading in off peak hours for your business, and over a short period of time.
6569

6670
While you can use a rolling upgrade for upgrading a major version of the software,
6771
we don't support mixing PostgreSQL, EDB Postgres Extended, and

0 commit comments

Comments
 (0)