Skip to content

Commit 5828a7f

Browse files
authored
Add additional setup instructions to README (#55)
Issue #, if available: Description of changes: This adds additional details for how to deploy the ACK service controller for RDS, including examples for creating database instances using the PostgreSQL and MariaDB engines. By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
1 parent ff861d8 commit 5828a7f

File tree

1 file changed

+31
-12
lines changed

1 file changed

+31
-12
lines changed

README.md

Lines changed: 31 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,45 @@
11
# ACK service controller for Amazon Relational Database Service (RDS)
22

3-
This repository contains source code for the AWS Controllers for Kubernetes
4-
(ACK) service controller for Amazon RDS.
3+
This repository contains source code for the AWS Controllers for Kubernetes (ACK) service controller for Amazon RDS.
54

6-
Please [log issues][ack-issues] and feedback on the main AWS Controllers for
7-
Kubernetes Github project.
5+
Please [log issues](https://github.com/aws-controllers-k8s/community/issues) and feedback on the main AWS Controllers for Kubernetes Github project.
6+
7+
## Overview
8+
9+
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:
10+
11+
* [Amazon Aurora](https://aws.amazon.com/rds/aurora/) (MySQL & PostgreSQL)
12+
* [Amazon RDS for PostgreSQL](https://aws.amazon.com/rds/postgresql/)
13+
* [Amazon RDS for MySQL](https://aws.amazon.com/rds/mysql/)
14+
* [Amazon RDS for MariaDB](https://aws.amazon.com/rds/mariadb/)
15+
* [Amazon RDS for Oracle](https://aws.amazon.com/rds/oracle/)
16+
* [Amazon RDS for SQL Server](https://aws.amazon.com/rds/sqlserver/)
17+
18+
The ACK service controller for Amazon RDS provides a set of Kubernetes [custom resource definitions](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) for interfacing with the [Amazon RDS API](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/) through a declarative Kubernetes workflow. This lets you to run your applications in Kubernetes with a fully-managed relational database in RDS.
19+
20+
## Getting Started
21+
22+
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/).
23+
24+
## Help & Feedback
25+
26+
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/).
27+
28+
You can learn more about [how to use Amazon RDS](https://docs.aws.amazon.com/rds/index.html) through the [documentation](https://docs.aws.amazon.com/rds/index.html).
29+
30+
For [general help with ACK](https://github.com/aws-controllers-k8s/community#help--feedback), please see the [ACK community README](https://github.com/aws-controllers-k8s/community#help--feedback).
831

9-
[ack-issues]: https://github.com/aws-controllers-k8s/community/issues
1032

1133
## Contributing
1234

1335
We welcome community contributions and pull requests.
1436

15-
See our [contribution guide](/CONTRIBUTING.md) for more information on how to
16-
report issues, set up a development environment, and submit code.
17-
18-
We adhere to the [Amazon Open Source Code of Conduct][coc].
37+
See our [contribution guide](https://github.com/aws-controllers-k8s/rds-controller/blob/main/CONTRIBUTING.md) for more information on how to report issues, set up a development environment, and submit code.
1938

20-
You can also learn more about our [Governance](/GOVERNANCE.md) structure.
39+
We adhere to the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
2140

22-
[coc]: https://aws.github.io/code-of-conduct
41+
You can also learn more about our [Governance](https://github.com/aws-controllers-k8s/rds-controller/blob/main/GOVERNANCE.md) structure.
2342

2443
## License
2544

26-
This project is [licensed](/LICENSE) under the Apache-2.0 License.
45+
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)