[WIP] Kubernetes Operator for Database and User on RDS Postgres (Aurora)

This an operator to create databases and users on RDS Postgres. It is developed for AWS Aurora RDS with Postgres engine but it can support RDS Postgres too.

Description

• This is written using Kubebuilder
• Create databases on AWS Aurora Postgres instance
• Configure ReadWrite and ReadOnly roles for the database
• Create users for the roles. These users can be used by an applicaion running on K8s container on AWS such as EKS.
• The user is authenticated using IAM authentication for RDS. See IAM Database Authentication.
• The container is recommended to use EKS Pod Identity or IRSA(IAM Roles for Service Accounts)

Assumption

• This operator doesn't deploy Aurora Postgres instance.
• It only create a database on the instance and configure Postgres roles that can be used by a app user.
• controller for creating app users will be added.
• The instance has to be deployed separately. An infrastructure as code (IaC) using Cloud Formation or Terraform is recommended.

Getting Started

Prerequisites

• go version v1.20.0+
• docker version 17.03+.
• kubectl version v1.11.3+.
• Access to a Kubernetes v1.11.3+ cluster.

To Deploy on the cluster

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

make docker-build docker-push IMG=<some-registry>/postgres-db-user:tag

NOTE: This image ought to be published in the personal registry you specified. And it is required to have access to pull the image from the working environment. Make sure you have the proper permission to the registry if the above commands don’t work.

Install the CRDs into the cluster:

make install

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

make deploy IMG=<some-registry>/postgres-db-user:tag

NOTE: If you encounter RBAC errors, you may need to grant yourself cluster-admin privileges or be logged in as admin.

Create instances of your solution You can apply the samples (examples) from the config/sample:

kubectl apply -k config/samples/

NOTE: Ensure that the samples has default values to test it out.

To Uninstall

Delete the instances (CRs) from the cluster:

kubectl delete -k config/samples/

Delete the APIs(CRDs) from the cluster:

make uninstall

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

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

More information can be found via the Kubebuilder Documentation

License

Copyright 2023.

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.