From 861077ec173dbeae83232247bec2a6f04d24ac21 Mon Sep 17 00:00:00 2001 From: Matyas Selmeci Date: Wed, 11 Dec 2024 12:48:49 -0600 Subject: [PATCH 1/6] Make the Pelican/OSDF cache RPM install instructions public (SOFTWARE-6013) --- mkdocs.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 4570b4be7..9994d5c41 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -68,7 +68,9 @@ nav: - 'Acceptable Use Policy': 'submit/ap-ospool-aup.md' - 'Data Federation (OSDF)': - 'Overview': 'data/stashcache/overview.md' - - Data Cache: + - Pelican-based Data Cache: + - 'Install from RPM': 'data/osdf/install-cache-rpm.md' + - Data Cache (old): - 'Install from container': 'data/stashcache/run-stashcache-container.md' - 'Install from RPM': 'data/stashcache/install-cache.md' - Data Origin: From f57815ad235019f7b81730f0b5a30dfa49629bbc Mon Sep 17 00:00:00 2001 From: Matyas Selmeci Date: Thu, 12 Dec 2024 16:17:48 -0600 Subject: [PATCH 2/6] Move old cache install doc to an 'archive' section --- mkdocs.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 9994d5c41..147f6138c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -72,7 +72,6 @@ nav: - 'Install from RPM': 'data/osdf/install-cache-rpm.md' - Data Cache (old): - 'Install from container': 'data/stashcache/run-stashcache-container.md' - - 'Install from RPM': 'data/stashcache/install-cache.md' - Data Origin: - 'Install from container': 'data/stashcache/run-stash-origin-container.md' - 'Install from RPM': 'data/stashcache/install-origin.md' @@ -98,6 +97,9 @@ nav: - 'Overview': 'security/host-certs/overview.md' - 'Using InCommon': 'security/host-certs/incommon.md' - "Using Let's Encrypt": 'security/host-certs/lets-encrypt.md' +- Archive: + - Data Cache (old): + - 'Install from RPM': 'data/stashcache/install-cache.md' markdown_extensions: - admonition From e1a479e9a7265bfd60b8f880a5d61fc3fc592cfc Mon Sep 17 00:00:00 2001 From: Matyas Selmeci Date: Thu, 12 Dec 2024 16:22:56 -0600 Subject: [PATCH 3/6] Link the old RPM cache install doc to the new RPM cache install doc --- docs/data/stashcache/install-cache.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/data/stashcache/install-cache.md b/docs/data/stashcache/install-cache.md index 93e8442ed..7cceca428 100644 --- a/docs/data/stashcache/install-cache.md +++ b/docs/data/stashcache/install-cache.md @@ -6,7 +6,9 @@ Installing the OSDF Cache !!! warning "Deprecation warning" This document is outdated and describes an XCache-based OSDF Cache install, which is deprecated. - Future OSDF Caches should be based on Pelican; documentation for a Pelican-based OSDF Cache install is forthcoming. + Future OSDF Caches should be based on Pelican. + + See the [Pelican-based Installing the OSDF Cache by RPM](../../osdf/install-cache-rpm) document This document describes how to install an Open Science Data Federation (OSDF) cache service. This service allows a site or regional network to cache data frequently used on the OSG, reducing data transfer over the wide-area network and From 20012261e5865dd5a473334778935ba5cdda5cb6 Mon Sep 17 00:00:00 2001 From: Matyas Selmeci Date: Thu, 12 Dec 2024 17:00:53 -0600 Subject: [PATCH 4/6] Copy the deprecation warning a couple of times just to remind the reader --- docs/data/stashcache/install-cache.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/data/stashcache/install-cache.md b/docs/data/stashcache/install-cache.md index 7cceca428..0c24702c9 100644 --- a/docs/data/stashcache/install-cache.md +++ b/docs/data/stashcache/install-cache.md @@ -54,6 +54,12 @@ As with all OSG software installations, there are some one-time steps to prepare Registering the Cache --------------------- +!!! warning "Deprecation warning" + This document is outdated and describes an XCache-based OSDF Cache install, which is deprecated. + Future OSDF Caches should be based on Pelican. + + See the [Pelican-based Installing the OSDF Cache by RPM](../../osdf/install-cache-rpm) document + To be part of the OSDF, your cache must be registered with the OSG. You will need basic information like the resource name, hostname, host certificate DN, and the administrative and security contacts. @@ -151,6 +157,12 @@ Mention in your ticket that you would like to "Finalize the cache registration." Installing the Cache -------------------- +!!! warning "Deprecation warning" + This document is outdated and describes an XCache-based OSDF Cache install, which is deprecated. + Future OSDF Caches should be based on Pelican. + + See the [Pelican-based Installing the OSDF Cache by RPM](../../osdf/install-cache-rpm) document + The OSDF software consists of an XRootD server with special configuration and supporting services. To simplify installation, OSG provides convenience RPMs that install all required packages with a single command: @@ -252,6 +264,7 @@ To use HTTPS: Manually Setting the FQDN (optional) ------------------------------------ + The FQDN of the cache server that you registered in [Topology](#registering-the-cache) may be different than its internal hostname (as reported by `hostname -f`). For example, this may be the case if your cache is behind a load balancer such as LVS. From 99cad1bf0dd379122cbf9c5791f6e3605e47524b Mon Sep 17 00:00:00 2001 From: Matyas Selmeci Date: Thu, 12 Dec 2024 17:06:32 -0600 Subject: [PATCH 5/6] Apply suggestions from @brianhlin --- mkdocs.yml | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 147f6138c..1476daad7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -68,10 +68,11 @@ nav: - 'Acceptable Use Policy': 'submit/ap-ospool-aup.md' - 'Data Federation (OSDF)': - 'Overview': 'data/stashcache/overview.md' - - Pelican-based Data Cache: + - Data Cache: - 'Install from RPM': 'data/osdf/install-cache-rpm.md' - - Data Cache (old): + - Data Cache (deprecated): - 'Install from container': 'data/stashcache/run-stashcache-container.md' + - 'Install from RPM': 'data/stashcache/install-cache.md' - Data Origin: - 'Install from container': 'data/stashcache/run-stash-origin-container.md' - 'Install from RPM': 'data/stashcache/install-origin.md' @@ -97,9 +98,6 @@ nav: - 'Overview': 'security/host-certs/overview.md' - 'Using InCommon': 'security/host-certs/incommon.md' - "Using Let's Encrypt": 'security/host-certs/lets-encrypt.md' -- Archive: - - Data Cache (old): - - 'Install from RPM': 'data/stashcache/install-cache.md' markdown_extensions: - admonition From b0e53154c5cc2b222aa1d1cf0c2cd0efee6b26ed Mon Sep 17 00:00:00 2001 From: Matyas Selmeci Date: Thu, 12 Dec 2024 17:11:04 -0600 Subject: [PATCH 6/6] Copy the admonition a few more times --- docs/data/stashcache/install-cache.md | 36 +++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/docs/data/stashcache/install-cache.md b/docs/data/stashcache/install-cache.md index 0c24702c9..247c1bede 100644 --- a/docs/data/stashcache/install-cache.md +++ b/docs/data/stashcache/install-cache.md @@ -174,6 +174,12 @@ root@host # yum install stash-cache Configuring the Cache --------------------- +!!! warning "Deprecation warning" + This document is outdated and describes an XCache-based OSDF Cache install, which is deprecated. + Future OSDF Caches should be based on Pelican. + + See the [Pelican-based Installing the OSDF Cache by RPM](../../osdf/install-cache-rpm) document + First, you must create a "cache directory", which will be used to store downloaded files. By default this is `/mnt/stash`. We recommend using a separate file system for the cache directory, @@ -216,6 +222,12 @@ The easiest solution for this is to use your host certificate and key as follows Configuring Optional Features ----------------------------- +!!! warning "Deprecation warning" + This document is outdated and describes an XCache-based OSDF Cache install, which is deprecated. + Future OSDF Caches should be based on Pelican. + + See the [Pelican-based Installing the OSDF Cache by RPM](../../osdf/install-cache-rpm) document + ### Adjust disk utilization To adjust the disk utilization of your cache, create or edit a file named `/etc/xrootd/config.d/90-local.cfg` @@ -265,6 +277,12 @@ To use HTTPS: Manually Setting the FQDN (optional) ------------------------------------ +!!! warning "Deprecation warning" + This document is outdated and describes an XCache-based OSDF Cache install, which is deprecated. + Future OSDF Caches should be based on Pelican. + + See the [Pelican-based Installing the OSDF Cache by RPM](../../osdf/install-cache-rpm) document + The FQDN of the cache server that you registered in [Topology](#registering-the-cache) may be different than its internal hostname (as reported by `hostname -f`). For example, this may be the case if your cache is behind a load balancer such as LVS. @@ -283,6 +301,12 @@ In this case, you must manually tell the cache services which FQDN to use for to Adding to Authorization Files (Optional) --------------------------------------------------------- +!!! warning "Deprecation warning" + This document is outdated and describes an XCache-based OSDF Cache install, which is deprecated. + Future OSDF Caches should be based on Pelican. + + See the [Pelican-based Installing the OSDF Cache by RPM](../../osdf/install-cache-rpm) document + The `stash-authfile` services on the cache generate files that configure authorization for XRootD. Put local additions to this configuration into separate files, according to this table: @@ -299,6 +323,12 @@ Put local additions to this configuration into separate files, according to this Managing OSDF services ------------------------------------------- +!!! warning "Deprecation warning" + This document is outdated and describes an XCache-based OSDF Cache install, which is deprecated. + Future OSDF Caches should be based on Pelican. + + See the [Pelican-based Installing the OSDF Cache by RPM](../../osdf/install-cache-rpm) document + These services must be managed by `systemctl` and may start additional services as dependencies. As a reminder, here are common service commands (all run as `root`): @@ -336,6 +366,12 @@ As a reminder, here are common service commands (all run as `root`): Validating the Cache --------------------- +!!! warning "Deprecation warning" + This document is outdated and describes an XCache-based OSDF Cache install, which is deprecated. + Future OSDF Caches should be based on Pelican. + + See the [Pelican-based Installing the OSDF Cache by RPM](../../osdf/install-cache-rpm) document + The cache server functions as a normal HTTP server and can interact with typical HTTP clients, such as `curl`.