Skip to content

Commit efd700d

Browse files
authored
Use atmos instead of makefile (#281)
1 parent 0214ead commit efd700d

4 files changed

Lines changed: 79 additions & 158 deletions

File tree

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,5 @@ Session.vim
4444
build-harness
4545

4646
**/*/*.lock
47+
48+
.atmos

Makefile

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,9 @@ index:
1111

1212
all: build index
1313
@exit 0
14+
15+
readme:
16+
@atmos readme
17+
18+
readme/build:
19+
@atmos readme

README.md

Lines changed: 69 additions & 158 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
1+
2+
13
<!-- markdownlint-disable -->
2-
# charts [![Build Status](https://travis-ci.org/cloudposse/charts.svg?branch=master)](https://travis-ci.org/cloudposse/charts-cloudtrail) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
3-
<!-- markdownlint-restore -->
4+
# charts <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/charts&utm_content="><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
5+
46

5-
[![README Header][readme_header_img]][readme_header_link]
7+
<a href="https://travis-ci.org/cloudposse/charts-cloudtrail"><img src="https://travis-ci.org/cloudposse/charts.svg?branch=master" alt="Build Status"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/badge.svg" alt="Slack Community"/></a>
68

7-
[![Cloud Posse][logo]](https://cpco.io/homepage)
9+
10+
<!-- markdownlint-restore -->
811

912
<!--
1013
@@ -13,7 +16,7 @@
1316
1417
** DO NOT EDIT THIS FILE
1518
**
16-
** This file was automatically generated by the `build-harness`.
19+
** This file was automatically generated by the `cloudposse/build-harness`.
1720
** 1) Make all changes to `README.yaml`
1821
** 2) Run `make init` (you only need to do this once)
1922
** 3) Run`make readme` to rebuild this file.
@@ -34,28 +37,6 @@ Geodesic is the fastest way to get up and running with a rock solid, production
3437
What makes this distribution special is we've developed these charts to integrate with third party services like Github for authentication (OAuth2) and Duo for MFA.
3538

3639

37-
---
38-
39-
This project is part of our comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
40-
[<img align="right" title="Share via Email" src="https://docs.cloudposse.com/images/ionicons/ios-email-outline-2.0.1-16x16-999999.svg"/>][share_email]
41-
[<img align="right" title="Share on Google+" src="https://docs.cloudposse.com/images/ionicons/social-googleplus-outline-2.0.1-16x16-999999.svg" />][share_googleplus]
42-
[<img align="right" title="Share on Facebook" src="https://docs.cloudposse.com/images/ionicons/social-facebook-outline-2.0.1-16x16-999999.svg" />][share_facebook]
43-
[<img align="right" title="Share on Reddit" src="https://docs.cloudposse.com/images/ionicons/social-reddit-outline-2.0.1-16x16-999999.svg" />][share_reddit]
44-
[<img align="right" title="Share on LinkedIn" src="https://docs.cloudposse.com/images/ionicons/social-linkedin-outline-2.0.1-16x16-999999.svg" />][share_linkedin]
45-
[<img align="right" title="Share on Twitter" src="https://docs.cloudposse.com/images/ionicons/social-twitter-outline-2.0.1-16x16-999999.svg" />][share_twitter]
46-
47-
48-
49-
50-
It's 100% Open Source and licensed under the [APACHE2](LICENSE).
51-
52-
53-
54-
55-
56-
57-
58-
5940

6041

6142

@@ -73,6 +54,9 @@ Currently, most of the charts are located in the `incubator/` directory until th
7354

7455

7556

57+
58+
59+
7660
### Incubator Repository
7761

7862
To add the `incubator` chart repository to your local `helm` client, run `helm repo add`:
@@ -113,14 +97,6 @@ Currently, most of the charts are located in the `incubator/` directory until th
11397
This project is under active development. We try our best to keep all of our repositories stable (even our incubator charts), but you might run into [issues](https://github.com/cloudposse/charts/issues). Please let us know if you run into any issue, or better yet, contribute a fix or feature.
11498

11599

116-
117-
## Share the Love
118-
119-
Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/charts)! (it helps us **a lot**)
120-
121-
Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =)
122-
123-
124100
## Related Projects
125101

126102
Check out these related projects.
@@ -131,86 +107,85 @@ Check out these related projects.
131107

132108

133109

134-
## Help
135-
136-
**Got a question?** We got answers.
137-
138-
File a GitHub [issue](https://github.com/cloudposse/charts/issues), send us an [email][email] or join our [Slack Community][slack].
139-
140-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
141-
142-
## DevOps Accelerator for Startups
110+
## ✨ Contributing
143111

112+
This project is under active development, and we encourage contributions from our community.
144113

145-
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.
146114

147-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
148115

149-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
116+
Many thanks to our outstanding contributors:
150117

151-
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.
118+
<a href="https://github.com/cloudposse/charts/graphs/contributors">
119+
<img src="https://contrib.rocks/image?repo=cloudposse/charts&max=24" />
120+
</a>
152121

153-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
154-
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
155-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
156-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
157-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
158-
- **Training.** You'll receive hands-on training so your team can operate what we build.
159-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
160-
- **Troubleshooting.** You'll get help to triage when things aren't working.
161-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
162-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
122+
For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/charts/issues).
163123

164-
## Slack Community
165-
166-
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.
167-
168-
## Discourse Forums
169-
170-
Participate in our [Discourse Forums][discourse]. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.
171-
172-
## Newsletter
173-
174-
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.
175-
176-
## Office Hours
124+
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
125+
1. Review our [Code of Conduct](https://github.com/cloudposse/charts/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md).
126+
2. **Fork** the repo on GitHub
127+
3. **Clone** the project to your own machine
128+
4. **Commit** changes to your own branch
129+
5. **Push** your work back up to your fork
130+
6. Submit a **Pull Request** so that we can review your changes
177131

178-
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
132+
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
179133

180-
[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]
181134

182-
## Contributing
135+
## Running Terraform Tests
183136

184-
### Bug Reports & Feature Requests
137+
We use [Atmos](https://atmos.tools) to streamline how Terraform tests are run. It centralizes configuration and wraps common test workflows with easy-to-use commands.
185138

186-
Please use the [issue tracker](https://github.com/cloudposse/charts/issues) to report any bugs or file feature requests.
139+
All tests are located in the [`test/`](test) folder.
187140

188-
### Developing
141+
Under the hood, tests are powered by Terratest together with our internal [Test Helpers](https://github.com/cloudposse/test-helpers) library, providing robust infrastructure validation.
189142

190-
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].
143+
Setup dependencies:
144+
- Install Atmos ([installation guide](https://atmos.tools/install/))
145+
- Install Go [1.24+ or newer](https://go.dev/doc/install)
146+
- Install Terraform or OpenTofu
191147

192-
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
148+
To run tests:
193149

194-
1. **Fork** the repo on GitHub
195-
2. **Clone** the project to your own machine
196-
3. **Commit** changes to your own branch
197-
4. **Push** your work back up to your fork
198-
5. Submit a **Pull Request** so that we can review your changes
150+
- Run all tests:
151+
```sh
152+
atmos test run
153+
```
154+
- Clean up test artifacts:
155+
```sh
156+
atmos test clean
157+
```
158+
- Explore additional test options:
159+
```sh
160+
atmos test --help
161+
```
162+
The configuration for test commands is centrally managed. To review what's being imported, see the [`atmos.yaml`](https://raw.githubusercontent.com/cloudposse/.github/refs/heads/main/.github/atmos/terraform-module.yaml) file.
199163

200-
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
164+
Learn more about our [automated testing in our documentation](https://docs.cloudposse.com/community/contribute/automated-testing/) or implementing [custom commands](https://atmos.tools/core-concepts/custom-commands/) with atmos.
201165

166+
### 🌎 Slack Community
202167

203-
## Copyright
168+
Join our [Open Source Community](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/charts&utm_content=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.
204169

205-
Copyright © 2017-2020 [Cloud Posse, LLC](https://cpco.io/copyright)
170+
### 📰 Newsletter
206171

172+
Sign up for [our newsletter](https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/charts&utm_content=newsletter) and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know.
173+
Dropped straight into your Inbox every week — and usually a 5-minute read.
207174

175+
### 📆 Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/charts&utm_content=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" /></a>
208176

177+
[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/charts&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.
178+
It's **FREE** for everyone!
209179
## License
210180

211-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
181+
<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>
182+
183+
<details>
184+
<summary>Preamble to the Apache License, Version 2.0</summary>
185+
<br/>
186+
<br/>
212187

213-
See [LICENSE](LICENSE) for full details.
188+
Complete license is available in the [`LICENSE`](LICENSE) file.
214189

215190
```text
216191
Licensed to the Apache Software Foundation (ASF) under one
@@ -230,81 +205,17 @@ KIND, either express or implied. See the License for the
230205
specific language governing permissions and limitations
231206
under the License.
232207
```
233-
234-
235-
236-
237-
238-
239-
240-
208+
</details>
241209

242210
## Trademarks
243211

244212
All other trademarks referenced herein are the property of their respective owners.
245213

246-
## About
247-
248-
This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know by [leaving a testimonial][testimonial]!
249-
250-
[![Cloud Posse][logo]][website]
251-
252-
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️ [Open Source Software][we_love_open_source].
253-
254-
We offer [paid support][commercial_support] on all of our projects.
255-
256-
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.
257-
258214

215+
---
216+
Copyright © 2017-2025 [Cloud Posse, LLC](https://cpco.io/copyright)
259217

260-
### Contributors
261218

262-
<!-- markdownlint-disable -->
263-
| [![Erik Osterman][osterman_avatar]][osterman_homepage]<br/>[Erik Osterman][osterman_homepage] | [![Igor Rodionov][goruha_avatar]][goruha_homepage]<br/>[Igor Rodionov][goruha_homepage] | [![Michal Matyjek][mkj28_avatar]][mkj28_homepage]<br/>[Michal Matyjek][mkj28_homepage] | [![Alexander Babai][alebabai_avatar]][alebabai_homepage]<br/>[Alexander Babai][alebabai_homepage] | [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]<br/>[Andriy Knysh][aknysh_homepage] |
264-
|---|---|---|---|---|
265-
<!-- markdownlint-restore -->
219+
<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/charts&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>
266220

267-
[osterman_homepage]: https://github.com/osterman
268-
[osterman_avatar]: https://img.cloudposse.com/150x150/https://github.com/osterman.png
269-
[goruha_homepage]: https://github.com/goruha
270-
[goruha_avatar]: https://img.cloudposse.com/150x150/https://github.com/goruha.png
271-
[mkj28_homepage]: https://github.com/mkj28
272-
[mkj28_avatar]: https://img.cloudposse.com/150x150/https://github.com/mkj28.png
273-
[alebabai_homepage]: https://github.com/alebabai
274-
[alebabai_avatar]: https://img.cloudposse.com/150x150/https://github.com/alebabai.png
275-
[aknysh_homepage]: https://github.com/aknysh
276-
[aknysh_avatar]: https://img.cloudposse.com/150x150/https://github.com/aknysh.png
277-
278-
[![README Footer][readme_footer_img]][readme_footer_link]
279-
[![Beacon][beacon]][website]
280-
281-
[logo]: https://cloudposse.com/logo-300x69.svg
282-
[docs]: https://cpco.io/docs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/charts&utm_content=docs
283-
[website]: https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/charts&utm_content=website
284-
[github]: https://cpco.io/github?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/charts&utm_content=github
285-
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/charts&utm_content=jobs
286-
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/charts&utm_content=hire
287-
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/charts&utm_content=slack
288-
[linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/charts&utm_content=linkedin
289-
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/charts&utm_content=twitter
290-
[testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/charts&utm_content=testimonial
291-
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/charts&utm_content=office_hours
292-
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/charts&utm_content=newsletter
293-
[discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/charts&utm_content=discourse
294-
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/charts&utm_content=email
295-
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/charts&utm_content=commercial_support
296-
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/charts&utm_content=we_love_open_source
297-
[terraform_modules]: https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/charts&utm_content=terraform_modules
298-
[readme_header_img]: https://cloudposse.com/readme/header/img
299-
[readme_header_link]: https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/charts&utm_content=readme_header_link
300-
[readme_footer_img]: https://cloudposse.com/readme/footer/img
301-
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/charts&utm_content=readme_footer_link
302-
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
303-
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/charts&utm_content=readme_commercial_support_link
304-
[share_twitter]: https://twitter.com/intent/tweet/?text=charts&url=https://github.com/cloudposse/charts
305-
[share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=charts&url=https://github.com/cloudposse/charts
306-
[share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/charts
307-
[share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/charts
308-
[share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/charts
309-
[share_email]: mailto:?subject=charts&body=https://github.com/cloudposse/charts
310-
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/charts?pixel&cs=github&cm=readme&an=charts
221+
<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/charts?pixel&cs=github&cm=readme&an=charts"/>

atmos.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
import:
2+
- https://raw.githubusercontent.com/cloudposse/.github/refs/heads/main/.github/atmos/github-action.yaml

0 commit comments

Comments
 (0)