Skip to content

Commit 6b553b9

Browse files
authored
docs: clarify that publish is needed before manual GC after enabling (#258)
Add a note warning that cvmfs_server gc requires a publish operation after setting CVMFS_GARBAGE_COLLECTION=true, since the GC flag is stored in the repository manifest and only updated during publish. Also expand the parameter reference with this information.
1 parent 1ca1736 commit 6b553b9

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

apx-parameters.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,8 @@ CVMFS_FILE_MBYTE_LIMIT | Maximum number of megabytes for a publishe
227227
CVMFS_FORCE_REMOUNT_WARNING | Enable/disable warning through ``wall`` and grace period before forcefully
228228
| remounting a CernVM-FS repository on the release managere machine.
229229
CVMFS_GARBAGE_COLLECTION Enables repository garbage collection |br| (Stratum~0 only | if set to *true*)
230+
| A publish operation is needed after changing this setting to update
231+
| the repository manifest before garbage collection can run.
230232
CVMFS_GC_DELETION_LOG | Log file path to track all garbage collected objects during sweeping
231233
| for bookkeeping or debugging
232234
CVMFS_GEO_DB_FILE Path to externally updated location of geolite2 city database, or 'None' for no database.

cpt-repo.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1436,6 +1436,15 @@ publish operation. Alternatively, ``CVMFS_AUTO_GC=false`` may be set and
14361436
operations will be happening; garbage collection and publish
14371437
operations cannot happen at the same time.
14381438

1439+
.. note::
1440+
1441+
If you plan to run ``cvmfs_server gc`` manually (instead of relying on
1442+
``CVMFS_AUTO_GC``), you must first publish a transaction after setting
1443+
``CVMFS_GARBAGE_COLLECTION=true``. The garbage collection flag is stored
1444+
in the repository manifest and is only updated during a publish operation.
1445+
Without this step, ``cvmfs_server gc`` will fail with
1446+
"repository does not allow garbage collection".
1447+
14391448
Enabling Garbage Collection on an Existing Replication (Stratum 1)
14401449
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14411450

0 commit comments

Comments
 (0)