mounts: refactor rclone toggle

defaults/settings.yml.default

@@ -4,6 +4,7 @@ authelia:
   subdomain: login
 downloads: /mnt/unionfs/downloads
 rclone:
+  enabled: true
   remotes:
     - remote: google
       template: google

inventories/group_vars/all.yml

@@ -65,7 +65,9 @@ rclone_remote_is_defined: "{{ (rclone is defined) and
                               (rclone.remotes is not none) and
                               (rclone.remotes | length > 0) }}"
 
-use_remote: true
+use_cloudplow: "{{ rclone_remote_is_defined and use_remote }}"
+
+use_remote: "{{ rclone.enabled }}"
 
 use_nvidia: "{{ gpu.nvidia | bool }}"
 

roles/docker/tasks/main.yml

@@ -37,7 +37,7 @@
   ansible.builtin.set_fact:
     _remotes_services_list: "{{ _remotes_services_list | default('') + (rclone_service_template + item.remote + '.service ') }}"
   with_items: "{{ rclone.remotes }}"
-  when: rclone_remote_is_defined
+  when: rclone_remote_is_defined and use_remote
 
 - name: Tasks for when Docker exists and is running
   when: docker_binary.stat.exists and docker_service_running

roles/docker/templates/override.conf.j2

@@ -9,9 +9,9 @@
 #########################################################################
 
 [Unit]
-{% if rclone_remote_is_defined and not continuous_integration %}
-After={{ _remotes_services_list if rclone_remote_is_defined else '' }}{{ docker_service_after }}
-Requires={{ _remotes_services_list if rclone_remote_is_defined else '' }}{{ docker_service_after }}
+{% if rclone_remote_is_defined and use_remote and not continuous_integration %}
+After={{ _remotes_services_list }}{{ docker_service_after }}
+Requires={{ _remotes_services_list }}{{ docker_service_after }}
 {% else %}
 After={{ docker_service_after }}
 Requires={{ docker_service_after }}

roles/remote/tasks/main.yml

@@ -102,4 +102,4 @@
 - name: Remote Tasks
   ansible.builtin.include_tasks: "remote.yml"
   with_items: "{{ rclone.remotes }}"
-  when: rclone_remote_is_defined
+  when: rclone_remote_is_defined and use_remote

roles/scripts/tasks/main.yml

@@ -135,7 +135,7 @@
     group: "{{ user.name }}"
     mode: "0775"
     force: true
-  when: rclone_remote_is_defined
+  when: rclone_remote_is_defined and use_remote
 
 - name: Import 'download_torrents_from_rclone_remote.sh'
   ansible.builtin.template:
@@ -145,7 +145,7 @@
     group: "{{ user.name }}"
     mode: "0775"
     force: true
-  when: rclone_remote_is_defined
+  when: rclone_remote_is_defined and use_remote
 
 - name: Import 'StickyDownloadQueue.py'
   ansible.builtin.get_url:

roles/settings/files/settings-updater.py

@@ -93,8 +93,12 @@ def is_remote_entry(thing):
     return ret_val
 
 def _inner_upgrade(settings1, settings2, key=None, overwrite=False):
+    if isinstance(settings2, (dict, list)):
+        merged = settings2.copy()
+    else:
+        merged = settings2
+
     sub_upgraded = False
-    merged = settings2.copy()
 
     if isinstance(settings1, dict):
         for k, v in settings1.items():
@@ -109,22 +113,38 @@ def _inner_upgrade(settings1, settings2, key=None, overwrite=False):
                 continue
 
             # iterate children
-            if isinstance(v, dict) or isinstance(v, list):
+            if isinstance(v, dict):
                 merged[k], did_upgrade = _inner_upgrade(settings1[k], settings2[k], key=k,
-                                                                overwrite=overwrite)
+                                                            overwrite=overwrite)
                 sub_upgraded = did_upgrade if did_upgrade else sub_upgraded
+            elif isinstance(v, list):
+                # check if the corresponding value in settings2 is also a list
+                if isinstance(settings2[k], list):
+                    merged[k], did_upgrade = _inner_upgrade(settings1[k], settings2[k], key=k,
+                                                                overwrite=overwrite)
+                    sub_upgraded = did_upgrade if did_upgrade else sub_upgraded
+                else:
+                    # if it's not a list, use the default list from settings1
+                    merged[k] = v
+                    sub_upgraded = True
+                    log.info("Mismatched type for %r. Used default value: %s", str(k), str(v))
             elif settings1[k] != settings2[k] and overwrite:
                 merged = settings1
                 sub_upgraded = True
     elif isinstance(settings1, list) and key:
-        for v in settings1:
-            is_remote = is_remote_entry(v)
-            might_not_want_it = len(settings2) > 0
-            if v not in settings2 and not is_remote and not might_not_want_it:
-                merged.append(v)
-                sub_upgraded = True
-                log.info("Added to setting %r: %s", str(key), str(v))
-                continue
+        # check if settings2 is also a list
+        if isinstance(settings2, list):
+            for v in settings1:
+                if v not in settings2:
+                    merged.append(v)
+                    sub_upgraded = True
+                    log.info("Added to setting %r: %s", str(key), str(v))
+                    continue
+        else:
+            # if settings2 is not a list, use the default list from settings1
+            merged = settings1
+            sub_upgraded = True
+            log.info("Mismatched type for %r. Used default value: %s", str(key), str(settings1))
 
     return merged, sub_upgraded
 

roles/settings/tasks/subtasks/migrator/settings_yml/migration_01.yml

@@ -39,11 +39,18 @@
 
 - name: Migrator | 'settings.yml' | Migration 01 | Create 'rclone.remotes' dict
   ansible.builtin.shell: |
-    yyq e -i '.rclone.remotes = ""' {{ playbook_dir }}/{{ file }}
+    yyq e -i '.rclone.remotes += [{"remote": "google", "template": "google", "cache": {"enabled": false, "size": "50G", "max_age": "504h"}, "port": 5572}]' {{ playbook_dir }}/{{ file }}
   become: true
   become_user: "{{ saltbox_yml.stat.pw_name }}"
   when: (rclone.remotes is undefined) and not rclone_remote_is_defined
 
+- name: Migrator | 'settings.yml' | Migration 01 | Create 'rclone.enabled' dict
+  ansible.builtin.shell: |
+    yyq e -i '.rclone.enabled = {{ "true" if rclone_remote_is_defined else "false" }}' {{ playbook_dir }}/{{ file }}
+  become: true
+  become_user: "{{ saltbox_yml.stat.pw_name }}"
+  when: (rclone.enabled is undefined)
+
 - name: Migrator | 'adv_settings.yml' | Migration 01 | Remove 'null' values
   ansible.builtin.replace:
     path: "{{ playbook_dir }}/{{ file }}"

roles/unionfs/tasks/subtasks/docker/daemon.yml

@@ -11,7 +11,7 @@
   ansible.builtin.set_fact:
     _remotes_services_list: "{{ _remotes_services_list | default('') + (rclone_service_template + item.remote + '.service ') }}"
   with_items: "{{ rclone.remotes }}"
-  when: rclone_remote_is_defined
+  when: rclone_remote_is_defined and use_remote
 
 - name: "Docker | Daemon | Create override directory"
   ansible.builtin.file:

roles/unionfs/tasks/subtasks/variables.yml

@@ -15,7 +15,7 @@
   ansible.builtin.set_fact:
     _remotes_list: "{{ _remotes_list | default('') + '/mnt/remote/' + item.remote + '=NC:' }}"
   with_items: "{{ rclone.remotes }}"
-  when: rclone_remote_is_defined and (item.remote != "feeder")
+  when: rclone_remote_is_defined and use_remote and (item.remote != "feeder")
 
 - name: Variables | Append 'custom_mount_branch' to '_remotes_list' variable
   ansible.builtin.set_fact:

saltbox.yml

@@ -41,7 +41,7 @@
     - { role: overseerr, tags: ['saltbox', 'mediabox', 'overseerr'] }
     - { role: portainer, tags: ['saltbox', 'feederbox', 'portainer'] }
     - { role: organizr, tags: ['saltbox', 'feederbox', 'organizr'] }
-    - { role: cloudplow, tags: ['saltbox', 'feederbox', 'cloudplow'], when: ['rclone_remote_is_defined'] }
+    - { role: cloudplow, tags: ['saltbox', 'feederbox', 'cloudplow'], when: ['use_cloudplow'] }
     - { role: sonarr, tags: ['saltbox', 'feederbox', 'sonarr'] }
     - { role: radarr, tags: ['saltbox', 'feederbox', 'radarr'] }
     - { role: lidarr, tags: ['saltbox', 'feederbox', 'lidarr'] }