Deployed ce40c86 with MkDocs version: 1.6.1

filesystem_layer/stratum1/index.html

@@ -2083,7 +2083,7 @@ <h3 id="configuration-using-ansible">Configuration using Ansible<a class="header
 However, for a private Stratum 1 this can be skipped, and you can disable the use of the GEO API in the configuration of your clients by setting <code>CVMFS_USE_GEOAPI=no</code>.
 In this case, they will just connect to your local Stratum 1 by default.</p>
 <p>If you do want to set up the GEO API, you can find more information on how to (freely) obtain this key in the CVMFS documentation: https://cvmfs.readthedocs.io/en/stable/cpt-replica.html#geo-api-setup.</p>
-<p>You can put your license key in the local configuration file <code>inventory/local_site_specific_vars.yml</code>.</p>
+<p>You can put your license key in the local configuration file <code>inventory/local_site_specific_vars.yml</code> with the variables <code>cvmfs_geo_license_key</code> and <code>cvmfs_geo_account_id</code>.</p>
 </div>
 <p>Start by installing Ansible, e.g.:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>sudo<span class="w"> </span>yum<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>ansible
@@ -2096,36 +2096,42 @@ <h3 id="configuration-using-ansible">Configuration using Ansible<a class="header
 create a symlink before running the playbook:
 <div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>sudo<span class="w"> </span>ln<span class="w"> </span>-s<span class="w"> </span>/lots/of/space/cvmfs<span class="w"> </span>/srv/cvmfs
 </code></pre></div></p>
-<p>Also make sure that you have added the hostname or IP address of your server to the
-<code>inventory/hosts</code> file, that you are able to log in to the server from the machine that is going to run the playbook
-(preferably using an SSH key), and that you can use <code>sudo</code>. </p>
+<p>Also make sure that:
+  - you are able to log in to the server from the machine that is going to run the playbook (preferably using an SSH key);
+  - you can use <code>sudo</code> on this machine;
+  - you add the hostname or IP address of your server to a <code>cvmfsstratum1servers</code> section in the <code>inventory/hosts</code> file, e.g.:
+<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>[cvmfsstratum1servers]
+<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>12.34.56.789 ansible_ssh_user=yourusername
+</code></pre></div></p>
 <p>Finally, install the Stratum 1 using:</p>
-<p><div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="c1"># -b to run as root, optionally use -K if a sudo password is required, and optionally include your site-specific variables</span>
-<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>ansible-playbook<span class="w"> </span>-b<span class="w"> </span><span class="o">[</span>-K<span class="o">]</span><span class="w"> </span><span class="o">[</span>-e<span class="w"> </span>@inventory/local_site_specific_vars.yml<span class="o">]</span><span class="w"> </span>stratum1.yml
+<p><div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="c1"># -b to run as root, optionally use -K if a sudo password is required, and optionally include your site-specific variables</span>
+<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a>ansible-playbook<span class="w"> </span>-b<span class="w"> </span><span class="o">[</span>-K<span class="o">]</span><span class="w"> </span><span class="o">[</span>-e<span class="w"> </span>@inventory/local_site_specific_vars.yml<span class="o">]</span><span class="w"> </span>stratum1.yml
 </code></pre></div>
-Running the playbook will automatically make replicas of all the repositories defined in <code>group_vars/all.yml</code>.</p>
+Running the playbook will automatically make replicas of all the EESSI repositories defined in <code>inventory/group_vars/all.yml</code>.
+If you only want to replicate the main software repository (<code>software.eessi.io</code>),
+you can remove the other ones from the <code>eessi_cvmfs_repositories</code> list in this file.</p>
 <h3 id="verification-of-the-stratum-1-using-curl">Verification of the Stratum 1 using <code>curl</code><a class="headerlink" href="#verification-of-the-stratum-1-using-curl" title="Permanent link">&para;</a></h3>
 <p>When the playbook has finished, your Stratum 1 should be ready. In order to test your Stratum 1,
 even without a client installed, you can use <code>curl</code>:</p>
-<p><div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>curl<span class="w"> </span>--head<span class="w"> </span>http://&lt;url-or-ip-to-your-stratum1&gt;/cvmfs/software.eessi.io/.cvmfspublished
+<p><div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>curl<span class="w"> </span>--head<span class="w"> </span>http://&lt;url-or-ip-to-your-stratum1&gt;/cvmfs/software.eessi.io/.cvmfspublished
 </code></pre></div>
 This should return something like:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>HTTP/1.1<span class="w"> </span><span class="m">200</span><span class="w"> </span>OK
-<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a>...
-<a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a>Content-Type:<span class="w"> </span>application/x-cvmfs
+<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>HTTP/1.1<span class="w"> </span><span class="m">200</span><span class="w"> </span>OK
+<a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a>...
+<a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a>Content-Type:<span class="w"> </span>application/x-cvmfs
 </code></pre></div>
 <p>Example with the EESSI Stratum 1 running in AWS:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>curl<span class="w"> </span>--head<span class="w"> </span>http://aws-eu-central-s1.eessi.science/cvmfs/software.eessi.io/.cvmfspublished
+<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>curl<span class="w"> </span>--head<span class="w"> </span>http://aws-eu-central-s1.eessi.science/cvmfs/software.eessi.io/.cvmfspublished
 </code></pre></div>
 <h3 id="verification-of-the-stratum-1-using-a-cvmfs-client">Verification of the Stratum 1 using a CVMFS client<a class="headerlink" href="#verification-of-the-stratum-1-using-a-cvmfs-client" title="Permanent link">&para;</a></h3>
 <p>You can, of course, also test access to your Stratum 1 from a client.
 This requires you to install a CernVM-FS client and add the Stratum 1 to the client configuration;
 this is explained in more detail on the <a href="../../getting_access/native_installation/">native installation page</a>.</p>
 <p>Then verify that the client connects to your new Stratum 1 by running:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>cvmfs_config<span class="w"> </span>stat<span class="w"> </span>-v<span class="w"> </span>software.eessi.io
+<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>cvmfs_config<span class="w"> </span>stat<span class="w"> </span>-v<span class="w"> </span>software.eessi.io
 </code></pre></div>
 <p>Assuming that your new Stratum 1 is working properly, this should return something like:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>Connection:<span class="w"> </span>http://&lt;url-or-ip-to-your-stratum1&gt;/cvmfs/software.eessi.io<span class="w"> </span>through<span class="w"> </span>proxy<span class="w"> </span>DIRECT<span class="w"> </span><span class="o">(</span>online<span class="o">)</span>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a>Connection:<span class="w"> </span>http://&lt;url-or-ip-to-your-stratum1&gt;/cvmfs/software.eessi.io<span class="w"> </span>through<span class="w"> </span>proxy<span class="w"> </span>DIRECT<span class="w"> </span><span class="o">(</span>online<span class="o">)</span>
 </code></pre></div>
 
 
@@ -2147,7 +2153,7 @@ <h3 id="verification-of-the-stratum-1-using-a-cvmfs-client">Verification of the
     <span class="md-icon" title="Last update">
       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">June 4, 2024</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">November 15, 2024</span>
   </span>
 
 

getting_access/native_installation/index.html

@@ -2114,18 +2114,22 @@ <h3 id="configuring-your-client-to-use-a-private-stratum-1-mirror-server">Config
 you can instruct your CernVM-FS client(s) to use it by prepending your newly created Stratum 1 to the existing list of EESSI Stratum 1 servers by creating a local CVMFS configuration file for the EESSI domain:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="nb">echo</span><span class="w"> </span><span class="s1">&#39;CVMFS_SERVER_URL=&quot;http://&lt;url-or-ip-to-your-stratum1&gt;/cvmfs/@fqrn@;$CVMFS_SERVER_URL&quot;&#39;</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>sudo<span class="w"> </span>tee<span class="w"> </span>-a<span class="w"> </span>/etc/cvmfs/domain.d/eessi.io.local
 </code></pre></div>
+<p>It is also strongly recommended to disable the GEO API when using a private Stratum 1, because you want your private Stratum 1 to be picked first anyway.
+In order to do this, add the following to <code>/etc/cvmfs/domain.d/eessi.io.local</code>:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="nv">CVMFS_USE_GEOAPI</span><span class="o">=</span>no
+</code></pre></div>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>By prepending your new Stratum 1 to the list of existing Stratum 1 servers, your clients should by default use the private Stratum 1.
+<p>By prepending your new Stratum 1 to the list of existing Stratum 1 servers and disabling the GEO API, your clients should by default use the private Stratum 1.
 In case of downtime of your private Stratum 1, they will also still be able to make use of the public EESSI Stratum 1 servers.</p>
 </div>
 <h3 id="applying-changes-in-the-cernvm-fs-client-configuration-files">Applying changes in the CernVM-FS client configuration files<a class="headerlink" href="#applying-changes-in-the-cernvm-fs-client-configuration-files" title="Permanent link">&para;</a></h3>
 <p>After you have made any changes to the CernVM-FS client configuration, you will have to apply them.
 If this is the first time you set up the client, you can simply run:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>sudo<span class="w"> </span>cvmfs_config<span class="w"> </span>setup
+<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>sudo<span class="w"> </span>cvmfs_config<span class="w"> </span>setup
 </code></pre></div>
 <p>If you already had configured the client before, you can reload the configuration for the EESSI repository (or, similarly, for any other repository) using:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>sudo<span class="w"> </span>cvmfs_config<span class="w"> </span>reload<span class="w"> </span>-c<span class="w"> </span>software.eessi.io
+<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>sudo<span class="w"> </span>cvmfs_config<span class="w"> </span>reload<span class="w"> </span>-c<span class="w"> </span>software.eessi.io
 </code></pre></div>
 
 
@@ -2147,7 +2151,7 @@ <h3 id="applying-changes-in-the-cernvm-fs-client-configuration-files">Applying c
     <span class="md-icon" title="Last update">
       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 30, 2024</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">November 15, 2024</span>
   </span>