improve 2.6 release notes

cpt-overview.rst

@@ -49,12 +49,12 @@ following key features:
 -  Transparent file compression/decompression and transparent file
    chunking
 
--  Capability to work in offline mode providing that all required files
+-  Capability to work in offline mode provided that all required files
    are cached
 
--  File system versioning
+-  File system data versioning
 
--  File system hotpatching
+-  File system client hotpatching
 
 -  Dynamic expansion of environment variables embedded in symbolic links
 
@@ -100,5 +100,5 @@ actually used are downloaded and cached.
 
    Opening a file on CernVM-FS. CernVM-FS resolves the name by means of
    an SQLite catalog. Downloaded files are verified against the
-   cryptographic hash of the corresponding catalog entry. The ``stat()`` system 
+   cryptographic hash of the corresponding catalog entry. The ``stat()`` system
    call can be entirely served from the in-kernel file system buffers.

cpt-releasenotes.rst

@@ -9,16 +9,17 @@ Brian Bockelman and Derek Weitzel (U. Nebraska) and Nick Hazekamp
 This release comes with several new, experimental satellite serivces around
 the CernVM-FS core components:
 
-1. DUCC (Daemon that unpacks container images into CernVM-FS). This new
-   component automates the publication of container images from a Docker
-   registry into CernVM-FS.
+  1. DUCC (daemon that unpacks container images into CernVM-FS).
+     This new component automates the publication of container images from a
+     Docker registry into CernVM-FS.
 
-2. Repository change notification system, which is complementary to the
-   default, pull-based approach to propagate repository updates.
+  2. Repository change notification system, which
+     is complementary to the default, pull-based approach to propagate
+     repository updates.
 
-3. Repository shrinkwrap utility. This new utility allows for exporting large
-   parts of a CernVM-FS repository to an external file system or a "fat image"
-   as they are used in some HPC environments.
+  3. Repository shrinkwrap utility. This new utility
+     allows for exporting large parts of a CernVM-FS repository to an external
+     file system or a "fat image" as they are used in some HPC environments.
 
 Together with CernVM-FS 2.6.0, we also release the CernVM-FS Repository Gateway
 version 1.0. The increased version number indicates that we are ready to assure
@@ -27,17 +28,18 @@ backward compatibility for the component, in line with
 
 Other notable changes include
 
-  * A new server command ``cvmfs_server ingest``, that can be used to directly
-    publish tarballs without extracting them first.
+  * A new server command ``cvmfs_server ingest``, that can be used to
+    :ref:`directly publish tarballs <sct_tarball>` without extracting them
+    first.
 
-  * A new server parameter ``CVMFS_PRINT_STATISTICS``. If enabled, publication
-    and garbage collection runs report key metrics about processed data to the
-    standard output and to a sqlite file.
+  * Publishing and garbage collection now maintain
+    :ref:`operational statistics <sct_repo_stats>`, for instance about the
+    number of files added and deleted.
 
   * Various improvements for the S3 backend.
 
-  * A file system call tracer that can be enabled on the client in order to
-    log the file system accesses to a repository.
+  * A :ref:`file system call tracer <cpt_tracer>` that can be enabled on the
+    client in order to log the file system accesses to a repository.
 
   * Support for bearer token authentication in addition to X.509 authentication
     for protected repositories.
@@ -61,6 +63,44 @@ configuration management system (Puppet, Chef, ...), please see Section
 :ref:`sct_manual_migration`.
 
 
+Container Image Unpacker (DUCC)
+-------------------------------
+
+The :ref:`DUCC system <cpt_ducc>` manages the conversion of container images
+from a Docker registry into an unpacked form on a CernVM-FS repository. The
+converted images can be used with Docker and the :ref:`CernVM-FS graph driver
+plugin <cpt_graphdriver>` for Docker.  They can also be used with Singularity
+and other container engines that work with a flat root file system.
+
+Starting containers from unpacked images in CernVM-FS often provides significant
+time and network traffic savings, as only a small fraction of the files in the
+container image is actually used at runtime.
+
+
+Repository Change Notifications
+-------------------------------
+
+The new :ref:`repository change notification system <cpt_notification_system>`
+provides a publish-subscribe service to instantaneously distribute repository
+updates. On publish, a change notification can be pushed, which is sent to
+via WebSockets to registered clients. The CernVM-FS client can be configured
+to show the new content within few seconds. This facilitates, for instance,
+CI pipelines where build artifacts from one build phase need to be available
+as an input to the next build phase.
+
+
+Shrinkwrap
+----------
+
+The :ref:`shrinkwrap <cpt_shrinkwrap>` utility is a stand-alone tool that
+exports a part of a CernVM-FS repository directory hierarchy to another file
+system.  This exported tree can then be re-packaged into a "fat image" for
+HPC systems, or it can be used for benchmarks that exclude possible performance
+effects caused by the CernVM-FS client, such as network accesses to populate the
+cache.
+
+
+
 Bug Fixes
 ---------
 
@@ -69,9 +109,6 @@ Bug Fixes
   * Client: fix credentials handling on HTTP retries for protected repositories
     (`CVM-1660 <https://sft.its.cern.ch/jira/browse/CVM-1660>`_)
 
-  * Client: add support for ``CVMFS_NFS_INTERLEAVED_INODES`` parameter
-    (`CVM-1561 <https://sft.its.cern.ch/jira/browse/CVM-1561>`_, `Documentation <cpt-configure.html#sct-nfs-interleaved>`_)
-
   * Server: prevent following dirtab entries that point outside the repository
     (`CVM-1608 <https://sft.its.cern.ch/jira/browse/CVM-1608>`_)
 
@@ -94,6 +131,10 @@ Other Improvements
   * Client: generally replace ``@fqrn@`` and ``@org@`` in configuration files
     (`CVM-1526 <https://sft.its.cern.ch/jira/browse/CVM-1526>`_)
 
+  * Client: add support for ``CVMFS_NFS_INTERLEAVED_INODES`` parameter
+    (`CVM-1561 <https://sft.its.cern.ch/jira/browse/CVM-1561>`_,
+    `Documentation <cpt-configure.html#sct-nfs-interleaved>`_)
+
   * Client: new parameter ``CVMFS_CATALOG_WATERMARK`` to unpin catalogs when
     their number surpasses the given watermark
 

cpt-repo.rst

@@ -1265,6 +1265,8 @@ revision containing :ref:`CernVM-FS catalogs <sct_filecatalog>` with updated
 UIDs and GIDs according to the provided rules. Thus, previous revisions of
 the CernVM-FS repository will *not* be affected by this update.
 
+.. _sct_repo_stats:
+
 Publisher Statistics
 --------------------
 

cpt-tracer.rst

@@ -1,3 +1,5 @@
+.. _cpt_tracer:
+
 Tracing File System Accesses
 ============================