Skip to content

Commit

Permalink
Add explanation for CVMFS_UPSTREAM_STORAGE
Browse files Browse the repository at this point in the history
  • Loading branch information
jblomer committed Mar 3, 2021
1 parent 778867d commit 9ce1c87
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion apx-parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ CVMFS_UNION_FS_TYPE | Defines the union file system to be used f
| (currently `aufs` and `overlayfs` are fully supported)
CVMFS_UPLOAD_STATS_DB | Publish repository statistics plots to the Stratum 0 /stats location
CVMFS_UPSTREAM_STORAGE | Upstream spooler description defining the basic upstream storage type
| and configuration.
| and configuration (see below).
CVMFS_USE_FILE_CHUNKING Allows backend to split big files into small chunks (*true* | *false*)
CVMFS_USER The user name that owns and manipulates the files inside the repository.
CVMFS_VIRTUAL_DIR | Set to *true* to enable the hidden, virtual ``.cvmfs/snapshots`` directory
Expand All @@ -229,6 +229,35 @@ X509_CERT_DIR | Directory file with CA certificates for HT
| defaults to /etc/grid-security/certificates (see :ref:`sct_data`)
=================================== ====================================================================================

Format of CVMFS_UPSTREAM_STORAGE
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The format of the ``CVMFS_UPSTREAM_STORAGE`` parameter depends on the storage backend.
Note that this parameter is initialized by ``cvmfs_server mkfs`` resp. ``cvmfs_server add-replica``.
The internals of the parameter are only relevant
if the configuration is maintained by a configuration management system.

For the local storage backend, the parameter specifies the storage directory (to be served by Apache)
and a temporary directory in the form ``local,<path for temporary files>,<path to storage>``, e.g.

::

CVMFS_UPSTREAM_STORAGE=local,/srv/cvmfs/sw.cvmfs.io/data/txn,/srv/cvmfs/sw.cvmfs.io

For the S3 backend, the parameter specifies a temporary directory and the location of the S3 config file
in the form ``s3,<path for temporary files>,<repository entry URL on the S3 server>@<S3 config file>``, e.g.

::

CVMFS_UPSTREAM_STORAGE=S3,/var/spool/cvmfs/sw.cvmfs.io/tmp,cvmfs/sw.cvmfs.io@/etc/cvmfs/s3.conf

The gateway backend can only be used on a remote publisher (not on a stratum 1).
The parameter specifies a temporary directory and the endpoint of the gateway service, e.g.

::

CVMFS_UPSTREAM_STORAGE=gw,/var/spool/cvmfs/sw.cvmfs.io/tmp,http://cvmfs-gw.cvmfs.io:4929/api/v1


.. _apxsct_cacheparams:

Expand Down

0 comments on commit 9ce1c87

Please sign in to comment.