Skip to content

Commit 3f862ac

Browse files
tjmoore4jose-joye
andauthored
Upgrade Documenation Updates and Cleanup
This update removes older versions of the manual upgrade procedures, corrects documentation links where needed and adds clarifying steps for manually upgrading clusters to the latest version. This is needed for clusters that have a primary PVC that is different from the default cluster name, which can occur after a failover or a restore. Co-authored-by: Jose Joye <[email protected]>
1 parent 1da460d commit 3f862ac

File tree

7 files changed

+40
-383
lines changed

7 files changed

+40
-383
lines changed

docs/content/Upgrade/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ For existing PostgreSQL Operator deployments that were installed using Ansible,
4848

4949
First, you will copy your existing inventory file as a backup for your existing settings. You will reference these settings, but you will need to use the updated version of the inventory file for the current version of PostgreSQL Operator.
5050

51-
Once you've checked out the appropriate release tag, please follow the [Update Instructions]({{< relref "installation/install-with-ansible/updating-operator.md" >}}), being sure to update the new inventory file with your required settings. Please keep the above [Considerations](/upgrade#considerations) in mind, particularly with regard to the version and storage requirements listed.
51+
Once you've checked out the appropriate release tag, please follow the [Update Instructions]({{< relref "installation/other/ansible/updating-operator.md" >}}), being sure to update the new inventory file with your required settings. Please keep the above [Considerations](/upgrade#considerations) in mind, particularly with regard to the version and storage requirements listed.
5252

5353
Once the update is complete, you should now see the PostgreSQL Operator pods are up and ready. It is strongly recommended that you create a test cluster to validate proper functionality before moving on to the [Automated Cluster Upgrade](/upgrade#postgres-operator-automated-cluster-upgrade) section below.
5454

docs/content/Upgrade/upgrade35.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,22 @@ For the cluster(s) you wish to upgrade, record the cluster details provided by
3737

3838
pgo show cluster <clustername>
3939

40-
so that your new clusters can be recreated with the proper settings.
40+
so that your new clusters can be recreated with the proper settings.
41+
42+
Also, you will need to note the name of the primary PVC. If it does not exactly match the cluster name, you will need to recreate your cluster using the primary PVC name as the new cluster name.
43+
44+
For example, given the following output:
45+
46+
$ pgo show cluster mycluster
47+
48+
cluster : mycluster (crunchy-postgres:centos7-11.5-2.4.2)
49+
pod : mycluster-7bbf54d785-pk5dq (Running) on kubernetes1 (1/1) (replica)
50+
pvc : mycluster
51+
pod : mycluster-ypvq-5b9b8d645-nvlb6 (Running) on kubernetes1 (1/1) (primary)
52+
pvc : mycluster-ypvq
53+
...
54+
55+
the new cluster's name will need to be "mycluster-ypvq"
4156

4257
##### Step2
4358

@@ -57,14 +72,14 @@ Delete the 3.5.x version of the operator by executing:
5772

5873
Log in as your new Linux user and install the 4.3.0 PostgreSQL Operator.
5974

60-
[Bash Installation]( {{< relref "installation/operator-install.md" >}})
75+
[Bash Installation]( {{< relref "installation/other/bash.md" >}})
6176

6277
Be sure to add the existing namespace to the Operator's list of watched namespaces (see the [Namespace]( {{< relref "architecture/namespace.md" >}}) section of this document for more information) and make sure to avoid overwriting any existing data storage.
6378

6479

6580
##### Step 5
6681

67-
Once the Operator is installed and functional, create a new 4.3.0 cluster matching the cluster details recorded in Step 1. Be sure to use the same name and the same major PostgreSQL version as was used previously. This will allow the new clusters to utilize the existing PVCs. A s
82+
Once the Operator is installed and functional, create a new 4.3.0 cluster matching the cluster details recorded in Step 1. Be sure to use the primary PVC name (also noted in Step 1) and the same major PostgreSQL version as was used previously. This will allow the new clusters to utilize the existing PVCs. A s
6883
imple example is given below, but more information on cluster creation can be found [here](/pgo-client/common-tasks#creating-a-postgresql-cluster)
6984

7085
pgo create cluster <clustername> -n <namespace>

docs/content/Upgrade/upgrade35to4.md

Lines changed: 0 additions & 90 deletions
This file was deleted.

docs/content/Upgrade/upgrade4.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,22 @@ For the cluster(s) you wish to upgrade, record the cluster details provided by
4444

4545
so that your new clusters can be recreated with the proper settings.
4646

47+
Also, you will need to note the name of the primary PVC. If it does not exactly match the cluster name, you will need to recreate your cluster using the primary PVC name as the new cluster name.
48+
49+
For example, given the following output:
50+
51+
$ pgo show cluster mycluster
52+
53+
cluster : mycluster (crunchy-postgres:centos7-11.5-2.4.2)
54+
pod : mycluster-7bbf54d785-pk5dq (Running) on kubernetes1 (1/1) (replica)
55+
pvc : mycluster
56+
pod : mycluster-ypvq-5b9b8d645-nvlb6 (Running) on kubernetes1 (1/1) (primary)
57+
pvc : mycluster-ypvq
58+
...
59+
60+
the new cluster's name will need to be "mycluster-ypvq"
61+
62+
4763
##### Step 1
4864

4965
For the cluster(s) you wish to upgrade, scale down any replicas, if necessary (see `pgo scaledown --help` for more information on command usage) page for more information), then delete the cluster
@@ -60,12 +76,12 @@ Save a copy of your current inventory file with a new name (such as `inventory.b
6076

6177
##### Step 3
6278

63-
Update the new inventory file with the appropriate values for your new Operator installation, as described in the [Ansible Install Prerequisites]( {{< relref "installation/install-with-ansible/prerequisites.md" >}}) and the [Compatibility Requirements Guide]( {{< relref "configuration/compatibility.md" >}}).
79+
Update the new inventory file with the appropriate values for your new Operator installation, as described in the [Ansible Install Prerequisites]( {{< relref "installation/other/ansible/prerequisites.md" >}}) and the [Compatibility Requirements Guide]( {{< relref "configuration/compatibility.md" >}}).
6480

6581

6682
##### Step 4
6783

68-
Now you can upgrade your Operator installation and configure your connection settings as described in the [Ansible Update Page]( {{< relref "installation/install-with-ansible/updating-operator.md" >}}).
84+
Now you can upgrade your Operator installation and configure your connection settings as described in the [Ansible Update Page]( {{< relref "installation/other/ansible/updating-operator.md" >}}).
6985

7086

7187
##### Step 5
@@ -80,7 +96,7 @@ And that it is upgraded to the appropriate version
8096

8197
##### Step 6
8298

83-
Once the Operator is installed and functional, create a new 4.3.0 cluster matching the cluster details recorded in Step 0. Be sure to use the same name and the same major PostgreSQL version as was used previously. This will allow the new clusters to utilize the existing PVCs. A simple example is given below, but more information on cluster creation can be found [here](/pgo-client/common-tasks#creating-a-postgresql-cluster)
99+
Once the Operator is installed and functional, create a new 4.3.0 cluster matching the cluster details recorded in Step 0. Be sure to use the primary PVC name (also noted in Step 0) and the same major PostgreSQL version as was used previously. This will allow the new clusters to utilize the existing PVCs. A simple example is given below, but more information on cluster creation can be found [here](/pgo-client/common-tasks#creating-a-postgresql-cluster)
84100

85101
pgo create cluster <clustername> -n <namespace>
86102

@@ -217,7 +233,7 @@ You will need to edit the `$PGOROOT/deploy/install-bootstrap-creds.sh` file to c
217233
export PGOADMIN_USERNAME=pgoadmin
218234
export PGOADMIN_PASSWORD=examplepassword
219235
```
220-
You will need to update the `$HOME/.pgouser`file to match the values you set in order to use the Operator. Additional accounts can be created later following the steps described in the 'Operator Security' section of the main [Bash Installation Guide] ( {{< relref "installation/operator-install.md" >}}). Once these accounts are created, you can change this file to login in via the PGO CLI as that user.
236+
You will need to update the `$HOME/.pgouser`file to match the values you set in order to use the Operator. Additional accounts can be created later following the steps described in the 'Operator Security' section of the main [Bash Installation Guide] ( {{< relref "installation/other/bash.md" >}}). Once these accounts are created, you can change this file to login in via the PGO CLI as that user.
221237

222238
##### Step 8
223239

docs/content/Upgrade/upgrade4xto42_ansible.md

Lines changed: 0 additions & 92 deletions
This file was deleted.

0 commit comments

Comments
 (0)