feat: make it easier to understand when/how to configure custom runne…

…r images
spacelift-io · Aug 5, 2024 · 144b219 · 144b219
1 parent 3a42508
commit 144b219
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/config.yml.example b/config.yml.example
@@ -23,13 +23,21 @@ generator:
 #  spacelift:
 #    manage_state: true
 
+#  # Custom runner to use for stacks with custom runner images configured
+#  # See customizing the runner image: https://docs.spacelift.io/integrations/docker#customizing-the-runner-image
+#  # Default: N/A, must be provided (however, not always used. If it is used and not provided an exception will be raised during code generation)
+#  custom_runner_image: public.ecr.aws/spacelift/runner-terraform
+
   extra_vars:
     foo: bar # "{{ extra_vars.foo }}" in a template will be replaced by "bar"
 
 github:
   api_token:
   endpoint: https://api.github.com
 
+gitlab:
+  modules: true
+
 spacelift:
   api:
     api_key_endpoint: https://<ACCOUNT NAME>>.app.spacelift.io/graphql

diff --git a/spacemk/commands/generate.py b/spacemk/commands/generate.py
@@ -21,7 +21,9 @@ def default(value, _default):
             "manage_state": default(config.get("generator.spacelift.manage_state"), True)
         }, "github": {
             "custom_app": default(config.get("generator.github.custom_app"), False)
-        }
+        },
+        "custom_runner_image": default(config.get("generator.custom_runner_image"),
+                                       "SPACELIFT_DEFAULT_INVALID"),
     }
 
     generator = Generator()

diff --git a/spacemk/templates/base.tf.jinja b/spacemk/templates/base.tf.jinja
@@ -95,7 +95,10 @@ resource "spacelift_stack" "{{ stack._relationships.space._migration_id }}_{{ st
   {% block stack_arguments_extra scoped %}{% endblock %}
 
   {% if stack.terraform.workflow_tool == "CUSTOM" %}
-  {{ argument("runner_image ", extra_vars.custom_terraform_runner_image ~ ":" ~ stack.terraform.version, required=True) }}
+  {% if generation_config.custom_runner_image == "SPACELIFT_DEFAULT_INVALID" %}
+  {% raise "generation_config.custom_runner_image is required for stacks with custom Terraform workflow tool." %}
+  {% endif %}
+  {{ argument("runner_image ", generation_config.custom_runner_image ~ ":" ~ stack.terraform.version, required=True) }}
   {% endif %}
 
   {% if stack.vcs.provider == "github_custom" %}