feat (docs): added postgres upgrade docs (#2823)
This commit is contained in:
5
.changeset/two-gorillas-mix.md
Normal file
5
.changeset/two-gorillas-mix.md
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'@nhost/docs': minor
|
||||
---
|
||||
|
||||
feat: added postgres upgrade docs
|
||||
37
docs/guides/database/upgrade-major.mdx
Normal file
37
docs/guides/database/upgrade-major.mdx
Normal file
@@ -0,0 +1,37 @@
|
||||
---
|
||||
title: "Upgrade Major Version"
|
||||
description: Upgrade to Postgres 15.x or 16.y
|
||||
icon: circle-up
|
||||
---
|
||||
|
||||
# Upgrade process
|
||||
|
||||
<Info>
|
||||
This document only applies when changing Postgres major version (i.e. from 14 to 15/16 or from 15 to 16). It doesn'e apply when upgrading minor versions (i.e. from 14.5 to 14.11).
|
||||
</Info>
|
||||
|
||||
While new cloud projects ship with Postgres 14 by default, versions 15 and 16 are also supported. To change your major version you can go to Settings -> Database, select the new major version and start the process:
|
||||
|
||||

|
||||
|
||||
<Warning>
|
||||
Keep in mind that the upgrade process requires downtime. Pay attention to all the information provided to you in the settings page.
|
||||
</Warning>
|
||||
|
||||
After starting the process you can follow it on the same page:
|
||||
|
||||

|
||||
|
||||
Finally, you can confirm the upgrade by executing the SQL query `SELECT version();`
|
||||
|
||||

|
||||
|
||||
## Projects with connected repos
|
||||
|
||||
This process can only be triggered from the dashboard. If you have a project with a connected repository and want to upgrade postgres to either 15 or 16 you will have to follow the steps below:
|
||||
|
||||
1. Upgrade the major version using the dashboard
|
||||
2. Run `nhost config pull` or edit the `nhost.toml` by hand.
|
||||
3. Push to git (this step should be a NOOP and can be skipped)
|
||||
|
||||
If you attempt to change major versions via a deployment the deployment will fail. This is done on purpose to avoid unintended upgrades which can lead to downtime.
|
||||
BIN
docs/images/guides/database/upgrade_01.png
Normal file
BIN
docs/images/guides/database/upgrade_01.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.1 MiB |
BIN
docs/images/guides/database/upgrade_02.png
Normal file
BIN
docs/images/guides/database/upgrade_02.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.0 MiB |
BIN
docs/images/guides/database/upgrade_03.png
Normal file
BIN
docs/images/guides/database/upgrade_03.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 892 KiB |
@@ -117,7 +117,8 @@
|
||||
"guides/database/configuring-postgres",
|
||||
"guides/database/access",
|
||||
"guides/database/extensions",
|
||||
"guides/database/performance"
|
||||
"guides/database/performance",
|
||||
"guides/database/upgrade-major"
|
||||
]
|
||||
},
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user