Skip to content

Commit

Permalink
Deployed 0f6a6bf with MkDocs version: 1.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Unknown committed Nov 21, 2024
1 parent 48e160a commit 4e5d404
Show file tree
Hide file tree
Showing 4 changed files with 88 additions and 90 deletions.
32 changes: 15 additions & 17 deletions data/osdf/install-cache-rpm/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1821,9 +1821,9 @@


<h1 id="installing-the-osdf-cache">Installing the OSDF Cache<a class="headerlink" href="#installing-the-osdf-cache" title="Permanent link">&para;</a></h1>
<p>This document describes how to install a Pelican-based Open Science Data Federation (OSDF) Cache service via RPMs.
<p>This document describes how to install an Open Science Data Federation (OSDF) Cache service via RPMs.
This service allows a site or regional network to cache data frequently used in Open Science Pool jobs,
reducing data transfer over the wide-area network and decreasing access latency.</p>
reducing data transfer over the wide-area network and increasing throughput to jobs.</p>
<h2 id="before-starting">Before Starting<a class="headerlink" href="#before-starting" title="Permanent link">&para;</a></h2>
<p>Before starting the installation process, consider the following requirements:</p>
<ul>
Expand All @@ -1848,11 +1848,12 @@ <h2 id="before-starting">Before Starting<a class="headerlink" href="#before-star
<li>8 cores</li>
<li>40 Gbps connectivity</li>
<li>2 TB of NVMe disk for the cache partition</li>
<li>24 GB of RAM
We suggest that several gigabytes of local disk space be available for log files,
although some logging verbosity can be reduced.</li>
<li>24 GB of RAM</li>
</ul>
</li>
<li>The cache should be a mounted filesystem; its mount location is referred to as <code>&lt;CACHE PARTITION&gt;</code> in the documentation below.
We suggest that several gigabytes of local disk space be available for log files,
although some logging verbosity can be reduced.</li>
</ul>
</li>
</ul>
Expand All @@ -1862,15 +1863,12 @@ <h2 id="before-starting">Before Starting<a class="headerlink" href="#before-star
<li>Prepare <a href="../../../common/yum/">the required Yum repositories</a></li>
</ul>
<div class="admonition note">
<p class="admonition-title">OSG 23</p>
<p>In OSG 23, the Pelican-based OSDF RPMs are only available in the "osg-upcoming" repositories.</p>
</div>
<div class="admonition note">
<p class="admonition-title">Host certificates</p>
<p>Caches should use a CA that is accepted by major browsers and operating systems,
such as InCommon RSA or <a href="../../../security/host-certs/lets-encrypt/">Let's Encrypt</a>.
IGTF certs are not recommended because clients are not configured to accept them by default.
Note that you will need the full certificate chain, not just the certificate.</p>
<p>Caches are accessed by users through browsers, meaning caches need a certificate from a CA acceptable to a standard browser.
Examples include <a href="../../../security/host-certs/lets-encrypt/">Let's Encrypt</a> or the InCommon IGTF CA.
Caches without a valid certificate for the browser cannot be added to the OSDF.
Note that, unlike legacy grid software, the public certificate file will need to contain the "full chain", including any
intermediate CAs (if you're unsure about your setup, try accessing your cache from your browser).</p>
<p>The following locations should be used (note that they are in separate directories):</p>
<ul>
<li><strong>Host Certificate Chain</strong>: <code>/etc/pki/tls/certs/pelican.crt</code></li>
Expand All @@ -1886,12 +1884,12 @@ <h2 id="installing-the-cache">Installing the Cache<a class="headerlink" href="#i
<p>OSG 23:
<div class="highlight"><pre><span></span><code><span class="gp">root@host # </span>yum install --enablerepo<span class="o">=</span>osg-upcoming-testing osdf-cache
</code></pre></div></p>
<h2 id="configuring-the-cache-server">Configuring the Cache Server<a class="headerlink" href="#configuring-the-cache-server" title="Permanent link">&para;</a></h2>
<div class="admonition note">
<p class="admonition-title">osdf-cache 7.11.1</p>
<p>This configuration requires version 7.11.1 or newer of the <code>osdf-cache</code>
and <code>pelican</code> RPMs.</p>
<p>This document covers versions 7.11.1 and later of the <code>osdf-cache</code> package; ensure the above installation
results in an appropriate version.</p>
</div>
<h2 id="configuring-the-cache-server">Configuring the Cache Server<a class="headerlink" href="#configuring-the-cache-server" title="Permanent link">&para;</a></h2>
<p>In <code>/etc/pelican/config.d/20-cache.yaml</code>, set <code>Cache.LocalRoot</code>, <code>Cache.DataLocation</code> and <code>Cache.MetaLocation</code> as follows,
replacing <code>&lt;CACHE PARTITION&gt;</code> with the mount point of the partition you will use for the cache.
<div class="highlight"><pre><span></span><code>Cache:
Expand All @@ -1911,7 +1909,7 @@ <h2 id="preparing-for-initial-startup">Preparing for Initial Startup<a class="he
<p>The newly created files, <code>issuer.jwk</code> and <code>issuer-pub.jwks</code> are the private and public keys, respectively.</p>
</li>
<li>
<p><strong>Save these files</strong>; if you lose them, your cache will need to be re-approved.</p>
<p><strong>Save these files</strong>; if you lose the <code>issuer.jwk</code>, your cache will need to be re-approved.</p>
</li>
</ol>
<h2 id="validating-the-cache-installation">Validating the Cache Installation<a class="headerlink" href="#validating-the-cache-installation" title="Permanent link">&para;</a></h2>
Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

Loading

0 comments on commit 4e5d404

Please sign in to comment.