-
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: Update README.md and Terraform module template
Update the README.md file to include information about creating a new module and reference the Terraform Registry. Also, add a new Terraform module template with its associated files and documentation.
- Loading branch information
1 parent
1322a1f
commit eb5cd1e
Showing
7 changed files
with
259 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# Terraform Module Template | ||
|
||
This is a template for creating Terraform modules. It includes a basic structure for organizing your module code and documentation. | ||
|
||
In this example, we show how to create an S3 bucket with versioning, encryption, logging, and lifecycle management. This module uses a customizable name prefix for all resources and allows extra tags to be assigned. | ||
|
||
## Key Highlights | ||
|
||
1. **`name` Variable**: Used as a prefix for all resources, providing an easy way to distinguish resources created by the module. | ||
2. **`tags` Variable**: Allows additional tags to be passed to the module, merged with the default tag structure. | ||
3. **Documentation**: The README clearly documents the purpose and examples of using the module. | ||
4. **Module Documentation**: The module documentation is generated using [terraform-docs](https://github.com/terraform-docs/terraform-docs) and provides detailed information about the module's inputs and outputs. | ||
|
||
## Usage | ||
|
||
```hcl | ||
module "s3_bucket" { | ||
source = "path_to_your_module" | ||
name = "data-lake" | ||
bucket_name = "raw-data" | ||
force_destroy = true | ||
enable_versioning = true | ||
kms_key_id = "alias/my-kms-key" | ||
logging_bucket = "my-logging-bucket" | ||
tags = { | ||
Owner = "Anton" | ||
Environment = "prod" | ||
} | ||
} | ||
``` | ||
|
||
## Module Documentation | ||
|
||
The module documentation is generated with [terraform-docs](https://github.com/terraform-docs/terraform-docs) by running `terraform-docs md . > ./docs/MODULE.md` from the module directory. | ||
|
||
You can also view the latest version of the module documentation [here](./docs/MODULE.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
<!-- BEGIN_TF_DOCS --> | ||
## Requirements | ||
|
||
| Name | Version | | ||
|------|---------| | ||
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 | | ||
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 5.0.0 | | ||
|
||
## Providers | ||
|
||
| Name | Version | | ||
|------|---------| | ||
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 5.0.0 | | ||
|
||
## Modules | ||
|
||
No modules. | ||
|
||
## Resources | ||
|
||
| Name | Type | | ||
|------|------| | ||
| [aws_s3_bucket.bucket](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket) | resource | | ||
| [aws_s3_bucket_lifecycle_configuration.lifecycle](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_lifecycle_configuration) | resource | | ||
| [aws_s3_bucket_logging.bucket_logging](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_logging) | resource | | ||
| [aws_s3_bucket_ownership_controls.ownership](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_ownership_controls) | resource | | ||
| [aws_s3_bucket_public_access_block.public_access](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_public_access_block) | resource | | ||
| [aws_s3_bucket_server_side_encryption_configuration.sse](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_server_side_encryption_configuration) | resource | | ||
| [aws_s3_bucket_versioning.versioning](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_versioning) | resource | | ||
|
||
## Inputs | ||
|
||
| Name | Description | Type | Default | Required | | ||
|------|-------------|------|---------|:--------:| | ||
| <a name="input_acl"></a> [acl](#input\_acl) | Canned ACL to apply to the bucket | `string` | `"private"` | no | | ||
| <a name="input_bucket_name"></a> [bucket\_name](#input\_bucket\_name) | The name of the S3 bucket | `string` | n/a | yes | | ||
| <a name="input_enable_lifecycle_rule"></a> [enable\_lifecycle\_rule](#input\_enable\_lifecycle\_rule) | Enable lifecycle rule | `bool` | `true` | no | | ||
| <a name="input_enable_versioning"></a> [enable\_versioning](#input\_enable\_versioning) | Enable versioning on the S3 bucket | `bool` | `false` | no | | ||
| <a name="input_force_destroy"></a> [force\_destroy](#input\_force\_destroy) | Force bucket deletion | `bool` | `false` | no | | ||
| <a name="input_kms_key_id"></a> [kms\_key\_id](#input\_kms\_key\_id) | KMS key for bucket encryption | `string` | `"alias/aws/s3"` | no | | ||
| <a name="input_lifecycle_expiration_days"></a> [lifecycle\_expiration\_days](#input\_lifecycle\_expiration\_days) | Number of days after which to expire objects | `number` | `90` | no | | ||
| <a name="input_lifecycle_storage_class"></a> [lifecycle\_storage\_class](#input\_lifecycle\_storage\_class) | Storage class for lifecycle transition | `string` | `"GLACIER"` | no | | ||
| <a name="input_lifecycle_transition_days"></a> [lifecycle\_transition\_days](#input\_lifecycle\_transition\_days) | Number of days after which to transition objects | `number` | `30` | no | | ||
| <a name="input_logging_bucket"></a> [logging\_bucket](#input\_logging\_bucket) | Bucket for storing logs | `string` | n/a | yes | | ||
| <a name="input_name"></a> [name](#input\_name) | Name to be used on all the resources as identifier | `string` | `""` | no | | ||
| <a name="input_tags"></a> [tags](#input\_tags) | Any extra tags to assign to objects | `map(any)` | `{}` | no | | ||
|
||
## Outputs | ||
|
||
| Name | Description | | ||
|------|-------------| | ||
| <a name="output_bucket_arn"></a> [bucket\_arn](#output\_bucket\_arn) | The ARN of the S3 bucket | | ||
| <a name="output_bucket_id"></a> [bucket\_id](#output\_bucket\_id) | The ID of the S3 bucket | | ||
| <a name="output_logging_bucket"></a> [logging\_bucket](#output\_logging\_bucket) | The logging bucket for the S3 bucket | | ||
<!-- END_TF_DOCS --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
resource "aws_s3_bucket" "bucket" { | ||
bucket = "${var.name}-${var.bucket_name}" | ||
|
||
force_destroy = var.force_destroy | ||
|
||
tags = merge({ | ||
Name = "${var.name}-s3-bucket" | ||
}, var.tags) | ||
} | ||
|
||
resource "aws_s3_bucket_ownership_controls" "ownership" { | ||
bucket = aws_s3_bucket.bucket.id | ||
|
||
rule { | ||
object_ownership = "BucketOwnerEnforced" | ||
} | ||
} | ||
|
||
resource "aws_s3_bucket_public_access_block" "public_access" { | ||
bucket = aws_s3_bucket.bucket.id | ||
|
||
block_public_acls = true | ||
block_public_policy = true | ||
restrict_public_buckets = true | ||
ignore_public_acls = true | ||
} | ||
|
||
resource "aws_s3_bucket_versioning" "versioning" { | ||
bucket = aws_s3_bucket.bucket.id | ||
|
||
versioning_configuration { | ||
status = var.enable_versioning ? "Enabled" : "Suspended" | ||
} | ||
} | ||
|
||
resource "aws_s3_bucket_server_side_encryption_configuration" "sse" { | ||
bucket = aws_s3_bucket.bucket.id | ||
|
||
rule { | ||
apply_server_side_encryption_by_default { | ||
sse_algorithm = "aws:kms" | ||
kms_master_key_id = var.kms_key_id | ||
} | ||
} | ||
} | ||
|
||
resource "aws_s3_bucket_lifecycle_configuration" "lifecycle" { | ||
bucket = aws_s3_bucket.bucket.id | ||
|
||
rule { | ||
id = "default" | ||
status = var.enable_lifecycle_rule ? "Enabled" : "Disabled" | ||
|
||
transition { | ||
days = var.lifecycle_transition_days | ||
storage_class = var.lifecycle_storage_class | ||
} | ||
|
||
expiration { | ||
days = var.lifecycle_expiration_days | ||
} | ||
} | ||
} | ||
|
||
resource "aws_s3_bucket_logging" "bucket_logging" { | ||
bucket = aws_s3_bucket.bucket.id | ||
target_bucket = var.logging_bucket | ||
target_prefix = "${var.name}-${var.bucket_name}/logs/" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
output "bucket_id" { | ||
description = "The ID of the S3 bucket" | ||
value = aws_s3_bucket.bucket.id | ||
} | ||
|
||
output "bucket_arn" { | ||
description = "The ARN of the S3 bucket" | ||
value = aws_s3_bucket.bucket.arn | ||
} | ||
|
||
output "logging_bucket" { | ||
description = "The logging bucket for the S3 bucket" | ||
value = aws_s3_bucket_logging.bucket_logging.target_bucket | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
variable "name" { | ||
description = "Name to be used on all the resources as identifier" | ||
type = string | ||
default = "" | ||
} | ||
|
||
variable "tags" { | ||
description = "Any extra tags to assign to objects" | ||
type = map(any) | ||
default = {} | ||
} | ||
|
||
variable "bucket_name" { | ||
description = "The name of the S3 bucket" | ||
type = string | ||
} | ||
|
||
variable "force_destroy" { | ||
description = "Force bucket deletion" | ||
type = bool | ||
default = false | ||
} | ||
|
||
variable "acl" { | ||
description = "Canned ACL to apply to the bucket" | ||
type = string | ||
default = "private" | ||
} | ||
|
||
variable "enable_versioning" { | ||
description = "Enable versioning on the S3 bucket" | ||
type = bool | ||
default = false | ||
} | ||
|
||
variable "kms_key_id" { | ||
description = "KMS key for bucket encryption" | ||
type = string | ||
default = "alias/aws/s3" | ||
} | ||
|
||
variable "enable_lifecycle_rule" { | ||
description = "Enable lifecycle rule" | ||
type = bool | ||
default = true | ||
} | ||
|
||
variable "lifecycle_transition_days" { | ||
description = "Number of days after which to transition objects" | ||
type = number | ||
default = 30 | ||
} | ||
|
||
variable "lifecycle_storage_class" { | ||
description = "Storage class for lifecycle transition" | ||
type = string | ||
default = "GLACIER" | ||
} | ||
|
||
variable "lifecycle_expiration_days" { | ||
description = "Number of days after which to expire objects" | ||
type = number | ||
default = 90 | ||
} | ||
|
||
variable "logging_bucket" { | ||
description = "Bucket for storing logs" | ||
type = string | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
terraform { | ||
required_version = ">= 1.0" | ||
|
||
required_providers { | ||
aws = { | ||
source = "hashicorp/aws" | ||
version = ">= 5.0.0" | ||
} | ||
} | ||
} |