Terraform Module for Levitate Installation using AWS ECS with EFS and Environment Configurations

Overview

This Terraform module is designed to deploy a Docker container as an AWS ECS Fargate task with an attached Amazon EFS filesystem. It allows for customized configurations, including setting up environment variables and remote write credentials for VictoriaMetrics (or similar tools).

Prerequisites

Terraform v0.12+ installed.
AWS CLI installed and configured.
An AWS account with necessary permissions.

Features

ECS Fargate Task: Deploys a Docker container on AWS ECS Fargate.
EFS Filesystem: Attaches an EFS filesystem to the ECS task for persistent storage.
Customizable Security Groups: Configures security groups for ECS tasks and EFS communication.
Environment Configurations: Sets up environment variables and remote write credentials.

Input Variables

aws_region: The AWS region for deploying resources.
vpc_id: The ID of the VPC where resources will be created.
subnet_ids: List of subnet IDs for the ECS service and EFS mount targets.
ecs_cluster_id: The ID of the ECS cluster for deploying services.
levitate_remote_write_url: The URL for Levitate remote write.
levitate_remote_write_username: The username for Levitate remote write authentication.
levitate_remote_write_password: The password for Levitate remote write authentication.
environment: The environment name where all these resources will reside.
container_mount_path: The path where the container will mount the volume.

Usage

To use this module in your Terraform environment, include the following configuration:

module "vmagent" {
  source                         = "./path/to/your/module"
  aws_region                     = "ap-south-1"
  vpc_id                         = "vpc-xxxxxxxxxxxx"
  subnet_ids                     = ["subnet-yyyyyyyy", "subnet-zzzzzzzz"]
  ecs_cluster_id                 = "ecs-cluster-id"
  levitate_remote_write_url      = "https://app-tsdb.last9.io/write"
  levitate_remote_write_username = "username"
  levitate_remote_write_password = "password"
  container_mount_path           = "/efs/mnt"
  environment                    = "staging"
}

Replace the values with your specific configuration details.

Outputs

ecs_service_name: The name of the ECS service deployed.
Additional outputs can be added as per the module configuration.

Notes

Ensure that the provided AWS credentials have the necessary permissions for creating and managing ECS and EFS resources.
Review and adjust security group rules as per your organization's security policies.
Validate your Terraform configurations with terraform plan before applying changes with terraform apply.

How to mount/unmount configuration files to the created EFS

Refer efs_mount.md
Refer efs_unmount.md

Disclaimer

Before proceeding with state management in Terraform, it is essential to adhere to your organization's established best practices and guidelines for managing Terraform state. If your organization has specific state management practices in place, please follow them diligently.

However, in cases where your organization does not have established Terraform state management practices, or if you are working on a one-time operation, you may consider checking in the state files directly into your Git repository, rather than implementing a dedicated remote state backend like Amazon S3 or other storage solutions.

Please exercise caution and consider the security and access control implications of storing state files in Git. This approach may not be suitable for all scenarios, and it is crucial to assess the potential risks and benefits before making a decision.

Ultimately, the choice of state management strategy should align with your project's specific requirements and your organization's policies. If in doubt or if security and compliance concerns arise, it is advisable to consult with your organization's infrastructure or security team for guidance on the best approach to Terraform state management.

last9/vmagent-ecs-terraform