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.
This module has a few dependencies:
- Terraform 0.12
- Go
- github.com/stretchr/testify/assert
- github.com/gruntwork-io/terratest/modules/terraform
IMPORTANT: Since the master
branch used in source
varies based on new modifications, we suggest that you use the release versions here.
Here is an example of how you can use this module in your inventory structure:
module "efs" {
source = "git::https://github.com/clouddrove/terraform-aws-efs.git?ref=tags/0.12.0"
name = "efs"
application = var.application
environment = var.environment
label_order = var.label_order
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"]
}
Name | Description | Type | Default | Required |
---|---|---|---|---|
application | Application name, e.g. cd or CloudDrove |
string | n/a | yes |
attributes | Additional attributes (e.g. 1 ) |
list(string) | <list> |
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_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 | "false" |
no |
environment | Environment, e.g. prod , staging , dev , or test |
string | n/a | yes |
label_order | label order, e.g. name ,application |
list | <list> |
no |
managedby | ManagedBy, eg 'CloudDrove' or 'AnmolNagpal'. | string | "[email protected]" |
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 | "" |
no |
name | Solution name, e.g. app |
string | 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 |
string | "0" |
no |
region | AWS Region | string | n/a | yes |
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) | <map> |
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 |
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 |
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
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 [email protected].
If you have found it worth your time, go ahead and give us a ★ on our GitHub!
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.