Charmed PostgreSQL Documentation

Charmed PostgreSQL Documentation

The Charmed PostgreSQL Operator delivers automated operations management from day 0 to day 2 on the PostgreSQL Database Management System. It is an open source, end-to-end, production-ready data platform on top of Juju.

PostgreSQL is a powerful, open source object-relational database system that uses and extends the SQL language combined with many features that safely store and scale the most complicated data workloads.

The Charmed PostgreSQL operator comes in two flavours to deploy and operate PostgreSQL on physical/virtual machines and Kubernetes. Both offer features such as replication, TLS, password rotation, and easy to use integration with applications. The Charmed PostgreSQL Operator meets the need of deploying PostgreSQL in a structured and consistent manner while allowing the user flexibility in configuration. It simplifies deployment, scaling, configuration and management of PostgreSQL in production at scale in a reliable way.

Why “Charmed PostgreSQL”?

This “Charmed PostgreSQL” operator (in the channel 14/stable) is a new “Charmed SDK”-based charm to replace legacy “Reactive”-based charm (in the channel latest/stable).
Read more about legacy charm here.

Project and community

Charmed PostgreSQL is an official distribution of PostgreSQL. It’s an open-source project that welcomes community contributions, suggestions, fixes and constructive feedback.

In this documentation

Get started - a hands-on introduction to using Charmed PostgreSQL operator for new users
How-to guides
Step-by-step guides covering key operations and common tasks
Technical information - specifications, APIs, architecture
Concepts - discussion and clarification of key topics


Level Path Navlink
1 tutorial Tutorial
2 t-overview Introduction
2 t-setup-environment 1. Set up the environment
2 t-deploy-charm 2. Deploy PostgreSQL
2 t-managing-units 3. Manage units
2 t-manage-passwords 4. Manage passwords
2 t-integrations 5. Integrate applications
2 t-enable-security 6. Enable security
2 t-cleanup-environment 7. Clean up environment
1 how-to How-to guides
2 h-setup Set up
3 h-deploy-lxd Deploy on LXD
3 h-manage-units Manage units
3 h-enable-encryption Enable encryption
3 h-manage-app Manage applications
3 h-async-replication Configure async replication
2 h-to-manage-backups Manage backups
3 h-configure-s3-aws Configure S3 AWS
3 h-configure-s3-radosgw Configure S3 RadosGW
3 h-create-and-list-backups Create and list backups
3 h-restore-backup Restore a local backup
3 h-migrate-cluster-via-restore Restore a foreign backup
2 h-to-cos Monitoring (COS)
3 h-enable-monitoring Enable monitoring (COS)
3 h-enable-alertrules Enable Alert Rules
2 h-enable-plugins Enable plugins/extensions
2 h-upgrade Upgrade
3 h-upgrade-intro Overview
3 h-upgrade-major Perform a major upgrade
3 h-rollback-major Perform a major rollback
3 h-upgrade-minor Perform a minor upgrade
3 h-rollback-minor Perform a minor rollback
2 h-develop Develop
3 h-develop-intro Overview
3 h-develop-mycharm Integrate a database with my charm
3 h-develop-migratedataby Migrate data via…
4 h-develop-pgdump …pg_dump
4 h-develop-backuprestore …backup/restore
1 reference Reference
2 r-releases-group Release Notes
3 r-releases All releases
3 r-releases-rev363 Revision 363
3 r-releases-rev351 Revision 351
3 r-releases-rev336 Revision 336
3 r-releases-rev288 Revision 288
2 r-requirements Requirements
2 r-testing Testing
2 h-troubleshooting Troubleshooting
2 r-profiles Profiles
2 r-plugins-extensions Plugins/extensions
2 r-contacts Contacts
1 explanation Explanation
2 e-architecture Architecture
2 e-interfaces Interfaces/endpoints
2 e-statuses Statuses
2 e-users Users
2 e-logs Logs
2 e-juju-details Juju
2 e-legacy-charm Legacy charm


Mapping table
Path Location