Skip to content

Commit 64389b8

Browse files
authored
update image and docs for connection pooler (zalando#898)
1 parent 1249626 commit 64389b8

File tree

5 files changed

+16
-11
lines changed

5 files changed

+16
-11
lines changed

docs/reference/cluster_manifest.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -376,10 +376,11 @@ present.
376376
How many instances of connection pooler to create.
377377

378378
* **schema**
379-
Schema to create for credentials lookup function.
379+
Database schema to create for credentials lookup function.
380380

381381
* **user**
382382
User to create for connection pooler to be able to connect to a database.
383+
You can also choose a role from the `users` section or a system user role.
383384

384385
* **dockerImage**
385386
Which docker image to use for connection pooler deployment.

docs/reference/operator_parameters.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Those are top-level keys, containing both leaf keys and groups.
8383
* **kubernetes_use_configmaps**
8484
Select if setup uses endpoints (default), or configmaps to manage leader when
8585
DCS is kubernetes (not etcd or similar). In OpenShift it is not possible to
86-
use endpoints option, and configmaps is required. By default,
86+
use endpoints option, and configmaps is required. By default,
8787
`kubernetes_use_configmaps: false`, meaning endpoints will be used.
8888

8989
* **docker_image**
@@ -615,11 +615,14 @@ operator being able to provide some reasonable defaults.
615615
the required minimum.
616616

617617
* **connection_pooler_schema**
618-
Schema to create for credentials lookup function. Default is `pooler`.
618+
Database schema to create for credentials lookup function to be used by the
619+
connection pooler. Is is created in every database of the Postgres cluster.
620+
You can also choose an existing schema. Default schema is `pooler`.
619621

620622
* **connection_pooler_user**
621623
User to create for connection pooler to be able to connect to a database.
622-
Default is `pooler`.
624+
You can also choose an existing role, but make sure it has the `LOGIN`
625+
privilege. Default role is `pooler`.
623626

624627
* **connection_pooler_image**
625628
Docker image to use for connection pooler deployment.

docs/user.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -527,7 +527,7 @@ spec:
527527
This will tell the operator to create a connection pooler with default
528528
configuration, through which one can access the master via a separate service
529529
`{cluster-name}-pooler`. In most of the cases the
530-
[default configuration](reference/operator_parameters.md#connection-pool-configuration)
530+
[default configuration](reference/operator_parameters.md#connection-pooler-configuration)
531531
should be good enough. To configure a new connection pooler individually for
532532
each Postgres cluster, specify:
533533

@@ -540,7 +540,8 @@ spec:
540540
# in which mode to run, session or transaction
541541
mode: "transaction"
542542
543-
# schema, which operator will create to install credentials lookup function
543+
# schema, which operator will create in each database
544+
# to install credentials lookup function for connection pooler
544545
schema: "pooler"
545546
546547
# user, which operator will create for connection pooler
@@ -560,11 +561,11 @@ The `enableConnectionPooler` flag is not required when the `connectionPooler`
560561
section is present in the manifest. But, it can be used to disable/remove the
561562
pooler while keeping its configuration.
562563

563-
By default, `pgbouncer` is used as connection pooler. To find out about pooler
564-
modes read the `pgbouncer` [docs](https://www.pgbouncer.org/config.html#pooler_mode)
564+
By default, [`PgBouncer`](https://www.pgbouncer.org/) is used as connection pooler.
565+
To find out about pool modes read the `PgBouncer` [docs](https://www.pgbouncer.org/config.html#pooler_mode)
565566
(but it should be the general approach between different implementation).
566567

567-
Note, that using `pgbouncer` a meaningful resource CPU limit should be 1 core
568+
Note, that using `PgBouncer` a meaningful resource CPU limit should be 1 core
568569
or less (there is a way to utilize more than one, but in K8s it's easier just to
569570
spin up more instances).
570571

manifests/configmap.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ data:
1515
# connection_pooler_default_cpu_request: "500m"
1616
# connection_pooler_default_memory_limit: 100Mi
1717
# connection_pooler_default_memory_request: 100Mi
18-
connection_pooler_image: "registry.opensource.zalan.do/acid/pgbouncer:master-5"
18+
connection_pooler_image: "registry.opensource.zalan.do/acid/pgbouncer:master-6"
1919
# connection_pooler_max_db_connections: 60
2020
# connection_pooler_mode: "transaction"
2121
# connection_pooler_number_of_instances: 2

manifests/postgresql-operator-default-configuration.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ configuration:
127127
connection_pooler_default_cpu_request: "500m"
128128
connection_pooler_default_memory_limit: 100Mi
129129
connection_pooler_default_memory_request: 100Mi
130-
connection_pooler_image: "registry.opensource.zalan.do/acid/pgbouncer:master-5"
130+
connection_pooler_image: "registry.opensource.zalan.do/acid/pgbouncer:master-6"
131131
# connection_pooler_max_db_connections: 60
132132
connection_pooler_mode: "transaction"
133133
connection_pooler_number_of_instances: 2

0 commit comments

Comments
 (0)