Add preinstall commands to user_kustomization

Author: vsalomaki

kube.tf.example

@@ -964,21 +964,24 @@ module "kube-hetzner" {
   # The Kustomization "sets" are run in sequential order (by numeric key) so that you can for example install a CRD and wait for it to be deployed.
   #
   # source_folder: Sets the source folder for *.yaml.tpl and Kustomization.yaml.tpl
-  # kustomize_parameters: Key-value map for passing variables into Kustomization. Applies only to the Kustomization-set in the object, but to all files defined in the source_folder of the "set".
-  # post_commands: Commands to be executed after applying the Kustomization ("kubectl apply -k"). You can use it to wait for CRD deployment etc.
+  # kustomize_parameters: Key-value map for passing variables into Kustomization. Applies only to the Kustomization-set in the object, but to all files defined in the source_folder of the "set". Defaults to {}.
+  # pre_commands: Commands to be executed before applying the Kustomization ("kubectl apply -k"). Defaults to "".
+  # post_commands: Commands to be executed after applying the Kustomization ("kubectl apply -k"). You can use it to wait for CRD deployment etc. Defaults to "".
   # - An example to wait for deployments in all namespaces: `kubectl wait --for=condition=Available deployment --all -A --timeout=120s || exit 0` (The `|| exit 0` is not "required", it just makes the deployment to continue even if a deployment hasn't started up properly)
   # - You can pass full bash-compatible scripts into the `post_commands`-variable with EOT
   # 
-  # An example from the default values: (uncomment or copy your own)
+  # An example from the default values:
   # user_kustomizations = {
   #   "1" = {
   #     source_folder        = "extra-manifests-preinstall"
   #     kustomize_parameters = {}
+  #     pre_commands         = ""
   #     post_commands        = ""
   #   },
   #   "2" = {
   #     source_folder        = "extra-manifests" # Uses `var.extra_kustomize_folder` internally, defaults to "extra-manifests"
   #     kustomize_parameters = var.extra_kustomize_parameters # Same as `extra_kustomize_parameters` in kube.tf, replace with actual values if uncommenting
+  #     pre_commands         = ""
   #     post_commands        = var.extra_kustomize_deployment_commands  # Same as `extra_kustomize_deployment_commands` in kube.tf, replace with actual values if uncommenting
   #   }
   # }

kustomization_user.tf

@@ -3,11 +3,13 @@ locals {
     "1" = {
       source_folder        = "extra-manifests-preinstall"
       kustomize_parameters = {}
+      pre_commands         = ""
       post_commands        = ""
     },
     "2" = {
       source_folder        = var.extra_kustomize_folder
       kustomize_parameters = var.extra_kustomize_parameters
+      pre_commands         = ""
       post_commands        = var.extra_kustomize_deployment_commands
     }
   }
@@ -19,6 +21,7 @@ locals {
       # kustomize_parameters may contain secrets
       kustomize_parameters = sensitive(config.kustomize_parameters)
       source_folder        = config.source_folder
+      pre_commands         = config.pre_commands
       post_commands        = config.post_commands
     }
   }

modules/user_kustomization_set/locals.tf

@@ -5,5 +5,6 @@ locals {
     filesha1("${var.source_folder}/${file_path}")
   ])
   parameters_sha           = sha1(jsonencode(var.template_parameters))
+  pre_commands_string_sha  = sha1(var.pre_commands_string)
   post_commands_string_sha = sha1(var.post_commands_string)
 }

modules/user_kustomization_set/main.tf

@@ -7,6 +7,7 @@ resource "null_resource" "create_target_directory" {
   triggers = {
     source_files_sha         = local.source_files_sha
     parameters_sha           = local.parameters_sha
+    pre_commands_string_sha  = local.pre_commands_string_sha
     post_commands_string_sha = local.post_commands_string_sha
   }
 
@@ -29,6 +30,11 @@ resource "null_resource" "create_target_directory" {
     ]
   }
 
+  provisioner "file" {
+    content     = templatefile("${path.module}/templates/bash.sh.tpl", { commands = var.pre_commands_string })
+    destination = "${var.destination_folder}/preinstall.sh"
+  }
+
   provisioner "file" {
     content     = templatefile("${path.module}/templates/bash.sh.tpl", { commands = var.post_commands_string })
     destination = "${var.destination_folder}/postinstall.sh"

modules/user_kustomization_set/out.tf

@@ -10,6 +10,10 @@ output "parameters_sha" {
   value = local.parameters_sha
 }
 
+output "pre_commands_string_sha" {
+  value = local.pre_commands_string_sha
+}
+
 output "post_commands_string_sha" {
   value = local.post_commands_string_sha
 }
@@ -21,6 +25,6 @@ output "files_count" {
 
 output "changes_sha" {
   value = sha1(join("", [
-    local.source_files_sha, local.parameters_sha, local.post_commands_string_sha
+    local.source_files_sha, local.parameters_sha, local.pre_commands_string_sha, local.post_commands_string_sha
   ]))
 }

modules/user_kustomization_set/variables.tf

@@ -34,6 +34,11 @@ variable "template_parameters" {
   sensitive = true
 }
 
+variable "pre_commands_string" {
+  type    = string
+  default = ""
+}
+
 variable "post_commands_string" {
   type    = string
   default = ""

modules/user_kustomizations/main.tf

@@ -8,9 +8,11 @@ module "user_kustomization_set" {
 
   ssh_connection = var.ssh_connection
 
-  source_folder        = each.value.source_folder
-  destination_folder   = "${local.base_destination_folder}/${each.key}"
-  template_parameters  = each.value.kustomize_parameters
+  source_folder       = each.value.source_folder
+  destination_folder  = "${local.base_destination_folder}/${each.key}"
+  template_parameters = each.value.kustomize_parameters
+
+  pre_commands_string  = each.value.pre_commands
   post_commands_string = each.value.post_commands
 }
 
@@ -42,12 +44,16 @@ resource "null_resource" "kustomization_user_deploy" {
       #!/bin/bash
       for dest_folder in ${join(" ", local.sorted_kustomization_destination_folders)}; do
         if [ -d "$dest_folder" ]; then
+          echo "Running pre-install script from $dest_folder"
+          /bin/bash "$dest_folder/preinstall.sh"
+
           if [ -f "$dest_folder/kustomization.yaml" ]; then
             echo "Applying kustomization from $dest_folder"
             kubectl apply -k "$dest_folder"
           else
             echo "No kustomization.yaml in $dest_folder, skipping apply."
           fi
+
           echo "Running post-install script from $dest_folder"
           /bin/bash "$dest_folder/postinstall.sh"
         fi

modules/user_kustomizations/variables.tf

@@ -17,8 +17,9 @@ variable "ssh_connection" {
 variable "kustomizations_map" {
   type = map(object({
     source_folder        = string
-    kustomize_parameters = map(any)
-    post_commands        = string
+    kustomize_parameters = optional(map(any), {})
+    pre_commands         = optional(string, "")
+    post_commands        = optional(string, "")
   }))
   default     = {}
   description = "Map of kustomization entries, where key is the order number."

variables.tf

@@ -1091,8 +1091,9 @@ variable "extra_kustomize_folder" {
 variable "user_kustomizations" {
   type = map(object({
     source_folder        = string
-    kustomize_parameters = map(any)
-    post_commands        = string
+    kustomize_parameters = optional(map(any), {})
+    pre_commands         = optional(string, "")
+    post_commands        = optional(string, "")
   }))
   default     = {}
   description = "Map of Kustomization-set entries, where key is the order number."