Merge pull request #219 from matyasselmeci/pr/make-cache-doc-public

Make the Pelican/OSDF cache RPM install instructions public (SOFTWARE-6013)

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
@@ -52,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.
@@ -149,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:
@@ -160,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,
@@ -202,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`
@@ -250,6 +276,13 @@ 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.
@@ -268,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:
 
@@ -284,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`):
 
@@ -321,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`.
 
 

mkdocs.yml

@@ -69,6 +69,8 @@ nav:
 - 'Data Federation (OSDF)':
   - 'Overview': 'data/stashcache/overview.md'
   - Data Cache:
+      - 'Install from RPM': 'data/osdf/install-cache-rpm.md'
+  - Data Cache (deprecated):
       - 'Install from container': 'data/stashcache/run-stashcache-container.md'
       - 'Install from RPM': 'data/stashcache/install-cache.md'
   - Data Origin: