Charmed PostgreSQL documentation¶
Charmed PostgreSQL is an open-source operator designed to deploy and operate PostgreSQL on virtual machines and cloud services. It packages the relational database management system PostgreSQL with the Patroni high-availability replication system into an operator for deployment with Juju .
This charmed operator simplifies deployment, scaling, configuration and management of PostgreSQL databases in large-scale production environments reliably. It is equipped with several features to securely store and scale complicated data workloads, including easy integration with client applications.
Charmed PostgreSQL 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.
Note
This is a IAAS/VM operator. To deploy on Kubernetes, see Charmed PostgreSQL K8s .
In this documentation¶
Get started¶
Learn about what’s in the charm, how to set up your environment, and perform the most common operations.
Charm overview: Architecture • System requirements • Charm versions
Deploy PostgreSQL: Guided tutorial • Quickstart • Set up a cloud
Key operations: Scale your cluster • Manage user credentials • Create a backup
Production deployments¶
Advanced deployments and operations focused on production scenarios and high availability.
Advanced deployment scenarios: Terraform • Air-gapped deployments • Multiple availability zones • Cluster-cluster replication • Logical replication
Networking: Juju spaces • Enable TLS encryption • External network access
Upgrades and data migration: In-place refresh (upgrade) • Cluster and data migration
Troubleshooting: Overview and tools • Manual switchover/failover • Logs • SoS report
Charm developers¶
Make your charm compatible with PostgreSQL: Interfaces and endpoints • How to integrate with your charm with PostgreSQL
Learn more about the charm: Internal users • Roles • Charm versions
Juju properties: Configuration parameters • Actions
How this documentation is organised¶
This documentation uses the Diátaxis documentation structure :
The Tutorial provides step-by-step guidance for a beginner through the basics of a deployment in a local machine.
How-to guides are more focused, and assume you already have basic familiarity with the product.
Reference contains structured information for quick lookup, such as system requirements and configuration parameters
Explanation gives more background and context about key topics
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.
Get involved¶
Governance and policies¶
Licensing & 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.