Skip to content

Commit

Permalink
Add new OSDF origin doc to the TOC; add some deprecation notices to t…
Browse files Browse the repository at this point in the history
…he old origin doc, with links to the new doc
  • Loading branch information
matyasselmeci committed Dec 12, 2024
1 parent a94302f commit 926e637
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 2 deletions.
55 changes: 54 additions & 1 deletion docs/data/stashcache/install-origin.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ Installing the OSDF Origin

!!! warning "Deprecation warning"
This document is outdated and describes an XCache-based OSDF Origin install, which is deprecated.
Future OSDF Origins should be based on Pelican; documentation for a Pelican-based OSDF Origin install is forthcoming.
Future OSDF Origins should be based on Pelican.

See the [Pelican-based Installing the OSDF Origin by RPM](../../osdf/install-origin-rpm) document

This document describes how to install an Open Science Data Federation (OSDF) origin service. This service allows an organization
to export its data to the data federation.
Expand All @@ -32,6 +34,12 @@ to export its data to the data federation.
Before Starting
---------------

!!! warning "Deprecation warning"
This document is outdated and describes an XCache-based OSDF Origin install, which is deprecated.
Future OSDF Origins should be based on Pelican.

See the [Pelican-based Installing the OSDF Origin by RPM](../../osdf/install-origin-rpm) document

Before starting the installation process, consider the following requirements:

* __Operating system:__ A RHEL 8 or RHEL 9 or compatible operating systems.
Expand All @@ -57,6 +65,12 @@ As with all OSG software installations, there are some one-time steps to prepare
Installing the Origin
---------------------

!!! warning "Deprecation warning"
This document is outdated and describes an XCache-based OSDF Origin install, which is deprecated.
Future OSDF Origins should be based on Pelican.

See the [Pelican-based Installing the OSDF Origin by RPM](../../osdf/install-origin-rpm) document

The origin service consists of one or more XRootD daemons and their dependencies for the authentication infrastructure.
To simplify installation, OSG provides convenience RPMs that install all required
software with a single command:
Expand All @@ -71,6 +85,12 @@ and owned by the `xrootd:xrootd` user.
Configuring the Origin Server
-----------------------------

!!! warning "Deprecation warning"
This document is outdated and describes an XCache-based OSDF Origin install, which is deprecated.
Future OSDF Origins should be based on Pelican.

See the [Pelican-based Installing the OSDF Origin by RPM](../../osdf/install-origin-rpm) document

The `stash-origin` package provides a default configuration files in
`/etc/xrootd/xrootd-stash-origin.cfg` and `/etc/xrootd/config.d`.
Administrators may provide additional configuration by placing files in `/etc/xrootd/config.d`
Expand Down Expand Up @@ -121,6 +141,13 @@ and use the `xrootd@stash-origin-auth` service (if not using [xrootd-multiuser][

Manually Setting the FQDN (optional)
------------------------------------

!!! warning "Deprecation warning"
This document is outdated and describes an XCache-based OSDF Origin install, which is deprecated.
Future OSDF Origins should be based on Pelican.

See the [Pelican-based Installing the OSDF Origin by RPM](../../osdf/install-origin-rpm) document

The FQDN of the origin server that you registered in [Topology](#registering-the-origin) may be different than its internal hostname
(as reported by `hostname -f`).
For example, this may be the case if your origin is behind a load balancer such as LVS.
Expand All @@ -138,6 +165,13 @@ In this case, you must manually tell the origin services which FQDN to use for t

Managing the Origin Services
----------------------------

!!! warning "Deprecation warning"
This document is outdated and describes an XCache-based OSDF Origin install, which is deprecated.
Future OSDF Origins should be based on Pelican.

See the [Pelican-based Installing the OSDF Origin by RPM](../../osdf/install-origin-rpm) document

Serving data for an origin is done by the `xrootd` daemon.
There can be multiple instances of `xrootd`, running on different ports.
The instance that serves unauthenticated data will run on port 1094.
Expand Down Expand Up @@ -184,6 +218,12 @@ In addition, the origin service automatically uses the following SystemD units:
Adding to Authorization Files (Optional)
----------------------------------------

!!! warning "Deprecation warning"
This document is outdated and describes an XCache-based OSDF Origin install, which is deprecated.
Future OSDF Origins should be based on Pelican.

See the [Pelican-based Installing the OSDF Origin by RPM](../../osdf/install-origin-rpm) document

The `stash-authfile` services on the origin generate files that configure authorization for XRootD.
Put local additions to this configuration into separate files, according to this table:

Expand All @@ -200,6 +240,12 @@ Put local additions to this configuration into separate files, according to this
Verifying the Origin Server
---------------------------

!!! warning "Deprecation warning"
This document is outdated and describes an XCache-based OSDF Origin install, which is deprecated.
Future OSDF Origins should be based on Pelican.

See the [Pelican-based Installing the OSDF Origin by RPM](../../osdf/install-origin-rpm) document

Once your server has been registered with the OSG and started,
perform the following steps to verify that it is functional.

Expand Down Expand Up @@ -303,6 +349,13 @@ If unsuccessful, you can pass the `-d` flag to `stashcp` for debug info.

Registering the Origin
----------------------

!!! warning "Deprecation warning"
This document is outdated and describes an XCache-based OSDF Origin install, which is deprecated.
Future OSDF Origins should be based on Pelican.

See the [Pelican-based Installing the OSDF Origin by RPM](../../osdf/install-origin-rpm) document

To be part of the Open Science Data Federation, your origin must be
[registered with the OSG](../../common/registration.md). The service type is `XRootD origin server`.

Expand Down
4 changes: 3 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,12 @@ nav:
- 'Overview': 'data/stashcache/overview.md'
- Data Cache:
- 'Install from RPM': 'data/osdf/install-cache-rpm.md'
- Data Origin:
- 'Install from RPM': 'data/osdf/install-origin-rpm.md'
- Data Cache (deprecated):
- 'Install from container': 'data/stashcache/run-stashcache-container.md'
- 'Install from RPM': 'data/stashcache/install-cache.md'
- Data Origin:
- Data Origin (deprecated):
- 'Install from container': 'data/stashcache/run-stash-origin-container.md'
- 'Install from RPM': 'data/stashcache/install-origin.md'
- 'Publishing VO data': 'data/stashcache/vo-data.md'
Expand Down

0 comments on commit 926e637

Please sign in to comment.