GitHub - cloudposse/terraform-aws-vpn-connection: Terraform module to provision a site-to-site VPN connection between a VPC and an on-premises network

Terraform module to provision a site-to-site VPN connection between a VPC and an on-premises network.

The module can do the following:

Create a Virtual Private Gateway (VPG) and attach it to the VPC
Create a Customer Gateway (CGW) pointing to the provided Internet-routable IP address of the external interface on the on-premises network
Create a Site-to-Site Virtual Private Network (VPN) connection
Request automatic route propagation between the VPG and the provided route tables in the VPC
If the VPN connection is configured to use static routes, provision a static route between the VPN connection and the CGW

Exactly what it does depends on the input parameters. The module is designed to be flexible and can be used in a variety of scenarios.

If you supply customer_gateway_ip_address and set transit_gateway_enabled to true, the module will create a CGW, then create a VPN connection, and then assign the connection to the Transit Gateway identified by existing_transit_gateway_id and the created CGW
If you supply customer_gateway_ip_address and set transit_gateway_enabled to false, the module will create a VPG and CGW, then create a VPN connection, and then assign it to the VPG and CGW
If you supply customer_gateway_ip_address and set cloudwan_enabled to true, the module will create a CGW then create a VPN connection, then attach it to the Cloud WAN Core Network identified by cloudwan_core_network_id
If you do not supply customer_gateway_ip_address (set it to null) then the module will only create a VPG

The module also provides some options for adding routes to the VPC or TGW route tables. You need to use the options that correspond to the kind of attachment point (VPC or TGW) you are using.

Tip

👽 Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform.
Works with Github Actions, Atlantis, or Spacelift.

Watch demo of using Atmos with Terraform

Example of running atmos to manage infrastructure from our Quick Start tutorial.

Usage

  module "vpn_connection" {
    source = "cloudposse/vpn-connection/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version = "x.x.x"
    namespace                                 = "eg"
    stage                                     = "dev"
    name                                      = "test"
    vpc_id                                    = "vpc-xxxxxxxx"
    vpn_gateway_amazon_side_asn               = 64512
    customer_gateway_bgp_asn                  = 65000
    customer_gateway_ip_address               = "172.0.0.1"
    route_table_ids                           = ["rtb-xxxxxxxx", "rtb-yyyyyyyy", "rtb-zzzzzzzz"]
    vpn_connection_static_routes_only         = "true"
    vpn_connection_static_routes_destinations = ["10.80.1.0/24"]
  }

Important

In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.

Requirements

Name	Version
terraform	>= 1.3.0
aws	>= 5.53.0

Providers

Name	Version
aws	>= 5.53.0

Modules

Name	Source	Version
logs	cloudposse/cloudwatch-logs/aws	0.6.9
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_customer_gateway.default	resource
aws_ec2_tag.default	resource
aws_ec2_transit_gateway_route.default	resource
aws_ec2_transit_gateway_route_table_association.default	resource
aws_ec2_transit_gateway_route_table_propagation.default	resource
aws_networkmanager_site_to_site_vpn_attachment.default	resource
aws_vpn_connection.default	resource
aws_vpn_connection_route.default	resource
aws_vpn_gateway.default	resource
aws_vpn_gateway_route_propagation.default	resource

Inputs

Name	Description	Type	Default	Required
additional_tag_map	Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`. This is for some rare cases where resources want additional configuration of tags and therefore take a list of maps with tag key, value, and additional configuration.	`map(string)`	`{}`	no
attributes	ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`, in the order they appear in the list. New attributes are appended to the end of the list. The elements of the list are joined by the `delimiter` and treated as a single ID element.	`list(string)`	`[]`	no
cloudwan_core_network_id	The ID of the Cloud WAN Core Network to attach the VPN connection to. Required if `cloudwan_enabled` is `true`, ignored otherwise.	`string`	`null`	no
cloudwan_enabled	If `true`, the module will create a CloudWAN attachment for the VPN connection. This allows you to attach an unattached VPN connection to an AWS Cloud WAN Core Network. Requires `cloudwan_core_network_id` to be set.	`bool`	`false`	no
context	Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as `null` to use default value. Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional_tag_map, which are merged.	`any`	{ "additional_tag_map": {}, "attributes": [], "delimiter": null, "descriptor_formats": {}, "enabled": true, "environment": null, "id_length_limit": null, "label_key_case": null, "label_order": [], "label_value_case": null, "labels_as_tags": [ "unset" ], "name": null, "namespace": null, "regex_replace_chars": null, "stage": null, "tags": {}, "tenant": null }	no
customer_gateway_bgp_asn	The Customer Gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN)	`number`	`65000`	no
customer_gateway_device_name	The Device Name of the Customer Gateway. Set to `null` to leave unnamed. WARNING: Changing this value will cause the Customer Gateway to be replaced.	`string`	`""`	no
customer_gateway_ip_address	The Internet-routable IP address of the Customer Gateway's external interface. WARNING: If set to `null`, the module will not create a Customer Gateway or a VPN connection and will only create a VPN Gateway.	`string`	`null`	no
delimiter	Delimiter to be used between ID elements. Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.	`string`	`null`	no
descriptor_formats	Describe additional descriptors to be output in the `descriptors` output map. Map of maps. Keys are names of descriptors. Values are maps of the form `{<br/> format = string<br/> labels = list(string)<br/>}` (Type is `any` so the map values can later be enhanced to provide additional options.) `format` is a Terraform format string to be passed to the `format()` function. `labels` is a list of labels, in order, to pass to `format()` function. Label values will be normalized before being passed to `format()` so they will be identical to how they appear in `id`. Default is `{}` (`descriptors` output will be empty).	`any`	`{}`	no
enabled	Set to false to prevent the module from creating any resources	`bool`	`null`	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	`string`	`null`	no
existing_transit_gateway_id	Existing Transit Gateway ID. Required if `transit_gateway_enabled` is `true`, ignored otherwise. To set up a transit gateway, one can use the`cloudposse/transit-gateway/aws` module and pass the output `transit_gateway_id` to this variable.	`string`	`""`	no
existing_vpn_gateway_id	Existing VPN Gateway ID. If provided the module will use the vpn gateway provided here.	`string`	`null`	no
id_length_limit	Limit `id` to this many characters (minimum 6). Set to `0` for unlimited length. Set to `null` for keep the existing setting, which defaults to `0`. Does not affect `id_full`.	`number`	`null`	no
label_key_case	Controls the letter case of the `tags` keys (label names) for tags generated by this module. Does not affect keys of tags passed in via the `tags` input. Possible values: `lower`, `title`, `upper`. Default value: `title`.	`string`	`null`	no
label_order	The order in which the labels (ID elements) appear in the `id`. Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.	`list(string)`	`null`	no
label_value_case	Controls the letter case of ID elements (labels) as included in `id`, set as tag values, and output by this module individually. Does not affect values of tags passed in via the `tags` input. Possible values: `lower`, `title`, `upper` and `none` (no transformation). Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs. Default value: `lower`.	`string`	`null`	no
labels_as_tags	Set of labels (ID elements) to include as tags in the `tags` output. Default is to include all labels. Tags with empty values will not be included in the `tags` output. Set to `[]` to suppress all generated tags. Notes: The value of the `name` tag, if included, will be the `id`, not the `name`. Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be changed in later chained modules. Attempts to change it will be silently ignored.	`set(string)`	[ "default" ]	no
name	ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. This is the only ID element not also included as a `tag`. The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input.	`string`	`null`	no
namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	`string`	`null`	no
regex_replace_chars	Terraform regular expression (regex) string. Characters matching the regex will be removed from the ID elements. If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits.	`string`	`null`	no
route_table_ids	The IDs of the route tables for which routes from the Virtual Private Gateway will be propagated	`list(string)`	`[]`	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
tags	Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`). Neither the tag keys nor the tag values will be modified by this module.	`map(string)`	`{}`	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	`string`	`null`	no
transit_gateway_enabled	If `true`, the module will not create a Virtual Private Gateway but instead will attach the VPN connection to the Transit Gateway specified by `existing_transit_gateway_id`	`bool`	`false`	no
transit_gateway_route_table_id	The ID of the route table for the transit gateway that you want to associate + propagate the VPN connection's TGW attachment	`string`	`null`	no
transit_gateway_routes	A map of transit gateway routes to create on the given TGW route table (via `transit_gateway_route_table_id`) for the created VPN Attachment. Use the key in the map to describe the route	map(object({ blackhole = optional(bool, false) destination_cidr_block = string }))	`{}`	no
vpc_id	The ID of the VPC to which the Virtual Private Gateway will be attached. Not needed if attaching the VPN connection to a Transit Gateway.	`string`	`null`	no
vpn_acceleration_enabled	Set to true to enable VPN acceleration for the VPN connection. Can only be set at creation time, cannot be changed later. Accelerated VPN connections come with several restrictions: consult the AWS documentation for details.	`bool`	`false`	no
vpn_connection_local_ipv4_network_cidr	The IPv4 CIDR on the Customer Gateway (on-premises) side of the VPN connection	`string`	`"0.0.0.0/0"`	no
vpn_connection_log_retention_in_days	Specifies the number of days you want to retain log events	`number`	`30`	no
vpn_connection_remote_ipv4_network_cidr	The IPv4 CIDR on the AWS side of the VPN connection	`string`	`"0.0.0.0/0"`	no
vpn_connection_static_routes_destinations	List of CIDR blocks to be used as destination for static routes. Routes to destinations will be propagated to the route tables defined in `route_table_ids`.	`list(string)`	`[]`	no
vpn_connection_static_routes_only	If set to `true`, the VPN connection will use static routes exclusively. Static routes must be used for devices that don't support BGP.	`bool`	`false`	no
vpn_connection_tunnel1_cloudwatch_log_enabled	Enable or disable VPN tunnel logging feature for the tunnel	`bool`	`false`	no
vpn_connection_tunnel1_cloudwatch_log_group_arn	The ARN of the CloudWatch log group to which the logs will be published. If the list is empty and `vpn_connection_tunnel1_cloudwatch_log_enabled` is `true`, the module will create a new log group and use it. If the list is not empty, the module will use the first ARN in the list.	`list(string)`	`[]`	no
vpn_connection_tunnel1_cloudwatch_log_output_format	Set log format for the tunnel. Default format is json. Possible values are `json` and `text`	`string`	`"json"`	no
vpn_connection_tunnel1_dpd_timeout_action	The action to take after DPD timeout occurs for the first VPN tunnel. Specify `restart` to restart the IKE initiation. Specify `clear` to end the IKE session. Valid values are `clear` \| `none` \| `restart`	`string`	`"clear"`	no
vpn_connection_tunnel1_ike_versions	The IKE versions that are permitted for the first VPN tunnel. Valid values are `ikev1` \| `ikev2`	`list(string)`	`[]`	no
vpn_connection_tunnel1_inside_cidr	The CIDR block of the inside IP addresses for the first VPN tunnel	`string`	`null`	no
vpn_connection_tunnel1_phase1_dh_group_numbers	List of one or more Diffie-Hellman group numbers that are permitted for the first VPN tunnel for phase 1 IKE negotiations. Valid values are 2 \| 14 \| 15 \| 16 \| 17 \| 18 \| 19 \| 20 \| 21 \| 22 \| 23 \| 24	`list(string)`	`[]`	no
vpn_connection_tunnel1_phase1_encryption_algorithms	List of one or more encryption algorithms that are permitted for the first VPN tunnel for phase 1 IKE negotiations. Valid values are AES128 \| AES256 \| AES128-GCM-16 \| AES256-GCM-16	`list(string)`	`[]`	no
vpn_connection_tunnel1_phase1_integrity_algorithms	One or more integrity algorithms that are permitted for the first VPN tunnel for phase 1 IKE negotiations. Valid values are SHA1 \| SHA2-256 \| SHA2-384 \| SHA2-512	`list(string)`	`[]`	no
vpn_connection_tunnel1_phase1_lifetime_seconds	The lifetime for phase 1 of the IKE negotiation for the first VPN tunnel, in seconds. Valid value is between 900 and 28800	`string`	`"28800"`	no
vpn_connection_tunnel1_phase2_dh_group_numbers	List of one or more Diffie-Hellman group numbers that are permitted for the first VPN tunnel for phase 1 IKE negotiations. Valid values are 2 \| 5 \| 14 \| 15 \| 16 \| 17 \| 18 \| 19 \| 20 \| 21 \| 22 \| 23 \| 24	`list(string)`	`[]`	no
vpn_connection_tunnel1_phase2_encryption_algorithms	List of one or more encryption algorithms that are permitted for the first VPN tunnel for phase 2 IKE negotiations. Valid values are AES128 \| AES256 \| AES128-GCM-16 \| AES256-GCM-16	`list(string)`	`[]`	no
vpn_connection_tunnel1_phase2_integrity_algorithms	One or more integrity algorithms that are permitted for the first VPN tunnel for phase 2 IKE negotiations. Valid values are SHA1 \| SHA2-256 \| SHA2-384 \| SHA2-512	`list(string)`	`[]`	no
vpn_connection_tunnel1_phase2_lifetime_seconds	The lifetime for phase 2 of the IKE negotiation for the first VPN tunnel, in seconds. Valid value is between 900 and 3600	`string`	`"3600"`	no
vpn_connection_tunnel1_preshared_key	The preshared key of the first VPN tunnel. The preshared key must be between 8 and 64 characters in length and cannot start with zero. Allowed characters are alphanumeric characters, periods(.) and underscores(_)	`string`	`null`	no
vpn_connection_tunnel1_startup_action	The action to take when the establishing the tunnel for the first VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for AWS to initiate the IKE negotiation. Valid values are `add` \| `start`	`string`	`"add"`	no
vpn_connection_tunnel2_cloudwatch_log_enabled	Enable or disable VPN tunnel logging feature for the tunnel	`bool`	`false`	no
vpn_connection_tunnel2_cloudwatch_log_group_arn	The ARN of the CloudWatch log group to which the logs will be published. If the list is empty and `vpn_connection_tunnel2_cloudwatch_log_enabled` is `true`, the module will create a new log group and use it. If the list is not empty, the module will use the first ARN in the list.	`list(string)`	`[]`	no
vpn_connection_tunnel2_cloudwatch_log_output_format	Set log format for the tunnel. Default format is json. Possible values are `json` and `text`	`string`	`"json"`	no
vpn_connection_tunnel2_dpd_timeout_action	The action to take after DPD timeout occurs for the second VPN tunnel. Specify restart to restart the IKE initiation. Specify clear to end the IKE session. Valid values are `clear` \| `none` \| `restart`	`string`	`"clear"`	no
vpn_connection_tunnel2_ike_versions	The IKE versions that are permitted for the second VPN tunnel. Valid values are `ikev1` \| `ikev2`	`list(string)`	`[]`	no
vpn_connection_tunnel2_inside_cidr	The CIDR block of the inside IP addresses for the second VPN tunnel	`string`	`null`	no
vpn_connection_tunnel2_phase1_dh_group_numbers	List of one or more Diffie-Hellman group numbers that are permitted for the first VPN tunnel for phase 1 IKE negotiations. Valid values are 2 \| 14 \| 15 \| 16 \| 17 \| 18 \| 19 \| 20 \| 21 \| 22 \| 23 \| 24	`list(string)`	`[]`	no
vpn_connection_tunnel2_phase1_encryption_algorithms	List of one or more encryption algorithms that are permitted for the second VPN tunnel for phase 1 IKE negotiations. Valid values are AES128 \| AES256 \| AES128-GCM-16 \| AES256-GCM-16	`list(string)`	`[]`	no
vpn_connection_tunnel2_phase1_integrity_algorithms	One or more integrity algorithms that are permitted for the second VPN tunnel for phase 1 IKE negotiations. Valid values are SHA1 \| SHA2-256 \| SHA2-384 \| SHA2-512	`list(string)`	`[]`	no
vpn_connection_tunnel2_phase1_lifetime_seconds	The lifetime for phase 1 of the IKE negotiation for the second VPN tunnel, in seconds. Valid value is between 900 and 28800	`string`	`"28800"`	no
vpn_connection_tunnel2_phase2_dh_group_numbers	List of one or more Diffie-Hellman group numbers that are permitted for the first VPN tunnel for phase 1 IKE negotiations. Valid values are 2 \| 5 \| 14 \| 15 \| 16 \| 17 \| 18 \| 19 \| 20 \| 21 \| 22 \| 23 \| 24	`list(string)`	`[]`	no
vpn_connection_tunnel2_phase2_encryption_algorithms	List of one or more encryption algorithms that are permitted for the second VPN tunnel for phase 2 IKE negotiations. Valid values are AES128 \| AES256 \| AES128-GCM-16 \| AES256-GCM-16	`list(string)`	`[]`	no
vpn_connection_tunnel2_phase2_integrity_algorithms	One or more integrity algorithms that are permitted for the second VPN tunnel for phase 2 IKE negotiations. Valid values are SHA1 \| SHA2-256 \| SHA2-384 \| SHA2-512	`list(string)`	`[]`	no
vpn_connection_tunnel2_phase2_lifetime_seconds	The lifetime for phase 2 of the IKE negotiation for the second VPN tunnel, in seconds. Valid value is between 900 and 3600	`string`	`"3600"`	no
vpn_connection_tunnel2_preshared_key	The preshared key of the second VPN tunnel. The preshared key must be between 8 and 64 characters in length and cannot start with zero. Allowed characters are alphanumeric characters, periods(.) and underscores(_)	`string`	`null`	no
vpn_connection_tunnel2_startup_action	The action to take when the establishing the tunnel for the second VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for AWS to initiate the IKE negotiation. Valid values are `add` \| `start`	`string`	`"add"`	no
vpn_gateway_amazon_side_asn	The Autonomous System Number (ASN) for the Amazon side of the VPN gateway. If you don't specify an ASN, the Virtual Private Gateway is created with the default ASN.	`number`	`64512`	no

Outputs

Name	Description
cloudwan_attachment_arn	The ARN of the Cloud WAN VPN attachment
cloudwan_attachment_id	The ID of the Cloud WAN VPN attachment
cloudwan_attachment_segment_name	The segment name associated with the Cloud WAN VPN attachment
customer_gateway_device_name	Customer Gateway Device Name
customer_gateway_id	Customer Gateway ID
transit_gateway_attachment_id	The ID of the transit gateway attachment for the VPN connection (if a TGW connection)
vpn_acceleration_enabled	Whether the VPN connection is enabled for acceleration
vpn_connection_customer_gateway_configuration	The configuration information for the VPN connection's Customer Gateway (in the native XML format)
vpn_connection_id	VPN Connection ID
vpn_connection_tunnel1_address	The public IP address of the first VPN tunnel
vpn_connection_tunnel1_cgw_inside_address	The RFC 6890 link-local address of the first VPN tunnel (Customer Gateway side)
vpn_connection_tunnel1_log_group_arn	The CloudWatch Log Group ARN for the tunnel 1 logs
vpn_connection_tunnel1_vgw_inside_address	The RFC 6890 link-local address of the first VPN tunnel (Virtual Private Gateway side)
vpn_connection_tunnel2_address	The public IP address of the second VPN tunnel
vpn_connection_tunnel2_cgw_inside_address	The RFC 6890 link-local address of the second VPN tunnel (Customer Gateway side)
vpn_connection_tunnel2_log_group_arn	The CloudWatch Log Group ARN for the tunnel 2 logs
vpn_connection_tunnel2_vgw_inside_address	The RFC 6890 link-local address of the second VPN tunnel (Virtual Private Gateway side)
vpn_gateway_id	Virtual Private Gateway ID

Related Projects

Check out these related projects.

terraform-aws-vpc - Terraform module that defines a VPC with public/private subnets across multiple AZs with Internet Gateways
terraform-aws-vpc-peering - Terraform module to create a peering connection between two VPCs
terraform-aws-kops-vpc-peering - Terraform module to create a peering connection between a backing services VPC and a VPC created by Kops
terraform-aws-dynamic-subnets - Terraform module for public and private subnets provisioning in existing VPC
terraform-aws-multi-az-subnets - Terraform module for multi-AZ public and private subnets provisioning
terraform-aws-named-subnets - Terraform module for named subnets provisioning

Tip

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

✅ We build it together with your team.
✅ Your team owns everything.
✅ 100% Open Source and backed by fanatical support.

📚 Learn More

Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

Day-2: Your Operational Mastery

Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

Review our Code of Conduct and Contributor Guidelines.
Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Running Terraform Tests

We use Atmos to streamline how Terraform tests are run. It centralizes configuration and wraps common test workflows with easy-to-use commands.

All tests are located in the test/ folder.

Under the hood, tests are powered by Terratest together with our internal Test Helpers library, providing robust infrastructure validation.

Setup dependencies:

Install Atmos (installation guide)
Install Go 1.24+ or newer
Install Terraform or OpenTofu

To run tests:

Run all tests:
```
atmos test run
```
Clean up test artifacts:
```
atmos test clean
```
Explore additional test options:
```
atmos test --help
```

The configuration for test commands is centrally managed. To review what's being imported, see the atmos.yaml file.

Learn more about our automated testing in our documentation or implementing custom commands with atmos.

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

📰 Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

Preamble to the Apache License, Version 2.0

Complete license is available in the LICENSE file.

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.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

Name		Name	Last commit message	Last commit date
Latest commit History 61 Commits
.github		.github
examples/complete		examples/complete
test		test
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
README.yaml		README.yaml
atmos.yaml		atmos.yaml
context.tf		context.tf
main.tf		main.tf
outputs.tf		outputs.tf
variables.tf		variables.tf
versions.tf		versions.tf

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!