feat: project-specific provider configurations

Setting provider_per_project=true in StackHead module configuration
will generate a project-specific provider file instead of the general one.

Author: saitho

Documentation/stackhead-modules/development/module-configuration-file.md

@@ -68,6 +68,10 @@ Per default StackHead will initialize an empty provider. If you need to setup th
 Per default Ansible paths are resolved from playbook directory. Start your path with the variable `{{ role_path }}` to point to your role.
 {% endhint %}
 
+You may set `provider_per_project` to true if your provider requires project-specific configurations.
+In this case, the provider will be created inside the project's Terraform directory.
+Make sure to set the "alias" in the provider configuration and the "provider" in your Terraform resource configurations.
+
 {% code title="stackhead-module.yml" %}
 ```yaml
 ---
@@ -78,6 +82,7 @@ terraform:
     version: 1.0.1
     init: "{{ role_path }}/templates/terraform/provider_init.tf.j2"
     resource_name: caddy_server_block
+    provider_per_project: true
 ```
 {% endcode %}
 

ansible/plugins/filter/string.py

@@ -0,0 +1,10 @@
+def endswith(string, suffix):
+    return string.endswith(suffix)
+
+class FilterModule(object):
+    """
+    Jinja2 filters for string related stuff
+    """
+
+    def filters(self):
+        return {"endswith": endswith}

ansible/roles/config_terraform/tasks/remove-project-symlinks.yml

@@ -7,8 +7,23 @@
     file_type: link
     use_regex: yes
   register: project_tf_symlinks
-- name: "StackHead::Project || Remove project symlinks | Project: {{ project_name }}"
+
+- set_fact:
+    project_tf_symlinks_providers: "{{ project_tf_symlinks_providers|d([]) + [item] }}"
+  when: item.path | getstackhead.stackhead.endswith('.provider.tf')
+  with_items: "{{ project_tf_symlinks.files }}"
+
+- block:
+    - name: "Remove project symlinks (non-providers) | Project: {{ project_name }}"
+      file:
+        path: "{{ item.path }}"
+        state: absent
+      with_items: "{{ project_tf_symlinks | difference(project_tf_symlinks_providers) }}"
+    - include_tasks: "../roles/config_terraform/tasks/execute.yml"
+  when: project_tf_symlinks_providers|d([]) | length > 0
+
+- name: "StackHead::Project || Remove all project symlinks | Project: {{ project_name }}"
   file:
     path: "{{ item.path }}"
     state: absent
-  with_items: "{{ project_tf_symlinks.files }}"
+  with_items: "{{ project_tf_symlinks.files }}"

ansible/roles/stackhead_module_api/tasks_internal/deployment.yml

@@ -12,3 +12,13 @@
     - { name: "{{ stackhead_config.container }}", group: 'container management', optional: false, config: "{{ stackhead_config.deployment[stackhead_config.container]|default([]) }}" }
     - { name: '{{ stackhead_config.webserver }}', group: 'webserver', optional: false, config: "{{ stackhead_config.deployment[stackhead_config.webserver]|default([]) }}" }
     - "{{ plugin_list|default([]) }}"
+
+# Create Terraform provider file if exists
+- include_tasks: "../roles/stackhead_module_api/tasks_internal/terraform/create-perproject-provider.yml"
+  loop_control:
+    loop_var: module
+  when: module != ''
+  with_items:
+    - "{{ stackhead_config.container }}"
+    - "{{ stackhead_config.webserver }}"
+    - "{{ stackhead_config.plugins }}"

ansible/roles/stackhead_module_api/tasks_internal/terraform/create-perproject-provider.yml

@@ -0,0 +1,12 @@
+---
+- name: "Load config for module"
+  getstackhead.stackhead.module.load_config:
+    name: "{{ module }}"
+  register: module_config
+
+- template:
+    src: "{{ tf_provider.init }}"
+    dest: "{{ stackhead__tf_root_folder }}/{{ module }}.provider.tf"
+  when: tf_provider.init is defined and tf_provider.provider_per_project|d(false)
+  vars:
+    tf_provider: "{{ module_config.config.terraform.provider|default({}) }}"

ansible/roles/stackhead_module_api/tasks_internal/terraform/module.yml

@@ -3,5 +3,7 @@
 - set_fact:
     loaded_config: "{{ ansible_facts[module.name | getstackhead.stackhead.module_vars_name] }}"
 - set_fact:
-    loaded_terraform_providers: "{{ loaded_terraform_providers|default([]) + [loaded_config.terraform.provider] }}"
-  when: loaded_config.terraform is defined and loaded_config.terraform.provider is defined and loaded_config.terraform.provider.name and loaded_config.terraform.provider.vendor is defined and loaded_config.terraform.provider.version is defined
+    loaded_terraform_providers: "{{ loaded_terraform_providers|default([]) + [tf_provider] }}"
+  when: tf_provider.name is defined and  tf_provider.vendor is defined and tf_provider.version is defined and not tf_provider.provider_per_project|d(false)
+  vars:
+    tf_provider: "{{ loaded_config.terraform.provider|default({}) }}"

ansible/schemas/module-config.schema.json

@@ -28,6 +28,9 @@
             },
             "resource_name": {
               "type": "string"
+            },
+            "provider_per_project": {
+              "type": "boolean"
             }
           }
         }