21126: Add doc comment to AllowTrashWhenReadOnly config.

[arvados.git] / lib / config / config.default.yml

diff --git a/lib/config/config.default.yml b/lib/config/config.default.yml
index a475f2fe68994b28b12aa3151cb9f3ccb60e5a61..9155a8edaa36352e6c687b58b991e8564d6051e5 100644 (file)
--- a/lib/config/config.default.yml
+++ b/lib/config/config.default.yml
@@ -1694,6 +1694,10 @@ Clusters:
             ReadOnly: false
           "http://host1.example:25107": {}
         ReadOnly: false
+        # AllowTrashWhenReadOnly enables unused and overreplicated
+        # blocks to be trashed/deleted even when ReadOnly is
+        # true. Normally, this is false and ReadOnly prevents all
+        # trash/delete operations as well as writes.
         AllowTrashWhenReadOnly: false
         Replication: 1
         StorageClasses: