https://github.com/jameswoolfenden/terraform-aws-statebucket
Contains the module, permissions and sample code to create a state bucket for further Terraform use.
https://github.com/jameswoolfenden/terraform-aws-statebucket
aws module terraform
Last synced: 5 months ago
JSON representation
Contains the module, permissions and sample code to create a state bucket for further Terraform use.
- Host: GitHub
- URL: https://github.com/jameswoolfenden/terraform-aws-statebucket
- Owner: JamesWoolfenden
- License: apache-2.0
- Created: 2018-12-01T17:19:14.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-09-20T14:31:55.000Z (almost 4 years ago)
- Last Synced: 2026-02-12T09:43:10.761Z (5 months ago)
- Topics: aws, module, terraform
- Language: HCL
- Homepage:
- Size: 137 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# terraform-aws-statebucket
[](https://github.com/JamesWoolfenden/terraform-aws-statebucket)
[](https://github.com/JamesWoolfenden/terraform-aws-statebucket/releases/latest)
[](https://github.com/JamesWoolfenden/terraform-aws-statebucket/releases/latest)
[](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=JamesWoolfenden%2Fterraform-aws-statebucket&benchmark=CIS+AWS+V1.2)
[](https://github.com/pre-commit/pre-commit)
[](https://www.checkov.io/)
[](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=JamesWoolfenden%2Fterraform-aws-statebucket&benchmark=INFRASTRUCTURE+SECURITY)
Terraform module to provision a secure terraform state bucket for team use of IAC.
---
It's 100% Open Source and licensed under the [APACHE2](LICENSE).
## Versions
| Terraform Version | Statebucket Release |
| :---------------: | :-----------------: |
| 0.12.x | 0.3.0 |
| 0.11.x | 0.2.25 |
## Usage
Include this repository as a module in your existing Terraform code:
```HCL
module statebucket {
source = "JamesWoolfenden/statebucket/aws"
version = "0.3.1"
}
```
Set-up as per example.
Use the generated `remote_state.tf` and change the bucket key for each subsequent service as required
```hcl
terraform {
...
backend "s3" {
...
key = "//terraform.tfstate"
...
}
}
```
## Instructions
When working with Terraform as part of a team, instead of a local **terraform.tfstate** file, a shared remote state store is required, for AWS this is a S3 bucket.
But if we want to automate everything via Terraform?
Traditionally we would have to create the initial bucket by hand via the console or by the cli and the resource unmanaged.
The module and example solves the issue of creating a state bucket in Terraform using Terraform itself.
### Chicken then Egg
The Makefile in folder _examples\examplesA_ has a number of tasks, one specifically to create the initial bucket:
```sh
make first
```
This makes the lock DB table, the state (S3) bucket, fills out and creates the remote_state.tf file and then copies the state from the local disk to the bucket.PHEW. The State of the bucket is now managed along with any future resources.
On the second and subsequent runs you use:
```sh
make build
```
## Features
This module implements state locking via DynamoDB, Versioning on files within the bucket and finally MFA Based deletes of the bucket itself.
The module also uses a tagging based on the map variable common_tags scheme.
This Scheme here uses as a minimum (see _examplea.auto.tfvars_):
```HCL
common_tags = {
application = "terraform"
module = "statebucket"
environment = "develop"
authors = "James Woolfenden, Oliver Smit"
}
```
## Costs
```text
Monthly cost estimate
Project: .
Name Monthly Qty Unit Monthly Cost
module.statebucket.aws_dynamodb_table.dynamodb-state-lock
├─ Write capacity unit (WCU) 14,600 WCU-hours $11.27
├─ Read capacity unit (RCU) 14,600 RCU-hours $2.25
├─ Data storage Cost depends on usage: $0.30 per GB-months
├─ Point-In-Time Recovery (PITR) backup storage Cost depends on usage: $0.24 per GB-months
├─ On-demand backup storage Cost depends on usage: $0.12 per GB-months
├─ Table data restored Cost depends on usage: $0.18 per GB
└─ Streams read request unit (sRRU) Cost depends on usage: $0.000000237 per sRRUs
module.statebucket.aws_s3_bucket.state_bucket
└─ Standard
├─ Storage Cost depends on usage: $0.02 per GB-months
├─ PUT, COPY, POST, LIST requests Cost depends on usage: $0.0053 per 1k requests
├─ GET, SELECT, and all other requests Cost depends on usage: $0.00042 per 1k requests
├─ Select data scanned Cost depends on usage: $0.00225 per GB-months
└─ Select data returned Cost depends on usage: $0.0008 per GB-months
PROJECT TOTAL $13.53
```
## Requirements
No requirements.
## Providers
| Name | Version |
|------|---------|
| [aws](#provider\_aws) | n/a |
| [local](#provider\_local) | n/a |
| [template](#provider\_template) | n/a |
## Modules
No modules.
## Resources
| Name | Type |
|------|------|
| [aws_dynamodb_table.dynamodb-state-lock](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/dynamodb_table) | resource |
| [aws_s3_bucket.state_bucket](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket) | resource |
| [aws_s3_bucket_acl.state_bucket](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_acl) | resource |
| [aws_s3_bucket_public_access_block.state_bucket](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_public_access_block) | resource |
| [aws_s3_bucket_server_side_encryption_configuration.state_bucket](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_server_side_encryption_configuration) | resource |
| [aws_s3_bucket_versioning.state_bucket](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_versioning) | resource |
| [local_file.remote_state](https://registry.terraform.io/providers/hashicorp/local/latest/docs/resources/file) | resource |
| [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source |
| [aws_region.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | data source |
| [template_file.remote_state](https://registry.terraform.io/providers/hashicorp/template/latest/docs/data-sources/file) | data source |
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| [acl](#input\_acl) | Not Likely/Unwise to want a public state bucket, but here's the option | `string` | `"private"` | no |
| [force\_destroy](#input\_force\_destroy) | Set force\_destroy property - unlikely to anything else but may want rid of at some point | `bool` | `false` | no |
| [sse\_algorithm](#input\_sse\_algorithm) | The type of encryption algorithm to use | `string` | `"aws:kms"` | no |
## Outputs
| Name | Description |
|------|-------------|
| [bucket\_domain\_name](#output\_bucket\_domain\_name) | The FQDN for the bucket |
| [statebucket](#output\_statebucket) | The state bucket details |
## Policy
This is the policy required to build this project:
The Terraform resource required is:
```golang
resource "aws_iam_policy" "terraform_pike" {
name_prefix = "terraform_pike"
path = "/"
description = "Pike Autogenerated policy from IAC"
policy = jsonencode({
"Version": "2012-10-17",
"Statement": [
{
"Sid": "VisualEditor0",
"Effect": "Allow",
"Action": [
"dynamodb:CreateTable",
"dynamodb:DeleteTable",
"dynamodb:DescribeContinuousBackups",
"dynamodb:DescribeTable",
"dynamodb:DescribeTimeToLive",
"dynamodb:ListTagsOfResource",
"dynamodb:UpdateTable",
"dynamodb:UpdateTimeToLive"
],
"Resource": "*"
},
{
"Sid": "VisualEditor1",
"Effect": "Allow",
"Action": [
"s3:CreateBucket",
"s3:DeleteBucket",
"s3:GetAccelerateConfiguration",
"s3:GetBucketAcl",
"s3:GetBucketCORS",
"s3:GetBucketLogging",
"s3:GetBucketObjectLockConfiguration",
"s3:GetBucketPolicy",
"s3:GetBucketPublicAccessBlock",
"s3:GetBucketRequestPayment",
"s3:GetBucketTagging",
"s3:GetBucketVersioning",
"s3:GetBucketWebsite",
"s3:GetEncryptionConfiguration",
"s3:GetLifecycleConfiguration",
"s3:GetObject",
"s3:GetObjectAcl",
"s3:GetReplicationConfiguration",
"s3:ListAllMyBuckets",
"s3:ListBucket",
"s3:PutBucketAcl",
"s3:PutBucketPublicAccessBlock",
"s3:PutBucketVersioning",
"s3:PutEncryptionConfiguration"
],
"Resource": "*"
}
]
})
}
```
## Checkov Security tests
This module is scanned by Checkov - and has 2 exclusions added:
```checkov
#checkov:skip=CKV_AWS_18: "Ensure the S3 bucket has access logging enabled"
#checkov:skip=CKV_AWS_52: "Ensure S3 bucket has MFA delete enabled"
```
These are added because access logging was not required, and that MFA delete was unsuitable and difficult to automate.
## Related Projects
Check out these related projects.
- [terraform-aws-s3](https://github.com/jameswoolfenden/terraform-aws-s3) - S3 buckets
## Help
**Got a question?**
File a GitHub [issue](https://github.com/JamesWoolfenden/terraform-aws-statebucket/issues).
## Contributing
### Bug Reports & Feature Requests
Please use the [issue tracker](https://github.com/JamesWoolfenden/terraform-aws-statebucket/issues) to report any bugs or file feature requests.
## Copyrights
Copyright © 2019-2022 James Woolfenden
## License
[](https://opensource.org/licenses/Apache-2.0)
See [LICENSE](LICENSE) for full details.
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
### Contributors
[![James Woolfenden][jameswoolfenden_avatar]][jameswoolfenden_homepage]
[James Woolfenden][jameswoolfenden_homepage]
[![Oliver Smit][olmesm_avatar]][olmesm_homepage]
[Oliver Smit][olmesm_homepage]
[jameswoolfenden_homepage]: https://github.com/jameswoolfenden
[jameswoolfenden_avatar]: https://github.com/jameswoolfenden.png?size=150
[olmesm_homepage]: https://github.com/olmesm
[olmesm_avatar]: https://github.com/olmesm.png?size=150