Skip to content

Commit 029579b

Browse files
MCatherine1994DerekRoberts
authored andcommitted
doc(db): update readme for db upgrade steps
1 parent b78b102 commit 029579b

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

db/README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,16 @@
1-
# PostgreSQL Database Migration Steps
1+
# PostgreSQL Database Major Version Upgrade Steps
22

33
This guide outlines the steps to migrate a database to PostgreSQL v17 in an OpenShift environment. It can be reused for upgrading to other versions.
44

5+
## Pre-request
6+
- Create a pr branch before upgrading, update the db/openshift.deployment.yml for DB_VERSION to next version (e.g., 18)
7+
- Check out the pr branch in local and use the branch terminal for execution steps
8+
9+
## Notes
10+
**Whenever we need to do a database migration, run the scripts first before merge the upgradation pr, as it will use the new PVC name for the new database.**
11+
12+
## Steps
13+
514
### 1. Set the Target Environment
615

716
Set the target to a PR number (e.g., `819`), `test`, or `prod`:
@@ -70,7 +79,7 @@ In non-prod environments, add a new FOM and verify project counts again.
7079
oc scale deployment fom-${TARGET}-api --replicas=3
7180
```
7281

73-
# Rollback Procedure
82+
## Rollback Procedure
7483

7584
1. Scale down the API:
7685

@@ -98,9 +107,6 @@ oc scale deployment fom-${TARGET}-api --replicas=3
98107
oc scale deployment fom-${TARGET}-api --replicas=3
99108
```
100109

101-
---
102110

103-
## Notes
104-
Whenever we need to do a database migration, run the scripts first before merge the upgradation pr, as it will use the new PVC name for the new database.
105111

106112

0 commit comments

Comments
 (0)