Merge pull request #226 from brianhlin/SOFTWARE-6043.osdf-origin-rpm-…

…upgrade

Add OSG origin upgrade docs (SOFTWARE-6043)

docs/data/osdf/install-origin-rpm.md

@@ -36,6 +36,13 @@ As with all OSG software installations, there are some one-time steps to prepare
 * Prepare [the required Yum repositories](../../common/yum.md);
   the [OSG 24 repositories](../../common/yum.md#install-the-osg-repositories) should be used.
 
+    !!! danger "Upgrading to a Pelican origin"
+        If you are upgrading from a pre-Pelican OSDF origin, update all of your OSG 23 packages before installing the OSG 24
+        repositories:
+
+            :::console
+            root@host # yum update
+
 !!! note "Host certificates"
     Origins are accessed by users through browsers, meaning origins 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 RSA CA.
@@ -48,7 +55,34 @@ As with all OSG software installations, there are some one-time steps to prepare
     * **Host Certificate Chain**: `/etc/pki/tls/certs/pelican.crt`
     * **Host Key**: `/etc/pki/tls/private/pelican.key`
 
+Upgrading a Non-Pelican Origin
+------------------------------
 
+If you are running a non-Pelican origin, e.g. one that was installed before OSG 24, there are special considerations for
+the upgrade to ensure minimal downtime for your users.
+This document will guide you through the upgrade process by installing and configuring a Pelican origin alongside your
+non-Pelican origin.
+
+!!! note "Using different hosts"
+    You may install your new Pelican origin on a separate host if your underlying data store is shared between hosts.
+
+First, determine if you have an active non-Pelican origin service running:
+
+```console
+user@host $ systemctl status xrootd@stash-origin-auth \
+                             xrootd@stash-origin \
+                             xrootd-privileged@stash-origin-auth \
+            | grep -F 'Active: active'
+   Active: active (running) since Wed 2024-12-04 17:46:17 CST; 1 weeks 1 days ago
+```
+
+*   **If you do not see any output from the above command**, you may proceed with the rest of the documentation.
+
+*   **If you see any output from the above command**, you may proceed with the rest of the documentation but keep an eye
+    out for special instructions related to the upgrade:
+
+    !!! danger "Upgrading to a Pelican origin"
+        You will find upgrade-specific instructions here.
 
 Installing the Origin
 ---------------------
@@ -57,7 +91,6 @@ The origin service is provided by the `osdf-origin` RPM.
 Install it using the following command:
 
 
-OSG 24:
 ```console
 root@host # yum install osdf-origin
 ```
@@ -145,14 +178,19 @@ Do the following steps to verify that the origin is functional:
 Joining the Origin to the Federation
 ------------------------------------
 
+!!! danger "Upgrading to a Pelican origin"
+    Once registered, all OSDF clients of your namespace will be directed to your Pelican origin.
+    Before initiating this process, ensure that your Pelican origin is functioning and that you are ready to migrate
+    production transfers.
+
 The origin must be registered with the OSG prior to joining the data federation.
 Send mail to <help@osg-htc.org> requesting registration; provide the following information:
 
 *   Origin hostname
 *   Administrative and security contact(s)
 *   Institution that the origin belongs to
 
-OSG Staff will register the origin and respond with the Resource Name that the origin was registered as.
+OSG Staff will register the origin and respond with the Resource Name.
 
 Once you have that information, edit `/etc/pelican/config.d/15-osdf.yaml`, and set `XRootD.Sitename`:
 ```
@@ -166,46 +204,37 @@ Then, restart the origin by running
 root@host$ systemctl restart osdf-origin
 ```
 
-Let OSG Staff know that you have restarted the origin with the updated sitename,
-so they can approve the new origin.
-
-
-
-<!--
-
-Upgrading a Non-Pelican Origin
-------------------------------
+Validating the Origin Through the Federation
+----------------------------------
 
-If you are running a non-Pelican origin, e.g. one that was installed before OSG 24, there are special consideratiosn for
-the upgrade to ensure minimal downtime for your users.
+Once your origin has been registered in the federation:
 
-1.  Verify that you are not already running a Pelican-based origin, run the following on your origin host:
+1.  Download a test file (POSIX) or object (S3) from your origin (replacing `ORIGIN_HOSTNAME` with the host name of your origin,
+    and TEST_PATH with the OSDF path to the test file or object:
 
         :::console
-        root@host # systemctl status osdf-origin
-        Unit osdf-origin.service could not be found.
-
-    If you see the following, then you are not running a Pelican-based origin and should proceed with the rest of the
-    instructions in this section
-
-1.  Install the origin
-
-1.  Configure the origin
+        user@host $ curl -L https://osdf-director.osg-htc.org:8443/TEST_PATH -o /tmp/testfile
 
-1.  Directly verify the origin
-
-1.  Register the origin in the Director and Topology
-
-    !!! danger ""
+    Verify the contents of `/tmp/testfile` match the test file or object your origin was serving.
 
-1.  Verify the origin through the OSDF director
+    If the download fails, debugging information is located in `/var/log/pelican/osdf-origin.log`.
+    See [this page](../../common/help.md) for requesting assistance; please include the log file
+    in your request.
 
-1.  Uninstall the old service:
+1.  Verify that your test is running against your Pelican origin:
 
         :::console
-        root@host # yum remove stash-origin
+        user@host $ grep <TEST_PATH> /var/log/pelican/osdf-origin.log
 
--->
+    Replacing `<TEST PATH>` with the same path that you used in step (1).
+    If you see output, then the OSDF is directing client requests to your Pelican origin!
+    If you do not see output, please [contact us](#getting-help).
+
+!!! danger "Upgrading to a Pelican origin"
+    Congratulations, you have fully verified the functionality of your Pelican origin!
+    You may uninstall the non-Pelican origin:
+
+        root@host $ yum remove stash-origin
 
 Managing the Origin Service
 ---------------------------

docs/release/updating-to-osg-24.md

@@ -5,21 +5,17 @@ Updating to OSG 24
 
 [OSG 24](release_series.md#series-overviews) (the *new series*) introduces support for the ARM architecture. Changes
 required to upgrade from OSG 23 are relatively minor.
-
--   [Compute Entrypoints](../compute-element/htcondor-ce-overview.md) should be updated to OSG 24 as soon as possible.
-
--   [HTCondor pools](#updating-your-htcondor-hosts) and [access points](#updating-your-osg-access-point) should be
-    updated to OSG 24 as soon as possible.
-
--   All other services (e.g., OSG Worker Node clients, Frontier Squids) should be updated to
-    [OSG 24](#updating-the-osg-repositories) as soon as possible.
+Please update all services to OSG 24 as soon as possible.
 
 Updating the OSG Repositories
 -----------------------------
 
-1.  Prerequisites:
+1.  Consult the relevant section for the service you're upgrading before updating the OSG Yum repositories:
 
-    -   Consult the [access point](#updating-your-osg-access-point), [compute entrypoint](#updating-your-osg-compute-entrypoint), and/or [HTCondor hosts](#updating-your-htcondor-hosts) upgrade notes before updating the OSG repositories.
+    -   [Access Point](#updating-your-osg-access-point)
+    -   [Compute Entrypoint](#updating-your-osg-compute-entrypoint)
+    -   [HTCondor hosts](#updating-your-htcondor-hosts)
+    -   [OSDF Origin](#updating-your-osdf-origin)
 
 1.  Clean the yum cache:
 
@@ -44,8 +40,6 @@ Updating the OSG Repositories
         Because configuration updates will be necessary, be sure to turn off any OSG services
         before updating them. Consult the sections below that match your situation.
 
-    <!-- comment -->
-
         :::console
         root@host # yum update
 
@@ -185,6 +179,23 @@ If you are running an HTCondor pool, consult the following instructions to updat
 
 You may proceed with the [repository and RPM update process](#updating-the-osg-repositories).
 
+
+Updating Your OSDF Origin
+-------------------------
+
+In OSG 24, the OSDF Origin has been updated to use the [Pelican Platform](https://pelicanplatform.org/).
+To update your OSG 23 OSDF Origin, follow the instructions below to minimize service disruptions.
+
+1.  Before installing the OSG 24 Yum repositories,
+    update your OSG packages (see [warnings above](#updating-the-osg-repositories)):
+
+        :::console
+        root@host # yum update
+
+1.  Follow the documentation in the [OSDF origin installation guide](../data/osdf/install-origin-rpm.md) and watch out
+    for upgrade-specific instructions.
+
+
 Getting Help
 ------------