Terraform AWS EFS

Terraform module to create or deploy EFS on AWS.

We eat, drink, sleep and most importantly love DevOps. We are working towards strategies for standardizing architecture while ensuring security for the infrastructure. We are strong believer of the philosophy Bigger problems are always solved by breaking them into smaller manageable problems. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller connected yet manageable pieces within the infrastructure.

This module is basically combination of Terraform open source and includes automatation tests and examples. It also helps to create and improve your infrastructure with minimalistic code instead of maintaining the whole infrastructure code yourself.

We have fifty plus terraform modules. A few of them are comepleted and are available for open source usage while a few others are in progress.

Prerequisites

This module has a few dependencies:

Examples

IMPORTANT: Since the master branch used in source varies based on new modifications, we suggest that you use the release versions here.

Simple Example

Here is an example of how you can use this module in your inventory structure:

    module "efs" {
      source                    = "clouddrove/efs/aws"
      version                   = "1.3.0"
      name                      = "efs"
      creation_token            = var.token
      region                    = var.region
      availability_zones        = ["${var.region}b", "${var.region}c"]
      vpc_id                    = module.vpc.vpc_id
      subnets                   = module.subnets.private_subnet_id
      security_groups           = ["sg-xxxxxxxxxxxx"]
      efs_backup_policy_enabled = true
    }

Inputs

Name	Description	Type	Default	Required
access_point_enabled	n/a	`bool`	`true`	no
allow_cidr	Provide allowed cidr to efs	`list(any)`	`[]`	no
attributes	If true, the file system will be encrypted	`list(string)`	`[]`	no
availability_zones	Availability Zone IDs	`list(string)`	n/a	yes
creation_token	A unique name (a maximum of 64 characters are allowed) used as reference when creating the EFS	`string`	n/a	yes
delimiter	Delimiter to be used between `namespace`, `stage`, `name` and `attributes`	`string`	`"-"`	no
efs_backup_policy_enabled	If `true`, it will turn on automatic backups.	`bool`	`true`	no
efs_enabled	Set to false to prevent the module from creating any resources	`bool`	`true`	no
encrypted	If true, the file system will be encrypted	`bool`	`true`	no
environment	Environment (e.g. `prod`, `dev`, `staging`).	`string`	`"test"`	no
kms_key_id	The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.	`string`	`""`	no
label_order	label order, e.g. `name`,`application`	`list(any)`	[ "name", "environment" ]	no
managedby	ManagedBy, eg 'CloudDrove'.	`string`	`"hello@clouddrove.com"`	no
mount_target_ip_address	The address (within the address range of the specified subnet) at which the file system may be mounted via the mount target	`string`	`null`	no
name	Solution name, e.g. `app`	`any`	n/a	yes
performance_mode	The file system performance mode. Can be either `generalPurpose` or `maxIO`	`string`	`"generalPurpose"`	no
provisioned_throughput_in_mibps	The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with `throughput_mode` set to provisioned	`number`	`0`	no
region	AWS Region	`string`	n/a	yes
repository	Terraform current module repo	`string`	`"https://github.com/clouddrove/terraform-aws-efs"`	no
security_groups	Security group IDs to allow access to the EFS	`list(string)`	n/a	yes
subnets	Subnet IDs	`list(string)`	n/a	yes
tags	Additional tags (e.g. `{ BusinessUnit = "XYZ" }`	`map(string)`	`{}`	no
throughput_mode	Throughput mode for the file system. Defaults to bursting. Valid values: `bursting`, `provisioned`. When using `provisioned`, also set `provisioned_throughput_in_mibps`	`string`	`"bursting"`	no
vpc_id	VPC ID	`string`	n/a	yes
zone_id	Route53 DNS zone ID	`string`	`""`	no

Outputs

Name	Description
arn	EFS ARN
id	EFS ID
mount_target_ids	List of EFS mount target IDs (one per Availability Zone)
mount_target_ips	List of EFS mount target IPs (one per Availability Zone)
network_interface_ids	List of mount target network interface IDs
tags	The tags of the ecs cluster

Testing

In this module testing is performed with terratest and it creates a small piece of infrastructure, matches the output like ARN, ID and Tags name etc and destroy infrastructure in your AWS account. This testing is written in GO, so you need a GO environment in your system.

You need to run the following command in the testing folder:

  go test -run Test

Feedback

If you come accross a bug or have any feedback, please log it in our issue tracker, or feel free to drop us an email at hello@clouddrove.com.

If you have found it worth your time, go ahead and give us a ★ on our GitHub!

About us

At CloudDrove, we offer expert guidance, implementation support and services to help organisations accelerate their journey to the cloud. Our services include docker and container orchestration, cloud migration and adoption, infrastructure automation, application modernisation and remediation, and performance engineering.

We are The Cloud Experts!

We ❤️ Open Source and you can check out our other modules to get help with your new Cloud ideas.

marzanchet/terraform-aws-efs