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 is a new “Charmed Operator SDK”-based charm to replace legacy “Reactive”-based charm (in the channel latest/stable of the current charm) providing all juju-interfaces of legacy charm.

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 1. Introduction
2 t-setup-environment 2. Set up the environment
2 t-deploy-charm 3. Deploy PostgreSQL
2 t-managing-units 4. Manage your units
2 t-manage-passwords 5. Manage passwords
2 t-integrations 6. Relate your PostgreSQL to other applications
2 t-enable-security 7. Enable security
2 t-cleanup-environment 8. Cleanup your environment
1 how-to How To
2 h-setup Setup
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
2 h-to-manage-backups Backup
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 Backup
3 h-migrate-cluster-via-restore Restore foreign Backup
2 h-enable-monitoring Monitoring (COS)
2 h-enable-plugins Plugins/Extensions
2 h-develop Develop
3 h-develop-intro Intro
3 h-develop-mycharm Use in my charm
3 h-troubleshooting Troubleshooting
3 h-legacy-charm Legacy charm
1 reference Reference
2 r-releases-group Release Notes
3 r-releases All releases
3 r-releases-rev324 Revision 324
3 r-releases-rev288 Revision 288
2 r-requirements Requirements
2 r-contributing Contributing
2 r-testing Testing
2 r-actions Actions
2 r-configurations Configurations
2 r-profiles Profiles
2 r-libraries Libraries
2 r-integrations Integrations
2 r-supported-plugins-extensions Supported plugins/extensions
2 r-contacts Contacts
1 explanation Explanation
2 e-architecture Architecture
2 e-interfaces Interfaces/endpoints
2 e-users Users
2 e-statuses Statuses
2 e-juju-details Juju
2 e-legacy-charm Legacy charm


Mapping table
Path Location