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 PostgreSQL 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 PostgreSQL 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 PostgreSQL Operator is developed and tested on CentOS and RHEL linux platforms but is known to run on other Linux variants.
Installation
PostgreSQL Operator Installation
The PostgreSQL Operator provides a few different methods for installation.
For an automated deployment using Ansible playbooks, please start here:
For a step by step customer installation using Bash, please start here:
For a quick start deployment using OperatorHub.io, please see instructions here:
For a quick start deployment to Google Kubernetes Engine (GKE), please see instructions here:
PGO CLI Installation
If you have the PostgreSQL Operator installed in your environment, and are interested in installation of the client interface, please start here:
Using the PostgreSQL Operator
If you have the PostgreSQL and Client Interface installed in your environment and are interested in guidance on the use of the Crunchy PostgreSQL Operator, please start here:
Contributing to the Project
Want to contribute to the PostgreSQL Operator project? Please review information here:
Development for the PostgreSQL Operator 4.0 code base is on the develop branch. In order to submit a Pull Request, please follow guidance here:
Submitting an Issue
Please use GitHub to submit an issue for the PostgreSQL Operator project.
If you would like to work the issue, please add that information in the issue so that we can confirm we are not already working no need to duplicate efforts.
If you have any question you can submit a Support - Question and Answer issue and we will work with you on how you can get more involved.
Complete Documentation
For additional information regarding design, configuration and operation of the PostgreSQL Operator, pleases see the Official Project Documentation
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/.
Past Versions
Documentation for previous releases can be found at the Crunchy Data Access Portal
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
apis
|
|
|
Package logging Functions to set unique configuration for use with the logrus logger
|
Package logging Functions to set unique configuration for use with the logrus logger |
|
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
|
|