Charmed PostgreSQL
- By Canonical Data Platform
- Databases
Channel | Revision | Published | Runs on |
---|---|---|---|
latest/stable | 316 | 11 Aug 2023 | |
14/stable | 288 | 18 Apr 2023 | |
14/candidate | 326 | 19 Sep 2023 | |
14/beta | 330 | 27 Sep 2023 | |
14/edge | 330 | 26 Sep 2023 |
juju deploy postgresql --channel 14/stable
You will need Juju 2.9 to be able to run this command. Learn how to upgrade to Juju 2.9.
Deploy universal operators easily with Juju, the Universal Operator Lifecycle Manager.
Platform:
How to deploy and manage units
Basic Usage
To deploy a single unit of PostgreSQL using its default configuration
juju deploy postgresql --channel 14/stable
It is customary to use PostgreSQL with replication. Hence usually more than one unit (preferably an odd number to prohibit a “split-brain” scenario) is deployed. To deploy PostgreSQL with multiple replicas, specify the number of desired units with the -n
option.
juju deploy postgresql --channel 14/stable -n <number_of_replicas>
To retrieve primary replica one can use the action get-primary
on any of the units running postgresql:
juju run-action postgresql/leader get-primary --wait
Similarly, the primary replica is displayed as a status message in juju status
, however one should note that this hook gets called on regular time intervals and the primary may be outdated if the status hook has not been called recently.
Further we highly suggest configuring the status hook to run frequently. In addition to reporting the primary, secondaries, and other statuses, the status hook performs self healing in the case of a network cut. To change the frequency of the update status hook do:
juju model-config update-status-hook-interval=<time(s/m/h)>
Note that this hook executes a read query to PostgreSQL. On a production level server this should be configured to occur at a frequency that doesn’t overload the server with read requests. Similarly the hook should not be configured at too quick of a frequency as this can delay other hooks from running. You can read more about status hooks here.
Replication
To scaling-up the cluster, use juju add-unit
:
juju add-unit postgresql --num-units <amount_of_units_to_add>
To scaling-down the cluster, use juju remove-unit
:
juju remove-unit postgresql/<unit_id_to_remove>
Warning: do NOT remove the last unit, it will destroy your data!
Help us improve this documentation
Most of this documentation can be collaboratively discussed and changed on the respective topic in the doc category of the Charmhub forum. See the documentation guidelines if you’d like to contribute.