Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modest tweaks from reviewing doc #212

Merged
merged 2 commits into from
Nov 21, 2024
Merged

Modest tweaks from reviewing doc #212

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e667fe6
Modest tweaks from reviewing doc
bbockelm Nov 12, 2024
0109773
Put back port 8444 warning pending discussion
matyasselmeci Nov 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 12 additions & 15 deletions docs/data/osdf/install-cache-rpm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ title: Installing the OSDF Cache by RPM
Installing the OSDF Cache
=========================

This document describes how to install a Pelican-based Open Science Data Federation (OSDF) Cache service via RPMs.
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.
reducing data transfer over the wide-area network and increasing throughput to jobs.


Before Starting
Expand Down Expand Up @@ -33,6 +33,7 @@ Before starting the installation process, consider the following requirements:
* 40 Gbps connectivity
* 2 TB of NVMe disk for the cache partition
* 24 GB of RAM
* The cache should be a mounted filesystem; its mount location is referred to as `<CACHE PARTITION>` 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.

Expand All @@ -42,14 +43,12 @@ As with all OSG software installations, there are some one-time steps to prepare
* Prepare [the required Yum repositories](../../common/yum.md)


!!! note "OSG 23"
In OSG 23, the Pelican-based OSDF RPMs are only available in the "osg-upcoming" repositories.

!!! note "Host certificates"
Caches should use a CA that is accepted by major browsers and operating systems,
such as InCommon RSA or [Let's Encrypt](../../security/host-certs/lets-encrypt.md).
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.
Caches are accessed by users through browsers, meaning caches need a certificate from a CA acceptable to a standard browser.
Examples include [Let's Encrypt](../../security/host-certs/lets-encrypt.md) 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).

The following locations should be used (note that they are in separate directories):

Expand All @@ -74,13 +73,12 @@ OSG 23:
root@host # yum install --enablerepo=osg-upcoming-testing osdf-cache
```

!!! note "osdf-cache 7.11.1"
This document covers versions 7.11.1 and later of the `osdf-cache` package; ensure the above installation
results in an appropriate version.

Configuring the Cache Server
----------------------------

!!! note "osdf-cache 7.11.1"
This configuration requires version 7.11.1 or newer of the `osdf-cache`
and `pelican` RPMs.

In `/etc/pelican/config.d/20-cache.yaml`, set `Cache.LocalRoot`, `Cache.DataLocation` and `Cache.MetaLocation` as follows,
replacing `<CACHE PARTITION>` with the mount point of the partition you will use for the cache.
Expand All @@ -91,7 +89,6 @@ Cache:
MetaLocation: "<CACHE PARTITION>/meta"
```


Preparing for Initial Startup
-----------------------------

Expand All @@ -105,7 +102,7 @@ before starting the cache for the first time, it is generate a keypair.

The newly created files, `issuer.jwk` and `issuer-pub.jwks` are the private and public keys, respectively.

1. **Save these files**; if you lose them, your cache will need to be re-approved.
1. **Save these files**; if you lose the `issuer.jwk`, your cache will need to be re-approved.


Validating the Cache Installation
Expand Down
Loading