Terraform module to provision a secure terraform state bucket for team use of IAC.
It's 100% Open Source and licensed under the APACHE2.
Include this repository as a module in your existing Terraform code:
module statebucket {
source = "JamesWoolfenden/statebucket/aws"
version = "0.2.25"
common_tags = var.common_tags
}When working with Terraform as part of a team, instead of a local terrraform.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 Terrraform itself.
The Makefile in folder examples\examplesA has a number of tasks, one specifically to create the initial bucket:
make firstThis 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:
make buildThis 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 (in your terraform.tfvars):
common_tags = {
Application = "terraform"
Module = "statebucket"
Environment = "develop"
}| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| common_tags | This is a map type for applying tags on resources | map | n/a | yes |
| Name | Description |
|---|---|
| bucket_domain_name | The FQDN for the bucket |
| statebucket | The state bucket details |
Check out these related projects.
- terraform-aws-s3 - S3 buckets
Got a question?
File a GitHub issue.
Please use the issue tracker to report any bugs or file feature requests.
Copyright © 2019-2019 Slalom, LLC
See 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
https://www.apache.org/licenses/LICENSE-2.0
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.