rds-controller

README

ACK service controller for Amazon Relational Database Service (RDS)

This repository contains source code for the AWS Controllers for Kubernetes (ACK) service controller for Amazon RDS.

Please log issues and feedback on the main AWS Controllers for Kubernetes Github project.

Overview

The ACK service controller for Amazon Relational Database Service (RDS) provides a way to manage RDS database instances directly from Kubernetes. This includes the following database engines:

• Amazon Aurora (MySQL & PostgreSQL)
• Amazon RDS for PostgreSQL
• Amazon RDS for MySQL
• Amazon RDS for MariaDB
• Amazon RDS for Oracle
• Amazon RDS for SQL Server

The ACK service controller for Amazon RDS provides a set of Kubernetes custom resource definitions for interfacing with the Amazon RDS API through a declarative Kubernetes workflow. This lets you to run your applications in Kubernetes with a fully-managed relational database in RDS.

Getting Started

To learn how to get started with the ACK service controller for Amazon RDS, please see the tutorial.

Annotations

For some resources, rds-controller supports annotations to provide additional control over the behavior of the controller. The following annotations are supported:

• For DBInstance and DBCluster CRDs:
  • rds.services.k8s.aws/skip-final-snapshot: When set to true, the final snapshot will not be created when the resource is deleted. Default value is true, when not set, the final snapshot is NOT created.
  • rds.services.k8s.aws/final-db-snapshot-identifier: When set, the final snapshot will be created with the provided identifier. Default value is empty, when not set, the controller delegates the identifier generation to the RDS service.
  • rds.services.k8s.aws/delete-automated-backups: When set to true, automated backups will be deleted when the resource is deleted. Default value is false, when not set, the automated backups are NOT deleted.

Help & Feedback

The ACK service controller for Amazon RDS is based on the Amazon RDS API. To get a full understanding of how all of the APIs work, please review the Amazon RDS API documentation.

You can learn more about how to use Amazon RDS through the documentation.

For general help with ACK, please see the ACK community README.

Contributing

We welcome community contributions and pull requests.

See our contribution guide for more information on how to report issues, set up a development environment, and submit code.

We adhere to the Amazon Open Source Code of Conduct.

You can also learn more about our Governance structure.

License

This project is licensed under the Apache-2.0 License.