Skip to content

Commit e832ead

Browse files
author
Jeff McCormick
committed
update docs with user mgmt commands
1 parent 121b600 commit e832ead

File tree

1 file changed

+62
-0
lines changed

1 file changed

+62
-0
lines changed

docs/user-guide.asciidoc

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -305,6 +305,68 @@ SQL against that cluster using the *postgres* user account.
305305
WARNING: policies are executed as the superuser in PostgreSQL therefore
306306
take caution when using them.
307307

308+
== User Management - Add a User
309+
310+
To create a new Postgres user to the *mycluster* cluster, execute:
311+
....
312+
pgo user --add-user=sally --selector=name=mycluster
313+
....
314+
315+
To add that user to a all clusters:
316+
....
317+
pgo user --add-user=sally
318+
....
319+
320+
== User Management - Delete a User
321+
322+
To delete a Postgres user in the *mycluster* cluster, execute:
323+
....
324+
pgo user --delete-user=sally --selector=name=mycluster
325+
....
326+
327+
To delete that user in all clusters:
328+
....
329+
pgo user --delete-user=sally
330+
....
331+
332+
== User Management - Change Password
333+
334+
To change the password for a user in the *mycluster* cluster:
335+
....
336+
pgo user --change-password=sally --selector=name=mycluster
337+
....
338+
339+
To change the password for the *sally* user in all clusters:
340+
....
341+
pgo user --change-password=sally
342+
....
343+
344+
The password is generated and printed in cleartext on your screen.
345+
346+
== User Management - Show Expired Passwords
347+
348+
To see user passwords that have expired past a certain number
349+
of days in the *mycluster* cluster:
350+
....
351+
pgo user --expired=7 --selector=name=mycluster
352+
....
353+
354+
The same command across all clusters:
355+
....
356+
pgo user --expired=7
357+
....
358+
359+
== User Management - Update Expired Passwords
360+
361+
To update expired passwords in a cluster:
362+
....
363+
pgo user --update-passwords --selector=name=mycluster
364+
....
365+
366+
The same command across all clusters:
367+
....
368+
pgo user --update-passwords
369+
....
308370

309371
== bash Completion
310372

0 commit comments

Comments
 (0)