Skip to content

Commit 192d3df

Browse files
authored
Add permissions warning to upgrade method #1
This updates the documentation for upgrade method 1 to include a warning that file permissions may need to be modified with certain storage solutions when performing this upgrade. This also updates spec references, where needed.
1 parent 0226f1d commit 192d3df

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

docs/content/guides/v4tov5.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,19 @@ A third PVC used to store write-ahead logs (WAL) may also be present if external
9595

9696
With the PGO v4 cluster's volumes prepared for the move to PGO v5, you can now create a [`PostgresCluster`]({{< relref "references/crd.md" >}}) custom resource using these volumes. This migration method does not carry over any specific configurations or customizations from PGO v4: you will need to create the specific `PostgresCluster` configuration that you need.
9797

98+
{{% notice warning %}}
99+
100+
Additional steps are required to set proper file permissions when using certain storage options,
101+
such as NFS and HostPath storage, due to a known issue with how fsGroups are applied. When
102+
migrating from PGO v4, this will require the user to manually set the group value of the pgBackRest
103+
repo directory, and all subdirectories, to `26` to match the `postgres` group used in PGO v5.
104+
Please see [here](https://github.com/kubernetes/examples/issues/260) for more information.
105+
106+
{{% /notice %}}
107+
98108
To complete the upgrade process, your `PostgresCluster` custom resource **MUST** include the following:
99109

100-
1\. An `existingVolumes` data source that points to the PostgreSQL data, PostgreSQL WAL (if applicable) and pgBackRest repository PVCs identified in the `spec.dataSource.existingVolumes` section.
110+
1\. A `volumes` data source that points to the PostgreSQL data, PostgreSQL WAL (if applicable) and pgBackRest repository PVCs identified in the `spec.dataSource.volumes` section.
101111

102112
For example, using the `hippo` cluster:
103113

@@ -134,7 +144,7 @@ This upgrade method allows you to migrate from PGO v4 to PGO v5 by creating a ne
134144

135145
*NOTE*: External WAL volumes **MUST** be enabled for the PGO v4 cluster being upgraded. Additionally, the backup that will be used to initialize the PGO v5 cluster **MUST** be created with external WAL volumes.
136146

137-
If you did not create your cluster with an external WAL volume (`pgo create cluster --wal-storage-config`), you can do so using the following command. Note that this involves a cluster deletion with the `-keep-data` flag::
147+
If you did not create your cluster with an external WAL volume (`pgo create cluster --wal-storage-config`), you can do so using the following command. Note that this involves a cluster deletion with the `-keep-data` flag:
138148

139149
```
140150
pgo delete cluster hippo --keep-data

0 commit comments

Comments
 (0)