Skip to content

Commit 2bb3395

Browse files
authored
chore: Update Scaffolding (#178)
1 parent 9f8894c commit 2bb3395

File tree

3 files changed

+82
-169
lines changed

3 files changed

+82
-169
lines changed

.github/mergify.yml

+1-76
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

+70-69
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
2+
13
<!-- markdownlint-disable -->
24
# terraform-aws-elasticsearch <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-elasticsearch&utm_content="><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
3-
<a href="https://g.codefresh.io/public/accounts/cloudposse/pipelines/5d22bfe5a7e22ea3b67ea820"><img src="https://g.codefresh.io/api/badges/pipeline/cloudposse/terraform-modules%2Fterraform-aws-elasticsearch?type=cf-1" alt="Codefresh Build Status"/></a><a href="https://github.com/cloudposse/terraform-aws-elasticsearch/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-elasticsearch.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-elasticsearch/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-elasticsearch.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-elasticsearch/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-elasticsearch.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
<!--
@@ -27,25 +29,16 @@
2729
Terraform module to provision an [`Elasticsearch`](https://aws.amazon.com/elasticsearch-service/) cluster with built-in integrations with [Kibana](https://aws.amazon.com/elasticsearch-service/kibana/) and [Logstash](https://aws.amazon.com/elasticsearch-service/logstash/).
2830

2931

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

5144
## Introduction
@@ -64,17 +57,8 @@ If you don't enable zone awareness, Amazon ES places an endpoint into only one s
6457

6558

6659

67-
## Usage
68-
69-
70-
71-
> [!IMPORTANT]
72-
> In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation
73-
> and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version
74-
> you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic
75-
> approach for updating versions to avoid unexpected changes.
76-
7760

61+
## Usage
7862

7963

8064
```hcl
@@ -105,6 +89,13 @@ module "elasticsearch" {
10589
}
10690
```
10791

92+
> [!IMPORTANT]
93+
> In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation
94+
> and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version
95+
> you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic
96+
> approach for updating versions to avoid unexpected changes.
97+
98+
10899

109100

110101

@@ -118,6 +109,7 @@ Here are automated tests for the complete example using [bats](https://github.co
118109

119110

120111

112+
121113
<!-- markdownlint-disable -->
122114
## Makefile Targets
123115
```text
@@ -295,23 +287,60 @@ For additional context, refer to some of these links.
295287
- [elasticsearch_domain_policy](https://www.terraform.io/docs/providers/aws/r/elasticsearch_domain_policy.html) - Terraform reference documentation for the `elasticsearch_domain_policy` resource
296288

297289

290+
291+
> [!TIP]
292+
> #### Use Terraform Reference Architectures for AWS
293+
>
294+
> Use Cloud Posse's ready-to-go [terraform architecture blueprints](https://cloudposse.com/reference-architecture/) for AWS to get up and running quickly.
295+
>
296+
> ✅ We build it with you.<br/>
297+
> ✅ You own everything.<br/>
298+
> ✅ Your team wins.<br/>
299+
>
300+
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-elasticsearch&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
301+
> <details><summary>📚 <strong>Learn More</strong></summary>
302+
>
303+
> <br/>
304+
>
305+
> Cloud Posse is the leading [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-elasticsearch&utm_content=commercial_support) for funded startups and enterprises.
306+
>
307+
> *Your team can operate like a pro today.*
308+
>
309+
> Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.
310+
> #### Day-0: Your Foundation for Success
311+
> - **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
312+
> - **Deployment Strategy.** Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
313+
> - **Site Reliability Engineering.** Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
314+
> - **Security Baseline.** Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
315+
> - **GitOps.** Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.
316+
>
317+
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-elasticsearch&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
318+
>
319+
> #### Day-2: Your Operational Mastery
320+
> - **Training.** Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
321+
> - **Support.** Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
322+
> - **Troubleshooting.** Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
323+
> - **Code Reviews.** Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
324+
> - **Bug Fixes.** Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
325+
> - **Migration Assistance.** Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
326+
> - **Customer Workshops.** Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.
327+
>
328+
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-elasticsearch&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
329+
> </details>
330+
298331
## ✨ Contributing
299332

300333
This project is under active development, and we encourage contributions from our community.
334+
335+
336+
301337
Many thanks to our outstanding contributors:
302338

303339
<a href="https://github.com/cloudposse/terraform-aws-elasticsearch/graphs/contributors">
304340
<img src="https://contrib.rocks/image?repo=cloudposse/terraform-aws-elasticsearch&max=24" />
305341
</a>
306342

307-
### 🐛 Bug Reports & Feature Requests
308-
309-
Please use the [issue tracker](https://github.com/cloudposse/terraform-aws-elasticsearch/issues) to report any bugs or file feature requests.
310-
311-
### 💻 Developing
312-
313-
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!
314-
Hit us up in [Slack](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-elasticsearch&utm_content=slack), in the `#cloudposse` channel.
343+
For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/terraform-aws-elasticsearch/issues).
315344

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

337366
[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-elasticsearch&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.
338367
It's **FREE** for everyone!
339-
340-
## About
341-
342-
This project is maintained by <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-elasticsearch&utm_content=">Cloud Posse, LLC</a>.
343-
<a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-elasticsearch&utm_content="><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
344-
345-
We are a [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-elasticsearch&utm_content=commercial_support) for funded startups and enterprises.
346-
Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly.
347-
We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.
348-
349-
<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-elasticsearch&utm_content=commercial_support"><img alt="Learn More" src="https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge"/></a>
350-
351-
*Your team can operate like a pro today.*
352-
353-
Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.
354-
355-
<details>
356-
<summary>📚 <strong>See What's Included</strong></summary>
357-
358-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
359-
- **Deployment Strategy.** You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
360-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
361-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
362-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
363-
- **Training.** You'll receive hands-on training so your team can operate what we build.
364-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
365-
- **Troubleshooting.** You'll get help to triage when things aren't working.
366-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
367-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
368-
</details>
369-
370-
<a href="https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-elasticsearch&utm_content=readme_commercial_support_link"><img src="https://cloudposse.com/readme/commercial-support/img"/></a>
371368
## License
372369

373370
<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>
@@ -376,7 +373,9 @@ Ensure that your team succeeds by using our proven process and turnkey blueprint
376373
<summary>Preamble to the Apache License, Version 2.0</summary>
377374
<br/>
378375
<br/>
376+
379377
Complete license is available in the [`LICENSE`](LICENSE) file.
378+
380379
```text
381380
Licensed to the Apache Software Foundation (ASF) under one
382381
or more contributor license agreements. See the NOTICE file
@@ -400,6 +399,8 @@ under the License.
400399
## Trademarks
401400

402401
All other trademarks referenced herein are the property of their respective owners.
402+
403+
403404
---
404405
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
405406

README.yaml

+11-24
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
---
21
#
32
# This is the canonical configuration for the `README.md`
43
# Run `make readme` to rebuild the `README.md`
@@ -18,17 +17,15 @@ github_repo: cloudposse/terraform-aws-elasticsearch
1817

1918
# Badges to display
2019
badges:
21-
- name: "Codefresh Build Status"
22-
image: "https://g.codefresh.io/api/badges/pipeline/cloudposse/terraform-modules%2Fterraform-aws-elasticsearch?type=cf-1"
23-
url: "https://g.codefresh.io/public/accounts/cloudposse/pipelines/5d22bfe5a7e22ea3b67ea820"
24-
- name: "Latest Release"
25-
image: "https://img.shields.io/github/release/cloudposse/terraform-aws-elasticsearch.svg"
26-
url: "https://github.com/cloudposse/terraform-aws-elasticsearch/releases/latest"
27-
- name: "Slack Community"
28-
image: "https://slack.cloudposse.com/badge.svg"
29-
url: "https://slack.cloudposse.com"
30-
31-
# Short description of this project
20+
- name: Latest Release
21+
image: https://img.shields.io/github/release/cloudposse/terraform-aws-elasticsearch.svg?style=for-the-badge
22+
url: https://github.com/cloudposse/terraform-aws-elasticsearch/releases/latest
23+
- name: Last Updated
24+
image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-elasticsearch.svg?style=for-the-badge
25+
url: https://github.com/cloudposse/terraform-aws-elasticsearch/commits
26+
- name: Slack Community
27+
image: https://slack.cloudposse.com/for-the-badge.svg
28+
url: https://slack.cloudposse.com
3229
description: |-
3330
Terraform module to provision an [`Elasticsearch`](https://aws.amazon.com/elasticsearch-service/) cluster with built-in integrations with [Kibana](https://aws.amazon.com/elasticsearch-service/kibana/) and [Logstash](https://aws.amazon.com/elasticsearch-service/logstash/).
3431
@@ -53,7 +50,7 @@ examples: |-
5350
- [`test`](test)
5451
5552
# How to use this project
56-
usage: |-
53+
usage: |2-
5754
5855
```hcl
5956
module "elasticsearch" {
@@ -117,14 +114,4 @@ references:
117114
url: "https://www.terraform.io/docs/providers/aws/r/elasticsearch_domain_policy.html"
118115

119116
# Contributors to this project
120-
contributors:
121-
- name: "Erik Osterman"
122-
github: "osterman"
123-
- name: "Andriy Knysh"
124-
github: "aknysh"
125-
- name: "Igor Rodionov"
126-
github: "goruha"
127-
- name: "Sarkis Varozian"
128-
github: "sarkis"
129-
- name: "Marcin Brański"
130-
github: "3h4x"
117+
contributors: []

0 commit comments

Comments
 (0)