Charmed PostgreSQL Documentation
Charmed PostgreSQL is an open-source software operator designed to deploy and operate object-relational databases on IAAS/VM. It packages the powerful database management system PostgreSQL into a charmed operator for deployment with Juju.
This charm offers automated operations management from day 0 to day 2. It is equipped with several features to securely store and scale complicated data workloads, including TLS encryption, backups, monitoring, password rotation, and easy integration with client applications.
Charmed PostgreSQL meets the need of deploying PostgreSQL in a structured and consistent manner while providing flexibility in configuration. It simplifies deployment, scaling, configuration and management of relational databases in large-scale production environments reliably.
This charmed operator is made for anyone looking for a comprehensive database management interface, whether for operating a complex production environment or simply as a playground to learn more about databases and charms.
This operator is built for IAAS/VM.
For deployments in Kubernetes environments, see Charmed PostgreSQL K8s.
In this documentation
| Tutorials Get started - a hands-on introduction to using Charmed PostgreSQL operator for new users |
How-to guides Step-by-step guides covering key operations such as scaling, encryption, and restoring backups |
| Reference Technical information such as requirements, release notes, and plugins |
Explanation Concepts - discussion and clarification of key topics such as architecture, users, and legacy charms |
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.
- Read our Code of Conduct
- Join the Discourse forum
- Contribute to the code or report an issue
- Explore Canonical Data Fabric solutions
- Contacts us for all further questions
Licencing & Trademark
The Charmed PostgreSQL Operator is distributed under the Apache Software Licence version 2.0. It depends on PostgreSQL, which is licensed under the PostgreSQL License - a liberal open-source licence similar to the BSD or MIT licences.
PostgreSQL is a trademark or registered trademark of PostgreSQL Global Development Group. Other trademarks are the property of their respective owners.
Navigation
| Level | Path | Navlink |
|---|---|---|
| 1 | tutorial | Tutorial |
| 2 | t-overview | Overview |
| 2 | t-set-up | 1. Set up the environment |
| 2 | t-deploy | 2. Deploy PostgreSQL |
| 2 | t-scale | 3. Scale replicas |
| 2 | t-passwords | 4. Manage passwords |
| 2 | t-integrate | 5. Integrate with other applications |
| 2 | t-enable-tls | 6. Enable TLS |
| 2 | t-clean-up | 7. Clean up environment |
| 1 | how-to | How-to guides |
| 2 | h-set-up | Set up |
| 3 | h-deploy-lxd | Deploy on LXD |
| 3 | h-deploy-maas | Deploy on MAAS |
| 3 | h-deploy-terraform | Deploy via Terraform |
| 3 | h-scale | Scale units |
| 3 | h-enable-tls | Enable TLS |
| 3 | h-manage-client | Manage client applications |
| 2 | h-backups | Back up and restore |
| 3 | h-configure-s3-aws | Configure S3 AWS |
| 3 | h-configure-s3-radosgw | Configure S3 RadosGW |
| 3 | h-create-backup | Create a backup |
| 3 | h-restore-backup | Restore a backup |
| 3 | h-manage-backup-retention | Manage backup retention |
| 3 | h-migrate-cluster | Migrate a cluster |
| 2 | h-monitor | Monitor (COS) |
| 3 | h-enable-monitoring | Enable Monitoring |
| 3 | h-enable-alert-rules | Enable Alert Rules |
| 3 | h-enable-tracing | Enable Tracing |
| 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-connect-your-charm | Connect your charm |
| 3 | h-integrate-with-your-charm | Integrate a database with your charm |
| 3 | h-connect-migrate-pgdump | Migrate data via pg_dump |
| 3 | h-connect-migrate-backup-restore | Migrate data via backup/restore |
| 2 | h-async | Cross-regional async replication |
| 3 | h-async-set-up | Set up clusters |
| 3 | h-async-integrate | Integrate with a client app |
| 3 | h-async-remove-recover | Remove or recover a cluster |
| 2 | h-enable-plugins-extensions | Enable plugins/extensions |
| 1 | reference | Reference |
| 2 | r-overview | Overview |
| 2 | r-releases-group | Release Notes |
| 3 | r-releases | All releases |
| 3 | r-revision-429 | Revision 429/430 |
| 3 | r-revision-363 | Revision 363 |
| 3 | r-revision-351 | Revision 351 |
| 3 | r-revision-336 | Revision 336 |
| 3 | r-revision-288 | Revision 288 |
| 2 | r-system-requirements | System requirements |
| 2 | r-software-testing | Software testing |
| 2 | r-performance | Performance and resource allocation |
| 2 | h-troubleshooting | Troubleshooting |
| 2 | r-plugins-extensions | Plugins/extensions |
| 2 | r-contacts | Contacts |
| 1 | explanation | Explanation |
| 2 | e-architecture | Architecture |
| 2 | e-interfaces-endpoints | Interfaces and endpoints |
| 2 | e-statuses | Statuses |
| 2 | e-users | Users |
| 2 | e-logs | Logs |
| 2 | e-juju-details | Juju |
| 2 | e-legacy-charm | Legacy charm |
| 1 | search | Search |
Redirects
Mapping table
| Path | Location |
|---|