Skip to content

Commit b961662

Browse files
modified: docs/how-to/backup-and-restore.md
1 parent 860e855 commit b961662

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

docs/how-to/backup-and-restore.md

+10-7
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ juju config s3-integrator endpoint=<s3 endpoint> bucket=<bucket name> path=<opti
2323
juju run s3-integrator/leader sync-s3-credentials access-key=<access-key> secret-key=<secret-key>
2424
```
2525

26-
Integrate with Synapse with:
26+
Integrate with Synapse using:
2727

2828
`juju integrate synapse:backup s3-integrator`
2929

@@ -37,7 +37,7 @@ juju config synapse backup_passphrase=<secret passphase>
3737

3838
### Create the backup
3939

40-
Create the backup with the next command:
40+
Create the backup:
4141
```
4242
juju run synapse/leader create-backup
4343
```
@@ -61,25 +61,28 @@ to also back up the cluster passwords. See:
6161
- For [postgresql-k8s](https://charmhub.io/postgresql-k8s/docs/h-migrate-cluster).
6262
- For [postgresql](https://charmhub.io/postgresql/docs/h-migrate-cluster).
6363

64+
6465
## Restore
6566

66-
The recommendation is to first restore PostgreSQL if necessary. Then deploying,
67-
configuring and integrating Synapse with other charms as done in a normal deployment
68-
and finally restoring Synapse.
67+
The recommendation is to first restore PostgreSQL if necessary. Then deploy,
68+
configure and integrate Synapse with other charms as done in a normal deployment.
69+
Finally, restore Synapse.
6970

7071
The PostgreSQL and Synapse charm revisions should be the same ones as the ones used
7172
for the backup. The configuration for Synapse before restoring the backup should also
7273
match the configuration in the original application. This is specially important for
7374
the configuration option `server_name` and any other configuration related to the filesystem.
7475

76+
7577
### Restore PostgreSQL
7678

79+
7780
If you use the PostgreSQL integration, follow the instructions given by PostgreSQL:
7881
- For postgresql-k8s: [local restore](https://charmhub.io/postgresql/docs/h-restore-backup), [foreign backup](https://charmhub.io/postgresql/docs/h-migrate-cluster).
7982
- for postgresql: [local restore](https://charmhub.io/postgresql/docs/h-restore-backup), [foreign backup](https://charmhub.io/postgresql/docs/h-migrate-cluster).
8083

8184
If you used the foreign backup, once the backup for PostgreSQL is restored, you should remove the S3 integration,
82-
as it was created in a different cluster, by running:
85+
as it was created in a different cluster:
8386

8487
```
8588
juju remove-relation s3-integrator postgresql
@@ -88,7 +91,7 @@ juju remove-relation s3-integrator postgresql
8891
### Deploy Synapse
8992

9093
Synapse should be deployed, integrated with all necessary charms and configured. If necessary, Synapse should be integrated with the PostgreSQL charm that
91-
has already being restored.
94+
has already been restored.
9295

9396
### Restore Synapse
9497

0 commit comments

Comments
 (0)