feat(config): support emptying config

The removal option is not suitable for systems where Salt is installed
from distribution packages which place back a default configuration.
Allow emptying the file instead of removing it, to benefit from removing
any undesired, unmanaged, configuration changes in it, whilst not
causing ping-pong between Salt and package updates.

Signed-off-by: Georg Pfuetzenreuter <[email protected]>

Author: tacerus

pillar.example

@@ -10,9 +10,15 @@ salt:
   # This state will remove "/etc/salt/minion" when you set this to true.
   minion_remove_config: true
 
+  # /etc/salt/minion will be emptied if you set this to true.
+  minion_empty_config: true
+
   # This state will remove "/etc/salt/master" when you set this to true.
   master_remove_config: true
 
+  # /etc/salt/master will be emptied if you set this to true.
+  master_empty_config: true
+
   # Set this to 'py3' to install the Python 3 packages.
   # The default varies between OS versions.
   py_ver: 'py3'

salt/defaults.yaml

@@ -16,7 +16,9 @@ salt:
   config_path: /etc/salt
 
   minion_remove_config: false
+  minion_empty_config: false
   master_remove_config: false
+  master_empty_config: false
   minion_config_use_TOFS: false
   master_config_use_TOFS: false
 

salt/master.sls

@@ -72,6 +72,12 @@ remove-default-master-conf-file:
     - name: {{ salt_settings.config_path }}/master
     - watch_in:
       - service: salt-master
+    {% elif salt_settings.master_empty_config %}
+empty-default-master-conf-file:
+  file.managed:
+    - name: {{ salt_settings.config_path }}/master
+    - contents: |
+        # Configuration is managed by Salt
     {% endif %}
 
 # clean up old _defaults.conf file if they have it around

salt/minion.sls

@@ -181,6 +181,12 @@ salt-minion-beacon-inotify:
 remove-default-minion-conf-file:
   file.absent:
     - name: {{ salt_settings.config_path }}/minion
+    {% elif salt_settings.minion_empty_config %}
+empty-default-minion-conf-file:
+  file.managed:
+    - name: {{ salt_settings.config_path }}/master
+    - contents: |
+        # Configuration is managed by Salt
     {% endif %}
 
 # clean up old _defaults.conf file if they have it around

test/integration/default/files/_mapdata/almalinux-8.yaml

@@ -80,6 +80,7 @@ values:
         base:
         - /srv/pillar
     minion_config_use_TOFS: false
+    minion_empty_config: false
     minion_remove_config: false
     minion_service: salt-minion
     minion_service_details:

test/integration/default/files/_mapdata/almalinux-9.yaml

@@ -80,6 +80,7 @@ values:
         base:
         - /srv/pillar
     minion_config_use_TOFS: false
+    minion_empty_config: false
     minion_remove_config: false
     minion_service: salt-minion
     minion_service_details:

test/integration/default/files/_mapdata/amazonlinux-2.yaml

@@ -80,6 +80,7 @@ values:
         base:
         - /srv/pillar
     minion_config_use_TOFS: false
+    minion_empty_config: false
     minion_remove_config: false
     minion_service: salt-minion
     minion_service_details:

test/integration/default/files/_mapdata/amazonlinux-2023.yaml

@@ -80,6 +80,7 @@ values:
         base:
         - /srv/pillar
     minion_config_use_TOFS: false
+    minion_empty_config: false
     minion_remove_config: false
     minion_service: salt-minion
     minion_service_details:

test/integration/default/files/_mapdata/arch-base-latest.yaml

@@ -80,6 +80,7 @@ values:
         base:
         - /srv/pillar
     minion_config_use_TOFS: false
+    minion_empty_config: false
     minion_remove_config: false
     minion_service: salt-minion
     minion_service_details:

test/integration/default/files/_mapdata/centos-7.yaml

@@ -80,6 +80,7 @@ values:
         base:
         - /srv/pillar
     minion_config_use_TOFS: false
+    minion_empty_config: false
     minion_remove_config: false
     minion_service: salt-minion
     minion_service_details: