fix: disable outputting config.toml by default (#768)

## Description

In #754 I unfortunately made a major oversight: the `local_file` doesn't
persist between machines (duh 🤦🏾 ). So for example in a CI/CD pipeline
the file is not present so it wants to render the whole file as new
every time. This defeats the main purpose that I had intended for this
feature... Also if the pipeline applies the plan, there will be a
perpetual diff, even if you save the file in repository.

I still think this is useful locally for debugging purposes, but
therefore I propose we disable this mechanism by default. In addition,
when these variables are enabled I changed the location to the Root
module for easier access if you want to debug the rendered files.

## Migrations required

YES/NO - Feature is quite new, if someone wants to use keep this as
introduced they now need to explicitly enable it.

## Verification

```hcl
output_runner_config_to_file = true
output_user_data_to_file     = true
```

Results:


![image](https://user-images.githubusercontent.com/17970041/227529895-864e45e0-70aa-4b23-a725-30c4cea8b955.png)

---------

Co-authored-by: kayma <[email protected]>
Co-authored-by: Matthias Kay <[email protected]>

Author: tmeijn

.gitignore

@@ -28,6 +28,7 @@ package*.json
 yarn.lock
 
 builds/
+debug/
 
 # exceptions for semantic release
 !.release/package*
@@ -38,7 +39,4 @@ builds/
 
 # Python
 .mypy_cache/
-venv/
-
-# Terraform rendered templates
-debug/
+venv/

.terraform.lock.hcl

@@ -93,12 +93,13 @@ locals {
 }
 
 resource "local_file" "config_toml" {
+  count    = var.debug.output_runner_config_to_file ? 1 : 0
   content  = local.template_runner_config
-  filename = "${path.module}/debug/runner_config.toml"
+  filename = "${path.root}/debug/${local.name_runner_agent_instance}/runner_config.toml"
 }
 
 resource "local_file" "user_data" {
-  count    = var.show_user_data_in_plan ? 1 : 0
-  content  = nonsensitive(local.template_user_data)
-  filename = "${path.module}/debug/user_data.sh"
+  count    = var.debug.output_runner_user_data_to_file ? 1 : 0
+  content  = local.template_user_data
+  filename = "${path.root}/debug/${local.name_runner_agent_instance}/user_data.sh"
 }

locals.tf

@@ -983,4 +983,29 @@ variable "show_user_data_in_plan" {
   description = "When enabled, shows the diff for agent configuration files in Terraform plan: `config.toml` and user data script"
   type        = bool
   default     = false
+  validation {
+    condition     = !var.show_user_data_in_plan
+    error_message = "The variable is deprecated. Please use the 'debug' variable instead."
+  }
+}
+
+variable "debug" {
+  description = <<EOT
+    Enable debug settings for development
+
+    output_runner_config_to_file: When enabled, outputs the rendered config.toml file in the root module. This can
+                                  then also be used by Terraform to show changes in plan. Note that enabling this can
+                                  potentially expose sensitive information.
+    output_user_data_to_file: When enabled, outputs the rendered userdata.sh file in the root module. This can then
+                              also be used by Terraform to show changes in plan. Note that enabling this can
+                              potentially expose sensitive information.
+  EOT
+  type = object({
+    output_runner_config_to_file    = bool
+    output_runner_user_data_to_file = bool
+  })
+  default = {
+    output_runner_config_to_file    = false
+    output_runner_user_data_to_file = false
+  }
 }