Terraform AWS Server

This module deploys infrastructure in AWS.

WARNING! We test in regions us-west-2, us-west-1, us-east-1, and us-east-2. Our selected image types may not exist in your region, in which case you can select an image manually. See the examples/select/image for an example of how to do this

Recent Changes

1. Image update and remove Terraform restrictions As part of a wider goal to support OpenTofu I have removed the restrictions on the Terraform provider. Added SLE-Micro 6.1 since it is now out and supported, and removed Rocky-8 since it is no longer actively supported.
2. IPv6 Only Support To support load balanced IPv6 only instances, the primary interface needs to have the 'primary ipv6 enabled' flag set. This flag is not currently available in the Terraform provider, but a PR exists: https://github.com/hashicorp/terraform-provider-aws/pull/36425 Until the provider supports this flag we are using a workaround. The workaround requires the AWS CLI to be installed on the server running Terraform. The AWS CLI will use the same authentication mechanisms as Terraform, so there is no need to configure additional credentials. WARNING! If deploying with ip_family = "ipv6" the server running Terraform must have the AWS CLI installed.
3. Rename images
   • Removed SUSE images that weren't BYOS (bring your own subscription)
     • Amazon subscriptions are harder to automate and don't provide direct service, it ends up being a hidden fee of using the image. Instead, users can use the BYOS image without a subscription until they need one, and then they can add a subscription separately bought from SUSE.
   • Started using SUSE cloud info API to get the latest image names

AWS Access

The first step to using the AWS modules is having an AWS account, here is a document describing this process. You will need an API access key id and API secret key, you can get the API keys following this tutorial. The Terraform AWS provider uses the AWS Go SDK, which allows the use of either environment variables or config files for authentication.

You do not need the AWS cli to generate the files, just place them in the proper place and Terraform will find and read them.

Server Types

This module provides a pre-chosen set of "types" of servers in order to reduce choice fatigue for the user and streamline testing. The choices are detailed in the server module and below:

# storage sizes in GB, using gp3 storage type
locals {
  types = {
    small = { # minimum required for rke2 control plane node, handles 0-225 agents
      id      = "t3.medium",
      cpu     = "2",
      ram     = "4",
      storage = "20",
    },
    medium = { # agent node, fits requirements for a database server or a small gaming server
      id      = "m5.large",
      cpu     = "2",
      ram     = "8",
      storage = "200",
    },
    large = { # control plane handling 226-450 agents, also fits requirements for a git server
      id      = "c5.xlarge",
      cpu     = "4",
      ram     = "8",
      storage = "500",
    },
    xl = { # control plane handling 451-1300 agents, also fits requirements for a large database server, gaming server, or a distributed storage solution
      id      = "t3.xlarge",
      cpu     = "4",
      ram     = "16",
      storage = "1000",
    }
    xxl = { # control plane handling 1300+ agents, also fits requirements for a large gaming server, a large database server, or a distributed storage solution
      id      = "m5.2xlarge",
      cpu     = "8",
      ram     = "32",
      storage = "2000",
    }
  }
}

Image types

This module provides a pre-chosen set of "types" of images in order to reduce choice fatigue for the user and streamline testing. The choices are detailed in the image module and below:

# using the getImages script in this directory with argument "sles"
# suse-sles-15-sp6-chost-byos-v20250212-hvm-ssd-x86_64
sles-15 = { # BYOS = Bring Your Own Subscription
  user         = "ec2-user",
  group        = "wheel",
  name         = "suse-sles-15-sp6-chost-byos-v*-hvm-ssd-x86_64",        #chost refers to an image that is optimized for running containers
  name_regex   = "^suse-sles-15-sp6-chost-byos-v[0-9]+-hvm-ssd-x86_64$", # we are specifically trying to avoid the -ecs- images
  product_code = "",
  owners       = ["013907871322"],
  architecture = "x86_64",
  workfolder   = "~"
},

# using the getImages script in this directory with argument "sle-micro"
# suse-sle-micro-5-5-byos-v20250131-hvm-ssd-x86_64
# sle micro is already optimized for containers
sle-micro-55 = { # BYOS = Bring Your Own Subscription
  user         = "ec2-user",
  group        = "wheel",
  name         = "suse-sle-micro-5-5-byos-v*-hvm-ssd-x86_64",
  name_regex   = "^suse-sle-micro-5-5-byos-v[0-9]+-hvm-ssd-x86_64$",
  product_code = "",
  owners       = ["013907871322"],
  architecture = "x86_64",
  workfolder   = "~"
}

# using the getImages script in this directory with argument "sle-micro"
# suse-sle-micro-6-0-byos-v20250210-hvm-ssd-x86_64
# sle micro is already optimized for containers
sle-micro-60 = { # BYOS = Bring Your Own Subscription
  user         = "suse",
  group        = "wheel",
  name         = "suse-sle-micro-6-0-byos-v*-hvm-ssd-x86_64",
  name_regex   = "^suse-sle-micro-6-0-byos-v[0-9]+-hvm-ssd-x86_64$",
  product_code = "",
  owners       = ["013907871322"],
  architecture = "x86_64",
  workfolder   = "~"
}

# using the getImages script in this directory with argument "sle-micro"
# suse-sle-micro-6-1-byos-v20250210-hvm-ssd-x86_64
# sle micro is already optimized for containers
sle-micro-61 = { # BYOS = Bring Your Own Subscription
  user         = "suse",
  group        = "wheel",
  name         = "suse-sle-micro-6-1-byos-v*-hvm-ssd-x86_64",
  name_regex   = "^suse-sle-micro-6-1-byos-v[0-9]+-hvm-ssd-x86_64$",
  product_code = "",
  owners       = ["013907871322"],
  architecture = "x86_64",
  workfolder   = "~"
}

# WARNING! you must subscribe and accept the terms to use this image
# https://aws.amazon.com/marketplace/server/procurement?productId=ca1fe94d-9237-41c7-8fc8-78b6b0658c9f
# example: CIS Red Hat Enterprise Linux 8 Benchmark - STIG - v12 -ca1fe94d-9237-41c7-8fc8-78b6b0658c9f
cis-rhel-8 = {
  user         = "ec2-user",
  group        = "wheel",
  name         = "CIS Red Hat Enterprise Linux 8 Benchmark - STIG*"
  name_regex   = ".*",
  product_code = "bysa8cc41lo4owixsmqw6v44f",
  owners       = ["679593333241"],
  architecture = "x86_64",
  workfolder   = "/var/tmp"
},

# WARNING! you must subscribe and accept the terms to use this image
# ubuntu/images/hvm-ssd/ubuntu-jammy-22.04-amd64-server-20250305
ubuntu-22 = {
  user         = "ubuntu",
  group        = "admin",
  name         = "ubuntu/images/hvm-ssd/ubuntu-jammy-22.04-amd64-server-*",
  name_regex   = "^ubuntu/images/hvm-ssd/ubuntu-jammy-22.04-amd64-server-[0-9]+$", # specifically avoiding .1 images eg. ubuntu-jammy-22.04-amd64-server-20240207.1-47489723-7305-4e22-8b22-b0d57054f216
  product_code = "",                                                               #"47xbqns9xujfkkjt189a13aqe",
  owners       = ["099720109477"],
  architecture = "x86_64",
  workfolder   = "~"
},

# WARNING! you must subscribe and accept the terms to use this image
# https://aws.amazon.com/marketplace/pp/prodview-a2hsmwr6uilqq
# ubuntu/images/hvm-ssd-gp3/ubuntu-noble-24.04-amd64-server-20250305
ubuntu-24 = {
  user         = "ubuntu",
  group        = "admin",
  name         = "ubuntu-minimal/images/hvm-ssd-gp3/ubuntu-noble-24.04-amd64-minimal-*",
  name_regex   = "^ubuntu-minimal/images/hvm-ssd-gp3/ubuntu-noble-24.04-amd64-minimal-[0-9]+$",
  product_code = "",
  owners       = ["099720109477"],
  architecture = "x86_64",
  workfolder   = "~"
},

# WARNING! you must subscribe and accept the terms to use this image
# https://aws.amazon.com/marketplace/pp/prodview-yjxmiuc6p5jzk
# Rocky-9-EC2-LVM-9.5-20241118.0.x86_64-prod-hyj6jp3bki4bm
rocky-9 = {
  user         = "ec2-user",
  group        = "wheel",
  name         = "Rocky-9-EC2-LVM-9.*-*.*.x86_64-prod-*",
  name_regex   = "^Rocky-9-EC2-LVM-9.[0-9]+-[0-9]+.[0-9].x86_64-prod-[0-9a-z]+$",
  product_code = "c0tjzp9xnxvr0ah4f0yletr6b",
  owners       = ["679593333241"],
  architecture = "x86_64",
  workfolder   = "~"
},

# the goal for these search strings is to keep them as stable as possible without specifying a version that is EOL
# our users often rely on extended support from RHEL, so we don't consider odd numbered minors which are inelegible for that
# https://access.redhat.com/support/policy/updates/errata
# therefore the search found here is the most recent even minor that has been released
# expect RHEL 9.4 in June 2024
# RHEL-9.5.0_HVM-20241211-x86_64-0-Hourly2-GP3
rhel-9 = {
  user         = "ec2-user",
  group        = "wheel",
  name         = "RHEL-9.*.*_HVM-*-x86_64-*-Hourly2-GP3",
  name_regex   = "^RHEL-9.[0-9].[0-9]_HVM-[0-9]+-x86_64-[0-9]-Hourly2-GP3$",
  product_code = "",
  owners       = ["309956199498"],
  architecture = "x86_64",
  workfolder   = "~"
},

# this is a community AMI with no product code or marketplace page, but it is produced by our cloud team
# suse-liberty-linux-8-9-byos-v20240603-x86_64
liberty-8 = {
  user         = "ec2-user",
  group        = "wheel",
  name         = "suse-liberty-linux-8-*-byos-v*-x86_64",
  name_regex   = "^suse-liberty-linux-8-[0-9]-byos-v[0-9]+-x86_64$",
  product_code = "",
  owners       = ["013907871322"],
  architecture = "x86_64",
  workfolder   = "~"
},

Examples

Local State

The specific use case for the example modules is temporary infrastructure for testing purposes. With that in mind, it is not expected that we manage the resources as a team, therefore the state files are all stored locally. If you would like to store the state files remotely, add a terraform backend file (*.name.tfbackend) to your root module. https://www.terraform.io/language/settings/backends/configuration#file

Development and Testing

Paradigms and Expectations

Please make sure to read terraform.md to understand the paradigms and expectations that this module has for development.

Environment

It is important to us that all collaborators have the ability to develop in similar environments, so we use tools which enable this as much as possible. These tools are not necessary, but they can make it much simpler to collaborate.

• I use nix that I have installed using their recommended script
• I use direnv that I have installed using brew.
• I simply use direnv allow to enter the environment
• I navigate to the tests directory and run go test -v -timeout=40m -parallel=10
  • It is important to note that the test files do not stand alone, they expect to run as a package.
  • This means that specifying the file to test (as follows) will fail: go test -v -timeout 40m -parallel 10 basic_test.go
• To run an individual test I navigate to the tests directory and run go test -v -timeout 40m -parallel 10 -run <test function name>
  • eg. go test -v -timeout 40m -parallel 10 -run TestBasic

Our continuous integration tests in the GitHub ubuntu-latest runner. It is free for public repositories, we use Nix to add dependencies to it for building and testing.