Skip to content

Commit

Permalink
Add missing params (#244)
Browse files Browse the repository at this point in the history 
* add some of the missing params

* remove CVMFS_SERVER_USE_CATALOG_CACHE as there is already another PR for it

* add all other missing params

---------

Co-authored-by: Valentin Volkl <valentin.volkl@cern.ch>
  • Loading branch information
@HereThereBeDragons @vvolkl
HereThereBeDragons and vvolkl authored Jan 22, 2025
1 parent 3cd875a commit b419c89
Showing 1 changed file with 36 additions and 2 deletions.
38 changes: 36 additions & 2 deletions apx-parameters.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,33 @@ Parameters recognized in configuration files under /etc/cvmfs:
CVMFS_ALIEN_CACHE If set, use an alien cache at the given location
CVMFS_ALT_ROOT_PATH | If set to *yes*, use alternative root catalog path.
| Only required for fixed catalogs (tag / hash) under the alternative path.
CVMFS_ARCH | Automatically set by CVMFs to reflect the CPU architecture on which the client runs (using ``uname -m``).
| Allows to utilize variant symlinks with cvmfs installations to auto-select the architecture.
CVMFS_AUTO_UPDATE If set to *no*, disables the automatic update of file catalogs.
CVMFS_AUTHZ_HELPER Full path to an authz helper, overwrites the helper hint in the catalog.
CVMFS_AUTHZ_SEARCH_PATH Full path to the directory that contains the authz helpers.
CVMFS_BACKOFF_INIT Seconds for the maximum initial backoff when retrying to download data.
CVMFS_BACKOFF_MAX Maximum backoff in seconds when retrying to download data.
CVMFS_BLACKLIST | File name of the blacklist that denies mounting any revision < revision N.
| Format: ``<REPO N`` where REPO is the repository name, N is the revision number,
| and the two parts are separated by whitespace.
| Note: no extra characters are allowed after N, not even whitespace.
CVMFS_CATALOG_WATERMARK | Try to release pinned catalogs when their number surpasses the given watermark.
| Defaults to 1/4 CVMFS_NFILES; explicitly set by shrinkwrap.
CVMFS_CACHE_ALIEN Deprecated, legacy parameter. Use ``CVMFS_ALIEN_CACHE`` instead.
CVMFS_CACHE_BASE Location (directory) of the CernVM-FS cache.
CVMFS_CACHE_DIR | Similar to ``CVMFS_CACHE_BASE``, but automatically set by cvmfs.
| Only might need manual overwriting when using ``libcvmfs``
CVMFS_CACHE_PRIMARY Type of cache to use. By default it is ``posix``. (see also :ref:`sct_cache_advanced`)
CVMFS_CACHE_REFCOUNT If set to *yes*, deduplicate open file descriptors by refcounting.
CVNFS_CACHE_<name>_<param> | Parameters used by advanced cache configuration for cache of type ``name``.
| See :ref:`sct_cache_advanced`. `<param>`` values can include e.g.
| ``LOCATOR``, ``TYPE``, ``CMDLINE``, ``ALIEN``, ``WORKSPACE``.
CVMFS_CACHE_SYMLINKS If set to *yes*, enables symlink caching in the kernel.
CVMFS_CHECK_PERMISSIONS If set to *no*, disable checking of file ownership and permissions (open all files).
CVMFS_CLAIM_OWNERSHIP If set to *yes*, allows CernVM-FS to claim ownership of files and directories.
CVMFS_CONFIG_REPOSITORY | CVMFS repository where a CVMFS client will get its config from.
| The default configuration rpm ``cvmfs-config-default`` sets this parameter to ``cvmfs-config.cern.ch``
CVMFS_CPU_AFFINITY Comma-separated list to set CPU affinity for all ``cvmfs`` components.
CVMFS_DEBUGLOG If set, run CernVM-FS in debug mode and write a verbose log the the specified file.
CVMFS_DEFAULT_DOMAIN | The default domain will be automatically appended to repository names
Expand All @@ -42,6 +57,7 @@ CVMFS_DNS_MIN_TTL | Minimum effective TTL in seconds for DNS queri
CVMFS_DNS_MAX_TTL | Maximum effective TTL in seconds for DNS queries of proxy server names
| (not Stratum 1s). Defaults to 1 day.
CVMFS_DNS_RETRIES Number of retries when resolving proxy names
CVMFS_DNS_SERVER IP of the DNS server CVMFS should use.
CVMFS_DNS_TIMEOUT Timeout in seconds when resolving proxy names
CVMFS_DNS_ROAMING If true, watch /etc/resolv.conf for nameserver changes
CVMFS_ENFORCE_ACLS | Enforce POSIX ACLs stored in the repository. Requires libfuse 3.
Expand All @@ -56,6 +72,10 @@ CVMFS_EXTERNAL_TIMEOUT_DIRECT Timeout in seconds for HTTP requests to an exter
CVMFS_EXTERNAL_URL Semicolon-separated chain of webservers serving external data chunks.
CVMFS_FALLBACK_PROXY | List of HTTP proxies similar to ``CVMFS_HTTP_PROXY``. The fallback proxies are
| added to the end of the normal proxies, and disable DIRECT connections.
CVMFS_FUSE_NOTIFY_INVALIDATION | Disable fuse notify invalidation. By default disabled on macOS to fix stability issues.
| On Linux systems, it is NOT recommended to turn it off.
CVMFS_FUSE3_MAX_THREADS Set max number of fuse threads (requires: libfuse3 > 3.12)
CVMFS_FUSE3_IDLE_THREADS Set max number of idle fuse threads (requires: libfuse3 > 3.12)
CVMFS_FOLLOW_REDIRECTS When set to *yes*, follow up to 4 HTTP redirects in requests.
CVMFS_HIDE_MAGIC_XATTRS If set to *yes* the client will not expose CernVM-FS specific extended attributes
CVMFS_HOST_RESET_AFTER See ``CVMFS_PROXY_RESET_AFTER``, for server URLs.
Expand All @@ -74,18 +94,25 @@ CVMFS_INFLUX_HOST Host name or IP address of the receiver of the I
CVMFS_INFLUX_METRIC_NAME Name of the measurement of the InfluxDB Telemetry Aggregator
CVMFS_INFLUX_PORT Port of the host (receiver) of the InfluxDB Telemetry Aggregator
CVMFS_IPFAMILY_PREFER Which IP protocol to prefer when connecting to proxies. Can be either 4 or 6.
CVMFS_IPV4_ONLY If set to a non-empty value, CVMFS does not try to resolve IPv6 records.
CVMFS_KCACHE_TIMEOUT Timeout in seconds for path names and file attributes in the kernel file system buffers.
CVMFS_KEYS_DIR | Directory containing \*.pub files used as repository signing keys.
| If set, this parameter has precedence over ``CVMFS_PUBLIC_KEY``.
CVMFS_LIBRARY_PATH | For standalone deployment. Allows ``cvmfs2`` to discover libraries
| ``libcvmfs_<...>.so`` that are not installed in one of standard search paths.
CVMFS_LOW_SPEED_LIMIT Minimum transfer rate in bytes/second a server or proxy must provide.
CVMFS_MAGIC_XATTRS_VISIBILITY | Allows to hide extended attributes to be listed. Options: ``always``, ``never``, ``rootonly``.
| ``rootonly`` means that the listing can only be requested for ``/cvmfs/<repo>``. For any other file,
| only a direct request to a specific extended attribute will work.
CVMFS_MAX_EXTERNAL_SERVERS | Limit the number of (geo sorted) stratum 1 servers for external data
| that are effectively used.
CVMFS_MAX_IPADDR_PER_PROXY | Limit the number of IP addresses a proxy names resolves into.
| From all registered addresses, up to the limit are randomly selected.
CVMFS_MAX_RETRIES Maximum number of retries for a given proxy/host combination.
CVMFS_MAX_SERVERS Limit the number of (geo sorted) stratum 1 servers that are effectively used.
CVMFS_MAX_TTL Maximum file catalog TTL in minutes. Can overwrite the TTL stored in the catalog.
CVMFS_MEMCACHE_SIZE Size of the CernVM-FS metadata memory cache in Megabyte.
CVMFS_MEMCACHE_SIZE Size of the CernVM-FS metadata memory cache in Megabytes.
CVMFS_MOUNT_DIR Directory where CernVM-FS is mounted to. Default is ``/cvmfs`` and cannot be overwritten.
CVMFS_METALINK_URL Semi-colon-separated chain of RFC6249-compliant servers to locate Stratum-1 servers.
CVMFS_METALINK_RESET_AFTER See ``CVMFS_PROXY_RESET_AFTER``, for metalink servers.
CVMFS_MOUNT_RW | Mount CernVM-FS as a read/write file system. Write operations will fail
Expand Down Expand Up @@ -127,12 +154,17 @@ CVMFS_SYSLOG_FACILITY | If set to a number between 0 and 7, uses the c
| LOCAL$n$ facility for syslog messages.
CVMFS_SYSLOG_LEVEL | If set to 1 or 2, sets the syslog level for CernVM-FS messages to
| LOG_DEBUG or LOG_INFO respectively.
CVMFS_SYSLOG_PREFIX Prefix for each CVMFS message in the syslog. By default it is the repo name.
CVMFS_SYSTEMD_NOKILL | If set to *yes*, modify the command line to ``@vmfs2 ...`` in order to
| act as a systemd lowlevel storage manager.
CVMFS_TALK_SOCKET Internal usage. Used for ``cvmfs_talk``. Default socket is ``/var/spool/cvmfs/<repo>/cvmfs_io``.
CVMFS_TALK_OWNER Internal usage. Used for ``cvmfs_talk``. By default it is the repo owner.
CVMFS_TELEMETRY_RATE Rate in seconds for Telemetry Aggregator to send the telemetry. Minimum send rate >= 5 sec.
CVMFS_TELEMETRY_SEND ``ON`` to activate Telemetry Aggregator.
CVMFS_TIMEOUT Timeout in seconds for HTTP requests with a proxy server.
CVMFS_TIMEOUT_DIRECT Timeout in seconds for HTTP requests without a proxy server.
CVMFS_TRACEBUFFER Internal usage. Max number of entries of the tracebuffer.
CVMFS_TRACEBUFFER_THRESHOLD Internal usage. Flush treshold after how many entries the tracebuffer is flushed to file.
CVMFS_TRACEFILE If set, enables the tracer and trace file system calls to the given file.
CVMFS_USE_GEOAPI Request order of Stratum 1 servers and fallback proxies via Geo-API.
CVMFS_USE_SSL_SYSTEM_CA | When connecting to an HTTPS endpoints,
Expand Down Expand Up @@ -183,6 +215,7 @@ CVMFS_CREATOR_VERSION | The CernVM-FS version that was used to cre
| (do not change manually).
CVMFS_DONT_CHECK_OVERLAYFS_VERSION | Disable checking of OverlayFS version before usage.
| (see :ref:`sct_reporequirements`)
CVMFS_ENABLE_MTIME_NS Use nanosecond-granularity for modification time of files (instead of milliseconds)
CVMFS_ENFORCE_LIMITS | Set to *true* to cause exceeding \*LIMIT variables to be fatal to a publish
| instead of a warning
CVMFS_EXTENDED_GC_STATS | Set to *true* to keep track of the volume of garbage collected files (increases GC running time)
Expand Down Expand Up @@ -220,7 +253,7 @@ CVMFS_REPOSITORY_TYPE Defines if the repository is a master copy (
CVMFS_REPOSITORY_TTL | The frequency in seconds of client lookups for changes in the repository.
| Defaults to 4 minutes.
CVMFS_ROOT_KCATALOG_LIMIT | Maximum thousands of files allowed in root catalogs, default 200
| (see also *CVMFS_NESTED_KCATALOG_LIMIT* and *CVMFS_ENFORCE_LIMITS*
| (see also *CVMFS_NESTED_KCATALOG_LIMIT* and *CVMFS_ENFORCE_LIMITS*)
CVMFS_SNAPSHOT_GROUP | Group name for subset of repositories used with ``cvmfs_server snapshot -a -g``.
| Added with ``cvmfs_server add-replica -g``.
CVMFS_SPOOL_DIR | Location of the upstream spooler scratch directories;
Expand All @@ -231,6 +264,7 @@ CVMFS_STRATUM0 URL of the master copy (*stratum0*) of this
CVMFS_STRATUM1 URL of the Stratum1 HTTP server for this specific repository.
CVMFS_SYNCFS_LEVEL | Controls how often ``sync`` will by called by ``cvmfs_server`` operations.
| Possible levels are 'none', 'default', 'cautious'.
CVMFS_S3_<param> S3-related parameters. See :ref:`S3 Parameter table <tab_s3confparameters>`
CVMFS_UID_MAP Path of a file for the mapping of file owner user ids.
CVMFS_UNION_DIR | Mount point of the union file system for copy-on-write semantics of CernVM-FS.
| Here, changes to the repository are performed
Expand Down

0 comments on commit b419c89

Please sign in to comment.