How-to guides

The following guides cover key processes and common tasks for setting up and managing Charmed PostgreSQL on machines.

Deployment and setup

Available deployment methods and specialised setups:

• Deploy
  • Sunbeam
  • MAAS
  • AWS EC2
  • GCE
  • Azure
  • Multi-AZ
  • Terraform
  • TLS VIP access
  • Juju spaces
  • Air-gapped
  • Juju storage

Usage and maintenance

Most common operations during the initial setup of a PostgreSQL cluster:

• Integrate
• Scale
• Manage passwords
• Enable TLS
• External network access
• Enable LDAP
• Enable plugins/extensions
• Switchover/failover

Backup and restore

Configuration of storage providers and backup management:

• Back up and restore
  • Configure S3 AWS
  • Configure S3 RadosGW
  • Create a backup
  • Restore a backup
  • Manage backup retention
  • Migrate a cluster

Monitoring (COS)

Observability and monitoring with the Canonical Observability Stack:

• Monitoring (COS)
  • Enable monitoring
  • Enable alert rules
  • Enable tracing
  • Enable profiling

Refresh (upgrade)

Instructions for performing an in-place application refresh:

• Refresh (upgrade)

Data migration

For charm developers looking to support PostgreSQL integrations with their charm:

• Data migration
  • Migrate data from PostgreSQL 14 to 16
  • Migrate data via `pg_dump`
  • Migrate data via backup/restore

Cross-regional (cluster-cluster) async replication

Walkthrough of a cluster-cluster deployment and its essential operations:

• Cross-regional async replication

Logical replication

How to replicate a subset of data to another PostgreSQL cluster:

• Logical replication
  • Set up two clusters
  • Re-enable logical replication

Charm development

For charm developers looking to support PostgreSQL integrations with their charm

• Integrate PostgreSQL with your charm

Other relevant guides:

• Migrate data via pg_dump

• Migrate data via backup/restore