Skip to content

Commit 6e6e0fb

Browse files
committed
doc updates
1 parent 788087b commit 6e6e0fb

File tree

2 files changed

+42
-1
lines changed

2 files changed

+42
-1
lines changed

hugo/content/getting-started/_index.adoc

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -483,6 +483,14 @@ To delete a Postgres user in the *mycluster* cluster, execute:
483483
pgo user delete user sally --selector=name=mycluster
484484
....
485485

486+
To create a new Postgres user to the *mycluster* cluster that has credentials created with Kubernetes Secrets, use the *--managed* flag:
487+
....
488+
pgo create user sally --managed --selector=name=mycluster
489+
....
490+
491+
A *managed* account is one that the Operator can manipulate as well; this means that when you run `pgo show cluster mycluster --show-secrets`
492+
their credentials are visible, when you run `pgo test mycluster` the account is tested with the other default accounts, etc.
493+
486494
To change the password for a user in the *mycluster* cluster:
487495
....
488496
pgo user --change-password=sally --selector=name=mycluster
@@ -498,7 +506,7 @@ pgo user --expired=7 --selector=name=mycluster
498506

499507
To assign users to a cluster:
500508
....
501-
pgo create user user1 --valid-days=30 --managed --db=userdb --selector=name=xraydb1
509+
pgo create user user1 --valid-days=30 --db=userdb --selector=name=xraydb1
502510
....
503511

504512
In this example, a user named *user1* is created with a *valid until* password date set to expire in 30 days. That user will be granted access to the *userdb* database. This user account also will have an associated *secret* created to hold the password that was generated for this user. Any clusters that match the selector value will have this user created on it.
@@ -661,3 +669,14 @@ Database Images:
661669
662670
Databases Not Ready:
663671
....
672+
673+
=== pgo show config
674+
675+
The `pgo show config` command displays the running operator configuration
676+
parameters that dictate the setup and user defined configuration of the
677+
operator. This command can be useful for sharing your configuration or
678+
verifying the setup is as expected.
679+
680+
....
681+
pgo show config
682+
....

hugo/content/installation/deployment.adoc

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,28 @@ The pgo client uses Basic Authentication to authenticate to the operator REST AP
7777
echo "username:password" > $HOME/.pgouser
7878
....
7979

80+
Roles are defined in a file called *pgorole*. This file defines each role and the
81+
permissions for that role. By default, two roles are defined as samples -
82+
....
83+
pgoadmin
84+
pgoreader
85+
....
86+
87+
This file, moved to your $HOME folder, is optional. These default settings can be adjusted to meet local
88+
security requirements.
89+
90+
The format of this file is as follows -
91+
....
92+
rolename: permissionA, permissionB
93+
....
94+
95+
These are defined in the following file -
96+
....
97+
$COROOT/conf/apiserver/pgorole
98+
....
99+
100+
The complete set of permissions is documented in the link:/installation/configuration/[Configuration] document.
101+
80102
The *pgo* client needs the URL to connect to the operator.
81103

82104
Depending on your Kubernetes environment this can be done the following ways.

0 commit comments

Comments
 (0)