Skip to content

Commit

Permalink
Document the *.local files in the non-container cache/origin install …
Browse files Browse the repository at this point in the history
…instructions
  • Loading branch information
matyasselmeci committed Dec 19, 2023
1 parent 0bf719f commit ff39df1
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/data/stashcache/install-cache.md
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,23 @@ In this case, you must manually tell the cache services which FQDN to use for to

1. Run `systemctl daemon-reload` after modifying the file.


Making custom additions to authorization files (optional)
---------------------------------------------------------

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

| **Purpose** | **Generated file** | **Local additions file** |
| :------------------------------------------------------------ | :------------------------------------- | :-------------------------------------------------- |
| VOMS/SSL/X.509 auth config for unauthenticated cache instance | `/run/stash-cache/Authfile` | `/etc/xrootd/stash-cache-Authfile.local` |
| VOMS/SSL/X.509 auth config for authenticated cache instance | `/run/stash-cache-auth/Authfile` | `/etc/xrootd/stash-cache-auth-Authfile.local` |
| SciTokens config for authenticated cache instance | `/run/stash-cache-auth/scitokens.conf` | `/etc/xrootd/stash-cache-auth-scitokens.conf.local` |

!!! note
These local additions files are only used in XCache 3.5.0 and newer.


Managing OSDF services
-------------------------------------------

Expand Down
17 changes: 17 additions & 0 deletions docs/data/stashcache/install-origin.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,23 @@ In addition, the origin service automatically uses the following SystemD units:
| `[email protected]` | Updates the authorization files periodically (unauthenticated instance) |
| `[email protected]` | Updates the authorization files periodically (authenticated instance) |


Making custom additions to authorization files (optional)
---------------------------------------------------------

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

| **Purpose** | **Generated file** | **Local additions file** |
| :------------------------------------------------------------- | :-------------------------------------- | :--------------------------------------------------- |
| VOMS/SSL/X.509 auth config for unauthenticated origin instance | `/run/stash-origin/Authfile` | `/etc/xrootd/stash-origin-Authfile.local` |
| VOMS/SSL/X.509 auth config for authenticated origin instance | `/run/stash-origin-auth/Authfile` | `/etc/xrootd/stash-origin-auth-Authfile.local` |
| SciTokens config for authenticated origin instance | `/run/stash-origin-auth/scitokens.conf` | `/etc/xrootd/stash-origin-auth-scitokens.conf.local` |

!!! note
These local additions files are only used in XCache 3.5.0 and newer.


Verifying the Origin Server
---------------------------

Expand Down

0 comments on commit ff39df1

Please sign in to comment.