Skip to content

docs: note that publish is needed before manual GC #258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vvolkl merged 1 commit into from
Feb 24, 2026
Merged

docs: note that publish is needed before manual GC #258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions apx-parameters.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,8 @@ CVMFS_FILE_MBYTE_LIMIT | Maximum number of megabytes for a publishe
CVMFS_FORCE_REMOUNT_WARNING | Enable/disable warning through ``wall`` and grace period before forcefully
| remounting a CernVM-FS repository on the release managere machine.
CVMFS_GARBAGE_COLLECTION Enables repository garbage collection |br| (Stratum~0 only | if set to *true*)
| A publish operation is needed after changing this setting to update
| the repository manifest before garbage collection can run.
CVMFS_GC_DELETION_LOG | Log file path to track all garbage collected objects during sweeping
| for bookkeeping or debugging
CVMFS_GEO_DB_FILE Path to externally updated location of geolite2 city database, or 'None' for no database.
Expand Down
9 changes: 9 additions & 0 deletions cpt-repo.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1436,6 +1436,15 @@ publish operation. Alternatively, ``CVMFS_AUTO_GC=false`` may be set and
operations will be happening; garbage collection and publish
operations cannot happen at the same time.

.. note::

If you plan to run ``cvmfs_server gc`` manually (instead of relying on
``CVMFS_AUTO_GC``), you must first publish a transaction after setting
``CVMFS_GARBAGE_COLLECTION=true``. The garbage collection flag is stored
in the repository manifest and is only updated during a publish operation.
Without this step, ``cvmfs_server gc`` will fail with
"repository does not allow garbage collection".

Enabling Garbage Collection on an Existing Replication (Stratum 1)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down