* get rid of tfvars.example

stew · stew · commit e534b65e6a86 · 2025-09-29T11:36:58.000-07:00
* add more kubectl to outputs
diff --git a/.gitignore b/.gitignore
@@ -6,7 +6,6 @@ unseal_key*
 vault_token
 .vscode
 .direnv
-terraform.tfvars
 terraform.tfstate*
 nimbus-secrets.json
 secrets.env
diff --git a/ec2/README.md b/ec2/README.md
@@ -42,9 +42,7 @@ If you use [Nix](https://nixos.org), there is a nix flake definition that instal
 
 ### terraform.tfvars
 
-You must create a `terraform.tfvars` file containing variables specific to your cluster. [variables.tf](variables.tf) contains all the variables you can set to customize the deployment. Many of these variables have defaults for a basic deployment that are optional in `terraform.tfvars`—some don't have defaults and must be set.
-
-There is a [terraform.tfvars.example](terraform.tfvars.example) file that contains all of the possible variables, you can use as a reference when creating your `terraform.tfvars`.
+[variables.tf](variables.tf) is where all of the variables for the deployment are defined. The values are set in [terraform.tfvars](terraform.tfvars). *You must* edit this file to set the `cluster_name` before deploying.
 
 #### Required variables:
 
diff --git a/ec2/cluster.tf b/ec2/cluster.tf
@@ -37,15 +37,3 @@ data "http" "set_cluster_uri" {
     depends_on = [terraform_data.cluster_uri]
 }
 
-output "cluster_id" {
-  value = data.http.cluster_id.response_body
-}
-
-output "cluster_token" {
-  value = data.http.cluster_token.response_body
-  sensitive = true
-}
-
-output "set_cluster_uri_response" {
-  value = data.http.set_cluster_uri.response_body
-}
diff --git a/ec2/outputs.tf b/ec2/outputs.tf
@@ -1,4 +1,19 @@
 
+output "update-kubeconfig-command" {
+  value       = "aws eks update-kubeconfig --region ${var.aws_region} --name ${module.eks.cluster_name}"
+  description = "Command to update your kubeconfig to connect to the new EKS cluster"
+}
+
+output "list-eks-nodes-command" {
+  value = <<EOF
+aws --region ${var.aws_region} ec2 describe-instances \
+  --filters "Name=tag:eks:cluster-name,Values=${var.cluster_name}" \
+  --query "Reservations[].Instances[].{Hostname:PrivateDnsName, Type:InstanceType, Health:State.Name}" \
+  --output table
+EOF
+  description = "command to get the health of the EKS nodes"
+}
+
 output "unison_public_endpoint_https" {
   value = "https://${aws_lb.main.dns_name}"
   description = "Public HTTPS endpoint for Unison Cloud API (with self-signed cert)"
@@ -38,4 +53,4 @@ output "cluster_setup_u" {
   sensitive = false
   description = "Unison script to connect to your cluster"
   value = local_file.cluster_setup_script.content
-}
+}
diff --git a/ec2/terraform.tfvars b/ec2/terraform.tfvars
@@ -0,0 +1,21 @@
+aws_region = "us-west-2"
+aws_availability_zones = ["us-west-2a", "us-west-2b"]
+
+# You must change the cluster_name before deploying. 
+# The new name must consistsolely of letters, numbers, and hyphens.
+
+cluster_name = "CHANGE_ME"
+
+# Optional variables with default values that can be overridden.
+# See varaibles.tf for descriptions:
+
+# vpc_cidr = "10.0.0.0/16"
+# public_subnets = ["10.0.20.0/25", "10.0.20.128/25"]
+# private_subnets = ["10.0.30.0/25", "10.0.30.128/25"]
+
+# Unison Cloud Configuration
+# unison_cloud_image_tag = "latest"
+# unison_instance_type = "t3.medium"
+# unison_min_instances = 1
+# unison_max_instances = 8
+# unison_desired_instances = 2
diff --git a/ec2/terraform.tfvars.example b/ec2/terraform.tfvars.example
diff --git a/ec2/variables.tf b/ec2/variables.tf
@@ -11,6 +11,11 @@ variable "aws_availability_zones" {
 variable "cluster_name" {
   type        = string
   description = "Name of the cluster"
+
+  validation {
+    condition     = var.cluster_name != "CHANGE_ME"
+    error_message = "You must edit the project_name variable from its default value before deploying."
+  }
 }
 
 variable "vpc_cidr" {
@@ -58,13 +63,13 @@ variable "unison_instance_type" {
 variable "unison_min_instances" {
   description = "Minimum number of Unison Cloud instances"
   type        = number
-  default     = 2
+  default     = 1
 }
 
 variable "unison_max_instances" {
   description = "Maximum number of Unison Cloud instances"
   type        = number
-  default     = 3
+  default     = 8
 }
 
 variable "unison_desired_instances" {
diff --git a/eks/README.md b/eks/README.md
@@ -45,9 +45,7 @@ If you use [Nix](https://nixos.org), there is a nix flake definition that instal
 
 ### terraform.tfvars
 
-You must create a `terraform.tfvars` file containing variables specific to your cluster. [variables.tf](variables.tf) contains all the variables you can set to customize the deployment. Many of these variables have defaults for a basic deployment that are optional in `terraform.tfvars`—some don't have defaults and must be set.
-
-There is a [terraform.tfvars.example](terraform.tfvars.example) file that contains all of the possible variables, you can use as a reference when creating your `terraform.tfvars`.
+[variables.tf](variables.tf) is where all of the variables for the deployment are defined. The values are set in [terraform.tfvars](terraform.tfvars). *You must* edit this file to set the `cluster_name` before deploying.
 
 #### Required variables:
 
@@ -57,14 +55,12 @@ The AWS region to deploy the cluster in. Examples include `us-west-2`, `us-east-
 
 You can find a complete list of zones and regions in the [AWS documentation](https://docs.aws.amazon.com/global-infrastructure/latest/regions/aws-availability-zones.html).
 
-
 ##### `aws_availability_zones`
 
-A list of availability zones to use for the VPC. This should be a list of two or more availability zones in the region you are deploying to. For example, `["us-west-2a", "us-west-2b"]`. You must include at least two availability zones for the EKS cluster to be created successfully.
+A list of availability zones to use for the VPC. This should be a list of two or more availability zones in the region you are deploying to. For example, `["us-west-2a", "us-west-2b"]`. You must include at least two availability zones for the load balancer to work across multiple AZs.
 
 You can find a complete list of zones and regions in the [AWS documentation](https://docs.aws.amazon.com/global-infrastructure/latest/regions/aws-availability-zones.html).
 
-
 ##### `cluster_name`
 
 The name of the cluster, which should match the name you used to create a `Cluster.Id`. This will be used to create the EKS cluster and the DynamoDB table. It must be a valid DNS subdomain, meaning it must consist of only lowercase letters, numbers, and hyphens, and must start and end with a letter or number.
diff --git a/eks/cluster.tf b/eks/cluster.tf
@@ -39,15 +39,3 @@ data "http" "set_cluster_uri" {
     depends_on = [kubernetes_service_v1.caddy_service, terraform_data.cluster_uri]
 }
 
-output "cluster_id" {
-  value = data.http.cluster_id.response_body
-}
-
-output "cluster_token" {
-  value = data.http.cluster_token.response_body
-  sensitive = true
-}
-
-output "set_cluster_uri_response" {
-  value = data.http.set_cluster_uri.response_body
-}
diff --git a/eks/outputs.tf b/eks/outputs.tf
@@ -4,6 +4,16 @@ output "update-kubeconfig-command" {
   description = "Command to update your kubeconfig to connect to the new EKS cluster"
 }
 
+output "list-eks-nodes-command" {
+  value = <<EOF
+aws --region ${var.aws_region} ec2 describe-instances \
+  --filters "Name=tag:eks:cluster-name,Values=${var.cluster_name}" \
+  --query "Reservations[].Instances[].{Hostname:PrivateDnsName, Type:InstanceType, Health:State.Name}" \
+  --output table
+EOF
+  description = "command to get the health of the EKS nodes"
+}
+
 resource "local_file" "cluster_setup_script" {
   filename = "${path.module}/outputs/cluster-setup.u"
   content = <<EOF
diff --git a/eks/terraform.tfvars b/eks/terraform.tfvars
@@ -0,0 +1,24 @@
+aws_region = "us-west-1"
+aws_availability_zones = ["us-west-1a", "us-west-1b"]
+
+# You must change the cluster_name before deploying. 
+# The new name must consistsolely of letters, numbers, and hyphens.
+
+cluster_name = "CHANGE_ME"
+
+# Optional variables with default values that can be overridden.
+# See varaibles.tf for descriptions:
+
+#kubernetes_admins = [
+#    "arn:aws:iam::123456789012:user/username1", 
+#    "arn:aws:iam::123456789012:user/username2"
+#]
+
+# vpc_cidr = "10.0.0.0/16"
+# public_subnets = ["10.0.20.0/25", "10.0.20.128/25"]
+# private_subnets = ["10.0.30.0/25", "10.0.30.128/25"]
+
+# cluster_version = "1.30"
+# desired_node_count = 3
+# eks_instance_type = "t3.medium"
+# unison_cloud_image_tag = "latest"
diff --git a/eks/terraform.tfvars.example b/eks/terraform.tfvars.example
diff --git a/eks/unison.tf b/eks/unison.tf
@@ -62,7 +62,7 @@ resource "kubernetes_config_map" "unison-cloud-config" {
     renderTemplate          = <<EOF
       #!/bin/sh
 
-      sed 's/{{POD_IP}}/'$${POD_IP}'/g ; s/{{CLUSTER_TOKEN}}/'${data.http.cluster_token.response_body}'/g' \
+      sed 's/{{POD_IP}}/'$${POD_IP}'/g ; s/{{CLUSTER_TOKEN}}/${data.http.cluster_token.response_body}/g' \
         < /etc/nimbus-template/config.json.template \
         > /etc/nimbus/secrets/partial-config.json
 EOF
diff --git a/eks/variables.tf b/eks/variables.tf
@@ -11,6 +11,11 @@ variable "aws_availability_zones" {
 variable "cluster_name" {
   type        = string
   description = "Name of the EKS cluster"
+  
+  validation {
+    condition     = var.cluster_name != "CHANGE_ME"
+    error_message = "You must edit the cluster_name variable in terraform.tfvars before deploying."
+  }
 }
 
 variable "vpc_cidr" {
@@ -55,12 +60,6 @@ variable "kubernetes_admins" {
   default = []
 }
 
-variable "unison_vpc_cidr" {
-  type        = string
-  description = "CIDR block for the Unison VPC"
-  default     = "172.20.0.0/16"
-}
-
 variable "unison_cloud_image_tag" {
   type        = string
   description = "Tag/version for the unisoncomputing/unison-cloud container image"
