Skip to content

Commit 7a7e9ec

Browse files
Sync docs from Discourse
1 parent 26a7982 commit 7a7e9ec

File tree

5 files changed

+26
-15
lines changed

5 files changed

+26
-15
lines changed

Diff for: docs/explanation/e-architecture.md

+4
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,10 @@ The snap "charmed-postgresql" also ships list of tools used by charm:
7575

7676
The charm "[PostgreSQL Test App](https://charmhub.io/postgresql-test-app)" is a Canonical test application to validate the charm installation / functionality and perform the basic performance tests.
7777

78+
### GLAuth
79+
80+
GLAuth is a secure, easy-to-use and open-sourced LDAP server which provides capabilities to centrally manage accounts across infrastructures. The charm is only available for Kubernetes clouds, under the [GLAuth-K8s operator](https://charmhub.io/glauth-k8s) page, so a cross-controller relation is needed in order to integrate both charms.
81+
7882
### Grafana
7983

8084
Grafana is an open-source visualization tools that allows to query, visualize, alert on, and visualize metrics from mixed datasources in configurable dashboards for observability. This charms is shipped with its own Grafana dashboard and supports integration with the [Grafana Operator](https://charmhub.io/grafana-k8s) to simplify observability. Please follow [COS Monitoring](/t/10600) setup.

Diff for: docs/explanation/e-users.md

+11-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# Charm Users explanations
22

3-
There are two types of users in PostgreSQL:
3+
There are three types of users in PostgreSQL:
44
* Internal users (used by charm operator)
5-
* Relation/integration users (used by related applications)
5+
* Relation users (used by related applications)
66
* Extra user roles (if default permissions are not enough)
7+
* Identity users (used when LDAP is enabled)
78

89
<a name="internal-users"></a>
910
## Internal users explanations:
@@ -72,7 +73,7 @@ unit-postgresql-1:
7273
**Note**: the action `set-password` must be executed on juju leader unit (to update peer relation data with new value).
7374
7475
<a name="relation-users"></a>
75-
## Relation/integration users explanations:
76+
## Relation users explanations:
7677
7778
The operator created a dedicated user for every application related/integrated with database. Those users are removed on the juju relation/integration removal request. However, DB data stays in place and can be reused on re-created relations (using new user credentials):
7879
@@ -99,4 +100,10 @@ postgres=# \du
99100
100101
When an application charm requests a new user through the relation/integration it can specify that the user should have the `admin` role in the `extra-user-roles` field. The `admin` role enables the new user to read and write to all databases (for the `postgres` system database it can only read data) and also to create and delete non-system databases.
101102
102-
**Note**: `extra-user-roles` is supported by modern interface `postgresql_client` only and missing for legacy `pgsql` interface. Read more about the supported charm interfaces [here](/t/10251).
103+
**Note**: `extra-user-roles` is supported by modern interface `postgresql_client` only and missing for legacy `pgsql` interface. Read more about the supported charm interfaces [here](/t/10251).
104+
105+
<a name="identity-users"></a>
106+
## Identity users explanations:
107+
The operator considers Identity users all those that are automatically created when the LDAP integration is enabled, or in other words, the [GLAuth](https://charmhub.io/glauth-k8s) charm is related/integrated.
108+
109+
When synchronized from the LDAP server, these users do not have any permissions by default, so the LDAP group they belonged to must be mapped to a PostgreSQL pre-defined authorization role by using the `ldap_map` configuration option.

Diff for: docs/how-to/h-enable-tls.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,9 @@ First, deploy the TLS charm:
3232
juju deploy self-signed-certificates
3333
```
3434

35-
To enable TLS on `postgresql`, integrate the two applications:
35+
To enable TLS integrate (formerly known as “relate”) the two applications:
3636
```shell
37-
juju integrate self-signed-certificates postgresql
38-
```
39-
40-
## Disable TLS
41-
Disable TLS by removing the integration.
42-
```shell
43-
juju remove-relation self-signed-certificates postgresql
37+
juju integrate postgresql:certificates self-signed-certificates:certificates
4438
```
4539

4640
## Check certificates in use
@@ -79,4 +73,10 @@ Updates can also be done with auto-generated keys:
7973
juju run postgresql/0 set-tls-private-key
8074
juju run postgresql/1 set-tls-private-key
8175
juju run postgresql/2 set-tls-private-key
76+
```
77+
78+
## Disable TLS
79+
Disable TLS by removing the integration.
80+
```shell
81+
juju remove-relation postgresql:certificates self-signed-certificates:certificates
8282
```

Diff for: docs/tutorial/t-enable-tls.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Machine State Address Inst id Series AZ Message
5555

5656
To enable TLS on Charmed PostgreSQL VM, integrate the two applications:
5757
```shell
58-
juju integrate postgresql self-signed-certificates
58+
juju integrate postgresql:certificates self-signed-certificates:certificates
5959
```
6060
PostgreSQL is now using TLS certificate generated by the `self-signed-certificates` charm.
6161

@@ -72,7 +72,7 @@ verify error:num=19:self-signed certificate in certificate chain
7272
<a href="#heading--remove-tls"><h2 id="heading--remove-tls"> Remove TLS certificate</h2></a>
7373
To remove the external TLS, remove the integration:
7474
```shell
75-
juju remove-relation postgresql self-signed-certificates
75+
juju remove-relation postgresql:certificates self-signed-certificates:certificates
7676
```
7777

7878
If you once again check the TLS certificates in use via the OpenSSL client, you will see something similar to the output below:

Diff for: docs/tutorial/t-set-up.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
> [Charmed PostgreSQL K8s Tutorial](/t/9707) > 1. Set up the environment
1+
> [Charmed PostgreSQL VM Tutorial](/t/9707) > 1. Set up the environment
22
33
# Set up the environment
44

0 commit comments

Comments
 (0)