pgdb

A Postgres Database Kubernetes Operator: you bring the cluster, we'll manage the database.

Description

pgdb will reconcile k8s Database resources with the specified Postgres clusters. You'll need a cluster setup with a secret containing connection credentials, such as pgdb-example-secret in the namespace dev-pg-16-0. The following will create a secret named pgdb-output in the current namespace with the connection credentials for the data store.

apiVersion: pgdb.storage.meschbach.com/v1alpha1
kind: Database
metadata:
  labels:
    app.kubernetes.io/name: database
    app.kubernetes.io/instance: database-sample
    app.kubernetes.io/part-of: pgdb
    app.kubernetes.io/managed-by: kustomize
    app.kubernetes.io/created-by: pgdb
  name: database-sample
spec:
  clusterNamespace: "dev-pg-16-0"
  clusterSecret: "pgdb-example-secret"
  databaseSecret: "pgdb-output"
  controller: "test"

The resulting secret will look like:

apiVersion: v1
kind: Secret
metadata:
  name: pgdb-output
  namespace: default
data:
  database: ZGVmYXVsdC1kYXRhYmFzZS1zYW1wbGU=
  host: ZGV2LXBnLTE2LTAuZGV2LXBnLTE2LTAuc3ZjLndvcmtzaG9wLms4cw==
  password: >-
    PSFsZ21qaXl3ZG1ta3hiamhJSEVZRlVXS1haWTAwaHJ5QklCQUFHV0lELTExOTFUU0hUSEdFVUVPPUlERUJWSg==
  port: NTQzMg==
  user: ZGVmYXVsdC1kYXRhYmFzZS1zYW1wbGU=
type: Opaque

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).

Running on the cluster

Install Instances of Custom Resources:

kubectl apply -k config/samples/

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

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

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

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

Uninstall CRDs

To delete the CRDs from the cluster:

make uninstall

Undeploy controller

UnDeploy the controller from the cluster:

make undeploy

Contributing

// TODO(user): Add detailed information on how you would like others to contribute to this project

How it works

This project aims to follow the Kubernetes Operator pattern.

It uses Controllers, which provide a reconcile function responsible for synchronizing resources until the desired state is reached on the cluster.

Test It Out

Install the CRDs into the cluster:

make install

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

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.

# Packages

# README