Add reference for postgres migrate commands

Co-authored-by: Trong Nguyen <trong.huu.nguyen@nav.no>
nais · Oct 7, 2024 · 972a1dc · 972a1dc
1 parent e5b94fc
commit 972a1dc
Show file tree

Hide file tree

Showing 3 changed files with 73 additions and 1 deletion.
diff --git a/docs/operate/cli/reference/postgres.md b/docs/operate/cli/reference/postgres.md
@@ -159,3 +159,69 @@ nais postgres password rotate appname
 | Argument    | Required  | Description                                                 |
 |-------------|-----------|-------------------------------------------------------------|
 | appname     | Yes       | Name of application owning the database                     |
+
+
+## migrate 
+
+Commands used for migrating to a new postgres instance.
+
+<!-- TODO: See also [Migrate](../../../persistence/postgres/how-to/migrate-to-new-instance.md) -->
+
+### migrate setup
+
+Setup will create a new (target) instance with updated configuration, and enable continuous replication of data from the source instance.
+
+```bash
+nais postgres migrate setup appname new-instance-name
+```
+
+| Argument          | Required | Description                                     |
+|-------------------|----------|-------------------------------------------------|
+| appname           | Yes      | Name of application owning the database         |
+| new-instance-name | Yes      | Name of the new postgres instance to migrate to |
+
+
+| Flag      | Description                                                                                                                     |
+|-----------|---------------------------------------------------------------------------------------------------------------------------------|
+| tier      | Tier of new instance. See [Postgres reference](../../../persistence/postgres/reference/README.md#server-size).                  |
+| type      | Postgres version of new instance. See [Postgres reference](../../../persistence/postgres/reference/README.md#postgres-version). |
+| disk-size | Disk size of new instance.                                                                                                      |
+
+### migrate promote
+
+Promote will promote the target instance to the new primary instance, and update the application to use the new instance.
+
+```bash
+nais postgres migrate promote appname new-instance-name
+```
+
+| Argument          | Required | Description                                     |
+|-------------------|----------|-------------------------------------------------|
+| appname           | Yes      | Name of application owning the database         |
+| new-instance-name | Yes      | Name of the new postgres instance to migrate to |
+
+### migrate finalize
+
+Finalize will remove the source instance and associated resources after a successful migration.
+
+```bash
+nais postgres migrate finalize appname new-instance-name
+```
+
+| Argument          | Required | Description                                     |
+|-------------------|----------|-------------------------------------------------|
+| appname           | Yes      | Name of application owning the database         |
+| new-instance-name | Yes      | Name of the new postgres instance to migrate to |
+
+### migrate rollback
+
+Rollback will roll back the migration, and restore the application to use the original instance.
+
+```bash
+nais postgres migrate rollback appname new-instance-name
+```
+
+| Argument          | Required | Description                                     |
+|-------------------|----------|-------------------------------------------------|
+| appname           | Yes      | Name of application owning the database         |
+| new-instance-name | Yes      | Name of the new postgres instance to migrate to |
diff --git a/docs/persistence/postgres/how-to/migrate-to-new-instance.md b/docs/persistence/postgres/how-to/migrate-to-new-instance.md
@@ -0,0 +1,6 @@
+---
+title: Migrate to new instance
+tags: [postgres, migrate, how-to]
+---
+
+# TODO
diff --git a/docs/persistence/postgres/reference/README.md b/docs/persistence/postgres/reference/README.md
@@ -143,7 +143,7 @@ For further reading see [google Cloud SQL PIT recovery](https://cloud.google.com
 
 In case of catastrophic failure in GCP we are running a daily complete backup of the postgresql databases in GCP to an on-prem location. This backup currently runs at 5 am. This is in addition to the regular backups in GCP.
 
-## Postgres vesion
+## Postgres version
 
 The Postgres version can be configured in the application spec. The version is defined by the `type` field in the `nais.yaml` file.