How lablabs/terraform-aws-eks-universal-addon works
Project Type and Purpose
• This is an open-source Terraform module for deploying a “universal addon” into an AWS EKS cluster.
• It provides two main flavors: a plain Helm chart deployment and an ArgoCD Application deployment.
• It also optionally configures IAM roles/policies via IRSA (IAM Roles for Service Accounts) and OIDC providers to give Kubernetes workloads AWS permissions.
File Structure Analysis
• Root
• main.tf, variables.tf, outputs.tf – orchestrate module inputs/outputs and call sub-modules.
• addon.tf, addon-irsa.tf, addon-oidc.tf – entry points for the three module entry-points.
• .github/, scripts/, docs/, examples/ – CI/CD definitions, helper scripts, documentation, and sample usage.
• modules/
• modules/addon – core Helm/ArgoCD deployment logic.
• modules/addon-irsa – IRSA IAM role & policy logic.
• modules/addon-oidc – OIDC provider & role logic.
• examples/basic – a standalone Terraform configuration using the module.
• CI/CD and linters under .github/workflows, pre-commit, renovate, etc.
Key Architecture Insights from README
• Supports multiple deployment methods: Helm (via Terraform Helm provider), ArgoCD Application (via Kubernetes manifest or Helm-based ArgoCD install).
• IRSA & OIDC sub-modules allow attaching IAM policies to service accounts.
• Uses Terraform >=1.5.0, AWS, Helm & Kubernetes providers, and a utils provider for YAML merging.
• Template-sync GitHub Action keeps scaffold ready for new addons.
a. Main Components
• User/CI: runs “terraform apply” using example/root module.
• Terraform Core: parses .tf files, loads providers, applies modules.
• Providers
• AWS Provider → manages IAM roles, OIDC provider, etc.
• Kubernetes Provider → applies CRDs when using manifest mode.
• Helm Provider → installs Helm chart or ArgoCD application via Helm.
• Sub-modules
• addon module → orchestrates chart installation or ArgoCD manifest.
• addon-irsa module → creates IAM role, attaches policies, annotates SA.
• addon-oidc module → configures OIDC provider, role, policies.
• AWS Account
• EKS Cluster (with OIDC issuer endpoint).
• IAM (roles, policies, OIDC provider).
• Kubernetes Cluster
• Namespaces, ServiceAccount (annotated for IRSA).
• HelmRelease or ArgoCD Application resources.
b. Interactions
1. Terraform → AWS Provider → create IAM roles & OIDC provider (modules/addon-irsa & addon-oidc).
2. Terraform → Kubernetes/Helm Provider → install Helm chart or apply ArgoCD CRD (modules/addon).
3. IAM role annotations on ServiceAccount allow pods to assume AWS permissions at runtime.
4. Optional ArgoCD operator pulls chart from repo and deploys into cluster.
c. Architectural Patterns
• Layered module design: root module delegates to specialized sub-modules (Separation of concerns).
• Infra-as-Code with Provider plugins (AWS/Kubernetes/Helm).
• Template pattern to scaffold new addons via GitHub template-sync.
d. Technologies & Libraries
• Terraform core, AWS provider (~>5), Kubernetes provider (>=2.20), Helm provider (>=2.6).
• cloudposse/utils for deep_merge_yaml.
• GitHub Actions and pre-commit for CI/CD.