docs(examples): Simplified Terraform Deployments - Githubissues

brexhq / substation

Substation is a toolkit for routing, normalizing, and enriching security event and audit logs.

https://substation.readme.io

MIT License

322 stars 16 forks source link

docs(examples): Simplified Terraform Deployments #157

Closed jshlbrd closed 5 months ago

jshlbrd commented 5 months ago

Description

This PR makes it way easier to deploy the Terraform examples:

Moves the Makefile to examples/ since it was always scoped to tests only
Updates the Makefile and associated docs for easier example deployments
Updates all Terraform examples to use the latest release
- This will require future updates
Updates the docs for the Firehose example (AWS renamed this service)
Adds the LICENSE file into any built container images

This also fixes an optional variable in the CloudWatch Terraform module (discovered while E2E testing).

Motivation and Context

We should always try to make testing the system easier (within reason).

How Has This Been Tested?

The Terraform examples were E2E tested for builds, deploys, and destroys.

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

[x] My code follows the code style of this project.
[x] My change requires a change to the documentation.
[x] I have updated the documentation accordingly.