PostgreSQL Operator

Features

• Create or update Databases with extensions and schemas
• Create or update Users with rights (Owner, Writer or Reader)
• Connections to multiple PostgreSQL Engines
• Generate secrets for User login and password
• Allow to change User password based on time (e.g: Each 30 days)

Concepts

When we speak about Engines, we speak about PostgreSQL Database Servers. It isn't the same as Databases. Databases will store tables, ...

In this operator, Users are linked to Databases and doesn't exist without it. They are "children" of databases.

Moreover, a single User can only have rights to one Database.

Supported Custom Resources

CustomResourceDefinition	Description
PostgresqlEngineConfiguration	Represents a PostgreSQL Engine Configuration with all necessary data to connect it
PostgresqlDatabase	Represents a PostgreSQL Database
PostgresqlUserRole	Represents a PostgreSQL User Role

How to deploy ?

Using Helm

From EasyMile Helm Chart Repository

helm repo add easymile https://easymile.github.io/helm-charts/

And then deploy:

helm install postgresql-operator easymile/postgresql-operator

From Git

The project has a Helm 3 chart located in deploy/helm/postgresql-operator.

It will deploy the operator running the command:

helm install postgresql-operator ./helm/postgresql-operator

Getting Started

You’ll need a Kubernetes cluster to run against. You can use KIND to get a local cluster for testing, or run against a remote cluster. Note: Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster kubectl cluster-info shows).

Read how to setup your environment here

Running on the cluster

1. Install Instances of Custom Resources:

kubectl apply -f config/samples/

2. Build and push your image to the location specified by IMG:

make docker-build docker-push IMG=<some-registry>/postgresql-operator:tag

3. Deploy the controller to the cluster with the image specified by IMG:

make deploy IMG=<some-registry>/postgresql-operator:tag

Uninstall CRDs

To delete the CRDs from the cluster:

make uninstall

Undeploy controller

UnDeploy the controller to the cluster:

make undeploy

Contributing

Read the CONTRIBUTING guide

How it works

This project aims to follow the Kubernetes Operator pattern

It uses Controllers which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster

Test It Out

1. Install the CRDs into the cluster:

make install

2. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):

make run

NOTE: You can also run this in one step by running: make install run

Modifying the API definitions

If you are editing the API definitions, generate the manifests such as CRs or CRDs using:

make manifests

NOTE: Run make --help for more information on all potential make targets

More information can be found via the Kubebuilder Documentation

License

Copyright 2022.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.