Skip to content

Commit bedf788

Browse files
roberto-melloandrewlecuyer
authored andcommitted
Clarifications to docs about restoring individual databases, plus additional links to CRD and cross-linking to improve readbility
1 parent 4eb0169 commit bedf788

File tree

3 files changed

+19
-7
lines changed

3 files changed

+19
-7
lines changed

docs/content/architecture/pgadmin4.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,9 @@ Optionally, you can also set a [custom password]({{< relref "architecture/user-m
7272
7373
## User Synchronization
7474
75-
The operator will synchronize users defined in the spec (e.g., in `spec.users`) with the pgAdmin 4
76-
deployment. Any user created in the database without being defined in the spec will not be
75+
The operator will synchronize users [defined in the spec]({{< relref "tutorial/user-management.md" >}})
76+
(e.g., in [`spec.users`]({{< relref "/references/crd#postgresclusterspecusersindex" >}}))
77+
with the pgAdmin 4 deployment. Any user created in the database without being defined in the spec will not be
7778
synchronized.
7879
7980
## Custom Configuration

docs/content/architecture/user-management.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ While the above defaults may work for your application, there are certain cases
4545

4646
## Custom Users and Databases
4747

48-
Users and databases can be customized in the `spec.users` section of the custom resource. These can be adding during cluster creation and adjusted over time, but it's important to note the following:
48+
Users and databases can be customized in the [`spec.users`]({{< relref "/references/crd#postgresclusterspecusersindex" >}}) section of the custom resource. These can be adding during cluster creation and adjusted over time, but it's important to note the following:
4949

5050
- If `spec.users` is set during cluster creation, PGO will **not** create any default users or databases except for `postgres`. If you want additional databases, you will need to specify them.
5151
- For any users added in `spec.users`, PGO will created a Secret of the format `<clusterName>-pguser-<userName>`. This will contain the user credentials.

docs/content/tutorial/disaster-recovery.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ Let's look at how we can perform different types of restore operations. First, l
1818
As of v5.0.5, PGO offers the ability to restore from an existing PostgresCluster or a remote
1919
cloud-based data source, such as S3, GCS, etc. For more on that, see the [Clone From Backups Stored in S3 / GCS / Azure Blob Storage](#cloud-based-data-source) section.
2020

21-
Note that you cannot use both a local PostgresCluster data source and a remote cloud-based data
21+
Note that you **cannot** use both a local PostgresCluster data source and a remote cloud-based data
2222
source at one time; if both the `dataSource.postgresCluster` and `dataSource.pgbackrest` fields
2323
are filled in, the local PostgresCluster data source will take precedence.
2424

2525
{{% /notice %}}
2626

27-
There are several attributes on the custom resource that are important to understand as part of the restore process. All of these attributes are grouped together in the `spec.dataSource.postgresCluster` section of the custom resource.
27+
There are several attributes on the custom resource that are important to understand as part of the restore process. All of these attributes are grouped together in the [`spec.dataSource.postgresCluster`]({{< relref "/references/crd#postgresclusterspecdatasourcepostgrescluster" >}}) section of the custom resource.
2828

2929
Please review the table below to understand how each of these attributes work in the context of setting up a restore operation.
3030

@@ -231,7 +231,19 @@ you can start accessing your database from that specific point in time!
231231

232232
## Restore Individual Databases
233233

234-
You can restore individual databases using a spec similar to the following:
234+
You might need to restore specific databases from a cluster backup, for performance reasons
235+
or to move selected databases to a machine that does not have enough space to restore the
236+
entire cluster backup.
237+
238+
pgBackRest supports this case, but it is important to make sure this is what you want.
239+
Restoring in this manner will restore the requested database from backup and making it
240+
accessible, but all of the other databases in the backup will **not** be accessible after restore.
241+
242+
For example, if your backup includes databases `test1` and `test2`, and you request that `test2`
243+
be restored, the `test1` database will not be accessible. Please review the pgBackRest documentation
244+
on the [limitations on restoring individual databases](https://pgbackrest.org/user-guide.html#restore/option-db-include).
245+
246+
You can restore individual databases from a backup using a spec similar to the following:
235247

236248
```yaml
237249
spec:
@@ -246,7 +258,6 @@ spec:
246258
247259
where `--db-include=hippo` would restore only the contents of the `hippo` database.
248260

249-
Please review the pgBackRest documentation on the [limitations on restoring individual databases](https://pgbackrest.org/user-guide.html#restore/option-db-include).
250261

251262
## Standby Cluster
252263

0 commit comments

Comments
 (0)