terraform-eks-deployment

Terraform module for bootstrapping and updating EKS cluster configuration repositories.

Overview

This module manages the GitHub repository that holds your cluster Terragrunt configuration. It renders core files such as root.hcl, account.hcl, region.hcl, vpc.hcl, cluster.hcl, and selected module terragrunt.hcl files from template-eks-cluster.

It supports two workflows:

create: create a repository, commit generated files to new/<cluster_name>, and open a pull request into main
update: manage an existing repository, commit generated files to update/<cluster_name>, and open a pull request into main

Features

Fully Terraform-native workflow
New-repo and update-repo support
Automatic working branch creation
Automatic pull request creation into main
Rendered Terragrunt configuration from module inputs
Optional syncing of module-specific terragrunt.hcl files from template-eks-cluster
Team access management through the underlying GitHub repo module

Prerequisites

Terraform 1.x
GitHub token with repository and pull request permissions
Access to your GitHub Enterprise instance, if applicable

Usage

Create a New Repository

module "eks_deployment" {
  source = "../../"

  name            = "csvd-lab-mcm"
  organization    = "SCT-Engineering"
  repository_mode = "create"
  environment     = "dev"
  region          = "us-gov-east-1"

  repository_teams = {
    "platform-team" = "admin"
    "developers"    = "push"
  }

  cluster_config = {
    account_name          = "lab-dev-gov"
    aws_account_id        = "224384469011"
    environment_abbr      = "lab"
    vpc_name              = "vpc3-lab-dev"
    vpc_domain_name       = "dev.lab.csp2.census.gov"
    cluster_mailing_list  = "matthew.c.morgan@census.gov"
    finops_project_name   = "csvd_platformbaseline"
    finops_project_number = "fs0000000078"
    finops_project_role   = "csvd_platformbaseline_eks"
    organization          = "census:ocio:csvd"
    tags = {
      Owner       = "matthew.c.morgan@census.gov"
      Environment = "development"
      CostCenter  = "fs0000000078"
    }
  }

  template_enabled_modules = {
    eks-gatekeeper = true
    eks-grafana    = true
    eks-kiali      = true
    eks-loki       = true
    eks-otel       = true
    eks-prometheus = true
    eks-tempo      = true
  }
}

Update an Existing Repository

module "eks_deployment" {
  source = "../../"

  name            = "csvd-lab-mcm"
  organization    = "SCT-Engineering"
  repository_mode = "update"
  environment     = "dev"
  region          = "us-gov-east-1"

  cluster_config = {
    account_name          = "lab-dev-gov"
    aws_account_id        = "224384469011"
    environment_abbr      = "lab"
    vpc_name              = "vpc3-lab-dev"
    vpc_domain_name       = "dev.lab.csp2.census.gov"
    cluster_mailing_list  = "matthew.c.morgan@census.gov"
    finops_project_name   = "csvd_platformbaseline"
    finops_project_number = "fs0000000078"
    finops_project_role   = "csvd_platformbaseline_eks"
    organization          = "census:ocio:csvd"
  }

  template_enabled_modules = {
    eks-gatekeeper = true
    eks-grafana    = true
    eks-kiali      = true
    eks-loki       = true
  }
}

Template Module Selection

template_enabled_modules controls which module-specific terragrunt.hcl files are synced from template-eks-cluster.

These core cluster modules are always enabled and cannot be turned off:

eks
eks-config
eks-karpenter
eks-istio
eks-dns

Any omitted key is treated as false for optional modules.

Generated Files

The module manages files such as:

root.hcl
config.json
README.md
<environment>/account.hcl
<environment>/<region>/region.hcl
<environment>/<region>/vpc/vpc.hcl
<environment>/<region>/vpc/cluster/cluster.hcl
<environment>/<region>/vpc/cluster/<module>/terragrunt.hcl for enabled template modules
_envcommon/default-versions.hcl
_envcommon/common-variables.hcl
_envcommon/prefixes.hcl

Working Branch and PR Behavior

repository_mode = "create" creates branch new/<name> and opens a PR to main
repository_mode = "update" creates branch update/<name> and opens a PR to main
For update mode, the working branch is created from the repository default branch unless files_branch_source_branch is provided

Key Inputs

Required

name
environment
region
cluster_config

Common Optional Inputs

organization
repository_mode
repository_teams
template_enabled_modules
files_branch_source_branch
force_name

See variables.tf for the full input surface.

Outputs

Name	Description
`repository_url`	URL of the created repository
`ssh_clone_url`	SSH clone URL of the repository

How It Works

The module computes whether it is in create or update mode.
It renders repository files from Terraform templates and input variables.
It creates or updates the target repository through terraform-github-repo.
It creates a working branch (new/<name> or update/<name>).
It commits the generated files to that branch.
It opens a pull request from that branch into main.

SCT-Engineering/terraform-eks-deployment

About

Topics

Resources

Stars

Watchers

Forks

Releases 13

Contributors 2

Languages