Terraform Best Practices
Search…
Key concepts
The official Terraform documentation describes all aspects of configuration in details. Read it carefully to understand the rest of this section.
This section describes key concepts which are used inside the book.
Resource
Resource is
aws_vpc, aws_db_instance, etc. A resource belongs to a provider, accepts arguments, outputs attributes, and has lifecycles. A resource can be created, retrieved, updated, and deleted.Resource module
Resource module is a collection of connected resources which together perform the common action (for eg, AWS VPC Terraform module creates VPC, subnets, NAT gateway, etc). It depends on provider configuration, which can be defined in it, or in higher-level structures (eg, in infrastructure module).
Infrastructure module
An infrastructure module is a collection of resource modules, which can be logically not connected, but in the current situation/project/setup serves the same purpose. It defines the configuration for providers, which is passed to the downstream resource modules and to resources. It is normally limited to work in one entity per logical separator (eg, AWS Region, Google Project).
For example, terraform-aws-atlantis module uses resource modules like terraform-aws-vpc and terraform-aws-security-group to manage the infrastructure required for running Atlantis on AWS Fargate.
Another example is terraform-aws-cloudquery module where multiple modules by terraform-aws-modules are being used together to manage the infrastructure as well as using Docker resources to build, push, and deploy Docker images. All in one set.
Composition
Composition is a collection of infrastructure modules, which can span across several logically separated areas (eg., AWS Regions, several AWS accounts). Composition is used to describe the complete infrastructure required for the whole organization or project.
A composition consists of infrastructure modules, which consist of resources modules, which implement individual resources.
Simple infrastructure composition
Data source
Data source performs a read-only operation and is dependant on provider configuration, it is used in a resource module and an infrastructure module.
Data source
terraform_remote_state acts as a glue for higher-level modules and compositions.The external data source allows an external program to act as a data source, exposing arbitrary data for use elsewhere in the Terraform configuration. Here is an example from the terraform-aws-lambda module where the filename is computed by calling an external Python script.
The http data source makes an HTTP GET request to the given URL and exports information about the response which is often useful to get information from endpoints where a native Terraform provider does not exist.
Remote state
Infrastructure modules and compositions should persist their Terraform state in a remote location where it can be retrieved by others in a controllable way (e.g. specify ACL, versioning, logging).
Provider, provisioner, etc
Providers, provisioners, and a few other terms are described very well on the official documentation and there is no point to repeat it here. To my opinion, they have little to do with writing good Terraform modules.
Why so difficult?
While individual resources are like atoms in the infrastructure, resource modules are molecules. A module is the smallest versioned and shareable unit. It has an exact list of arguments, implement basic logic for such a unit to do the required function. Eg. terraform-aws-security-group module creates
aws_security_group and aws_security_group_rule resources based on input. This resource module by itself can be used together with other modules to create the infrastructure module.Access to data across molecules (resource modules and infrastructure modules) is performed using the modules' outputs and data sources.
Access between compositions is often performed using remote state data sources. There are multiple ways to share data between configurations.
When putting concepts described above in pseudo-relations it may look like this:
1
composition-1 {
2
infrastructure-module-1 {
3
data-source-1 => d1
4
5
resource-module-1 {
6
data-source-2 => d2
7
resource-1 (d1, d2)
8
resource-2 (d2)
9
}
10
11
resource-module-2 {
12
data-source-3 => d3
13
resource-3 (d1, d3)
14
resource-4 (d3)
15
}
16
}
17
18
}
Copied!
Last modified 15d ago
Export as PDF
Copy link
Edit on GitHub