Skip to content

Commit ddb8626

Browse files
committed
add annotation documentation for DBInstance and DBCluster (#189)
Update README with documentation for supported annotations on `DBInstance` and `DBCluster` resources: - rds.services.k8s.aws/skip-final-snapshot (default: true): Skip creating a final snapshot before deletion - rds.services.k8s.aws/final-db-snapshot-identifier: Specify the identifier to use for the final snapshot - rds.services.k8s.aws/delete-automated-backups (default: false): Delete automated backups associated with the instance/cluster
1 parent 5bc1836 commit ddb8626

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,23 @@ The ACK service controller for Amazon RDS provides a set of Kubernetes [custom r
2121

2222
To learn how to [get started with the ACK service controller for Amazon RDS](https://aws-controllers-k8s.github.io/community/docs/tutorials/rds-example/), please see the [tutorial](https://aws-controllers-k8s.github.io/community/docs/tutorials/rds-example/).
2323

24+
## Annotations
25+
26+
27+
For some resources, `rds-controller` supports annotations to provide additional control over
28+
the behavior of the controller. The following annotations are supported:
29+
30+
- For **DBInstance** and **DBCluster** CRDs:
31+
- `rds.services.k8s.aws/skip-final-snapshot`: When set to `true`, the final snapshot will
32+
not be created when the resource is deleted. Default value is `true`, when not set, the
33+
final snapshot is NOT created.
34+
- `rds.services.k8s.aws/final-db-snapshot-identifier`: When set, the final snapshot will
35+
be created with the provided identifier. Default value is empty, when not set, the controller
36+
delegates the identifier generation to the RDS service.
37+
- `rds.services.k8s.aws/delete-automated-backups`: When set to `true`, automated backups
38+
will be deleted when the resource is deleted. Default value is `false`, when not set, the
39+
automated backups are NOT deleted.
40+
2441
## Help & Feedback
2542

2643
The ACK service controller for Amazon RDS is based on the [Amazon RDS API](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/). To get a full understanding of how all of the APIs work, please review the [Amazon RDS API documentation](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/).
@@ -42,4 +59,4 @@ You can also learn more about our [Governance](https://github.com/aws-controller
4259

4360
## License
4461

45-
This project is [licensed](https://github.com/aws-controllers-k8s/rds-controller/blob/main/LICENSE) under the Apache-2.0 License.
62+
This project is [licensed](https://github.com/aws-controllers-k8s/rds-controller/blob/main/LICENSE) under the Apache-2.0 License.

0 commit comments

Comments
 (0)