Add README template for EKS cluster configuration

main.tf

@@ -33,12 +33,17 @@ locals {
       finops_project_role         = var.cluster_config.finops_project_role,
       tags                        = var.cluster_config.tags,
       module_enablement_overrides = var.cluster_config.module_enablement_overrides
+    }),
+    "README.md" : templatefile("${path.module}/templates/README.md.tf.tpl", {
+      environment  = var.environment,
+      aws_region   = var.region,
+      cluster_name = var.cluster_config.cluster_name
     })
   }
 }
 
 module "github_repo" {
-  source = "github.com/HappyPathway/terraform-github-repo"
+  source = "HappyPathway/repo/github"
 
   name                    = var.repository_name
   repo_org                = var.organization
@@ -55,7 +60,7 @@ module "github_repo" {
   github_has_wiki     = true
   github_has_projects = true
 
-  files = [
+  managed_extra_files = [
     for path, content in local.rendered_files : {
       path    = path
       content = content

templates/README.md.tf.tpl

@@ -0,0 +1,39 @@
+# EKS Cluster Configuration - ${upper(environment)}
+
+This EKS cluster configuration was generated using Terraform and the terraform-eks-deployment module.
+
+## Environment Details
+
+- **Environment**: ${environment}
+- **Region**: ${aws_region}
+- **Cluster Name**: ${cluster_name}
+
+## Directory Structure
+
+## Getting Started
+
+To apply this configuration:
+
+1. Change to the directory of the module you want to deploy:
+   ```
+   cd ${environment}/${aws_region}/vpc/${cluster_name}/eks
+   ```
+
+2. Initialize and apply the Terragrunt configuration:
+   ```
+   terragrunt init
+   terragrunt plan
+   terragrunt apply
+   ```
+
+3. Deploy additional modules as needed:
+   ```
+   cd ../eks-cert-manager
+   terragrunt init
+   terragrunt plan
+   terragrunt apply
+   ```
+
+## Customization
+
+Each module can be deployed independently using Terragrunt.