Skip to content

Commit

Permalink
update server config settings documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jblomer committed Jan 25, 2021
1 parent 0e9aade commit 41d9989
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 27 deletions.
5 changes: 2 additions & 3 deletions apx-parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -165,8 +165,7 @@ 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*)
CVMFS_GENERATE_LEGACY_BULK_CHUNKS | Set to *false* to disable generation of whole-file objects for large files.
| Requires clients >= 2.1.7.
CVMFS_GENERATE_LEGACY_BULK_CHUNKS | Deprecated, set to *true* to enable generation of whole-file objects for large files.
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 All @@ -175,7 +174,7 @@ CVMFS_GID_MAP Path of a file for the mapping of file owner
CVMFS_HASH_ALGORITHM | Define which secure hash algorithm should be used by CernVM-FS for CAS objects
| (supported are: *sha1*, *rmd160* and *shake128*)
CVMFS_IGNORE_SPECIAL_FILES Set to *true* to skip special files during publish without aborting.
CVMFS_IGNORE_XDIR_HARDLINKS | If set to *true*, do not abort the publish operation when cross-directory
CVMFS_IGNORE_XDIR_HARDLINKS | Deprecated, defaults to *true*
| hardlinks are found. Instead automatically break the hardlinks across directories.
CVMFS_INCLUDE_XATTRS Set to *true* to process extended attributes
CVMFS_MAX_CHUNK_SIZE Maximal size of a file chunk in bytes (see also *CVMFS_USE_FILE_CHUNKING*)
Expand Down
27 changes: 3 additions & 24 deletions cpt-repo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1480,20 +1480,7 @@ files in CernVM-FS if they won't be able to be read by anyone.
Hardlinks
~~~~~~~~~

By default CernVM-FS does not allow hardlinks of a file to be in
different directories. If there might be any such hardlinks in a
repository, set the option

::

CVMFS_IGNORE_XDIR_HARDLINKS=true

in the repository's ``server.conf``. The file will not appear to be
hardlinked to the client, but it will still be stored as only one file
in the repository just like any other files that have identical content.
Note that if, in a subsequent publish operation, only one of these
cross-directory hardlinks gets changed, the other hardlinks remain
unchanged (the hardlink got "broken").
CernVM-FS breaks hardlinks on publishing into multiple, independent regular files.


Configuration Recommendation by Use Case
Expand All @@ -1506,22 +1493,14 @@ other typical use cases, the configuration should be adapted.
General Recommendations
~~~~~~~~~~~~~~~~~~~~~~~

**NOTE:** Do _not_ use ``CVMFS_GENERATE_LEGACY_BULK_CHUNKS=false`` together
with a hash algorithm other than SHA-1 in CernVM-FS <= 2.4.3.

Unless an older client base needs to be supported, we recommend to the following
configuration changes::

CVMFS_AUTO_TAG_TIMESPAN="2 weeks ago"
CVMFS_IGNORE_XDIR_HARDLINKS=true
CVMFS_GENERATE_LEGACY_BULK_CHUNKS=false
CVMFS_HASH_ALGORITHM=shake128

These changes make unreferenced objects older than two weeks subject to garbage
collection (without enabling garbage collection). It tolerates that hard links
among different directories (see :ref:`sct_limit_hardlink`), creates only
chunked versions of large files and uses the more future-proof SHA-3 derived
content hash algorithm.
These changes make unreferenced objects older than two weeks subject to garbage collection (without enabling garbage collection)
and uses the more future-proof SHA-3 derived content hash algorithm.


Multi-Tenant Repositories
Expand Down

0 comments on commit 41d9989

Please sign in to comment.