Skip to content

Commit af4edcd

Browse files
committed
chore: update README.md
1 parent eed0992 commit af4edcd

File tree

1 file changed

+70
-52
lines changed

1 file changed

+70
-52
lines changed

README.md

Lines changed: 70 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1+
2+
13
<!-- markdownlint-disable -->
2-
<a href="https://cpco.io/homepage"><img src=".github/banner.png?raw=true" alt="Project Banner"/></a><br/>
4+
<a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse/terraform-aws-components/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a><br/>
35
<p align="right">
46
<a href="https://github.com/cloudposse/terraform-aws-components/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-components.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-components/commits/main/"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-components/main?style=for-the-badge" alt="Last Update"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a></p>
57
<!-- markdownlint-restore -->
@@ -29,16 +31,16 @@ This is a collection of reusable [AWS Terraform components](https://atmos.tools/
2931
They work really well with [Atmos](https://atmos.tools), our open-source tool for managing infrastructure as code with Terraform.
3032

3133

32-
---
33-
> [!NOTE]
34-
> This project is part of Cloud Posse's comprehensive ["SweetOps"](https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-components&utm_content=) approach towards DevOps.
35-
> <details><summary><strong>Learn More</strong></summary>
36-
>
37-
> It's 100% Open Source and licensed under the [APACHE2](LICENSE).
34+
> [!TIP]
35+
> #### 👽 Use Atmos with Terraform
36+
> Cloud Posse uses [`atmos`](https://atmos.tools) to easily orchestrate multiple environments using Terraform. <br/>
37+
> Works with [Github Actions](https://atmos.tools/integrations/github-actions/), [Atlantis](https://atmos.tools/integrations/atlantis), or [Spacelift](https://atmos.tools/integrations/spacelift).
3838
>
39-
> </details>
40-
41-
<a href="https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-components&utm_content=readme_header_link"><img src="https://cloudposse.com/readme/header/img"/></a>
39+
> <details>
40+
> <summary><strong>Watch demo of using Atmos with Terraform</strong></summary>
41+
> <img src="https://github.com/cloudposse/atmos/blob/master/docs/demo.gif?raw=true"/><br/>
42+
> <i>Example of running <a href="https://atmos.tools"><code>atmos</code></a> to manage infrastructure from our <a href="https://atmos.tools/quick-start/">Quick Start</a> tutorial.</i>
43+
> </detalis>
4244
4345

4446
## Introduction
@@ -59,9 +61,8 @@ with Terraform that can be used with [Atmos](https://atmos.tools).
5961

6062

6163

62-
## Usage
63-
6464

65+
## Usage
6566

6667

6768
Please take a look at each [component's README](https://docs.cloudposse.com/components/) for specific usage.
@@ -153,6 +154,14 @@ make rebuild-docs
153154
>
154155
> We intend to eventually delete, but are leaving them for now in the repo.
155156

157+
> [!IMPORTANT]
158+
> In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation
159+
> and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version
160+
> you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic
161+
> approach for updating versions to avoid unexpected changes.
162+
163+
164+
156165

157166

158167

@@ -190,23 +199,60 @@ For additional context, refer to some of these links.
190199
- [Reference Architectures](https://cloudposse.com/) - Launch effortlessly with our turnkey reference architectures, built either by your team or ours.
191200

192201

202+
203+
> [!TIP]
204+
> #### Use Terraform Reference Architectures for AWS
205+
>
206+
> Use Cloud Posse's ready-to-go [terraform architecture blueprints](https://cloudposse.com/reference-architecture/) for AWS to get up and running quickly.
207+
>
208+
> ✅ We build it together with your team.<br/>
209+
> ✅ Your team owns everything.<br/>
210+
> ✅ 100% Open Source and backed by fanatical support.<br/>
211+
>
212+
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-components&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
213+
> <details><summary>📚 <strong>Learn More</strong></summary>
214+
>
215+
> <br/>
216+
>
217+
> Cloud Posse is the leading [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-components&utm_content=commercial_support) for funded startups and enterprises.
218+
>
219+
> *Your team can operate like a pro today.*
220+
>
221+
> Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.
222+
> #### Day-0: Your Foundation for Success
223+
> - **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
224+
> - **Deployment Strategy.** Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
225+
> - **Site Reliability Engineering.** Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
226+
> - **Security Baseline.** Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
227+
> - **GitOps.** Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.
228+
>
229+
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-components&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
230+
>
231+
> #### Day-2: Your Operational Mastery
232+
> - **Training.** Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
233+
> - **Support.** Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
234+
> - **Troubleshooting.** Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
235+
> - **Code Reviews.** Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
236+
> - **Bug Fixes.** Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
237+
> - **Migration Assistance.** Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
238+
> - **Customer Workshops.** Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.
239+
>
240+
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-components&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
241+
> </details>
242+
193243
## ✨ Contributing
194244

195245
This project is under active development, and we encourage contributions from our community.
246+
247+
248+
196249
Many thanks to our outstanding contributors:
197250

198251
<a href="https://github.com/cloudposse/terraform-aws-components/graphs/contributors">
199252
<img src="https://contrib.rocks/image?repo=cloudposse/terraform-aws-components&max=24" />
200253
</a>
201254

202-
### 🐛 Bug Reports & Feature Requests
203-
204-
Please use the [issue tracker](https://github.com/cloudposse/terraform-aws-components/issues) to report any bugs or file feature requests.
205-
206-
### 💻 Developing
207-
208-
If you are interested in being a contributor and want to get involved in developing this project or help out with Cloud Posse's other projects, we would love to hear from you!
209-
Hit us up in [Slack](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-components&utm_content=slack), in the `#cloudposse` channel.
255+
For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/terraform-aws-components/issues).
210256

211257
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
212258
1. Review our [Code of Conduct](https://github.com/cloudposse/terraform-aws-components/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md).
@@ -231,38 +277,6 @@ Dropped straight into your Inbox every week — and usually a 5-minute read.
231277

232278
[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-components&utm_content=office_hours) for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a _live Q&A_ that you can’t find anywhere else.
233279
It's **FREE** for everyone!
234-
235-
## About
236-
237-
This project is maintained by <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-components&utm_content=">Cloud Posse, LLC</a>.
238-
<a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-components&utm_content="><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
239-
240-
We are a [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-components&utm_content=commercial_support) for funded startups and enterprises.
241-
Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly.
242-
We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.
243-
244-
<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-components&utm_content=commercial_support"><img alt="Learn More" src="https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge"/></a>
245-
246-
*Your team can operate like a pro today.*
247-
248-
Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.
249-
250-
<details>
251-
<summary>📚 <strong>See What's Included</strong></summary>
252-
253-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
254-
- **Deployment Strategy.** You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
255-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
256-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
257-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
258-
- **Training.** You'll receive hands-on training so your team can operate what we build.
259-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
260-
- **Troubleshooting.** You'll get help to triage when things aren't working.
261-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
262-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
263-
</details>
264-
265-
<a href="https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-components&utm_content=readme_commercial_support_link"><img src="https://cloudposse.com/readme/commercial-support/img"/></a>
266280
## License
267281

268282
<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge" alt="License"></a>
@@ -271,7 +285,9 @@ Ensure that your team succeeds by using our proven process and turnkey blueprint
271285
<summary>Preamble to the Apache License, Version 2.0</summary>
272286
<br/>
273287
<br/>
288+
274289
Complete license is available in the [`LICENSE`](LICENSE) file.
290+
275291
```text
276292
Licensed to the Apache Software Foundation (ASF) under one
277293
or more contributor license agreements. See the NOTICE file
@@ -295,6 +311,8 @@ under the License.
295311
## Trademarks
296312

297313
All other trademarks referenced herein are the property of their respective owners.
314+
315+
298316
---
299317
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
300318

0 commit comments

Comments
 (0)