Charmed PostgreSQL K8s Documentation

Charmed PostgreSQL K8s Documentation

Charmed PostgreSQL K8s is an open-source 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 K8s 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 Kubernetes.

For deployments in IAAS/VM, see Charmed PostgreSQL.

Tutorials
Get started - a hands-on introduction to using Charmed PostgreSQL K8s 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 K8s is an official distribution of PostgreSQL. It’s an open-source project that welcomes community contributions, suggestions, fixes and constructive feedback.

Navigation

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-access-postgresql 3. Access PostgreSQL
2 t-managing-units 4. Manage units
2 t-manage-passwords 5. Manage passwords
2 t-integrations 6. Integrate applications
2 t-enable-security 7. Enable security
2 t-cleanup-environment 8. Clean up environment
1 how-to How-to guides
2 h-setup Set up
3 h-deploy-microk8s Deploy on MicroK8s
3 h-deploy-gke Deploy on GKE
3 h-deploy-eks Deploy on EKS
3 h-manage-units Manage units
3 h-enable-encryption Enable encryption
3 h-manage-app Manage applications
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 Migrate a cluster
2 h-to-cos Monitoring (COS)
3 h-enable-monitoring Enable Monitoring
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 database with my charm
3 h-develop-migratedataby Migrate data via…
4 h-develop-pgdump …pg_dump
4 h-develop-backuprestore …backup/restore
2 h-async Async replication
3 h-async-deployment Deploy
3 h-async-clients Clients
3 h-async-switchover Switchover
3 h-async-recovery Recovery
3 h-async-removal Removal
1 reference Reference
2 r-overview Overview
2 r-releases-group Release Notes
3 r-releases All releases
3 r-releases-rev193 Revision 193
3 r-releases-rev177 Revision 177
3 r-releases-rev158 Revision 158
3 r-releases-rev73 Revision 73
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 flowcharts Flowcharts
3 e-charm Charm flowcharts
3 e-peers Relations flowcharts
3 e-backups Backups flowcharts
2 e-legacy-charm Legacy charm

Redirects

Mapping table
Path Location
1 Like