CernVM-FS Parameters — CernVM-FS 2.12.6 documentation (original) (raw)

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 Advanced Cache Configuration)

CVMFS_CACHE_REFCOUNT

If set to yes, deduplicate open file descriptors by refcounting.

CVNFS_CACHE__

Parameters used by advanced cache configuration for cache of type name.

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

when given without a domain.

CVMFS_DNS_MIN_TTL

Minimum effective TTL in seconds for DNS queries of proxy server names

(not Stratum 1s). Defaults to 1 minute.

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.

CVMFS_EXTERNAL_FALLBACK_PROXY

List of HTTP proxies similar to CVMFS_EXTERNAL_HTTP_PROXY.

The fallback proxies are added to the end of the normal proxies,

and disable DIRECT connections.

CVMFS_EXTERNAL_HTTP_PROXY

Chain of HTTP proxy groups to be used when CernVM-FS is accessing external data

CVMFS_EXTERNAL_MAX_SERVERS

Caps the list of external hosts to the given number (after geo-sorting them)

CVMFS_EXTERNAL_METALINK

Semi-colon-separated chain of RFC6249-compliant servers to locate webservers serving external data.

CVMFS_EXTERNAL_TIMEOUT

Timeout in seconds for HTTP requests to an external-data server with a proxy server

CVMFS_EXTERNAL_TIMEOUT_DIRECT

Timeout in seconds for HTTP requests to an external-data server without a proxy server

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.

CVMFS_HTTP_PROXY

Chain of HTTP proxy groups used by CernVM-FS. Necessary.

Set to DIRECT if you don’t use proxies.

CVMFS_HTTP_TRACING

Activates that a tracing header is attached to each CURL request. Consists of uid, pid, and gid. Default is off.

CVMFS_HTTP_TRACING_HEADERS

Adds additional static, user-defined tracing headers. Format: key1:val1|key2:val2|key3:val3. Needs CVMFS_HTTP_TRACING to be set to on.

CVMFS_IGNORE_SIGNATURE

When set to yes, don’t verify CernVM-FS file catalog signatures.

CVMFS_INITIAL_GENERATION

Initial inode generation. Used for testing.

CVMFS_INSTRUMENT_FUSE

When set to true gather performance statistics about the FUSE callbacks.

The results are displayed with cvmfs_talk internal affairs.

CVMFS_NFS_INTERLEAVED_INODES

In NFS mode, use only inodes of the form \(an+b\), specified as “b%a”.

CVMFS_INFLUX_EXTRA_FIELDS

Static fields always attached to the (absolute) output of the InfluxDB Telemetry Aggregator

CVMFS_INFLUX_EXTRA_TAGS

Static tags always attached to the (absolute + delta) output of the InfluxDB Telemetry Aggregator

CVMFS_INFLUX_HOST

Host name or IP address of the receiver of the InfluxDB Telemetry Aggregator

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 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

but this option can workaround faulty open() flags.

CVMFS_NFILES

Maximum number of open file descriptors that can be used by the CernVM-FS process.

CVMFS_NFS_SOURCE

If set to yes, act as a source for the NFS daemon (NFS export).

CVMFS_NFS_SHARED

If set a path, used to store the NFS maps in an SQlite database,

instead of the usual LevelDB storage in the cache directory.

CVMFS_PAC_URLS

Chain of URLs pointing to PAC files with HTTP proxy configuration information.

CVMFS_OOM_SCORE_ADJ

Set the Linux kernel’s out-of-memory killer priority

for the CernVM-FS client [-1000 - 1000].

CVMFS_PROXY_RESET_AFTER

Delay in seconds after which CernVM-FS will retry the primary proxy group

in case of a fail-over to another group.

CVMFS_PROXY_SHARD

If set to yes, shard requests across all proxies within the current

load-balancing group using consistent hashing.

CVMFS_PROXY_TEMPLATE

Overwrite the default proxy template in Geo-API calls. Only needed for debugging.

CVMFS_PUBLIC_KEY

Colon-separated list of repository signing keys.

CVMFS_QUOTA_LIMIT

Soft-limit of the cache in Megabyte.

CVMFS_RELOAD_SOCKETS

Directory of the sockets used by the CernVM-FS loader to trigger hotpatching/reloading.

CVMFS_REPOSITORIES

Comma-separated list of fully qualified repository names

to include in use of client utilities such as cvmfs_talk and cvmfs_config.

Does not limit which repositories may be mounted, unless CVMFS_STRICT_MOUNT is

set to yes.

CVMFS_REPOSITORY_DATE

A timestamp in ISO format (e.g. 2007-03-01T13:00:00Z).

Selects the repository state as of the given date.

CVMFS_REPOSITORY_TAG

Select a named repository snapshot that should be mounted instead of trunk.

CVMFS_CONFIG_REPO_REQUIRED

If set to yes, no repository can be mounted unless the config repository is available.

CVMFS_ROOT_HASH

Hash of the root file catalog, implies CVMFS_AUTO_UPDATE=no.

CVMFS_SEND_INFO_HEADER

If set to yes, include the cvmfs path of downloaded data in HTTP headers.

CVMFS_SERVER_CACHE_MODE

Enable special cache semantics for a client used as a publisher’s repository base line.

CVMFS_SERVER_URL

Semicolon-separated chain of Stratum~1 servers.

CVMFS_SHARED_CACHE

If set to no, makes a repository use an exclusive cache.

CVMFS_STATFS_CACHE_TIMEOUT

Caching time of statfs() in seconds (no caching by default).

Calling statfs() in high frequency can be expensive.

CVMFS_STREAMING_CACHE

If set to yes, use a download manager to download regular files on read.

CVMFS_STRICT_MOUNT

If set to yes, mount only repositories that are listed in CVMFS_REPOSITORIES.

CVMFS_SUID

If set to yes, enable suid magic on the mounted repository. Requires mounting as root.

CVMFS_SYSLOG_FACILITY

If set to a number between 0 and 7, uses the corresponding

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,

it will load the certificates provided by the system.

CVMFS_USER

Sets the gid and uid mount options. Don’t touch or overwrite.

CVMFS_USYSLOG

All messages that normally are logged to syslog are re-directed to the given file.

This file can grow up to 500kB and there is one step of log rotation.

Required for mumumuCernVM.

CVMFS_XATTR_PRIVILEGED_GIDS

Comma-separated list of (main) group IDs that are allowed to access the extended attributes listed by CVMFS_XATTR_PROTECTED_XATTRS.

CVMFS_XATTR_PROTECTED_XATTRS

Comma-separated list of extended attributes (full name, e.g. user.fqrn) that are only accessible by root and the group IDs listed by CVMFS_XATTR_PRIVILEGED_GIDS.

CVMFS_WORKSPACE

Set the local directory for storing special files (defaults to the cache directory).

CVMFS_WORLD_READABLE

Override posix read permissions to make files in repository globally readable