chore: refactor into record tasks files

.github/workflows/release.yml

@@ -4,17 +4,10 @@ name: Release
 # This release workflow requires the following environment variables:
 # - galaxy_api_key (API key for Ansible Galaxy)
 
-# disable GH action for template
-# remove and uncommment below "on" block when using in production
 on:
   push:
-    branches-ignore:
-      - '**'
-
-#on:
-#  push:
-#    branches:
-#    - master
+    branches:
+    - master
 
 jobs:
   release:

.github/workflows/test.yml

@@ -81,7 +81,7 @@ jobs:
         wait_for_ssh: 1
       env:
         API_TOKEN: ${{ secrets.HETZNER_TOKEN }}
-    - uses: getstackhead/stackhead/actions/integration-test@feature/dns-support
+    - uses: getstackhead/stackhead/actions/integration-test@next
       with:
         ipaddress: ${{ steps.setup_server.outputs.hcloud_server_created_ipv4 }}
         domain: '${{ env.DOMAIN_NAME }}.${{ env.DOMAIN_SUFFIX }}'

README.md

@@ -4,6 +4,8 @@ StackHead module for Cloudflare DNS.
 
 ## Installation
 
+### Ansible
+
 Install it via `ansible-galaxy`:
 
 ```
@@ -27,12 +29,11 @@ all:
           # ...
 ```
 
-
 ## Configuration
 
-Make sure to provide the API token for Cloudflare via StackHead CLI configuration file.
+### API Token
 
-You can generate an API token [in your Cloudflare profile](https://dash.cloudflare.com/profile/api-tokens).
+Make sure to provide the API token for Cloudflare. You can generate an API token [in your Cloudflare profile](https://dash.cloudflare.com/profile/api-tokens).
 Make sure to grant `write` permissions to DNS on Zone level.
 
 ```yaml
@@ -50,6 +51,8 @@ stackhead__config_deployment:
     cloudflare_api_token: MY-API-TOKEN
 ```
 
+### Domain setting
+
 You'll also have to define the DNS provider to be used for each domain you want to set up in project definition:
 
 ```yaml

stackhead-module.yml

@@ -1,2 +1,4 @@
 ---
+constraints:
+  - stackhead>=1.3.0
 type: dns

tasks/steps/deploy.yml

@@ -5,14 +5,9 @@
     that:
       - module.config.cloudflare_api_token|d("") != ""
 - name: "Create A record for domain {{ item.domain }}"
-  cloudflare_dns:
-    zone: "{{ item.domain|getstackhead.stackhead.domain }}"
-    record: "{{ item.domain|getstackhead.stackhead.subdomain|d('@', true) }}"
-    type: A
-    value: "{{ ansible_ssh_host }}"
-    api_token: "{{ module.config.cloudflare_api_token }}"
-    proxied: no
-    solo: yes
+  include_tasks: "{{ module_role_path | default(role_path) }}/tasks/steps/records/a.yml"
+  vars:
+    domain: "{{ item.domain }}"
     state: present
-  when: item.dns.provider|d('') == 'cloudflare'
+  when: item.dns.provider|d('') == 'getstackhead.stackhead_dns_cloudflare'
   with_items: "{{ app_config.domains }}" # item.domain

tasks/steps/destroy.yml

@@ -5,12 +5,9 @@
     that:
       - module.config.cloudflare_api_token|d("") != ""
 - name: "Remove A record for domain {{ item.domain }}"
-  cloudflare_dns:
-    zone: "{{ item.domain|getstackhead.stackhead.domain }}"
-    record: "{{ item.domain|getstackhead.stackhead.subdomain|d('@', true) }}"
-    type: A
-    value: "{{ ansible_ssh_host }}"
-    api_token: "{{ module.config.cloudflare_api_token }}"
+  include_tasks: "{{ module_role_path | default(role_path) }}/tasks/steps/records/a.yml"
+  vars:
+    domain: "{{ item.domain }}"
     state: absent
-  when: item.dns.provider|d('') == 'cloudflare'
+  when: item.dns.provider|d('') == 'getstackhead.stackhead_dns_cloudflare'
   with_items: "{{ app_config.domains }}" # item.domain

tasks/steps/records/a.yml

@@ -0,0 +1,26 @@
+# required vars:
+#   - domain
+#   - state
+# optional vars:
+#   - proxied
+#   - solo
+---
+- cloudflare_dns:
+    zone: "{{ domain|getstackhead.stackhead.domain }}"
+    record: "{{ domain|getstackhead.stackhead.subdomain|d('@', true) }}"
+    type: A
+    value: "{{ ansible_ssh_host }}"
+    api_token: "{{ module.config.cloudflare_api_token }}"
+    proxied: "{{ proxied|d(false) }}"
+    solo: "{{ solo|d(true) }}"
+    state: present
+  when: state == 'present'
+- cloudflare_dns:
+    zone: "{{ domain|getstackhead.stackhead.domain }}"
+    record: "{{ domain|getstackhead.stackhead.subdomain|d('@', true) }}"
+    type: A
+    value: "{{ ansible_ssh_host }}"
+    api_token: "{{ module.config.cloudflare_api_token }}"
+    proxied: "{{ proxied|d(false) }}"
+    state: "{{ state }}"
+  when: state != 'present'

tasks/steps/records/aaaa.yml

@@ -0,0 +1,26 @@
+# required vars:
+#   - domain
+#   - state
+# optional vars:
+#   - proxied
+#   - solo
+---
+- cloudflare_dns:
+    zone: "{{ domain|getstackhead.stackhead.domain }}"
+    record: "{{ domain|getstackhead.stackhead.subdomain|d('@', true) }}"
+    type: AAAA
+    value: "{{ ansible_ssh_host }}"
+    api_token: "{{ module.config.cloudflare_api_token }}"
+    proxied: "{{ proxied|d(false) }}"
+    solo: "{{ solo|d(true) }}"
+    state: present
+  when: state == 'present'
+- cloudflare_dns:
+    zone: "{{ domain|getstackhead.stackhead.domain }}"
+    record: "{{ domain|getstackhead.stackhead.subdomain|d('@', true) }}"
+    type: AAAA
+    value: "{{ ansible_ssh_host }}"
+    api_token: "{{ module.config.cloudflare_api_token }}"
+    proxied: "{{ proxied|d(false) }}"
+    state: "{{ state }}"
+  when: state != 'present'

tasks/steps/records/cname.yml

@@ -0,0 +1,27 @@
+# required vars:
+#   - domain
+#   - value
+#   - state
+# optional vars:
+#   - proxied
+#   - solo
+---
+- cloudflare_dns:
+    zone: "{{ domain|getstackhead.stackhead.domain }}"
+    record: "{{ domain|getstackhead.stackhead.subdomain|d('@', true) }}"
+    type: CNAME
+    value: "{{ value }}"
+    api_token: "{{ module.config.cloudflare_api_token }}"
+    proxied: "{{ proxied|d(false) }}"
+    solo: "{{ solo|d(true) }}"
+    state: present
+  when: state == 'present'
+- cloudflare_dns:
+    zone: "{{ domain|getstackhead.stackhead.domain }}"
+    record: "{{ domain|getstackhead.stackhead.subdomain|d('@', true) }}"
+    type: CNAME
+    value: "{{ value }}"
+    api_token: "{{ module.config.cloudflare_api_token }}"
+    proxied: "{{ proxied|d(false) }}"
+    state: "{{ state }}"
+  when: state != 'present'

tasks/steps/records/mx.yml

@@ -0,0 +1,29 @@
+# required vars:
+#   - domain
+#   - value
+#   - state
+# optional vars:
+#   - proxied
+#   - solo
+---
+- cloudflare_dns:
+    zone: "{{ domain|getstackhead.stackhead.domain }}"
+    record: "{{ domain|getstackhead.stackhead.subdomain|d('@', true) }}"
+    type: MX
+    priority: 1
+    value: "{{ value }}"
+    api_token: "{{ module.config.cloudflare_api_token }}"
+    proxied: "{{ proxied|d(false) }}"
+    solo: "{{ solo|d(true) }}"
+    state: present
+  when: state == 'present'
+- cloudflare_dns:
+    zone: "{{ domain|getstackhead.stackhead.domain }}"
+    record: "{{ domain|getstackhead.stackhead.subdomain|d('@', true) }}"
+    type: MX
+    priority: 1
+    value: "{{ value }}"
+    api_token: "{{ module.config.cloudflare_api_token }}"
+    proxied: "{{ proxied|d(false) }}"
+    state: "{{ state }}"
+  when: state != 'present'

tasks/steps/records/spf.yml

@@ -0,0 +1,27 @@
+# required vars:
+#   - domain
+#   - value
+#   - state
+# optional vars:
+#   - proxied
+#   - solo
+---
+- cloudflare_dns:
+    zone: "{{ domain|getstackhead.stackhead.domain }}"
+    record: "{{ domain|getstackhead.stackhead.subdomain|d('@', true) }}"
+    type: SPF
+    value: "{{ value }}"
+    api_token: "{{ module.config.cloudflare_api_token }}"
+    proxied: "{{ proxied|d(false) }}"
+    solo: "{{ solo|d(true) }}"
+    state: present
+  when: state == 'present'
+- cloudflare_dns:
+    zone: "{{ domain|getstackhead.stackhead.domain }}"
+    record: "{{ domain|getstackhead.stackhead.subdomain|d('@', true) }}"
+    type: SPF
+    value: "{{ value }}"
+    api_token: "{{ module.config.cloudflare_api_token }}"
+    proxied: "{{ proxied|d(false) }}"
+    state: "{{ state }}"
+  when: state != 'present'

tasks/steps/records/txt.yml

@@ -0,0 +1,27 @@
+# required vars:
+#   - domain
+#   - value
+#   - state
+# optional vars:
+#   - proxied
+#   - solo
+---
+- cloudflare_dns:
+    zone: "{{ domain|getstackhead.stackhead.domain }}"
+    record: "{{ domain|getstackhead.stackhead.subdomain|d('@', true) }}"
+    type: TXT
+    value: "{{ value }}"
+    api_token: "{{ module.config.cloudflare_api_token }}"
+    proxied: "{{ proxied|d(false) }}"
+    solo: "{{ solo|d(true) }}"
+    state: present
+  when: state == 'present'
+- cloudflare_dns:
+    zone: "{{ domain|getstackhead.stackhead.domain }}"
+    record: "{{ domain|getstackhead.stackhead.subdomain|d('@', true) }}"
+    type: TXT
+    value: "{{ value }}"
+    api_token: "{{ module.config.cloudflare_api_token }}"
+    proxied: "{{ proxied|d(false) }}"
+    state: "{{ state }}"
+  when: state != 'present'