Charmed PostgreSQL How-To | Scale units

Note: All commands are written for juju >= v.3.0

If you are using an earlier version, check the Juju 3.0 Release Notes.

How to scale units

Replication in PostgreSQL is the process of creating copies of the stored data. This provides redundancy, which means the application can provide self-healing capabilities in case one replica fails. In this context, each replica is equivalent one juju unit.

This guide will show you how to establish and change the amount of juju units used to replicate your data.

Deploy PostgreSQL with replicas

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>

Primary vs. leader unit

The PostgreSQL primary server unit may or may not be the same as the juju leader unit.

The juju leader unit is the represented in juju status by an asterisk (*) next to its name.

To retrieve the juju unit that corresponds to the PostgreSQL primary, use the action get-primary on any of the units running postgresql:

juju run postgresql/leader get-primary

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.

We highly suggest configuring the update-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, run

juju model-config update-status-hook-interval=<time(s/m/h)>

Scale replicas on an existing application

To scale up the cluster, use juju add-unit:

juju add-unit postgresql --num-units <amount_of_units_to_add>

To scale 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!