Skip to content

ConfigScript.md

Latest commit

 

History

History
244 lines (162 loc) · 4.68 KB

ConfigScript.md

File metadata and controls

244 lines (162 loc) · 4.68 KB

📘 Configuration Script

This document provides instructions and usage examples for the config.sh script, which automates provisioning, managing, and cleaning up infrastructure and applications using Terraform, AWS, Helm, and Kubernetes.

🚀 Overview

The script helps with:

  • Managing Terraform workflows (fmt, init, validate, plan, apply, destroy).
  • Provisioning and tearing down full environments.
  • Deploying Kubernetes applications with Helm.
  • Managing AWS EKS clusters and kubeconfig.
  • Encrypting and decrypting secrets using AWS KMS.
  • Debugging and smoke testing applications.
  • Cleaning up stuck cluster resources.

Default environment: production

🛠️ Prerequisites

Before running the script, ensure the following tools are installed:

Run the following to check prerequisites:

./config.sh prerequisites

Also make sure to:

Configure Terraform Values

  1. Rename terraform.tfvars.example as terraform.tfvars in terraform/environments/production/ folder
  2. Edit it with your own values

Configure Manifests values

  • Configure files under manifests/environments/production folder

⚙️ Commands

1. Terraform Workflow

  • Format code

    ./config.sh fmt

  • Initialize environment

    ./config.sh init

  • Validate code

    ./config.sh validate

  • Plan changes

    ./config.sh plan
./config.sh plan <target>

  • Import resource

    ./config.sh import <resource_address> <import_address>

  • Apply changes

    ./config.sh apply
./config.sh apply <target>

  • Destroy resources

    ./config.sh destroy
./config.sh destroy <target>

2. Provisioning & Tear-down

  • Provision all modules

    ./config.sh provision

    Runs in order: VPC → EKS → Helm Base → Secret Store → Bucket → RDS.

  • Tear down modules

    ./config.sh tear-down

    Runs in reverse order: RDS → Bucket → Secret Store → Helm Base → EKS → VPC.

3. Kubernetes & Helm

  • Update kubeconfig

    ./config.sh kubeconfig

  • Template Helm chart

    ./config.sh template

  • Deploy application(s)

    ./config.sh deploy

    Deploys Supabase and HAProxy manifests into the cluster.

  • Debug cluster

    ./config.sh debug

    Opens an ephemeral alpine pod with psql client pre-installed for live debugging.

4. Cluster Cleanup

  • Clean up cluster resources

    ./config.sh cleanup

    Cleans up:

    • Karpenter CRDs & resources
    • Stuck nodes
    • Leftover resources in non-system namespaces

5. Secrets Management

  • Encrypt secret with AWS KMS

    ./config.sh encrypt

  • Decrypt secret

    ./config.sh decrypt

6. Application Testing

  • Smoke test Supabase

    ./config.sh smoke

    Retrieves the anonKey from AWS Secrets Manager and runs a test request against Supabase’s REST API endpoint.

❌ Error Handling

  • If a required tool is missing, the script exits with installation instructions.

  • Unknown commands will produce:

    ❌ Unknown Command: <COMMAND>

✅ Best Practices

  • Always run ./config.sh prerequisites before working in a new environment.
  • Use plan before apply or destroy to review changes.
  • Keep AWS credentials configured with the correct profile.
  • Use cleanup if resources get stuck (especially after partial deletions).
  • Use smoke to validate app endpoints after deployment.
  • Encrypt secrets before committing them anywhere.

📖 Example Workflow

  1. Check tools

    ./config.sh prerequisites

  2. Provision infrastructure

    ./config.sh provision

  3. Update kubeconfig

    ./config.sh kubeconfig

  4. Deploy application

    ./config.sh deploy

  5. Smoke test app

    ./config.sh smoke

  6. Tear down when done

    ./config.sh tear-down

🔑 Default Configurations

  • Environment: production
  • Cluster name: production-cluster
  • App name: supabase
  • Namespace: supabase
  • Key alias: production-secret-store-key
  • Secret ID Name: production-supabase-jwt
  • Helm chart path: manifests/environments/production/supabase