Skip to content

Commit b8b7fb5

Browse files
Update README.md and docs (#150)
1 parent 9058aa1 commit b8b7fb5

File tree

1 file changed

+55
-126
lines changed

1 file changed

+55
-126
lines changed

README.md

Lines changed: 55 additions & 126 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11

22
<!-- markdownlint-disable -->
3-
# terraform-aws-tfstate-backend [![Latest Release](https://img.shields.io/github/release/cloudposse/terraform-aws-tfstate-backend.svg)](https://github.com/cloudposse/terraform-aws-tfstate-backend/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
3+
# terraform-aws-tfstate-backend<a href="https://cpco.io/homepage"><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a> [![Latest Release](https://img.shields.io/github/release/cloudposse/terraform-aws-tfstate-backend.svg)](https://github.com/cloudposse/terraform-aws-tfstate-backend/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
44
<!-- markdownlint-restore -->
55

6-
[![README Header][readme_header_img]][readme_header_link]
7-
8-
[![Cloud Posse][logo]](https://cpco.io/homepage)
96

107
<!--
118
@@ -45,57 +42,32 @@ __NOTE:__ The operators of the module (IAM Users) must have permissions to creat
4542

4643
__NOTE:__ This module cannot be used to apply changes to the `mfa_delete` feature of the bucket. Changes regarding mfa_delete can only be made manually using the root credentials with MFA of the AWS Account where the bucket resides. Please see: https://github.com/terraform-providers/terraform-provider-aws/issues/62
4744

48-
---
49-
50-
This project is part of our comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
51-
52-
53-
[![Terraform Open Source Modules](https://docs.cloudposse.com/images/terraform-open-source-modules.svg)][terraform_modules]
54-
55-
56-
57-
It's 100% Open Source and licensed under the [APACHE2](LICENSE).
58-
59-
60-
61-
62-
63-
64-
65-
We literally have [*hundreds of terraform modules*][terraform_modules] that are Open Source and well-maintained. Check them out!
66-
67-
68-
6945

46+
---
47+
> [!NOTE]
48+
> This project is part of Cloud Posse's comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
49+
> <a href="https://cpco.io/terraform-modules"><img src="https://docs.cloudposse.com/images/terraform-open-source-modules.svg" align="right" /></a>
50+
>
51+
> It's 100% Open Source and licensed under the [APACHE2](LICENSE).
52+
>
53+
> We literally have [*hundreds of terraform modules*][terraform_modules] that are Open Source and well-maintained. Check them out!
7054
55+
[![README Header][readme_header_img]][readme_header_link]
7156

72-
## Security & Compliance [<img src="https://cloudposse.com/wp-content/uploads/2020/11/bridgecrew.svg" width="250" align="right" />](https://bridgecrew.io/)
7357

74-
Security scanning is graciously provided by Bridgecrew. Bridgecrew is the leading fully hosted, cloud-native solution providing continuous Terraform security and compliance.
7558

76-
| Benchmark | Description |
77-
|--------|---------------|
78-
| [![Infrastructure Security](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-tfstate-backend/general)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-tfstate-backend&benchmark=INFRASTRUCTURE+SECURITY) | Infrastructure Security Compliance |
79-
| [![CIS KUBERNETES](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-tfstate-backend/cis_kubernetes)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-tfstate-backend&benchmark=CIS+KUBERNETES+V1.5) | Center for Internet Security, KUBERNETES Compliance |
80-
| [![CIS AWS](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-tfstate-backend/cis_aws)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-tfstate-backend&benchmark=CIS+AWS+V1.2) | Center for Internet Security, AWS Compliance |
81-
| [![CIS AZURE](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-tfstate-backend/cis_azure)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-tfstate-backend&benchmark=CIS+AZURE+V1.1) | Center for Internet Security, AZURE Compliance |
82-
| [![PCI-DSS](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-tfstate-backend/pci)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-tfstate-backend&benchmark=PCI-DSS+V3.2) | Payment Card Industry Data Security Standards Compliance |
83-
| [![NIST-800-53](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-tfstate-backend/nist)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-tfstate-backend&benchmark=NIST-800-53) | National Institute of Standards and Technology Compliance |
84-
| [![ISO27001](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-tfstate-backend/iso)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-tfstate-backend&benchmark=ISO27001) | Information Security Management System, ISO/IEC 27001 Compliance |
85-
| [![SOC2](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-tfstate-backend/soc2)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-tfstate-backend&benchmark=SOC2)| Service Organization Control 2 Compliance |
86-
| [![CIS GCP](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-tfstate-backend/cis_gcp)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-tfstate-backend&benchmark=CIS+GCP+V1.1) | Center for Internet Security, GCP Compliance |
87-
| [![HIPAA](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-tfstate-backend/hipaa)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-tfstate-backend&benchmark=HIPAA) | Health Insurance Portability and Accountability Compliance |
8859

60+
## Usage
8961

9062

91-
## Usage
9263

64+
> **Important**
65+
> We do not pin modules to versions in Cloud Posse's examples because of the
66+
> difficulty of keeping the versions in the documentation in sync with the latest released versions.
67+
> We highly recommend that in your code you pin the version to the exact version you are
68+
> using so that your infrastructure remains stable, and update versions in a
69+
> systematic way so that they do not catch you by surprise.
9370
94-
**IMPORTANT:** We do not pin modules to versions in our examples because of the
95-
difficulty of keeping the versions in the documentation in sync with the latest released versions.
96-
We highly recommend that in your code you pin the version to the exact version you are
97-
using so that your infrastructure remains stable, and update versions in a
98-
systematic way so that they do not catch you by surprise.
9971

10072

10173

@@ -354,84 +326,29 @@ Available targets:
354326
<!-- markdownlint-restore -->
355327

356328

357-
358-
## Share the Love
359-
360-
Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/terraform-aws-tfstate-backend)! (it helps us **a lot**)
361-
362-
363-
364329
## Related Projects
365330

366331
Check out these related projects.
367332

368333
- [terraform-aws-dynamodb](https://github.com/cloudposse/terraform-aws-dynamodb) - Terraform module that implements AWS DynamoDB with support for AutoScaling
369334
- [terraform-aws-dynamodb-autoscaler](https://github.com/cloudposse/terraform-aws-dynamodb-autoscaler) - Terraform module to provision DynamoDB autoscaler
370335

371-
## Help
372-
373-
**Got a question?** We got answers.
374-
375-
File a GitHub [issue](https://github.com/cloudposse/terraform-aws-tfstate-backend/issues), send us an [email][email] or join our [Slack Community][slack].
376-
377-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
378-
379-
## DevOps Accelerator for Startups
380-
381-
382-
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.
383-
384-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
385-
386-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
387-
388-
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.
389-
390-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
391-
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
392-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
393-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
394-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
395-
- **Training.** You'll receive hands-on training so your team can operate what we build.
396-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
397-
- **Troubleshooting.** You'll get help to triage when things aren't working.
398-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
399-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
400-
401-
## Slack Community
402-
403-
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.
404-
405-
## Newsletter
406-
407-
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.
408-
409-
## Office Hours
410-
411-
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
412-
413-
[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]
414-
415336
## ✨ Contributing
416337

417-
418-
419338
This project is under active development, and we encourage contributions from our community.
420339
Many thanks to our outstanding contributors:
421340

422341
<a href="https://github.com/cloudposse/terraform-aws-tfstate-backend/graphs/contributors">
423342
<img src="https://contrib.rocks/image?repo=cloudposse/terraform-aws-tfstate-backend&max=24" />
424343
</a>
425344

426-
427-
428-
### Bug Reports & Feature Requests
345+
### 🐛 Bug Reports & Feature Requests
429346

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

432-
### Developing
349+
### 💻 Developing
433350

434-
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].
351+
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 Cloud Posse's other projects, we would love to hear from you! Shoot us an [email][email].
435352

436353
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
437354

@@ -443,13 +360,43 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
443360

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

363+
### 🌎 Slack Community
446364

447-
## Copyright
365+
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.
448366

449-
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
367+
### 📰 Newsletter
368+
369+
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.
370+
371+
### 📆 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" />
372+
373+
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
374+
375+
## About
376+
377+
This project is maintained and funded by [Cloud Posse, LLC][website].
378+
<a href="https://cpco.io/homepage"><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
379+
380+
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.
381+
382+
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
383+
384+
Work directly with our team of DevOps experts via email, slack, and video conferencing.
450385

386+
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.
451387

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

399+
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
453400
## License
454401

455402
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
@@ -475,29 +422,12 @@ specific language governing permissions and limitations
475422
under the License.
476423
```
477424

478-
479-
480-
481-
482-
483-
484-
485-
486425
## Trademarks
487426

488427
All other trademarks referenced herein are the property of their respective owners.
489-
490-
## About
491-
492-
This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know by [leaving a testimonial][testimonial]!
493-
494-
[![Cloud Posse][logo]][website]
495-
496-
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️ [Open Source Software][we_love_open_source].
497-
498-
We offer [paid support][commercial_support] on all of our projects.
499-
500-
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]
428+
---
429+
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
430+
[![README Footer][readme_footer_img]][readme_footer_link]
501431
[![Beacon][beacon]][website]
502432
<!-- markdownlint-disable -->
503433
[logo]: https://cloudposse.com/logo-300x69.svg
@@ -508,7 +438,6 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
508438
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-tfstate-backend&utm_content=hire
509439
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-tfstate-backend&utm_content=slack
510440
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-tfstate-backend&utm_content=twitter
511-
[testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-tfstate-backend&utm_content=testimonial
512441
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-tfstate-backend&utm_content=office_hours
513442
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-tfstate-backend&utm_content=newsletter
514443
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-tfstate-backend&utm_content=email

0 commit comments

Comments
 (0)