Skip to content

Commit 902d76e

Browse files
committed
Update OSDF origin RPM installation doc to make it match the OSDF cache RPM installation doc in terms of structure and phrasing
1 parent 3d9991f commit 902d76e

File tree

1 file changed

+65
-16
lines changed

1 file changed

+65
-16
lines changed

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

+65-16
Original file line numberDiff line numberDiff line change
@@ -58,23 +58,22 @@ The origin service is provided by the `osdf-origin` RPM.
5858
Install it using the following command:
5959

6060

61+
OSG 24:
6162
```console
62-
root@host # yum install --enablerepo=osg-upcoming osdf-origin
63+
root@host # yum install osdf-origin
6364
```
6465

6566

67+
!!! note "osdf-cache 7.11.1"
68+
This document covers versions 7.11.1 and later of the `osdf-cache` package; ensure the above installation
69+
results in an appropriate version.
70+
6671
Configuring the Origin Server
6772
-----------------------------
6873

69-
Configuration for a Pelican-based OSDF Origin is located in `/etc/pelican/osdf-origin.yaml`.
74+
Create a file named `/etc/pelican/config.d/20-origin.yaml`
7075

71-
You must configure the following:
72-
```
73-
XRootD:
74-
Sitename: <RESOURCE NAME REGISTERED WITH OSG>
75-
```
76-
77-
In addition, you must tell Pelican the data to export to the federation.
76+
You must tell Pelican the data to export to the federation.
7877
An origin may export one or more directory trees, or one or more S3 buckets -- follow one of the sections below.
7978
A single origin cannot export both a bucket and a directory tree.
8079

@@ -111,17 +110,67 @@ Preparing for Initial Startup
111110
1. The origin identifies itself to the federation via public key authentication;
112111
before starting the origin for the first time, it is recommended to generate a keypair.
113112

114-
:::command
115-
root@host$ cd /etc/pelican
116-
root@host$ pelican generate keygen
113+
:::console
114+
root@host$ cd /etc/pelican
115+
root@host$ pelican generate keygen
117116

118117

119118
The newly created files, `issuer.jwk` and `issuer-pub.jwks` are the private and public keys, respectively.
120-
**Save these files**; if you lose them, you will have to re-register the origin.
121119

122-
1. Contact OSG Staff and let them know that you are about to start your origin,
123-
and what namespace(s) the origin will serve.
124-
OSG Staff will need to approve the origin's registration.
120+
1. **Save these files**; if you lose the `issuer.jwk`, your origin will need to be re-approved.
121+
122+
123+
Validating the Origin Installation
124+
----------------------------------
125+
126+
Do the following steps to verify that the cache is functional:
127+
128+
1. Start the origin using the following command:
129+
130+
:::console
131+
root@host$ systemctl start osdf-origin
132+
133+
1. Download a test file (POSIX) or object (S3) from your origin (replacing `ORIGIN_HOSTNAME` with the host name of your origin,
134+
and TEST_PATH with the OSDF path to the test file or object
135+
136+
:::console
137+
user@host$ curl -L https://ORIGIN_HOSTNAME:8443/TEST_PATH -o /tmp/testfile
138+
139+
Verify the contents of `/tmp/testfile` match the test file or object your origin was serving.
140+
141+
If the download fails, debugging information is located in `/var/log/pelican/osdf-origin.log`.
142+
See [this page](../../common/help.md) for requesting assistance; please include the log file
143+
in your request.
144+
145+
146+
Joining the Origin to the Federation
147+
------------------------------------
148+
149+
The origin must be registered with the OSG prior to joining the data federation.
150+
Send mail to <[email protected]> requesting registration; provide the following information:
151+
152+
* Origin hostname
153+
* Administrative and security contact(s)
154+
* Institution that the cache belongs to
155+
156+
OSG Staff will register the origin and respond with the Resource Name that the origin was registered as.
157+
158+
Once you have that information, edit `/etc/pelican/config.d/15-osdf.yaml`, and set `XRootD.Sitename`:
159+
```
160+
XRootD:
161+
Sitename: <RESOURCE NAME REGISTERED WITH OSG>
162+
```
163+
164+
Then, restart the origin by running
165+
166+
```console
167+
root@host$ systemctl restart osdf-origin
168+
```
169+
170+
Let OSG Staff know that you have restarted the origin with the updated sitename,
171+
so they can approve the new origin.
172+
173+
125174

126175
<!--
127176

0 commit comments

Comments
 (0)