Installing and Maintaining the CernVM File System Client¶
EL7 version compatibility
There is an incompatibility with EL7 < 7.5 due to an old version of the
The CernVM File System (CVMFS) is an HTTP-based file distribution service used to provide data and software for jobs. By installing CVMFS, you have access to an alternative installation method for required worker node software and your site you will be able to support a wider range of user jobs. For example, CVMFS provides easy access to the following:
Use this page to learn how to install, configure, run, test, and troubleshoot the CVMFS client from the OSG software repositories.
The applicable software versions for this document are OSG Version >= 3.4.3. The version of CVMFS installed should be >= 2.4.1
Before starting the installation process, consider the following points (consulting the Reference section below as needed):
- User IDs: If it does not exist already, the installation will create the
- Group IDs: If they do not exist already, the installation will create the Linux groups
- Network ports: You will need network access to a local squid server such as the squid distributed by OSG. The squid will need out-bound access to cvmfs stratum 1 servers.
- Host choice: - Sufficient (~20GB+20%) cache space reserved, preferably in a separate filesystem (details below)
- FUSE: CVMFS requires FUSE
As with all OSG software installations, there are some one-time (per host) steps to prepare in advance:
- Ensure the host has a supported operating system
- Obtain root access to the host
- Prepare the required Yum repositories
The following will install CVMFS from the OSG yum repository. It will also install fuse and autofs if you do not have them, and it will install the configuration for the OSG CVMFS distribution which is called OASIS. To simplify installation, OSG provides convenience RPMs that install all required software with a single command.
Clean yum cache:
root@host # yum clean all --enablerepo=*
root@host # yum update
This command will update all packages
Install CVMFS software:
root@host # yum install osg-oasis
If automount is not yet in use on the system, do the following:
root@host # systemctl enable autofs root@host # systemctl start autofs
Put the following in
Restart autofs to make the change take effect:
root@host # systemctl restart autofs
Create or edit
/etc/cvmfs/default.local, a file that controls the
CVMFS configuration. Below is a sample configuration, but please note
that you will need to edit the parts in angle brackets. In
CVMFS_HTTP_PROXY line below must be edited for your
CVMFS_REPOSITORIES="$((echo oasis.opensciencegrid.org;echo cms.cern.ch;ls /cvmfs)|sort -u|paste -sd ,)" CVMFS_QUOTA_LIMIT=<QUOTA LIMIT> CVMFS_HTTP_PROXY="<SQUID URL>:<SQUID PORT>"
CVMFS by default allows any repository to be mounted, no matter what
the setting of
CVMFS_REPOSITORIES is; that variable is used by support
tools such as
cvmfs_talk when they need to know a
list of repositories. The recommended
above is so that those tools will use two common repositories plus any
additional that have been mounted. You may want to choose a different
set of always-known repositories.
Set up a list of CVMFS HTTP proxies to retrieve from in
CVMFS_HTTP_PROXY. If you do not have any squid at your site follow
the instructions to install squid from OSG.
Vertical bars separating proxies means to load balance between them
and try them all before continuing. A semicolon between proxies means
to try that one only after the previous ones have failed. For example:
If no squid is available, it is acceptable for very small sites and
laptops to set
CVMFS_HTTP_PROXY="DIRECT". In that case, the OSG
configuration sets the servers to be contacted through
globally distributed caches.
This is strongly discouraged for large sites because of the performance
impact and because of the potential impact on the global caches. When
there is at least one local proxy defined, the OSG configuration instead
adds fallback proxies at Fermilab and CERN. Those fallback proxies are
monitored by a WLCG team that will contact your site when your local
proxy is failing and help you fix it.
Set up the cache limit in
CVMFS_QUOTA_LIMIT (in Megabytes). The
recommended value for most applications is
20000 MB. This is the
combined limit for all but the osgstorage.org repositories. This cache
will be stored in
/var/lib/cvmfs by default; to override the
that an additional 1000 MB is allocated for a separate osgstorage.org
repositories cache in
$CVMFS_CACHE_BASE/osgstorage. To be safe, make
sure that at least 20% more than
$CVMFS_QUOTA_LIMIT + 1000 MB of space
stays available for CVMFS in that filesystem. This is very important,
since if that space is not available it can cause many I/O errors and
application crashes. Many system administrators choose to put the
cache space in a separate filesystem, which is a good way to manage
If you change CVMFS_CACHE_BASE...
- The new cache directory must be owned by the
cvmfsuser, and have
If you use SELinux, then the new cache directory must be labeled with SELinux type
cvmfs_cache_t. This can be done by executing the following command:
:::console user@host $ chcon -R -t cvmfs_cache_t
After CVMFS is installed, you should be able to see the
directory. But note that it will initially appear to be empty:
user@host $ ls /cvmfs user@host $
/cvmfs will not be mounted until you examine them. For instance:
user@host $ ls /cvmfs user@host $ ls -l /cvmfs/atlas.cern.ch total 1 drwxr-xr-x 8 cvmfs cvmfs 3 Apr 13 14:50 repo user@host $ ls -l /cvmfs/oasis.opensciencegrid.org/cmssoft total 1 lrwxrwxrwx 1 cvmfs cvmfs 18 May 13 2015 cms -> /cvmfs/cms.cern.ch user@host $ ls -l /cvmfs/glast.egi.eu total 5 drwxr-xr-x 9 cvmfs cvmfs 4096 Feb 7 2014 glast user@host $ ls -l /cvmfs/nova.osgstorage.org total 6 lrwxrwxrwx 1 cvmfs cvmfs 43 Jun 14 2016 analysis -> pnfs/fnal.gov/usr/nova/persistent/analysis/ lrwxrwxrwx 1 cvmfs cvmfs 32 Jan 19 11:40 flux -> pnfs/fnal.gov/usr/nova/data/flux drwxr-xr-x 3 cvmfs cvmfs 4096 Jan 19 11:39 pnfs user@host $ ls /cvmfs atlas.cern.ch glast.egi.eu oasis.opensciencegrid.org config-osg.opensciencegrid.org nova.osgstorage.org
If no directories exist under
/cvmfs/, you can try the following
steps to debug:
- Mount it manually with
mkdir -p /mnt/cvmfsand then
mount -t cvmfs REPOSITORYNAME /mnt/cvmfswhere REPOSITORYNAME is the repository, for example config-osg.opensciencegrid.org (which is the best one to try first because other repositories require it to be mounted). If this works, then CVMFS is working, but there is a problem with automount.
- If that doesn't work and doesn't give any explanatory errors, try
cvmfs_config showconfig REPOSITORYNAMEto verify your setup.
- If chksetup reports access problems to proxies, it may be caused by access control settings in the squids.
- If you have changed settings in
/etc/cvmfs/default.local, and they do not seem to be taking effect, note that there are other configuration files that can override the settings. See the comments at the beginning of
/etc/cvmfs/default.confregarding the order in which configuration files are evaluated and look for old files that may have been left from a previous installation.
- More things to try are in the upstream documentation.
Starting and Stopping services¶
Once it is set up, CVMFS is always automatically started when one of the repositories are accessed; there are no system services to start.
CVMFS can be stopped via:
root@host # cvmfs_config umount Unmounting /cvmfs/config-osg.opensciencegrid.org: OK Unmounting /cvmfs/atlas.cern.ch: OK Unmounting /cvmfs/oasis.opensciencegrid.org: OK Unmounting /cvmfs/glast.egi.eu: OK Unmounting /cvmfs/nova.osgstorage.org: OK
How to get Help?¶
If you cannot resolve the problem, there are several ways to receive help:
- For bug reporting and OSG-specific issues, see our help procedure
- For community support and best-effort software team support contact email@example.com.
- For general CernVM File System support contact firstname.lastname@example.org.
Users and Groups¶
This installation will create one user unless it already exists
||CernVM-FS service account|
The installation will also create a cvmfs group and default the cvmfs user to that group. In addition, if the fuse RPM is not already installed, installing cvmfs will also install fuse and that will create another group:
||CernVM-FS service account||none|
||FUSE service account||