FlowFuse-oriented infrastructure in AWS using Terraform and Helm

This step-by-step guide will help you use the Terraform modules available in the FlowFuse repository to setup resources required to run FlowFuse platform on AWS. After following the commands in this documentation, the following resources will be created:

The full list of the resources created by each module can be found in the documentation of the respective modules. To ensure proper infrastructure deployment, these modules must be executed in a specific order: vpc, eks, rds, vpc-peering, route53 and ses. Additionally, a shared variables file (terraform.tfvars) will be created to manage configuration used by all modules.

While Terraform supports nested modules for complex infrastructure, this guide will treat each module as a root module for simplicity. All modules are configurable, allowing you to customize the infrastructure to meet your specific needs. Detailed information on configuring each module can be found in its documentation. This guide will uses minimal configuration to demonstrate the basic setup.

Prerequisites

  • Terraform, kubectl, Helm and git installed on your machine.
  • Access to an AWS account through AWS access key, that allows the creation of new resources. The specific resources created by each module are detailed in the documentation of the respective modules.

Step 1: Clone the Repository

First, clone the FlowFuse Terraform repository to your local machine:

git clone https://github.com/FlowFuse/terraform-aws-flowfuse.git
cd terraform-aws-flowfuse

Step 2: Set AWS Environment Variables

Set the following environment variables to authenticate Terraform with your AWS account:

export AWS_ACCESS_KEY_ID=<your-access-key-id>
export AWS_SECRET_ACCESS_KEY=<your-secret-access-key>
export AWS_REGION=<your-desired-region>

Replace <your-access-key-id>, <your-secret-access-key>, and <your-desired-region> with your actual AWS credentials and desired AWS region. All resources must be created in the same region.

For example, if you want to create resources in us-west-2, set the region as follows:

export AWS_REGION=us-west-2

Ensure that these environment variables are set for the duration of the session or included in your shell profile to persist across sessions.

Step 3: Create the terraform.tfvars File

Create a terraform.tfvars file in the root directory of the repository. This file will contain the shared variables for all the modules.

touch terraform.tfvars

Edit the terraform.tfvars file and add the following content. Replace <aws-user-arn> with the ARN of the AWS user that will have access to the EKS cluster. This user will be granted the ClusterAdmin role in the EKS cluster.

namespace = "my-company"
stage = "production"
route53_zone_name = "my-domain.com"
eks_access_entry_map = {
"<aws-user-arn>" = {
access_policy_associations = {
ClusterAdmin = {}
}
}
}

Step 4: Create AWS Resources

The order of creating resources is important. The documentation specifies the correct order. Attempts to create resources in a different order may fail.

1. VPC Module

To create basic networking, initialize the VPC module:

terraform -chdir=vpc init

Apply the VPC module using the shared variables file:

terraform -chdir=vpc apply -var-file=../terraform.tfvars

2. EKS Module

To create EKS cluster, initialize the EKS module:

terraform -chdir=eks init

Apply the EKS module using the shared variables file:

terraform -chdir=eks apply -var-file=../terraform.tfvars

3. RDS Module

To create RDS database, initialize the RDS module:

terraform -chdir=rds init

Apply the RDS module using the shared variables file:

terraform -chdir=rds apply -var-file=../terraform.tfvars

4. VPC Peering Module

To create a peering between EKS and RDS networks, initialize the VPC Peering module:

terraform -chdir=vpc-peering init

Apply the VPC Peering module using the shared variables file:

terraform -chdir=vpc-peering apply -var-file=../terraform.tfvars

5. Route53 Module

To create a domain and certificate, initialize the Route53 module:

terraform -chdir=route53 init

Apply the Route53 module using the shared variables file:

terraform -chdir=route53 apply -var-file=../terraform.tfvars

Remember to change NS records in your domain registrar to the ones provided by the Route53 module. NS records are printed after the Route53 module is applied. They can be also printed using the following command:

terraform -chdir=route53 output domain_dns_records

6. SES Module

To create an email service, initialize the SES module:

terraform -chdir=ses init

Apply the SES module using the shared variables file:

terraform -chdir=ses apply -var-file=../terraform.tfvars

To get the IAM role ARN created by the SES module and required during FlowFuse platform configuration, run the following command:

terraform -chdir=ses output flowfuse_ses_role_arn

Step 5: Deploy Nginx Ingress Controller

It is recommended to run the Nginx Ingress controller even on AWS EKS (The AWS ALB load balancer currently appears to only support up to 100 Ingress Targets which limits the number of Instance/Projects that can be run).

Create a nginx-ingress-values.yaml file to pass the values to the nginx helm file.

touch nginx-ingress-values.yaml

Get the certificate ARN (<your-certificate-arn>) from the route53 module outputs:

terraform -chdir=route53 output acm_certificate_arn

Fill the nginx-ingress-values.yaml file with the following content. Replace <your-certificate-arn> with the certificate ARN.

controller:
# publishService required to Allow ELB Alias for DNS registration w/ external-dns
publishService:
enabled: true
tcp:
configNameSpace: $(POD_NAMESPACE)/tcp-services
udp:
configNameSpace: $(POD_NAMESPACE)/udp-services
config:
proxy-body-size: "0"
service:
# AWS Annotations for LoadBalaner with Certificate ARN
annotations:
service.beta.kubernetes.io/aws-load-balancer-ssl-cert: "<your-certificate-arn>"
service.beta.kubernetes.io/aws-load-balancer-backend-protocol: "tcp"
service.beta.kubernetes.io/aws-load-balancer-ssl-ports: "443"
service.beta.kubernetes.io/aws-load-balancer-type: "nlb"
service.beta.kubernetes.io/aws-load-balancer-connection-idle-timeout: "120"
# TLS (https) terminated at ELB, so internal endpoint is 'http'
targetPorts:
https: http
ingressClassResource:
default: true

The proxy-body-size: "0" removes the 1m nginx default limit, you can set this to a different vale e.g. "5m" which will match the Node-RED default.

Update your kubeconfig file to point to the EKS cluster and set the correct context

aws eks update-kubeconfig --name $(terraform -chdir=eks output -raw cluster_name)

Install the Nginx Ingress controller with the following command:

helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx
helm repo update
helm upgrade -i ingress-nginx ingress-nginx/ingress-nginx \
--create-namespace \
--namespace ingress \
--values "nginx-ingress-values.yaml" \
--wait \
--atomic

Conclusion

You have successfully set up the necessary AWS infrastructure to run the FlowFuse platform and performed minimal EKS cluster configuration required. With this infrastructure in place, your environment is now ready for the installation of the FlowFuse platform. For detailed installation instructions, please visit: FlowFuse Kubernetes Installation Guide.