Charmed PostgreSQL K8s documentation¶
Charmed PostgreSQL K8s is an open-source software operator designed to deploy and operate object-relational databases on Kubernetes. It packages the powerful database management system PostgreSQL into a charmed operator for deployment with Juju.
This charmed operator meets the need of simplifying deployment, scaling, configuration and management of relational 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 K8s 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 Kubernetes operator. To deploy on IAAS/VM, see Charmed PostgreSQL VM.
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: System requirements • Architecture
Deploy PostgreSQL: Guided tutorial • Quickstart • Set up a cloud
Key operations: Scale your cluster • Connect to a client • 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: Enable TLS encryption • External network access
Troubleshooting: Overview and tools • Logs
Charm developers¶
Information for developers looking to make their application compatible with PostgreSQL.
Charm integrations: Interfaces and endpoints • How to integrate with your charm with PostgreSQL
Learn about the PostgreSQL charm’s design: Architecture • Internal users • Roles
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.