From d2ef7e1df48b1719159591f16fbaa3a2e449dd89 Mon Sep 17 00:00:00 2001 From: Dj Walker-Morgan Date: Wed, 6 Mar 2024 09:51:49 +0000 Subject: [PATCH 1/6] Fixed error and freshened file. Signed-off-by: Dj Walker-Morgan --- .../docs/pgd/5/upgrades/tpa_overview.mdx | 34 ++++++++++++------- 1 file changed, 22 insertions(+), 12 deletions(-) diff --git a/product_docs/docs/pgd/5/upgrades/tpa_overview.mdx b/product_docs/docs/pgd/5/upgrades/tpa_overview.mdx index 2c2ef760207..c50b8f5ddc4 100644 --- a/product_docs/docs/pgd/5/upgrades/tpa_overview.mdx +++ b/product_docs/docs/pgd/5/upgrades/tpa_overview.mdx @@ -3,28 +3,32 @@ title: Upgrading PGD clusters with TPA --- !!! Note No Postgres major version upgrades -TPA doesn't currently support major version upgrades of Postgres. The techniques outlined here can perform minor version upgrades of the PGD software and minor version upgrades of Postgres. To perform a major version upgrade of Postgres, see [In-place Postgres major version upgrades](bdr_pg_upgrade). +TPA doesn't currently support major version upgrades of Postgres. + +To perform a major version upgrade of Postgres, see [In-place Postgres major version upgrades](bdr_pg_upgrade). !!! -If you used TPA to install your cluster, you can also use TPA to upgrade your cluster. You can read more, in detail, about the capabilities of TPA upgrades in [Upgrading your cluster](/tpa/latest/tpaexec-upgrade/) in the TPA documentation. +If you used TPA to install your cluster, you can also use TPA to upgrade it. The techniques outlined here can perform minor and major version upgrades of the PGD software. They can also perform minor version upgrades of Postgres. + +You can read more about the capabilities of TPA upgrades in [Upgrading your cluster](/tpa/latest/tpaexec-upgrade/) in the TPA documentation. !!! Warning Always test first -If possible, always test upgrade processes in a QA environment first to ensure there are no unexpected factors to be taken into account. TPA's ability to reproducibly deploy a PGD configuration makes it much easier to build a test environment to work with. +If possible, always test upgrade processes in a QA environment first. This should help ensure that there are no unexpected factors that should be taken into account. TPA's ability to reproducibly deploy a PGD configuration makes it much easier to build a test environment to work with. !!! ## Minor and major PGD upgrades -Minor version upgrades of PGD are managed automatically +TPA automatically manages minor version upgrades of PGD. -Major version upgrades of PGD will require changes to the TPA `config.yml` file which contains the deployment configuration. +Major version upgrades of PGD will require changes to the TPA `config.yml` file, which contains the deployment configuration. -If you are upgrading to PGD 5, from previous PGD major versions, you will be able to use [`tpaexec reconfigure`](/tpa/latest/reference/tpaexec-reconfigure/) to help you make appropriate modifications to your deployment configuration. +When upgrading to PGD 5 from previous PGD major versions, you can use [`tpaexec reconfigure`](/tpa/latest/reference/tpaexec-reconfigure/). This command will help you make appropriate modifications to your deployment configuration. The `reconfigure` command will require settings for architecture (only `PGD_Always_ON` and PGD Proxy routing to run. Remember to back up your deployment configuration before running, and use the `--describe` and `--output` options to preview the reconfiguration. ## Pre-requisites -* The cluster configuration directory that was created when TPA deployed your PGD cluster. +* The cluster configuration directory created when TPA deployed your PGD cluster. * If performing a major version upgrade of PGD, ensure that `tpaexec reconfigure` has been run and [appropriate configuration changes](#minor-and-major-pgd-upgrades) have been made. @@ -39,17 +43,23 @@ tpaexec upgrade clustername Where **clustername** is the name of the cluster and the path to the cluster configuration directory. By default, TPA will upgrade each node of the cluster to the latest minor versions of the software the nodes were configured with. -!!! Note TPA's automated rolling upgrade procedure -TPA will test first the cluster then the nodes. Each node will then be isolated from the cluster, upgraded and then returned to operation within the cluster. +## TPA's automated rolling upgrade procedure + +TPA will first test the cluster and then the nodes. + +Each node will then be isolated from the cluster, upgraded, and returned to operation within the cluster. + +### TPA upgrades - step by step * Checks that all preconditions for upgrading the cluster are met. -* For each instance in the cluster, checks that it has the correct repositories configured and that the required postgres packages are available in them. +* For each instance in the cluster + * Checks that it has the correct repositories configured + * Check that the required Postgres packages are available in those repositories. * For each BDR node in the cluster, one at a time: * Fences the node off to ensure that pgd-proxy doesn't send any connections to it. - * Stops, updates, and restarts postgres. + * Stops, updates, and restarts Postgres. * Unfences the node so it can receive connections again. * Updates pgbouncer, pgd-proxy, and pgd-cli, as applicable for this node. -!!! From 765709749d72c18c957b3bd28cee5327c00e4aaa Mon Sep 17 00:00:00 2001 From: Dj Walker-Morgan <126472455+djw-m@users.noreply.github.com> Date: Mon, 11 Mar 2024 13:03:42 +0000 Subject: [PATCH 2/6] Update product_docs/docs/pgd/5/upgrades/tpa_overview.mdx Co-authored-by: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> --- product_docs/docs/pgd/5/upgrades/tpa_overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/pgd/5/upgrades/tpa_overview.mdx b/product_docs/docs/pgd/5/upgrades/tpa_overview.mdx index c50b8f5ddc4..d187e5683d9 100644 --- a/product_docs/docs/pgd/5/upgrades/tpa_overview.mdx +++ b/product_docs/docs/pgd/5/upgrades/tpa_overview.mdx @@ -22,7 +22,7 @@ TPA automatically manages minor version upgrades of PGD. Major version upgrades of PGD will require changes to the TPA `config.yml` file, which contains the deployment configuration. -When upgrading to PGD 5 from previous PGD major versions, you can use [`tpaexec reconfigure`](/tpa/latest/reference/tpaexec-reconfigure/). This command will help you make appropriate modifications to your deployment configuration. +When upgrading to PGD 5 from previous PGD major versions, you can use [`tpaexec reconfigure`](/tpa/latest/reference/tpaexec-reconfigure/). This command helps you make appropriate modifications to your deployment configuration. The `reconfigure` command will require settings for architecture (only `PGD_Always_ON` and PGD Proxy routing to run. Remember to back up your deployment configuration before running, and use the `--describe` and `--output` options to preview the reconfiguration. From 78c5c86f4ed09fa989b94ea518ddbce6f67ad381 Mon Sep 17 00:00:00 2001 From: Dj Walker-Morgan <126472455+djw-m@users.noreply.github.com> Date: Mon, 11 Mar 2024 13:03:53 +0000 Subject: [PATCH 3/6] Update product_docs/docs/pgd/5/upgrades/tpa_overview.mdx Co-authored-by: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> --- product_docs/docs/pgd/5/upgrades/tpa_overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/pgd/5/upgrades/tpa_overview.mdx b/product_docs/docs/pgd/5/upgrades/tpa_overview.mdx index d187e5683d9..7c29b64ed91 100644 --- a/product_docs/docs/pgd/5/upgrades/tpa_overview.mdx +++ b/product_docs/docs/pgd/5/upgrades/tpa_overview.mdx @@ -20,7 +20,7 @@ If possible, always test upgrade processes in a QA environment first. This shoul TPA automatically manages minor version upgrades of PGD. -Major version upgrades of PGD will require changes to the TPA `config.yml` file, which contains the deployment configuration. +Major version upgrades of PGD require changes to the TPA `config.yml` file, which contains the deployment configuration. When upgrading to PGD 5 from previous PGD major versions, you can use [`tpaexec reconfigure`](/tpa/latest/reference/tpaexec-reconfigure/). This command helps you make appropriate modifications to your deployment configuration. From 358f912b9487063d6d79d3aa45519370910266cb Mon Sep 17 00:00:00 2001 From: Dj Walker-Morgan <126472455+djw-m@users.noreply.github.com> Date: Mon, 11 Mar 2024 13:04:09 +0000 Subject: [PATCH 4/6] Update product_docs/docs/pgd/5/upgrades/tpa_overview.mdx Co-authored-by: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> --- product_docs/docs/pgd/5/upgrades/tpa_overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/pgd/5/upgrades/tpa_overview.mdx b/product_docs/docs/pgd/5/upgrades/tpa_overview.mdx index 7c29b64ed91..a7ccb0a7095 100644 --- a/product_docs/docs/pgd/5/upgrades/tpa_overview.mdx +++ b/product_docs/docs/pgd/5/upgrades/tpa_overview.mdx @@ -46,7 +46,7 @@ Where **clustername** is the name of the cluster and the path to the cluster con ## TPA's automated rolling upgrade procedure -TPA will first test the cluster and then the nodes. +TPA first tests the cluster and then the nodes. Each node will then be isolated from the cluster, upgraded, and returned to operation within the cluster. From 200f6cdd743da2ad6eee22f71e232dfa58e52b08 Mon Sep 17 00:00:00 2001 From: Dj Walker-Morgan <126472455+djw-m@users.noreply.github.com> Date: Mon, 11 Mar 2024 13:04:24 +0000 Subject: [PATCH 5/6] Update product_docs/docs/pgd/5/upgrades/tpa_overview.mdx Co-authored-by: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> --- product_docs/docs/pgd/5/upgrades/tpa_overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/pgd/5/upgrades/tpa_overview.mdx b/product_docs/docs/pgd/5/upgrades/tpa_overview.mdx index a7ccb0a7095..f2d3fe7af9d 100644 --- a/product_docs/docs/pgd/5/upgrades/tpa_overview.mdx +++ b/product_docs/docs/pgd/5/upgrades/tpa_overview.mdx @@ -48,7 +48,7 @@ Where **clustername** is the name of the cluster and the path to the cluster con TPA first tests the cluster and then the nodes. -Each node will then be isolated from the cluster, upgraded, and returned to operation within the cluster. +Each node is then isolated from the cluster, upgraded, and returned to operation within the cluster. ### TPA upgrades - step by step From 46f6b332cb6fe5409a21f404599b81530a405396 Mon Sep 17 00:00:00 2001 From: Dj Walker-Morgan <126472455+djw-m@users.noreply.github.com> Date: Mon, 11 Mar 2024 13:04:40 +0000 Subject: [PATCH 6/6] Update product_docs/docs/pgd/5/upgrades/tpa_overview.mdx Co-authored-by: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> --- product_docs/docs/pgd/5/upgrades/tpa_overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/pgd/5/upgrades/tpa_overview.mdx b/product_docs/docs/pgd/5/upgrades/tpa_overview.mdx index f2d3fe7af9d..8643bd4ee68 100644 --- a/product_docs/docs/pgd/5/upgrades/tpa_overview.mdx +++ b/product_docs/docs/pgd/5/upgrades/tpa_overview.mdx @@ -24,7 +24,7 @@ Major version upgrades of PGD require changes to the TPA `config.yml` file, whic When upgrading to PGD 5 from previous PGD major versions, you can use [`tpaexec reconfigure`](/tpa/latest/reference/tpaexec-reconfigure/). This command helps you make appropriate modifications to your deployment configuration. -The `reconfigure` command will require settings for architecture (only `PGD_Always_ON` and PGD Proxy routing to run. Remember to back up your deployment configuration before running, and use the `--describe` and `--output` options to preview the reconfiguration. +The `reconfigure` command requires settings for architecture (only `PGD_Always_ON` and PGD Proxy routing to run. Remember to back up your deployment configuration before running, and use the `--describe` and `--output` options to preview the reconfiguration. ## Pre-requisites