#4019: Add housekeeping to RTW

Author: ehogan

doc/sphinx/source/utils/RTW/common.txt

@@ -11,6 +11,7 @@
 .. |KGOs| replace:: :term:`KGOs`
 .. |KGO| replace:: :term:`KGOs`
 .. |Rose| replace:: :term:`Rose`
+.. |rose_prune| replace:: ``rose_prune``
 
 .. Links
 
@@ -24,6 +25,7 @@
 .. _ESMValTool PR #3664: https://github.com/ESMValGroup/ESMValTool/pull/3664
 .. _jasmin-recipes.jinja: https://github.com/ESMValGroup/ESMValTool/blob/main/esmvaltool/utils/recipe_test_workflow/site/jasmin-recipes.jinja
 .. _Jinja2: https://jinja.palletsprojects.com/en/stable/
+.. _metoffice-recipes.jinja: https://github.com/ESMValGroup/ESMValTool/blob/main/esmvaltool/utils/recipe_test_workflow/site/metoffice-recipes.jinja
 .. _new ESMValTool issue: https://github.com/ESMValGroup/ESMValTool/issues/new
 .. _Rose Documentation: https://metomi.github.io/rose/doc/html/index.html
-.. _metoffice-recipes.jinja: https://github.com/ESMValGroup/ESMValTool/blob/main/esmvaltool/utils/recipe_test_workflow/site/metoffice-recipes.jinja
+.. _rose_prune: https://metomi.github.io/rose/doc/html/api/built-in/rose_prune.html

doc/sphinx/source/utils/RTW/user_guide/workflow.rst

@@ -65,6 +65,17 @@ The |RTW| performs the following steps:
      Runs each cycle for every recipe defined in the |RTW| after ``process``
      has completed
 
+``housekeeping``
+  :Description:
+     Removes the logs and data (including recipe outputs)
+     from two days or more before the current cycle
+  :Runs on:
+     Localhost
+  :Executes:
+     The |rose_prune|_ application
+  :Details:
+     Runs at the end of each cycle (except the first cycle)
+
 Design considerations
 ---------------------
 

esmvaltool/utils/recipe_test_workflow/app/housekeeping/rose-app.conf

@@ -0,0 +1,7 @@
+meta=rose_prune
+mode=rose_prune
+
+[prune]
+prune-remote-logs-at=-P2D
+prune{share/cycle}=-P2D
+prune{work}=-P2D

esmvaltool/utils/recipe_test_workflow/flow.cylc

@@ -45,6 +45,7 @@
             # of the process and compare tasks.
             process<fast>:fail? | compare<fast>:finish => generate_report
             process<medium>:fail? | compare<medium>:finish => generate_report
+            generate_report => housekeeping
         """
 
 [runtime]
@@ -161,4 +162,7 @@
             PRODUCTION = {{ PRODUCTION }}
             REPORT_PATH = ${ROSE_DATAC}/status_report.html
 
+    [[housekeeping]]
+        platform = localhost
+
 {% include "site/" ~ SITE ~ "/runtime.cylc" %}