EC2 Minecraft deployment

Background

This repo contains automation to create an EC2 instance on AWS and deploy a Minecraft server on it using a Podman container.

The EC2 instance will be created using an OpenTofu/Terraform configuration defined in main.tf. This will connect to AWS and provision the required resources.

Minecraft will be deployed via the Ansible playbook playbook.yaml. It will create a Podman Quadlet with a Mincraft container image.

Requirements

• An AWS account
  • Adequite IAM rules to perform tasks such as creating EC2 instances and VPCs
• The AWS CLI v2
• AWS credentials stored as evironemnt variables as outlined in .envrc
  • This .envrc file is optional to use (given you set the environment variables another way), however it is designed to be used in tandem with direnv to aid development.
• An SSH key pair set, with the public key present as an environment variable (also outlined in .envrc)
• OpenTofu or Terraform installed
• Ansible installed
• (Optional) nmap to verify successful deployment

Process Flow

flowchart LR
    Start{{Start}}

    subgraph Terraform
        TB(Load env vars)
        TC(Create VPC)
        TD(Create security group)
        TE(Create EC2 instace)
        TF(Ouput instance information)
    end

    subgraph Ansible
        subgraph Inventory
            AIA(Gather hosts from AWS)
        end
        subgraph Playbook
            APA(Install Podman)
            APB(Copy Quadlet files)
            APC(Enable linger for user)
            APD(Generate, enable, and start unit files)
        end
    end
    
    End{{End}}
    
    Start-->Terraform

    TB-->TC
    TC-->TD
    TD-->TE
    TE-->TF

    Terraform-->Ansible
    AIA-->APA
    APA-->APB
    APB-->APC
    APC-->APD

    Ansible-->End

Loading

Usage

1. Clone the repo and navigate to it

git clone https://github.com/KekoaM/cs312_project && cd cs312_project

2. Set environment variables as described in Requirements
3. Create the EC2 instance with:

tofu apply

or

terraform apply

4. Install Minecraft with:

ansible-playbook -i inventory.aws_ec2.yaml playbook.yaml

5. Get the public DNS record of the instance:

tofu output -raw instance_public_dns

6. Connect to the DNS record at the defualt port (25565) and enjoy the game!