Skip to content

Commit 5530c23

Browse files
committed
Provide clarity on retrieving credentials for standbys
The `pgo show user` command has a `--show-system-accounts` flag for retrieving the credentials of system accounts (e.g. superuser, replication users, etc.), which can be helpful when setting up standby clusters. Issue: #2053
1 parent c8202cc commit 5530c23

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

docs/content/architecture/high-availability/multi-cluster-kubernetes.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,14 @@ that matches that of the active cluster it is replicating.
9393
- `--pgbackrest-s3-endpoint`: The S3 endpoint to use
9494
- `--pgbackrest-s3-region`: The S3 region to use
9595

96+
If you do not want to set the user credentials, you can retrieve them at a later
97+
time by using the [`pgo show user`]({{< relref "/pgo-client/reference/pgo_show_user.md" >}})
98+
command with the `--show-system-accounts` flag, e.g.
99+
100+
```
101+
pgo show user --show-system-accounts hippo
102+
```
103+
96104
With respect to the credentials, it should be noted that when the standby
97105
cluster is being created within the same Kubernetes cluster AND it has access to
98106
the Kubernetes Secret created for the active cluster, one can use the
@@ -182,6 +190,9 @@ pgo create cluster hippo-standby --standby --pgbouncer --replica-count=2 \
182190
--password=opensourcehippo
183191
```
184192

193+
(If you are unsure of your credentials, you can use
194+
`pgo show user hippo --show-system-accounts` to retrieve them).
195+
185196
Note the use of the `--pgbackrest-repo-path` flag as it points to the name of
186197
the pgBackRest repository that is used for the original `hippo` cluster.
187198

docs/content/pgo-client/common-tasks.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1314,6 +1314,14 @@ pgo create cluster hippo-standby --standby --replica-count=2 \
13141314
--password=opensourcehippo
13151315
```
13161316

1317+
If you are unsure of your user credentials form the original `hippo` cluster,
1318+
you can retrieve them using the [`pgo show user`]({{< relref "/pgo-client/reference/pgo_show_user.md" >}})
1319+
command with the `--show-system-accounts` flag:
1320+
1321+
```
1322+
pgo show user hippo --show-system-accounts
1323+
```
1324+
13171325
The standby cluster will take a few moments to bootstrap, but it is now set up!
13181326

13191327
### Promoting a Standby Cluster

0 commit comments

Comments
 (0)