Skip to content

Commit 833599a

Browse files
authored
fix: updates README due to failed release (#164)
1 parent 5702cff commit 833599a

File tree

1 file changed

+45
-106
lines changed

1 file changed

+45
-106
lines changed

README.md

+45-106
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,7 @@ Terraform module to provision AWS [`RDS`](https://aws.amazon.com/rds/) instances
3333
---
3434

3535
This project is part of our comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
36-
37-
38-
[![Terraform Open Source Modules](https://docs.cloudposse.com/images/terraform-open-source-modules.svg)][terraform_modules]
39-
36+
<a href="https://cpco.io/terraform-modules"><img src="https://docs.cloudposse.com/images/terraform-open-source-modules.svg" align="right" /></a>
4037

4138

4239
It's 100% Open Source and licensed under the [APACHE2](LICENSE).
@@ -65,33 +62,18 @@ The module will create:
6562
* DNS Record in Route53 for the DB endpoint
6663

6764

68-
## Security & Compliance [<img src="https://cloudposse.com/wp-content/uploads/2020/11/bridgecrew.svg" width="250" align="right" />](https://bridgecrew.io/)
69-
70-
Security scanning is graciously provided by Bridgecrew. Bridgecrew is the leading fully hosted, cloud-native solution providing continuous Terraform security and compliance.
71-
72-
| Benchmark | Description |
73-
|--------|---------------|
74-
| [![Infrastructure Security](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-rds/general)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-rds&benchmark=INFRASTRUCTURE+SECURITY) | Infrastructure Security Compliance |
75-
| [![CIS KUBERNETES](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-rds/cis_kubernetes)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-rds&benchmark=CIS+KUBERNETES+V1.5) | Center for Internet Security, KUBERNETES Compliance |
76-
| [![CIS AWS](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-rds/cis_aws)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-rds&benchmark=CIS+AWS+V1.2) | Center for Internet Security, AWS Compliance |
77-
| [![CIS AZURE](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-rds/cis_azure)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-rds&benchmark=CIS+AZURE+V1.1) | Center for Internet Security, AZURE Compliance |
78-
| [![PCI-DSS](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-rds/pci)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-rds&benchmark=PCI-DSS+V3.2) | Payment Card Industry Data Security Standards Compliance |
79-
| [![NIST-800-53](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-rds/nist)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-rds&benchmark=NIST-800-53) | National Institute of Standards and Technology Compliance |
80-
| [![ISO27001](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-rds/iso)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-rds&benchmark=ISO27001) | Information Security Management System, ISO/IEC 27001 Compliance |
81-
| [![SOC2](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-rds/soc2)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-rds&benchmark=SOC2)| Service Organization Control 2 Compliance |
82-
| [![CIS GCP](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-rds/cis_gcp)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-rds&benchmark=CIS+GCP+V1.1) | Center for Internet Security, GCP Compliance |
83-
| [![HIPAA](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-rds/hipaa)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-rds&benchmark=HIPAA) | Health Insurance Portability and Accountability Compliance |
8465

66+
## Usage
8567

8668

87-
## Usage
8869

70+
> **Important**
71+
> We do not pin modules to versions in our examples because of the
72+
> difficulty of keeping the versions in the documentation in sync with the latest released versions.
73+
> We highly recommend that in your code you pin the version to the exact version you are
74+
> using so that your infrastructure remains stable, and update versions in a
75+
> systematic way so that they do not catch you by surprise.
8976
90-
**IMPORTANT:** We do not pin modules to versions in our examples because of the
91-
difficulty of keeping the versions in the documentation in sync with the latest released versions.
92-
We highly recommend that in your code you pin the version to the exact version you are
93-
using so that your infrastructure remains stable, and update versions in a
94-
systematic way so that they do not catch you by surprise.
9577

9678

9779
```hcl
@@ -336,82 +318,27 @@ Available targets:
336318
<!-- markdownlint-restore -->
337319

338320

339-
340-
## Share the Love
341-
342-
Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/terraform-aws-rds)! (it helps us **a lot**)
343-
344-
345-
346321
## Related Projects
347322

348323
Check out these related projects.
349324

350325
- [terraform-aws-rds-cluster](https://github.com/cloudposse/terraform-aws-rds-cluster) - Terraform module to provision an RDS Aurora cluster for MySQL or Postgres
351326
- [terraform-aws-rds-cloudwatch-sns-alarms](https://github.com/cloudposse/terraform-aws-rds-cloudwatch-sns-alarms) - Terraform module that configures important RDS alerts using CloudWatch and sends them to an SNS topic
352327

353-
## Help
354-
355-
**Got a question?** We got answers.
356-
357-
File a GitHub [issue](https://github.com/cloudposse/terraform-aws-rds/issues), send us an [email][email] or join our [Slack Community][slack].
358-
359-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
360-
361-
## DevOps Accelerator for Startups
362-
363-
364-
We are a [**DevOps Accelerator**][commercial_support]. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.
365-
366-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
367-
368-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
369-
370-
We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.
371-
372-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
373-
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
374-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
375-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
376-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
377-
- **Training.** You'll receive hands-on training so your team can operate what we build.
378-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
379-
- **Troubleshooting.** You'll get help to triage when things aren't working.
380-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
381-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
382-
383-
## Slack Community
384-
385-
Join our [Open Source Community][slack] on Slack. It's **FREE** for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally *sweet* infrastructure.
386-
387-
## Newsletter
388-
389-
Sign up for [our newsletter][newsletter] that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
390-
391-
## Office Hours
392-
393-
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
394-
395-
[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]
396-
397328
## ✨ Contributing
398329

399-
400-
401330
This project is under active development, and we encourage contributions from our community.
402331
Many thanks to our outstanding contributors:
403332

404333
<a href="https://github.com/cloudposse/terraform-aws-rds/graphs/contributors">
405334
<img src="https://contrib.rocks/image?repo=cloudposse/terraform-aws-rds&max=24" />
406335
</a>
407336

408-
409-
410-
### Bug Reports & Feature Requests
337+
### 🐛 Bug Reports & Feature Requests
411338

412339
Please use the [issue tracker](https://github.com/cloudposse/terraform-aws-rds/issues) to report any bugs or file feature requests.
413340

414-
### Developing
341+
### 💻 Developing
415342

416343
If you are interested in being a contributor and want to get involved in developing this project or [help out](https://cpco.io/help-out) with our other projects, we would love to hear from you! Shoot us an [email][email].
417344

@@ -425,13 +352,43 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
425352

426353
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
427354

355+
### 🌎 Slack Community
428356

429-
## Copyright
357+
Join our [Open Source Community][slack] on Slack. It's **FREE** for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally *sweet* infrastructure.
430358

431-
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
359+
### 📰 Newsletter
360+
361+
Sign up for [our newsletter][newsletter] that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
362+
363+
### 📆 Office Hours <img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" />
364+
365+
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
366+
367+
## About
432368

369+
This project is maintained and funded by [Cloud Posse, LLC][website].
370+
<a href="https://cpco.io/homepage"><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
433371

372+
We are a [**DevOps Accelerator**][commercial_support]. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.
373+
374+
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
375+
376+
Work directly with our team of DevOps experts via email, slack, and video conferencing.
377+
378+
We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.
434379

380+
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
381+
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
382+
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
383+
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
384+
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
385+
- **Training.** You'll receive hands-on training so your team can operate what we build.
386+
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
387+
- **Troubleshooting.** You'll get help to triage when things aren't working.
388+
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
389+
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
390+
391+
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
435392
## License
436393

437394
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
@@ -457,29 +414,12 @@ specific language governing permissions and limitations
457414
under the License.
458415
```
459416

460-
461-
462-
463-
464-
465-
466-
467-
468417
## Trademarks
469418

470419
All other trademarks referenced herein are the property of their respective owners.
471-
472-
## About
473-
474-
This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know by [leaving a testimonial][testimonial]!
475-
476-
[![Cloud Posse][logo]][website]
477-
478-
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️ [Open Source Software][we_love_open_source].
479-
480-
We offer [paid support][commercial_support] on all of our projects.
481-
482-
Check out [our other projects][github], [follow us on twitter][twitter], [apply for a job][jobs], or [hire us][hire] to help with your cloud strategy and implementation.[![README Footer][readme_footer_img]][readme_footer_link]
420+
---
421+
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
422+
[![README Footer][readme_footer_img]][readme_footer_link]
483423
[![Beacon][beacon]][website]
484424
<!-- markdownlint-disable -->
485425
[logo]: https://cloudposse.com/logo-300x69.svg
@@ -490,7 +430,6 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
490430
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds&utm_content=hire
491431
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds&utm_content=slack
492432
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds&utm_content=twitter
493-
[testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds&utm_content=testimonial
494433
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds&utm_content=office_hours
495434
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds&utm_content=newsletter
496435
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds&utm_content=email

0 commit comments

Comments
 (0)