Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nozaq/terraform-aws-remote-state-s3-backend

A terraform module to set up remote state management with S3 backend for your account.
https://github.com/nozaq/terraform-aws-remote-state-s3-backend

aws devops terraform terraform-modules

Last synced: about 1 month ago
JSON representation

A terraform module to set up remote state management with S3 backend for your account.

Awesome Lists containing this project

README 

        
# terraform-aws-remote-state-s3-backend



[![Github Actions](https://github.com/nozaq/terraform-aws-remote-state-s3-backend/actions/workflows/main.yml/badge.svg)](https://github.com/nozaq/terraform-aws-remote-state-s3-backend/actions/workflows/main.yml)

[![Releases](https://img.shields.io/github/v/release/nozaq/terraform-aws-remote-state-s3-backend)](https://github.com/nozaq/terraform-aws-remote-state-s3-backend/releases/latest)



[Terraform Module Registry](https://registry.terraform.io/modules/nozaq/remote-state-s3-backend/aws)



A terraform module to set up [remote state management](https://www.terraform.io/docs/state/remote.html) with [S3 backend](https://www.terraform.io/docs/backends/types/s3.html) for your account. It creates an encrypted S3 bucket to store state files and a DynamoDB table for state locking and consistency checking.

Resources are defined following best practices as described in [the official document](https://www.terraform.io/docs/backends/types/s3.html#multi-account-aws-architecture) and [ozbillwang/terraform-best-practices](https://github.com/ozbillwang/terraform-best-practices).



## Features



- Create a S3 bucket to store remote state files.

- Encrypt state files with KMS.

- Enable bucket replication and object versioning to prevent accidental data loss.

- Automatically transit non-current versions in S3 buckets to AWS S3 Glacier to optimize the storage cost.

- Optionally you can set to expire aged non-current versions(disabled by default).

- Optionally you can set fixed S3 bucket name to be user friendly(false by default).

- Create a DynamoDB table for state locking, encryption is optional.

- Optionally create an IAM policy to allow permissions which Terraform needs.



## Usage



The module outputs `terraform_iam_policy` which can be attached to IAM users, groups or roles running Terraform. This will allow the entity accessing remote state files and the locking table. This can optionally be disabled with `terraform_iam_policy_create = false`



```hcl

provider "aws" {

  region = "us-east-1"

}



provider "aws" {

  alias  = "replica"

  region = "us-west-1"

}



module "remote_state" {

  source = "nozaq/remote-state-s3-backend/aws"



  providers = {

    aws         = aws

    aws.replica = aws.replica

  }

}



resource "aws_iam_user" "terraform" {

  name = "TerraformUser"

}



resource "aws_iam_user_policy_attachment" "remote_state_access" {

  user       = aws_iam_user.terraform.name

  policy_arn = module.remote_state.terraform_iam_policy.arn

}

```



Note that you need to provide two providers, one for the main state bucket and the other for the bucket to which the main state bucket is replicated to. Two providers must point to different AWS regions.



Once resources are created, you can configure your terraform files to use the S3 backend as follows.



```hcl

terraform {

  backend "s3" {

    bucket         = "THE_NAME_OF_THE_STATE_BUCKET"

    key            = "some_environment/terraform.tfstate"

    region         = "us-east-1"

    encrypt        = true

    kms_key_id     = "THE_ID_OF_THE_KMS_KEY"

    dynamodb_table = "THE_ID_OF_THE_DYNAMODB_TABLE"

  }

}

```



`THE_NAME_OF_THE_STATE_BUCKET`, `THE_ID_OF_THE_DYNAMODB_TABLE` and `THE_ID_OF_THE_KMS_KEY` can be replaced by `state_bucket.bucket`, `dynamodb_table.id` and `kms_key.id` in outputs from this module respectively.



See [the official document](https://www.terraform.io/docs/backends/types/s3.html#example-configuration) for more detail.



## Compatibility



- Starting from v1.0, this module requires [Terraform Provider for AWS](https://github.com/terraform-providers/terraform-provider-aws) v4.0 or later. [Version 1.0 Upgrade Guide](./docs/upgrade-1.0.md) described the recommended procedure after the upgrade.



## Requirements



| Name | Version |

|------|---------|

|  [terraform](#requirement\_terraform) | >= 1.1.4 |

|  [aws](#requirement\_aws) | >= 4.3 |



## Providers



| Name | Version |

|------|---------|

|  [aws](#provider\_aws) | >= 4.3 |

|  [aws.replica](#provider\_aws.replica) | >= 4.3 |



## Inputs



| Name | Description | Type | Required |

|------|-------------|------|:--------:|

|  [dynamodb\_deletion\_protection\_enabled](#input\_dynamodb\_deletion\_protection\_enabled) | Whether or not to enable deletion protection on the DynamoDB table | `bool` | no |

|  [dynamodb\_enable\_server\_side\_encryption](#input\_dynamodb\_enable\_server\_side\_encryption) | Whether or not to enable encryption at rest using an AWS managed KMS customer master key (CMK) | `bool` | no |

|  [dynamodb\_table\_billing\_mode](#input\_dynamodb\_table\_billing\_mode) | Controls how you are charged for read and write throughput and how you manage capacity. | `string` | no |

|  [dynamodb\_table\_name](#input\_dynamodb\_table\_name) | The name of the DynamoDB table to use for state locking. | `string` | no |

|  [enable\_replication](#input\_enable\_replication) | Set this to true to enable S3 bucket replication in another region | `bool` | no |

|  [iam\_policy\_attachment\_name](#input\_iam\_policy\_attachment\_name) | The name of the attachment. | `string` | no |

|  [iam\_policy\_name](#input\_iam\_policy\_name) | If override\_iam\_policy\_name is true, use this policy name instead of dynamic name with policy\_prefix | `string` | no |

|  [iam\_policy\_name\_prefix](#input\_iam\_policy\_name\_prefix) | Creates a unique name beginning with the specified prefix. | `string` | no |

|  [iam\_role\_arn](#input\_iam\_role\_arn) | Use IAM role of specified ARN for s3 replication instead of creating it. | `string` | no |

|  [iam\_role\_name](#input\_iam\_role\_name) | If override\_iam\_role\_name is true, use this role name instead of dynamic name with role\_prefix | `string` | no |

|  [iam\_role\_name\_prefix](#input\_iam\_role\_name\_prefix) | Creates a unique name beginning with the specified prefix. | `string` | no |

|  [iam\_role\_permissions\_boundary](#input\_iam\_role\_permissions\_boundary) | Use permissions\_boundary with the replication IAM role. | `string` | no |

|  [kms\_key\_alias](#input\_kms\_key\_alias) | The alias for the KMS key as viewed in AWS console. It will be automatically prefixed with `alias/` | `string` | no |

|  [kms\_key\_deletion\_window\_in\_days](#input\_kms\_key\_deletion\_window\_in\_days) | Duration in days after which the key is deleted after destruction of the resource, must be between 7 and 30 days. | `number` | no |

|  [kms\_key\_description](#input\_kms\_key\_description) | The description of the key as viewed in AWS console. | `string` | no |

|  [kms\_key\_enable\_key\_rotation](#input\_kms\_key\_enable\_key\_rotation) | Specifies whether key rotation is enabled. | `bool` | no |

|  [noncurrent\_version\_expiration](#input\_noncurrent\_version\_expiration) | Specifies when noncurrent object versions expire. See the aws\_s3\_bucket document for detail. | 
object({
    days = number
  })
 | no |

|  [noncurrent\_version\_transitions](#input\_noncurrent\_version\_transitions) | Specifies when noncurrent object versions transitions. See the aws\_s3\_bucket document for detail. | 
list(object({
    days          = number
    storage_class = string
  }))
 | no |

|  [override\_iam\_policy\_name](#input\_override\_iam\_policy\_name) | override iam policy name to disable policy\_prefix and create policy with static name | `bool` | no |

|  [override\_iam\_role\_name](#input\_override\_iam\_role\_name) | override iam role name to disable role\_prefix and create role with static name | `bool` | no |

|  [override\_s3\_bucket\_name](#input\_override\_s3\_bucket\_name) | override s3 bucket name to disable bucket\_prefix and create bucket with static name | `bool` | no |

|  [override\_terraform\_iam\_policy\_name](#input\_override\_terraform\_iam\_policy\_name) | override terraform iam policy name to disable policy\_prefix and create policy with static name | `bool` | no |

|  [replica\_bucket\_prefix](#input\_replica\_bucket\_prefix) | Creates a unique replica bucket name beginning with the specified prefix. | `string` | no |

|  [s3\_bucket\_force\_destroy](#input\_s3\_bucket\_force\_destroy) | A boolean that indicates all objects should be deleted from S3 buckets so that the buckets can be destroyed without error. These objects are not recoverable. | `bool` | no |

|  [s3\_bucket\_name](#input\_s3\_bucket\_name) | If override\_s3\_bucket\_name is true, use this bucket name instead of dynamic name with bucket\_prefix | `string` | no |

|  [s3\_bucket\_name\_replica](#input\_s3\_bucket\_name\_replica) | If override\_s3\_bucket\_name is true, use this bucket name for replica instead of dynamic name with bucket\_prefix | `string` | no |

|  [s3\_logging\_target\_bucket](#input\_s3\_logging\_target\_bucket) | The name of the bucket for log storage. The "S3 log delivery group" should have Objects-write und ACL-read permissions on the bucket. | `string` | no |

|  [s3\_logging\_target\_prefix](#input\_s3\_logging\_target\_prefix) | The prefix to apply on bucket logs, e.g "logs/". | `string` | no |

|  [state\_bucket\_prefix](#input\_state\_bucket\_prefix) | Creates a unique state bucket name beginning with the specified prefix. | `string` | no |

|  [tags](#input\_tags) | A mapping of tags to assign to resources. | `map(string)` | no |

|  [terraform\_iam\_policy\_create](#input\_terraform\_iam\_policy\_create) | Specifies whether to terraform IAM policy is created. | `bool` | no |

|  [terraform\_iam\_policy\_name](#input\_terraform\_iam\_policy\_name) | If override\_terraform\_iam\_policy\_name is true, use this policy name instead of dynamic name with policy\_prefix | `string` | no |

|  [terraform\_iam\_policy\_name\_prefix](#input\_terraform\_iam\_policy\_name\_prefix) | Creates a unique name beginning with the specified prefix. | `string` | no |



## Outputs



| Name | Description |

|------|-------------|

|  [dynamodb\_table](#output\_dynamodb\_table) | The DynamoDB table to manage lock states. |

|  [kms\_key](#output\_kms\_key) | The KMS customer master key to encrypt state buckets. |

|  [kms\_key\_alias](#output\_kms\_key\_alias) | The alias of the KMS customer master key used to encrypt state bucket and dynamodb. |

|  [kms\_key\_replica](#output\_kms\_key\_replica) | The KMS customer master key to encrypt replica bucket and dynamodb. |

|  [replica\_bucket](#output\_replica\_bucket) | The S3 bucket to replicate the state S3 bucket. |

|  [state\_bucket](#output\_state\_bucket) | The S3 bucket to store the remote state file. |

|  [terraform\_iam\_policy](#output\_terraform\_iam\_policy) | The IAM Policy to access remote state environment. |