README
¶
Crunchy Data PostgreSQL Operator
The postgres-operator is a controller that runs within a Kubernetes cluster that provides a means to deploy and manage PostgreSQL clusters.
Use the postgres-operator to:
- deploy PostgreSQL containers including streaming replication clusters
- scale up PostgreSQL clusters with extra replicas
- add pgpool, pgbouncer, and metrics sidecars to PostgreSQL clusters
- apply SQL policies to PostgreSQL clusters
- assign metadata tags to PostgreSQL clusters
- maintain PostgreSQL users and passwords
- perform minor upgrades to PostgreSQL clusters
- load simple CSV and JSON files into PostgreSQL clusters
- perform database backups
Deployment Requirements
The Operator is validated for deployment on Kubernetes, OpenShift, and VMware Enterprise PKS clusters. Some form of storage is required, NFS, hostPath, and Storage Classes are currently supported.
The Operator includes various components that get deployed to your Kubernetes cluster as shown in the following diagram and detailed in the Design section of the documentation for the version you are running.
The Operator is developed and tested on CentOS and RHEL linux platforms but is known to run on other Linux variants.
Documentation 4.0.0
If you are new to the Crunchy PostgreSQL Operator and interested in installing the Crunchy PostgreSQL Operator in your environment, please start here:
If you have the Crunchy PostgreSQL Operator installed in your environment, and are interested in installation of the client interface, please start here: PGO Client Install
If you have the Crunchy PostgreSQL and Client Interface installed in your environment and are interested in guidance on the use of the Crunchy PostgreSQL Operator, please start here:
Want to contribute to the product find more info here:
- Developer Setup
- Development for the 4.0 code base is on the develop branch.
- GitHub issues and Pull Request information
Documentation 3.5.3
If you are new to the Crunchy PostgreSQL Operator and interested in installing the Crunchy PostgreSQL Operator in your environment, please start here:
If you have the Crunchy PostgreSQL Operator installed in your environment, and are interested in installation of the client interface, please start here: PGO Client Install
If you have the Crunchy PostgreSQL and Client Interface installed in your environment and are interested in guidance on the use of the Crunchy PostgreSQL Operator, please start here:
Want to contribute to the product find more info here:
- Developer Setup
- Development on 3.5 codebase is on the develop-3.5 branch.
- GitHub issues and Pull Request information
Documentation for previous releases can be found at the Crunchy Data Access Portal
If you are looking for the latest documentation, please see the develop branch which is considered unstable. The development documentation can be reviewed at https://crunchydata.github.io/postgres-operator/latest/.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
apis
|
|
|
cluster
Package cluster holds the cluster CRD logic and definitions A cluster is comprised of a primary service, replica service, primary deployment, and replica deployment
|
Package cluster holds the cluster CRD logic and definitions A cluster is comprised of a primary service, replica service, primary deployment, and replica deployment |
|
cmd
Package cmd provides the command line functions of the crunchy CLI
|
Package cmd provides the command line functions of the crunchy CLI |
|
testing
|
|