add object store cleanup script

group_vars/maintenance.yml

@@ -19,6 +19,16 @@ galaxy_user:
   uid: 999
   shell: /bin/bash
 
+# *****************************************************************************************
+# WARNING: Adding or modifying entries in `galaxy_cleanup_scratchstorage` will cause data
+#          in the specified object stores to be **deleted** after the defined retention
+#          period (e.g., `days: 60`).  Ensure you only include object stores that are meant
+#          to be cleaned up, and double‑check the `objectstore_id` values before saving.
+# *****************************************************************************************
+galaxy_cleanup_scratchstorage:
+  - objectstore_id: 's3_scratch_netapp01'
+    days: 60
+
 # Role: hxr.postgres-connection
 # Role: usegalaxy-eu.galaxy-slurp
 postgres_user: galaxy

maintenance.yml

@@ -141,6 +141,7 @@
     - galaxyproject.gxadmin
     - usegalaxy-eu.galaxy-slurp
     - usegalaxy_eu.fs_maintenance
+    - usegalaxy_eu.galaxy_cleanup # Cleanup the Galaxy objectstores and old datasets
     # - usegalaxy-eu.htcondor_release
     # - usegalaxy-eu.fix-unscheduled-workflows
     - usegalaxy-eu.fix-ancient-ftp-data

roles/usegalaxy_eu.galaxy_cleanup/defaults/main.yml

@@ -0,0 +1,18 @@
+---
+# Example:
+# galaxy_cleanup_scratchstorage:
+#   - objectstore_id: ''
+#     days: 60
+
+# *****************************************************************************************
+# WARNING: Adding or modifying entries in `galaxy_cleanup_objectstores` will cause data
+#          in the specified object stores to be **deleted** after the defined retention
+#          period (e.g., `days: 60`).  Ensure you only include object stores that are meant
+#          to be cleaned up, and double‑check the `objectstore_id` values before saving.
+# *****************************************************************************************
+galaxy_cleanup_scratchstorage: []
+
+# Cron schedule for galaxy cleanup objectstores script
+# Default: runs daily at 1:00 AM
+galaxy_cleanup_minute: 0
+galaxy_cleanup_hour: 1

roles/usegalaxy_eu.galaxy_cleanup/tasks/main.yml

@@ -0,0 +1,25 @@
+---
+- name: Check that all objectstore_id include 'scratch'
+  assert:
+    that:
+      - galaxy_cleanup_scratchstorage | length > 0
+      - galaxy_cleanup_scratchstorage
+        | rejectattr('objectstore_id', 'search', 'scratch')
+        | list
+        | length == 0
+    fail_msg: "Found objectstore_id entries that do NOT contain 'scratch'"
+    success_msg: "All objectstore_id values contain 'scratch'"
+
+- name: Install cleanup scratch script
+  template:
+    src: "clean_scratch_storage.sh.j2"
+    dest: "/usr/local/bin/clean_scratch_storage.sh"
+    mode: "0555"
+
+- name: Schedule Galaxy cleanup objectstore script
+  ansible.builtin.cron:
+    name: "Galaxy cleanup scratch"
+    job: "/usr/local/bin/clean_scratch_storage.sh"
+    minute: "{{ galaxy_cleanup_minute }}"
+    hour: "{{ galaxy_cleanup_hour }}"
+    user: "{{ galaxy_user.name }}"

roles/usegalaxy_eu.galaxy_cleanup/templates/clean_scratch_storage.sh.j2

@@ -0,0 +1,9 @@
+#!/bin/sh
+##
+## This file is maintained by Ansible - CHANGES WILL BE OVERWRITTEN
+##
+set -e
+
+{% for item in galaxy_cleanup_scratchstorage %}
+{{ galaxy_venv_dir }}/bin/python {{ galaxy_server_dir }}/scripts/cleanup_datasets/pgcleanup.py -c {{ galaxy_config_file }} -o {{ item.days }} -l {{ galaxy_log_dir }} -w 128MB --object-store-id {{ item.objectstore_id }} purge_old_hdas 2>&1 | tee -a {{ galaxy_log_dir }}/cleanup-$(date --rfc-3339=seconds)-purge_old_hdas.log
+{% endfor %}