Skip to content

Commit 1764879

Browse files
authored
chore: Update Scaffolding (#186)
1 parent 9010cc0 commit 1764879

File tree

3 files changed

+108
-202
lines changed

3 files changed

+108
-202
lines changed

.github/mergify.yml

Lines changed: 1 addition & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1 @@
1-
# https://docs.mergify.io/conditions.html
2-
# https://docs.mergify.io/actions.html
3-
pull_request_rules:
4-
- name: "approve automated PRs that have passed checks"
5-
conditions:
6-
- "author~=^(cloudpossebot|renovate\\[bot\\])$"
7-
- "-closed"
8-
- "head~=^(auto-update|renovate)/.*"
9-
- "check-success=test/bats"
10-
- "check-success=test/readme"
11-
- "check-success=test/terratest"
12-
- "check-success=validate-codeowners"
13-
- or:
14-
- "base=master"
15-
- "base=main"
16-
- "base~=^release/v\\d{1,2}$"
17-
18-
actions:
19-
review:
20-
type: "APPROVE"
21-
bot_account: "cloudposse-mergebot"
22-
message: "We've automatically approved this PR because the checks from the automated Pull Request have passed."
23-
24-
- name: "merge automated PRs when approved and tests pass"
25-
conditions:
26-
- "author~=^(cloudpossebot|renovate\\[bot\\])$"
27-
- "-closed"
28-
- "head~=^(auto-update|renovate)/.*"
29-
- "check-success=test/bats"
30-
- "check-success=test/readme"
31-
- "check-success=test/terratest"
32-
- "check-success=validate-codeowners"
33-
- "#approved-reviews-by>=1"
34-
- "#changes-requested-reviews-by=0"
35-
- "#commented-reviews-by=0"
36-
- or:
37-
- "base=master"
38-
- "base=main"
39-
- "base~=^release/v\\d{1,2}$"
40-
41-
actions:
42-
merge:
43-
method: "squash"
44-
45-
- name: "delete the head branch after merge"
46-
conditions:
47-
- "merged"
48-
actions:
49-
delete_head_branch: {}
50-
51-
- name: "ask to resolve conflict"
52-
conditions:
53-
- "conflict"
54-
- "-closed"
55-
actions:
56-
comment:
57-
message: "This pull request is now in conflict. Could you fix it @{{author}}? 🙏"
58-
59-
- name: "remove outdated reviews"
60-
conditions:
61-
- or:
62-
- "base=master"
63-
- "base=main"
64-
- "base~=^release/v\\d{1,2}$"
65-
actions:
66-
dismiss_reviews:
67-
changes_requested: true
68-
approved: true
69-
message: "This Pull Request has been updated, so we're dismissing all reviews."
70-
71-
- name: "close Pull Requests without files changed"
72-
conditions:
73-
- "#files=0"
74-
actions:
75-
close:
76-
message: "This pull request has been automatically closed by Mergify because there are no longer any changes."
1+
extends: .github

README.md

Lines changed: 69 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
2+
13
<!-- markdownlint-disable -->
24
# terraform-aws-ec2-instance <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-instance&utm_content="><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
3-
<a href="https://github.com/cloudposse/terraform-aws-ec2-instance/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-ec2-instance.svg" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/badge.svg" alt="Slack Community"/></a>
5+
<a href="https://github.com/cloudposse/terraform-aws-ec2-instance/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-ec2-instance.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-ec2-instance/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-ec2-instance.svg?style=for-the-badge" alt="Last Updated"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a>
46
<!-- markdownlint-restore -->
57

68
<!--
@@ -33,41 +35,23 @@ Included features:
3335
* Assume Role capability
3436

3537

36-
---
37-
> [!NOTE]
38-
> 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-ec2-instance&utm_content=) approach towards DevOps.
39-
> <details><summary><strong>Learn More</strong></summary>
40-
> <a href="https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-instance&utm_content=terraform_modules">
41-
> <picture>
42-
> <source media="(prefers-color-scheme: dark)" srcset="https://docs.cloudposse.com/images/terraform-open-source-modules-light.svg">
43-
> <source media="(prefers-color-scheme: light)" srcset="https://docs.cloudposse.com/images/terraform-open-source-modules-dark.svg">
44-
> <img alt="Terraform Open Source Modules" src="https://docs.cloudposse.com/images/terraform-open-source-modules.svg" align="right">
45-
> </picture>
46-
> </a>
47-
>
38+
> [!TIP]
39+
> #### 👽 Use Atmos with Terraform
40+
> Cloud Posse uses [`atmos`](https://atmos.tools) to easily orchestrate multiple environments using Terraform. <br/>
41+
> Works with [Github Actions](https://atmos.tools/integrations/github-actions/), [Atlantis](https://atmos.tools/integrations/atlantis), or [Spacelift](https://atmos.tools/integrations/spacelift).
4842
>
49-
> It's 100% Open Source and licensed under the [APACHE2](LICENSE).
50-
>
51-
> We literally have [*hundreds of terraform modules*](https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-instance&utm_content=terraform_modules) that are Open Source and well-maintained. Check them out!
52-
> </details>
43+
> <details>
44+
> <summary><strong>Watch demo of using Atmos with Terraform</strong></summary>
45+
> <img src="https://github.com/cloudposse/atmos/blob/master/docs/demo.gif?raw=true"/><br/>
46+
> <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>
47+
> </detalis>
5348
54-
<a href="https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-instance&utm_content=readme_header_link"><img src="https://cloudposse.com/readme/header/img"/></a>
5549

5650

5751

5852

5953
## Usage
6054

61-
62-
63-
> [!IMPORTANT]
64-
> In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation
65-
> and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version
66-
> you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic
67-
> approach for updating versions to avoid unexpected changes.
68-
69-
70-
7155
Note: add `${var.ssh_key_pair}` private key to the `ssh agent`.
7256

7357
Include this repository as a module in your existing terraform code.
@@ -147,6 +131,14 @@ module "kafka_instance" {
147131
}
148132
```
149133

134+
> [!IMPORTANT]
135+
> In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation
136+
> and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version
137+
> you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic
138+
> approach for updating versions to avoid unexpected changes.
139+
140+
141+
150142

151143

152144

@@ -349,23 +341,60 @@ For additional context, refer to some of these links.
349341
- [terraform-aws-ec2-bastion-server](https://github.com/cloudposse/terraform-aws-ec2-bastion-server) - Terraform Module to define a generic Bastion host with parameterized user_data
350342

351343

344+
345+
> [!TIP]
346+
> #### Use Terraform Reference Architectures for AWS
347+
>
348+
> Use Cloud Posse's ready-to-go [terraform architecture blueprints](https://cloudposse.com/reference-architecture/) for AWS to get up and running quickly.
349+
>
350+
> ✅ We build it with you.<br/>
351+
> ✅ You own everything.<br/>
352+
> ✅ Your team wins.<br/>
353+
>
354+
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-instance&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
355+
> <details><summary>📚 <strong>Learn More</strong></summary>
356+
>
357+
> <br/>
358+
>
359+
> Cloud Posse is the leading [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-instance&utm_content=commercial_support) for funded startups and enterprises.
360+
>
361+
> *Your team can operate like a pro today.*
362+
>
363+
> Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.
364+
> #### Day-0: Your Foundation for Success
365+
> - **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
366+
> - **Deployment Strategy.** Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
367+
> - **Site Reliability Engineering.** Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
368+
> - **Security Baseline.** Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
369+
> - **GitOps.** Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.
370+
>
371+
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-instance&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
372+
>
373+
> #### Day-2: Your Operational Mastery
374+
> - **Training.** Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
375+
> - **Support.** Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
376+
> - **Troubleshooting.** Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
377+
> - **Code Reviews.** Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
378+
> - **Bug Fixes.** Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
379+
> - **Migration Assistance.** Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
380+
> - **Customer Workshops.** Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.
381+
>
382+
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-instance&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
383+
> </details>
384+
352385
## ✨ Contributing
353386

354387
This project is under active development, and we encourage contributions from our community.
388+
389+
390+
355391
Many thanks to our outstanding contributors:
356392

357393
<a href="https://github.com/cloudposse/terraform-aws-ec2-instance/graphs/contributors">
358394
<img src="https://contrib.rocks/image?repo=cloudposse/terraform-aws-ec2-instance&max=24" />
359395
</a>
360396

361-
### 🐛 Bug Reports & Feature Requests
362-
363-
Please use the [issue tracker](https://github.com/cloudposse/terraform-aws-ec2-instance/issues) to report any bugs or file feature requests.
364-
365-
### 💻 Developing
366-
367-
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!
368-
Hit us up in [Slack](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-instance&utm_content=slack), in the `#cloudposse` channel.
397+
For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/terraform-aws-ec2-instance/issues).
369398

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

391420
[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-instance&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.
392421
It's **FREE** for everyone!
393-
394-
## About
395-
396-
This project is maintained by <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-instance&utm_content=">Cloud Posse, LLC</a>.
397-
<a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-instance&utm_content="><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
398-
399-
We are a [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-instance&utm_content=commercial_support) for funded startups and enterprises.
400-
Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly.
401-
We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.
402-
403-
<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-instance&utm_content=commercial_support"><img alt="Learn More" src="https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge"/></a>
404-
405-
*Your team can operate like a pro today.*
406-
407-
Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.
408-
409-
<details>
410-
<summary>📚 <strong>See What's Included</strong></summary>
411-
412-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
413-
- **Deployment Strategy.** You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
414-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
415-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
416-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
417-
- **Training.** You'll receive hands-on training so your team can operate what we build.
418-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
419-
- **Troubleshooting.** You'll get help to triage when things aren't working.
420-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
421-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
422-
</details>
423-
424-
<a href="https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-instance&utm_content=readme_commercial_support_link"><img src="https://cloudposse.com/readme/commercial-support/img"/></a>
425422
## License
426423

427424
<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>
@@ -430,7 +427,9 @@ Ensure that your team succeeds by using our proven process and turnkey blueprint
430427
<summary>Preamble to the Apache License, Version 2.0</summary>
431428
<br/>
432429
<br/>
430+
433431
Complete license is available in the [`LICENSE`](LICENSE) file.
432+
434433
```text
435434
Licensed to the Apache Software Foundation (ASF) under one
436435
or more contributor license agreements. See the NOTICE file
@@ -454,6 +453,8 @@ under the License.
454453
## Trademarks
455454

456455
All other trademarks referenced herein are the property of their respective owners.
456+
457+
457458
---
458459
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
459460

README.yaml

Lines changed: 38 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,42 @@
11
name: terraform-aws-ec2-instance
22
tags:
3-
- aws
4-
- terraform
5-
- terraform-modules
6-
- platform
7-
- ec2
8-
- instance
9-
- security
10-
- ansible
3+
- aws
4+
- terraform
5+
- terraform-modules
6+
- platform
7+
- ec2
8+
- instance
9+
- security
10+
- ansible
1111
categories:
12-
- terraform-modules/platform
12+
- terraform-modules/platform
1313
license: APACHE2
1414
github_repo: cloudposse/terraform-aws-ec2-instance
1515
badges:
16-
- name: Latest Release
17-
image: https://img.shields.io/github/release/cloudposse/terraform-aws-ec2-instance.svg
18-
url: https://github.com/cloudposse/terraform-aws-ec2-instance/releases/latest
19-
- name: Slack Community
20-
image: https://slack.cloudposse.com/badge.svg
21-
url: https://slack.cloudposse.com
16+
- name: Latest Release
17+
image: https://img.shields.io/github/release/cloudposse/terraform-aws-ec2-instance.svg?style=for-the-badge
18+
url: https://github.com/cloudposse/terraform-aws-ec2-instance/releases/latest
19+
- name: Last Updated
20+
image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-ec2-instance.svg?style=for-the-badge
21+
url: https://github.com/cloudposse/terraform-aws-ec2-instance/commits
22+
- name: Slack Community
23+
image: https://slack.cloudposse.com/for-the-badge.svg
24+
url: https://slack.cloudposse.com
25+
26+
# List any related terraform modules that this module may be used with or that this module depends on.
2227
related:
23-
- name: terraform-aws-ec2-ami-backup
24-
description: Terraform module for automatic & scheduled AMI creation
25-
url: https://github.com/cloudposse/terraform-aws-ec2-ami-backup
26-
- name: terraform-aws-ec2-ami-snapshot
27-
description: Terraform module to easily generate AMI snapshots to create replica
28-
instances
29-
url: https://github.com/cloudposse/terraform-aws-ec2-ami-snapshot
30-
- name: terraform-aws-ec2-cloudwatch-sns-alarms
31-
description: Terraform module that configures CloudWatch SNS alerts for EC2 instances
32-
url: https://github.com/cloudposse/terraform-aws-ec2-cloudwatch-sns-alarms
33-
- name: terraform-null-label
34-
description: Terraform Module to define a consistent naming convention by (namespace,
35-
stage, name, [attributes])
36-
url: https://github.com/cloudposse/terraform-null-label
28+
- name: terraform-aws-ec2-ami-backup
29+
description: Terraform module for automatic & scheduled AMI creation
30+
url: https://github.com/cloudposse/terraform-aws-ec2-ami-backup
31+
- name: terraform-aws-ec2-ami-snapshot
32+
description: Terraform module to easily generate AMI snapshots to create replica instances
33+
url: https://github.com/cloudposse/terraform-aws-ec2-ami-snapshot
34+
- name: terraform-aws-ec2-cloudwatch-sns-alarms
35+
description: Terraform module that configures CloudWatch SNS alerts for EC2 instances
36+
url: https://github.com/cloudposse/terraform-aws-ec2-cloudwatch-sns-alarms
37+
- name: terraform-null-label
38+
description: Terraform Module to define a consistent naming convention by (namespace, stage, name, [attributes])
39+
url: https://github.com/cloudposse/terraform-null-label
3740
description: |-
3841
Terraform Module for provisioning a general purpose EC2 host.
3942
@@ -122,33 +125,10 @@ usage: |-
122125
}
123126
```
124127
references:
125-
- name: terraform-aws-ec2-bastion-server
126-
description: Terraform Module to define a generic Bastion host with parameterized
127-
user_data
128-
url: https://github.com/cloudposse/terraform-aws-ec2-bastion-server
128+
- name: terraform-aws-ec2-bastion-server
129+
description: Terraform Module to define a generic Bastion host with parameterized user_data
130+
url: https://github.com/cloudposse/terraform-aws-ec2-bastion-server
129131
include:
130-
- docs/targets.md
131-
- docs/terraform.md
132-
contributors:
133-
- name: Erik Osterman
134-
github: osterman
135-
- name: Igor Rodionov
136-
github: goruha
137-
- name: Andriy Knysh
138-
github: aknysh
139-
- name: Sergey Vasilyev
140-
github: s2504s
141-
- name: Valeriy
142-
github: drama17
143-
- name: Ivan Pinatti
144-
github: ivan-pinatti
145-
- name: Vladimir Syromyatnikov
146-
github: SweetOps
147-
- name: Konstantin B
148-
github: comeanother
149-
- name: Maarten van der Hoef
150-
github: maartenvanderhoef
151-
- name: Chris Weyl
152-
github: rsrchboy
153-
- name: Yonatan Koren
154-
github: korenyoni
132+
- docs/targets.md
133+
- docs/terraform.md
134+
contributors: []

0 commit comments

Comments
 (0)