https://github.com/brandonc/terraform-random-monorepo
Generates a monorepo of bespoke terraform root modules with various backends, resources, etc
https://github.com/brandonc/terraform-random-monorepo
Last synced: 3 months ago
JSON representation
Generates a monorepo of bespoke terraform root modules with various backends, resources, etc
- Host: GitHub
- URL: https://github.com/brandonc/terraform-random-monorepo
- Owner: brandonc
- License: mit
- Created: 2022-12-14T02:04:11.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-16T18:22:03.000Z (over 2 years ago)
- Last Synced: 2024-12-28T16:26:37.686Z (5 months ago)
- Language: HCL
- Size: 14.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# terraform-random-monorepo
A terraform module to generate... random terraform modules. Each module contains a minimal configuration,
but vary in their terraform configuration. This is an early proof-of-concept. Here are the supported variations:
- [ ] Backends
- [x] local
- [x] s3
- [x] gcs
- [ ] azurerm
- [ ] Workspaces
- [ ] Submodules
- [ ] Outputs
---
## Quickstart
Use the `size` variable to vary the number of terraform root modules that are created. Each is initialized and applied with the system version of terraform.
`terraform apply -var size=4`
The following directory layout is generated:
```
_generated/
└── components
├── curious-wombat
│ ├── main.tf
│ └── terraform.tfstate
├── resolved-pangolin
│ ├── main.tf
│ └── terraform.tfstate
├── sure-basilisk
│ ├── main.tf
│ └── terraform.tfstate
└── tidy-cat
├── main.tf
└── terraform.tfstate
```
## Usage
Import this module with relevant provider configuration.
```hcl
provider "aws" {
region = "us-west-2"
}
provider "google" {
project = "terraform-random-monorepo"
region = "us-west1"
}
module "random-monorepo" {
source = "github.com/brandonc/terraform-random-monorepo"
s3_enabled = true
gcs_enabled = true
local_enabled = false
size = 4
backend_config = {
bucket = "my-bucket"
key_prefix = "state"
s3 = {
provider_region = "us-west-2" # Must match your provider config region!
}
gcs = {
provider_region = "us-west1" # Must match your provider config region!
}
}
}
```
### Variables
| Name | Type | Default |
|----------------|--------|---------|
| local_enabled | bool | `true` |
| s3_enabled | bool | `false` |
| gcs_enabled | bool | `false` |
| backend_config | object | `{}` |
If remote backends are enabled, the backend_config variable must have a `bucket` and `key_prefix` set, but also a key for each enabled backend with its specific configuration:
```
backend_config = {
bucket = "[BUCKET]"
key_prefix = "state"
s3 = {
provider_region = "us-west-2" # Must match your provider config region!
}
gcs = {
provider_region = "us-west1" # Must match your provider config region!
}
}
```
### Backend Variations
#### Local
By default, only the local backend variation is enabled because it is the only one that does not require configuration.
Remove this option by setting `local_enabled = false`
#### S3
Configure your CLI environment with the AWS credentials to use (ex: AWS_PROFILE). Enable this option by setting `s3_enabled = true` and adding an s3 key to `backend_config` (See usage above)
#### GCS
Configure your CLI environment with the Google credentials to use (ex: GOOGLE_CREDENTIALS). Enable this option by setting `gcs_enabled = true` and adding a gcs key to `backend_config` (See usage above)