Deployed 25bf0b0 with MkDocs version: 1.5.3

access/client/index.html

@@ -612,6 +612,72 @@
     </span>
   </a>
 
+    <nav class="md-nav" aria-label="Minimal client configuration">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#configuration_hierarchy" class="md-nav__link">
+    <span class="md-ellipsis">
+      Hierarchy of configuration files
+    </span>
+  </a>
+
+    <nav class="md-nav" aria-label="Hierarchy of configuration files">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#order-of-configuration-files" class="md-nav__link">
+    <span class="md-ellipsis">
+      Order of configuration files
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#general-level" class="md-nav__link">
+    <span class="md-ellipsis">
+      General level
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#domain-specific-level" class="md-nav__link">
+    <span class="md-ellipsis">
+      Domain-specific level
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#repository-specific-level" class="md-nav__link">
+    <span class="md-ellipsis">
+      Repository-specific level
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#show-configuration" class="md-nav__link">
+    <span class="md-ellipsis">
+      Show configuration
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
 </li>
 
         <li class="md-nav__item">
@@ -666,7 +732,7 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#inspecting-repository-configuration" class="md-nav__link">
+  <a href="#inspecting_configuration" class="md-nav__link">
     <span class="md-ellipsis">
       Inspecting repository configuration
     </span>
@@ -933,6 +999,72 @@
     </span>
   </a>
 
+    <nav class="md-nav" aria-label="Minimal client configuration">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#configuration_hierarchy" class="md-nav__link">
+    <span class="md-ellipsis">
+      Hierarchy of configuration files
+    </span>
+  </a>
+
+    <nav class="md-nav" aria-label="Hierarchy of configuration files">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#order-of-configuration-files" class="md-nav__link">
+    <span class="md-ellipsis">
+      Order of configuration files
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#general-level" class="md-nav__link">
+    <span class="md-ellipsis">
+      General level
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#domain-specific-level" class="md-nav__link">
+    <span class="md-ellipsis">
+      Domain-specific level
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#repository-specific-level" class="md-nav__link">
+    <span class="md-ellipsis">
+      Repository-specific level
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#show-configuration" class="md-nav__link">
+    <span class="md-ellipsis">
+      Show configuration
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
 </li>
 
         <li class="md-nav__item">
@@ -987,7 +1119,7 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#inspecting-repository-configuration" class="md-nav__link">
+  <a href="#inspecting_configuration" class="md-nav__link">
     <span class="md-ellipsis">
       Inspecting repository configuration
     </span>
@@ -1127,6 +1259,63 @@ <h2 id="minimal_configuration">Minimal client configuration<a class="headerlink"
 <p>For more information on cache-related configuration settings,
 <a href="https://cvmfs.readthedocs.io/en/stable/cpt-configure.html#cache-settings">see the CernVM-FS documentation</a>.</p>
 </details>
+<h3 id="configuration_hierarchy">Hierarchy of configuration files<a class="headerlink" href="#configuration_hierarchy" title="Permanent link">&para;</a></h3>
+<p>CernVM-FS can be configured through a <em>hierarchy</em> of configuration files (sometimes also referred to as
+parameter files), which can be located under either <code>/etc/cvmfs</code>, or the <a href="https://cvmfs.readthedocs.io/en/stable/cpt-configure.html#the-config-repository">CernVM-FS configuration repository</a>
+that is being used (there can be only one), which lives under <code>/cvmfs</code> and is determined by the
+<code>CVMFS_CONFIG_REPOSITORY</code> configuration setting.</p>
+<p>There are 3 levels of configuration files: <a href="#cfg_general">general</a>, <a href="#cfg_domain">domain-specific</a>, and <a href="#cfg_repository">repository-specific</a>.</p>
+<p>Each CernVM-FS configuration file has either <code>.conf</code> or <code>.local</code> as file extension.</p>
+<h4 id="order-of-configuration-files">Order of configuration files<a class="headerlink" href="#order-of-configuration-files" title="Permanent link">&para;</a></h4>
+<p>A CernVM-FS configuration file is <em>sourced</em> to set the configuration settings (a.k.a. parameters)
+it specifies, in the order outlined below:</p>
+<ul>
+<li>By level: first general, then domain-specific, finally repository-specific;</li>
+<li>Within each level:<ul>
+<li><code>.conf</code> before <code>.local</code>;</li>
+<li>CernVM-FS configuration repository before <code>/etc/cvmfs</code> (except for general level);</li>
+</ul>
+</li>
+</ul>
+<p>As a result, a configuration file that is picked up later can override configuration settings
+that were specified in an earlier consider configuration file.</p>
+<p>Concrete example: the settings in the general <code>/etc/cvmfs/default.local</code> configuration file
+are overridden by those specified in the domain-specific configuration file
+<code>/cvmfs/cvmfs-config.cern.ch/etc/cvmfs/domain.d/eessi.io.conf</code> (which is located in
+the default CernVM-FS configuration repository <code>cvmfs-config.cern.ch</code>).</p>
+<h4 id="general-level">General level<a class="headerlink" href="#general-level" title="Permanent link">&para;</a></h4>
+<p>At the general level, the following configuration files are considered (in order):</p>
+<ul>
+<li><code>/etc/cvmfs/default.conf</code></li>
+<li><code>/etc/cvmfs/default.d/*.conf</code> (in alphabetical order)</li>
+<li><code>$CVMFS_CONFIG_REPOSITORY/etc/cvmfs/default.conf</code></li>
+<li><code>/etc/cvmfs/default.local</code></li>
+</ul>
+<h4 id="domain-specific-level">Domain-specific level<a class="headerlink" href="#domain-specific-level" title="Permanent link">&para;</a></h4>
+<p>At the domain-specific level, the following configuration files are considered (in order):</p>
+<ul>
+<li><code>$CVMFS_CONFIG_REPOSITORY/etc/cvmfs/domain.d/DOMAIN.conf</code></li>
+<li><code>/etc/cvmfs/domain.d/DOMAIN.conf</code></li>
+<li><code>/etc/cvmfs/domain.d/DOMAIN.local</code></li>
+</ul>
+<p>where "<code>DOMAIN</code>" is replaced by the domain of the CernVM-FS repository being considered,
+like <code>eessi.io</code> for <code>software.eessi.io</code>.</p>
+<h4 id="repository-specific-level">Repository-specific level<a class="headerlink" href="#repository-specific-level" title="Permanent link">&para;</a></h4>
+<p>At the repository-specific level, the following configuration files are considered (in order):</p>
+<ul>
+<li><code>$CVMFS_CONFIG_REPOSITORY/etc/cvmfs/config.d/&lt;your_repository&gt;.conf</code></li>
+<li><code>/etc/cvmfs/config.d/&lt;your_repository&gt;.conf</code></li>
+<li><code>/etc/cvmfs/config.d/&lt;your_repository&gt;.local</code></li>
+</ul>
+<h3 id="show-configuration">Show configuration<a class="headerlink" href="#show-configuration" title="Permanent link">&para;</a></h3>
+<p>To show all configuration settings in alphabetical order, including by which configuration file it got set,
+use <code>cvmfs_config showconfig</code>, for example:</p>
+<div class="copy highlight"><pre><span></span><code>cvmfs_config<span class="w"> </span>showconfig<span class="w"> </span>software.eessi.io
+</code></pre></div>
+<p>For <code>CVMFS_QUOTA_LIMIT</code>, you should see this in the output:</p>
+<div class="highlight"><pre><span></span><code>CVMFS_QUOTA_LIMIT=10000    # from /etc/cvmfs/default.local
+</code></pre></div>
+<p>See also <a href="#inspecting_configuration">Inspecting repository configuration</a>.</p>
 <h2 id="completing-the-client-setup">Completing the client setup<a class="headerlink" href="#completing-the-client-setup" title="Permanent link">&para;</a></h2>
 <p>To complete the setup of the CernVM-FS client component,
 we need to make sure that a <code>cvmfs</code> service account and group are present on the system,
@@ -1199,7 +1388,7 @@ <h2 id="default-repositories">Default repositories<a class="headerlink" href="#d
 <div class="highlight"><pre><span></span><code>$ ls /cvmfs/software.eessi.io
 README.eessi  host_injections  versions
 </code></pre></div>
-<h2 id="inspecting-repository-configuration">Inspecting repository configuration<a class="headerlink" href="#inspecting-repository-configuration" title="Permanent link">&para;</a></h2>
+<h2 id="inspecting_configuration">Inspecting repository configuration<a class="headerlink" href="#inspecting_configuration" title="Permanent link">&para;</a></h2>
 <p>To check whether a specific CernVM-FS repository is accessible, we can <em>probe</em> it:</p>
 <div class="highlight"><pre><span></span><code>$ cvmfs_config probe software.eessi.io
 Probing /cvmfs/software.eessi.io... OK