Skip to content

Commit 75f75c8

Browse files
committed
add documentation for external files
1 parent e0a9086 commit 75f75c8

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

apx-parameters.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ CVMFS_EXTERNAL_FALLBACK_PROXY | List of HTTP proxies similar to ``CVMFS_EXTERN
4646
| The fallback proxies are added to the end of the normal proxies,
4747
| and disable DIRECT connections.
4848
CVMFS_EXTERNAL_HTTP_PROXY Chain of HTTP proxy groups to be used when CernVM-FS is accessing external data
49+
CVMFS_EXTERNAL_MAX_SERVERS | Caps the list of external hosts to the given number (after geo-sorting them)
4950
CVMFS_EXTERNAL_TIMEOUT Timeout in seconds for HTTP requests to an external-data server with a proxy server
5051
CVMFS_EXTERNAL_TIMEOUT_DIRECT Timeout in seconds for HTTP requests to an external-data server without a proxy server
5152
CVMFS_EXTERNAL_URL Semicolon-separated chain of webservers serving external data chunks.

cpt-repo.rst

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -356,6 +356,39 @@ repository life time. Existing content will remain untouched, new content will
356356
be processed with the new settings.
357357

358358

359+
External Files
360+
^^^^^^^^^^^^^^
361+
362+
Files in a CernVM-FS repository can be marked as *external files*. Externals
363+
files are not expected to be served from the HTTP server(s) that provide the
364+
file catalogs but from an independent set of HTTP server(s). The idea is for
365+
CernVM-FS to be able to provide a directory of files that is already present
366+
on an HTTP service. External files are often :ref:`grafted
367+
<sct_grafting>`.
368+
369+
While regular files use their content hash as basis for the HTTP URL, external
370+
files are expected to be available under their file system name. For instance,
371+
a file ``/foo/bar`` with content hash ``0x1234`` would be addressed as
372+
373+
::
374+
375+
$HTTP_SERVER_URL/12/34 # as regular file
376+
$HTTP_EXTERNAL_URL/foo/bar # as external file
377+
378+
Note that the content hash of external files is still verified on download. Also
379+
note that CernVM-FS by itself does not know or store the location of external
380+
files but it must be explicitly set through the client configuration. On the
381+
clients, the ``CVMFS_EXTERNAL_URL``, ``CVMFS_EXTERNAL_HTTP_PROXY`` and the other
382+
"external" parameters are used to configure the external HTTP servers
383+
(see :ref:`appendix <apxsct_clientparameters>`).
384+
385+
Files are marked as external data if the ``CVMFS_EXTERNAL_DATA`` server
386+
setting is enabled or if the ``cvmfs_server publish -X`` option is used.
387+
Conversely, if ``CVMFS_EXTERNAL_DATA`` is set and the
388+
``cvmfs_server publish -N`` option is used, this particular publish operation
389+
will treat its files exceptionally as non-external files.
390+
391+
359392
Confidential Repositories
360393
^^^^^^^^^^^^^^^^^^^^^^^^^
361394

0 commit comments

Comments
 (0)