Skip to content

Commit 2986cfc

Browse files
committed
DOC: Update documentation with respect to recycle bin configuration changes
and what steps system admins can take to clean up the old configurtaion.
1 parent f6fb434 commit 2986cfc

3 files changed

Lines changed: 91 additions & 0 deletions

File tree

doc/diopside/manual/interfaces.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2715,6 +2715,17 @@ If you want to list all the parameter affecting the recycle bin you running
27152715
collect_interval_sec=20
27162716
remove_interval_sec=10
27172717
2718+
Enable/Disable the recycle bin
2719+
""""""""""""""""""""""""""""""
2720+
2721+
If you want to enable or disable the recycle bin globally you run
2722+
**recycle config --enable <on|off>**:
2723+
2724+
.. code-block:: bash
2725+
2726+
EOS Console [root://localhost] |/eos/> recycle config --enable on
2727+
2728+
27182729
Define the object lifetime
27192730
""""""""""""""""""""""""""
27202731
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
Recycle Bin Configuration Update
2+
================================
3+
4+
.. important::
5+
**Configuration Migration Required**
6+
7+
The recycle bin configuration has moved from extended attributes on the recycle directory to the global EOS configuration.
8+
9+
New Configuration Commands
10+
--------------------------
11+
12+
Use the ``eos recycle config`` command to configure the recycle bin policy.
13+
14+
**Enable/Disable:**
15+
16+
.. code-block:: bash
17+
18+
# Enable the recycle bin globally
19+
eos recycle config --enable on
20+
21+
# Disable the recycle bin globally
22+
eos recycle config --enable off
23+
24+
25+
**Set Policy Parameters:**
26+
27+
.. code-block:: bash
28+
29+
# Set keep time in seconds (e.g., 1 day)
30+
eos recycle config --lifetime 86400
31+
32+
# Set space keep ratio (0.0 - 1.0)
33+
eos recycle config --ratio 0.8
34+
35+
# Set collection interval in seconds
36+
eos recycle config --collect-interval 300
37+
38+
39+
Cleanup Legacy Configuration
40+
----------------------------
41+
42+
Old extended attributes on the recycle directory (typically ``/eos/<instance>/proc/recycle/`` or configured path) are **NO LONGER USED** for policy enforcement and should be removed to avoid confusion.
43+
44+
**Attributes to Remove:**
45+
46+
* ``sys.recycle.keeptime``
47+
* ``sys.recycle.keepratio``
48+
* ``sys.recycle.collectinterval``
49+
* ``sys.recycle.removeinterval``
50+
51+
**How to Remove:**
52+
53+
Use the ``eos attr rm`` command on your recycle bin directory (check your specific path, commonly ``/eos/<instance>/proc/recycle/``):
54+
55+
.. code-block:: bash
56+
57+
eos attr rm sys.recycle.keeptime /eos/<instance>/proc/recycle/
58+
eos attr rm sys.recycle.keepratio /eos/<instance>/proc/recycle/
59+
eos attr rm sys.recycle.collectinterval /eos/<instance>/proc/recycle/
60+
eos attr rm sys.recycle.removeinterval /eos/<instance>/proc/recycle/
61+
62+
.. note::
63+
The ``sys.recycle`` attribute on individual directories is **STILL SUPPORTED** to explicitly mark a subtree for recycling even if global enforcement is off. You do not need to remove ``sys.recycle`` from user directories.
64+
65+
Space Policy Notice
66+
-------------------
67+
68+
The ``eos space config ... policy.recycle=on`` command is **DEPRECATED** and has been removed. Use ``eos recycle config --enable on`` instead.

doc/diopside/releases/diopside-release.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,18 @@ Introduction
1616

1717
This release is based on XRootD V5.
1818

19+
``v5.4.0 Diopside``
20+
===================
21+
22+
2025-12-08
23+
24+
Major Change
25+
------------
26+
27+
* **Recycle Bin Configuration Update**: The recycle bin configuration has been refactored.
28+
Please see :doc:`5.4.0/recycle_bin_config` for important migration instructions regarding new configuration commands and cleanup of legacy attributes.
29+
30+
1931
``v5.3.26 Diopside``
2032
====================
2133

0 commit comments

Comments
 (0)