Skip to content

Commit 38fb640

Browse files
committed
chore(master): Improve empty reserved files docs
Explicitly mark EMPTY_RESERVED_FILES_PERIOD_MSECONDS as experimental and add a detailed warning to clarify the potential risks of enabling periodic reserved file cleanup. The warning highlights possible disruption of active workloads and advises administrators to use this option with caution. Signed-off-by: Rolando Sánchez Ramos <rolysr@leil.io>
1 parent 304d7e1 commit 38fb640

File tree

2 files changed

+28
-5
lines changed

2 files changed

+28
-5
lines changed

doc/sfsmaster.cfg.5.adoc

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -290,6 +290,23 @@ for TLS connections (there is no default value).
290290
Path to the trusted CA certificate which is used to authenticate
291291
the TLS connection (there is no default value).
292292

293+
*EMPTY_RESERVED_FILES_PERIOD_MSECONDS (EXPERIMENTAL)*::
294+
Interval for periodic cleaning of reserved files, in milliseconds.
295+
If set to 0, the reserved files deletion is disabled. (Default: 0)
296+
297+
[WARNING]
298+
====
299+
Administrator-only option. Enabling periodic deletion may remove master-side
300+
references to reserved files that are still held by other applications or
301+
client instances that have not released them yet. This can disrupt ongoing
302+
operations and lead to unexpected errors.
303+
304+
Recommended approach: Do not enable automatic deletion unless you fully
305+
understand the impact on running workloads. Prefer manually freeing reserved
306+
files by locating each reference or process using them and stopping it before
307+
releasing the reservation.
308+
====
309+
293310
== NOTES
294311

295312
Chunks in master are tested in loop. Speed (or frequency) is regulated by two

src/data/sfsmaster.cfg.in

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -244,11 +244,6 @@
244244
## (Default: 3600)
245245
# METADATA_DUMP_PERIOD_SECONDS = 3600
246246

247-
## Interval for periodically cleaning of reserved files, in milliseconds. If set to 0, the reserved files
248-
## deletion is disabled.
249-
## (Default: 0)
250-
# EMPTY_RESERVED_FILES_PERIOD_MSECONDS = 0
251-
252247
# deprecated:
253248
# CHUNKS_DEL_LIMIT - use CHUNKS_SOFT_DEL_LIMIT instead
254249

@@ -355,3 +350,14 @@
355350
## Example: /etc/saunafs/ssl/ca.crt
356351
## (There is no default)
357352
# TLS_CA_CERT_FILE =
353+
354+
## Interval for periodic cleaning of reserved files, in milliseconds.
355+
## If set to 0, the reserved files deletion is disabled.
356+
## (Default: 0)
357+
##
358+
## Note: Administrator-only option. Enabling periodic deletion may remove
359+
## master-side references to reserved files that are still held by other
360+
## applications or client instances that have not released them yet. This
361+
## can disrupt ongoing operations and lead to unexpected errors.
362+
##
363+
# EMPTY_RESERVED_FILES_PERIOD_MSECONDS = 0

0 commit comments

Comments
 (0)