Renamed backup roles

docs/analysis/Features.md

@@ -15,7 +15,7 @@ Every business is unique, and so is CyMaIS! With a modular architecture, it adap
 With automated updates, system health checks, and security audits, CyMaIS ensures your infrastructure is always up-to-date and running smoothly. Roles such as `sys-hlth-docker-container`, `sys-hlth-btrfs`, and `sys-hlth-webserver` help monitor system integrity.
 
 ## Uncompromised Security 🔒
-Security is a top priority! CyMaIS includes robust security features like full-disk encryption recommendations, 2FA enforcement, encrypted server deployments (`web-app-keycloak`, `svc-db-openldap`), and secure backup solutions (`sys-bkp-remote-to-local`, `svc-bkp-2-usb`).
+Security is a top priority! CyMaIS includes robust security features like full-disk encryption recommendations, 2FA enforcement, encrypted server deployments (`web-app-keycloak`, `svc-db-openldap`), and secure backup solutions (`sys-bkp-remote-to-local`, `svc-bkp-loc-2-usb`).
 
 ## User-Friendly with Expert Support 👩‍💻
 No need to be a Linux or Docker expert! CyMaIS simplifies deployment with intuitive role-based automation. Documentation and community support make IT administration accessible to all experience levels.

docs/guides/administrator/Readme.md

@@ -10,7 +10,7 @@ Follow these guides to install and configure CyMaIS:
 
 ## Key Responsibilities 🔧
 - **User Management** - Configure LDAP, Keycloak, and user permissions.
-- **Security & Backups** - Set up `sys-bkp-remote-to-local`, `svc-bkp-2-usb`, and `core-security` roles.
+- **Security & Backups** - Set up `sys-bkp-remote-to-local`, `svc-bkp-loc-2-usb`, and `core-security` roles.
 - **Application Hosting** - Deploy services like `Nextcloud`, `Matrix`, `Gitea`, and more.
 - **Networking & VPN** - Configure `WireGuard`, `OpenVPN`, and `Nginx Reverse Proxy`.
 

group_vars/all/05_maintenace.yml

@@ -13,10 +13,10 @@ system_maintenance_lock_timeout_restart_docker:    "{{system_maintenance_lock_ti
 
 ### Defined Services for Backup Tasks
 system_maintenance_backup_services:
-  - "sys-bkp-docker-to-local"
-  - "svc-sys-bkp-rmt-2-loc"
-  - "svc-bkp-2-usb"
-  - "sys-bkp-docker-to-local-everything"
+  - "sys-bkp-docker-2-loc"
+  - "svc-bkp-rmt-2-loc"
+  - "svc-bkp-loc-2-usb"
+  - "sys-bkp-docker-2-loc-everything"
 
 ### Defined Services for System Cleanup
 system_maintenance_cleanup_services:

roles/cmp-rdbms/tasks/main.yml

@@ -15,4 +15,4 @@
   when: applications | get_app_conf(application_id, 'features.central_database', False)
 
 - name: "For '{{ application_id }}': Add Entry for Backup Procedure"
-  include_tasks: "{{ playbook_dir }}/roles/sys-bkp-docker-to-local/tasks/seed-database-to-backup.yml"
+  include_tasks: "{{ playbook_dir }}/roles/sys-bkp-docker-2-loc/tasks/seed-database-to-backup.yml"

roles/docker-core/meta/main.yml

@@ -27,7 +27,7 @@ galaxy_info:
   documentation: "https://s.veen.world/cymais/docker"
 
 dependencies:
-  - sys-bkp-docker-to-local
+  - sys-bkp-docker-2-loc
   - user-administrator
   - sys-hlth-docker-container
   - sys-hlth-docker-volumes

roles/svc-bkp-2-usb/handlers/main.yml

@@ -1,5 +0,0 @@
-- name: "reload svc-bkp-2-usb.cymais.service"
-  systemd:
-    name: svc-bkp-2-usb.cymais.service
-    state: reloaded
-    daemon_reload: yes

roles/svc-bkp-loc-2-usb/files/svc-sys-bkp-data-to-usb.python

@@ -21,7 +21,7 @@ def main():
     machine_id = subprocess.run(["sha256sum", "/etc/machine-id"], capture_output=True, text=True).stdout.strip()[:64]
     print(f"machine id: {machine_id}")
     
-    versions_path = os.path.join(backup_to_usb_destination_path, f"{machine_id}/svc-bkp-2-usb/")
+    versions_path = os.path.join(backup_to_usb_destination_path, f"{machine_id}/svc-bkp-loc-2-usb/")
     print(f"versions path: {versions_path}")
     
     if not os.path.isdir(versions_path):

roles/svc-bkp-loc-2-usb/handlers/main.yml

@@ -0,0 +1,5 @@
+- name: "reload svc-bkp-loc-2-usb.cymais.service"
+  systemd:
+    name: svc-bkp-loc-2-usb.cymais.service
+    state: reloaded
+    daemon_reload: yes

roles/svc-bkp-loc-2-usb/tasks/main.yml

@@ -1,6 +1,6 @@
 - name: Copy backup script to the scripts directory
   copy:
-    src: svc-bkp-2-usb.python
+    src: svc-bkp-loc-2-usb.python
     dest: "{{ backup_to_usb_script_path }}"
     owner: root
     group: root
@@ -8,9 +8,9 @@
 
 - name: Copy systemd service to systemd directory
   template:
-    src: svc-bkp-2-usb.service.j2
-    dest: /etc/systemd/system/svc-bkp-2-usb.cymais.service
+    src: svc-bkp-loc-2-usb.service.j2
+    dest: /etc/systemd/system/svc-bkp-loc-2-usb.cymais.service
     owner: root
     group: root
     mode: '0644'
-  notify: reload svc-bkp-2-usb.cymais.service
+  notify: reload svc-bkp-loc-2-usb.cymais.service

roles/svc-bkp-loc-2-usb/vars/main.yml

@@ -1,6 +1,6 @@
-backup_to_usb_script_path: /usr/local/sbin/svc-bkp-2-usb.python
+backup_to_usb_script_path: /usr/local/sbin/svc-bkp-loc-2-usb.python
 backup_to_usb_destination: '{{backup_to_usb_mount}}{{backup_to_usb_destination_subdirectory}}'
 backups_folder_path: '{{backup_to_usb_destination}}'
 systemctl_mount_service_name: '{{ backup_to_usb_mount | trim(''/'') | replace(''/'',
   ''-'') }}.mount'
-application_id: svc-bkp-2-usb
+application_id: svc-bkp-loc-2-usb

roles/svc-bkp-rmt-2-loc/handlers/main.yml

@@ -0,0 +1,4 @@
+- name: "reload svc-bkp-rmt-2-loc service"
+  systemd:
+    name: svc-bkp-rmt-2-loc.cymais.service
+    daemon_reload: yes

roles/svc-bkp-rmt-2-loc/tasks/main.yml

@@ -4,17 +4,17 @@
     state: directory
     mode: 0755
 
-- name: create svc-sys-bkp-rmt-2-loc.sh
+- name: create svc-bkp-rmt-2-loc.sh
   copy:
-    src: svc-sys-bkp-rmt-2-loc.sh
-    dest: "{{docker_backup_remote_to_local_folder}}svc-sys-bkp-rmt-2-loc.sh"
+    src: svc-bkp-rmt-2-loc.sh
+    dest: "{{docker_backup_remote_to_local_folder}}svc-bkp-rmt-2-loc.sh"
     mode: 0755
 
-- name: create svc-sys-bkp-rmt-2-loc.cymais.service
+- name: create svc-bkp-rmt-2-loc.cymais.service
   template: 
-    src:  svc-sys-bkp-rmt-2-loc.service.j2 
-    dest: /etc/systemd/system/svc-sys-bkp-rmt-2-loc.cymais.service
-  notify: reload svc-sys-bkp-rmt-2-loc service
+    src:  svc-bkp-rmt-2-loc.service.j2 
+    dest: /etc/systemd/system/svc-bkp-rmt-2-loc.cymais.service
+  notify: reload svc-bkp-rmt-2-loc service
 
 - name: create backups-remote-to-local.sh
   template: 

roles/svc-bkp-rmt-2-loc/templates/backups-remote-to-local.sh.j2

@@ -3,6 +3,6 @@
 hosts="{{ pull_remote_backups | join(' ') }}";
 errors=0
 for host in $hosts; do
-  bash {{ docker_backup_remote_to_local_folder }}svc-sys-bkp-rmt-2-loc.sh $host || ((errors+=1));
+  bash {{ docker_backup_remote_to_local_folder }}svc-bkp-rmt-2-loc.sh $host || ((errors+=1));
 done;
 exit $errors;

roles/svc-bkp-rmt-2-loc/vars/main.yml

@@ -0,0 +1,2 @@
+docker_backup_remote_to_local_folder: '{{path_administrator_scripts}}svc-bkp-rmt-2-loc/'
+application_id: svc-bkp-rmt-2-loc

roles/svc-opt-ssd-hdd/templates/svc-opt-ssd-hdd.service.j2

@@ -4,5 +4,5 @@ OnFailure=sys-alm-compose.cymais@%n.service
 
 [Service]
 Type=oneshot
-ExecStartPre=/bin/sh -c '/usr/bin/python {{ path_system_lock_script }} {{ system_maintenance_services | join(' ')  }} --ignore svc-opt-ssd-hdd svc-sys-bkp-rmt-2-loc --timeout "{{system_maintenance_lock_timeout_storage_optimizer}}"'
+ExecStartPre=/bin/sh -c '/usr/bin/python {{ path_system_lock_script }} {{ system_maintenance_services | join(' ')  }} --ignore svc-opt-ssd-hdd svc-bkp-rmt-2-loc --timeout "{{system_maintenance_lock_timeout_storage_optimizer}}"'
 ExecStart=/bin/sh -c '/usr/bin/python {{storage_optimizer_script}} --rapid-storage-path {{path_rapid_storage}} --mass-storage-path {{path_mass_storage}}'

roles/svc-sys-bkp-rmt-2-loc/handlers/main.yml

@@ -1,4 +0,0 @@
-- name: "reload svc-sys-bkp-rmt-2-loc service"
-  systemd:
-    name: svc-sys-bkp-rmt-2-loc.cymais.service
-    daemon_reload: yes

roles/svc-sys-bkp-rmt-2-loc/vars/main.yml

@@ -1,2 +0,0 @@
-docker_backup_remote_to_local_folder: '{{path_administrator_scripts}}svc-sys-bkp-rmt-2-loc/'
-application_id: svc-sys-bkp-rmt-2-loc

roles/sys-bkp-directory-validator/README.md

@@ -2,7 +2,7 @@
 
 ## Description
 
-This Ansible role installs the [directory-validator](https://github.com/kevinveenbirkenbach/directory-validator.git). It is used by the sys-bkp-docker-to-local and sys-cln-faild-bkps roles to verify whether backups have been successfully created.
+This Ansible role installs the [directory-validator](https://github.com/kevinveenbirkenbach/directory-validator.git). It is used by the sys-bkp-docker-2-loc and sys-cln-faild-bkps roles to verify whether backups have been successfully created.
 
 ## Overview
 

roles/sys-bkp-docker-2-loc/README.md

@@ -2,7 +2,7 @@
 
 ## Description
 
-This Ansible role automates the process of backing up Docker volumes to a local folder. It pulls the [sys-bkp-docker-to-local repository](https://github.com/kevinveenbirkenbach/sys-bkp-docker-to-local.git), installs required software, configures systemd services for both standard and "everything" backup modes, and seeds backup database entries as needed.
+This Ansible role automates the process of backing up Docker volumes to a local folder. It pulls the [sys-bkp-docker-2-loc repository](https://github.com/kevinveenbirkenbach/sys-bkp-docker-2-loc.git), installs required software, configures systemd services for both standard and "everything" backup modes, and seeds backup database entries as needed.
 
 ## Overview
 
@@ -20,7 +20,7 @@ Backup Docker Volumes to Local is a comprehensive solution that leverages rsync
 ## Features
 
 - **Required Software Installation:** Installs necessary packages (e.g., lsof, python-pandas) via pacman.
-- **Git Repository Pull:** Automatically pulls the latest version of the [sys-bkp-docker-to-local repository](https://github.com/kevinveenbirkenbach/sys-bkp-docker-to-local.git).
+- **Git Repository Pull:** Automatically pulls the latest version of the [sys-bkp-docker-2-loc repository](https://github.com/kevinveenbirkenbach/sys-bkp-docker-2-loc.git).
 - **Systemd Service Configuration:** Deploys and reloads two systemd service templates to manage backup tasks.
 - **Database Seeding:** Includes tasks to seed and manage a backup database (`databases.csv`) for tracking backup details.
 - **Dependency Integration:** Works in conjunction with the dependent roles listed above to verify and manage backups.

roles/sys-bkp-docker-2-loc/handlers/main.yml

@@ -0,0 +1,9 @@
+- name: "reload sys-bkp-docker-2-loc-everything.cymais.service"
+  systemd:
+    name: sys-bkp-docker-2-loc-everything.cymais.service
+    daemon_reload: yes
+
+- name: "reload sys-bkp-docker-2-loc.cymais.service"
+  systemd:
+    name: sys-bkp-docker-2-loc.cymais.service
+    daemon_reload: yes

roles/sys-bkp-docker-2-loc/tasks/main.yml

@@ -21,18 +21,18 @@
   include_tasks: reset.yml 
   when: mode_reset | bool and run_once_bkp_docker_to_local is not defined
 
-- name: configure sys-bkp-docker-to-local-everything.cymais.service
+- name: configure sys-bkp-docker-2-loc-everything.cymais.service
   template: 
-    src: sys-bkp-docker-to-local-everything.service.j2
-    dest: /etc/systemd/system/sys-bkp-docker-to-local-everything.cymais.service
-  notify: reload sys-bkp-docker-to-local-everything.cymais.service
+    src: sys-bkp-docker-2-loc-everything.service.j2
+    dest: /etc/systemd/system/sys-bkp-docker-2-loc-everything.cymais.service
+  notify: reload sys-bkp-docker-2-loc-everything.cymais.service
   when: run_once_bkp_docker_to_local is not defined
 
-- name: configure sys-bkp-docker-to-local.cymais.service
+- name: configure sys-bkp-docker-2-loc.cymais.service
   template: 
-    src: sys-bkp-docker-to-local.service.j2
-    dest: /etc/systemd/system/sys-bkp-docker-to-local.cymais.service
-  notify: reload sys-bkp-docker-to-local.cymais.service
+    src: sys-bkp-docker-2-loc.service.j2
+    dest: /etc/systemd/system/sys-bkp-docker-2-loc.cymais.service
+  notify: reload sys-bkp-docker-2-loc.cymais.service
   when: run_once_bkp_docker_to_local is not defined
 
 - name: "set 'service_name' to '{{ role_name }}'"

roles/sys-bkp-docker-2-loc/templates/sys-bkp-docker-2-loc-everything.service.j2

@@ -4,6 +4,6 @@ OnFailure=sys-alm-compose.cymais@%n.service sys-cln-faild-bkps.cymais.service
 
 [Service]
 Type=oneshot
-ExecStartPre=/bin/sh -c '/usr/bin/python {{ path_system_lock_script }} {{ system_maintenance_services | join(' ')  }} --ignore {{ system_maintenance_backup_services | reject('equalto', 'sys-bkp-docker-to-local') | join(' ') }} --timeout "{{system_maintenance_lock_timeout_backup_services}}"'
+ExecStartPre=/bin/sh -c '/usr/bin/python {{ path_system_lock_script }} {{ system_maintenance_services | join(' ')  }} --ignore {{ system_maintenance_backup_services | reject('equalto', 'sys-bkp-docker-2-loc') | join(' ') }} --timeout "{{system_maintenance_lock_timeout_backup_services}}"'
 ExecStart=/bin/sh -c '/usr/bin/python {{backup_docker_to_local_folder}}backup-docker-to-local.py --compose-dir {{path_docker_compose_instances}} --everything'
 ExecStartPost=/bin/sh -c '/bin/systemctl start sys-rpr-docker-soft.cymais.service &'

roles/sys-bkp-docker-2-loc/templates/sys-bkp-docker-2-loc.service.j2

@@ -4,6 +4,6 @@ OnFailure=sys-alm-compose.cymais@%n.service sys-cln-faild-bkps.cymais.service
 
 [Service]
 Type=oneshot
-ExecStartPre=/bin/sh -c '/usr/bin/python {{ path_system_lock_script }} {{ system_maintenance_services | join(' ')  }} --ignore {{ system_maintenance_backup_services | reject('equalto', 'sys-bkp-docker-to-local-everything') | join(' ') }} --timeout "{{system_maintenance_lock_timeout_backup_services}}"'
+ExecStartPre=/bin/sh -c '/usr/bin/python {{ path_system_lock_script }} {{ system_maintenance_services | join(' ')  }} --ignore {{ system_maintenance_backup_services | reject('equalto', 'sys-bkp-docker-2-loc-everything') | join(' ') }} --timeout "{{system_maintenance_lock_timeout_backup_services}}"'
 ExecStart=/bin/sh -c '/usr/bin/python {{backup_docker_to_local_folder}}backup-docker-to-local.py --compose-dir {{path_docker_compose_instances}}'
 ExecStartPost=/bin/sh -c '/bin/systemctl start sys-rpr-docker-soft.cymais.service &'

roles/sys-bkp-docker-to-local/handlers/main.yml

@@ -1,9 +0,0 @@
-- name: "reload sys-bkp-docker-to-local-everything.cymais.service"
-  systemd:
-    name: sys-bkp-docker-to-local-everything.cymais.service
-    daemon_reload: yes
-
-- name: "reload sys-bkp-docker-to-local.cymais.service"
-  systemd:
-    name: sys-bkp-docker-to-local.cymais.service
-    daemon_reload: yes

roles/sys-bkp-provider-user/files/ssh-wrapper.sh

@@ -12,8 +12,8 @@ hashed_machine_id="$($get_hashed_machine_id | head -c 64)"
 get_backup_types="find /Backups/$hashed_machine_id/ -maxdepth 1 -type d -execdir basename {} ;";
 
 
-# @todo This configuration is not scalable yet. If other backup services then sys-bkp-docker-to-local are integrated, this logic needs to be optimized
-get_version_directories="ls -d /Backups/$hashed_machine_id/sys-bkp-docker-to-local/*"
+# @todo This configuration is not scalable yet. If other backup services then sys-bkp-docker-2-loc are integrated, this logic needs to be optimized
+get_version_directories="ls -d /Backups/$hashed_machine_id/sys-bkp-docker-2-loc/*"
 last_version_directory="$($get_version_directories | tail -1)"
 rsync_command="sudo rsync --server --sender -blogDtpre.iLsfxCIvu . $last_version_directory/"
 

roles/sys-rpr-docker-soft/files/sys-rpr-docker-soft.py

@@ -40,7 +40,7 @@ def main(base_directory):
     
     while blocker_running:
         try: 
-            bash("systemctl is-active --quiet sys-bkp-docker-to-local.cymais.service")
+            bash("systemctl is-active --quiet sys-bkp-docker-2-loc.cymais.service")
             bash("systemctl is-active --quiet update-docker.cymais.service")
             print("Backup is running.")
             print(f"Trying again in {waiting_time} seconds.")

roles/update-docker/tasks/main.yml

@@ -1,6 +1,6 @@
-- name: "start sys-bkp-docker-to-local-everything.cymais.service"
+- name: "start sys-bkp-docker-2-loc-everything.cymais.service"
   systemd:
-    name: sys-bkp-docker-to-local-everything.cymais.service
+    name: sys-bkp-docker-2-loc-everything.cymais.service
     state: started
   when: mode_backup | bool
 

roles/web-app-bigbluebutton/tasks/main.yml

@@ -10,7 +10,7 @@
     database_name:      ""                              # Multiple databases
 
 - name:                 "Seed BigBlueButton Database for Backup"
-  include_tasks:        "{{ playbook_dir }}/roles/sys-bkp-docker-to-local/tasks/seed-database-to-backup.yml"
+  include_tasks:        "{{ playbook_dir }}/roles/sys-bkp-docker-2-loc/tasks/seed-database-to-backup.yml"
   vars:
     database_instance:  "{{ application_id }}"
     database_password:  "{{ applications | get_app_conf(application_id, 'credentials.postgresql_secret', True) }}"

roles/web-app-matrix/tasks/create-and-seed-database.yml

@@ -10,4 +10,4 @@
   when: applications | get_app_conf(application_id, 'features.central_database', False)
 
 - name: "include seed-database-to-backup.yml"
-  include_tasks: "{{ playbook_dir }}/roles/sys-bkp-docker-to-local/tasks/seed-database-to-backup.yml"
+  include_tasks: "{{ playbook_dir }}/roles/sys-bkp-docker-2-loc/tasks/seed-database-to-backup.yml"

roles/web-app-nextcloud/docs/Update.md

@@ -43,8 +43,8 @@ and disable any non-functioning apps.
 ```bash
 cd {{path_docker_compose_instances}}nextcloud &&
 docker-compose down &&
-docker-compose exec -i database mysql -u nextcloud -pPASSWORT nextcloud < "/Backups/$(sha256sum /etc/machine-id | head -c 64)/sys-bkp-docker-to-local/latest/nextcloud_database/sql/backup.sql" &&
-cd {{path_administrator_scripts}}sys-bkp-docker-to-local &&
+docker-compose exec -i database mysql -u nextcloud -pPASSWORT nextcloud < "/Backups/$(sha256sum /etc/machine-id | head -c 64)/sys-bkp-docker-2-loc/latest/nextcloud_database/sql/backup.sql" &&
+cd {{path_administrator_scripts}}sys-bkp-docker-2-loc &&
 bash ./recover-web-app-from-local.sh "nextcloud_data" "$(sha256sum /etc/machine-id | head -c 64)"
 ```