Skip to content

Commit

Permalink
Specify that paths for Cache.<LocalRoot/DataLocations/MetaLocations m…
Browse files Browse the repository at this point in the history
…ust be absolute in docs
  • Loading branch information
jhiemstrawisc committed Nov 6, 2024
1 parent 6fd02ca commit b0ecc1e
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions docs/parameters.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1078,7 +1078,7 @@ components: ["cache"]
---
name: Cache.LocalRoot
description: |+
A path to the directory where xrootd will create its default namespace, `meta`, and `data` directories. For example,
An absolute path to the directory where xrootd will create its default namespace, `meta`, and `data` directories. For example,
setting `Cache.LocalRoot=/run/pelican/cache` without specifying further `Cache.DataLocations` or `Cache.MetaLocations`
values will result in the cache creating a directory structure like:
```
Expand Down Expand Up @@ -1106,6 +1106,8 @@ description: |+
resolve the underlying object through these symbolic links.
We recommend tying the `Cache.LocalRoot` to a fast storage device, such as an SSD, to ensure optimal cache performance.
If this directory does not already exist, it will be created by Pelican.
type: string
root_default: /run/pelican/cache
default: $XDG_RUNTIME_DIR/pelican/cache
Expand All @@ -1121,26 +1123,30 @@ components: ["cache"]
---
name: Cache.DataLocations
description: |+
A list of filesystem paths/directories where the cache's object data will be stored. This list of directories can be used to string together
A list of absolute filesystem paths/directories where the cache's object data will be stored. This list of directories can be used to string together
multiple storage devices to increase the cache's storage capacity, as long as each of the directories is accessible by the cache service.
For example, setting `Cache.DataLocations=["/mnt/cache1", "/mnt/cache2"]` will result in splitting cache data between two mounted drives,
`/mnt/cache1` and `/mnt/cache2`. As such, these drives should be fast storage devices, such as SSDs.
For more information, see the [xrootd oss documentation](https://xrootd.slac.stanford.edu/doc/dev56/ofs_config.pdf) for the `oss.space` directive
as well as the [xrootd pfc documentation](https://xrootd.slac.stanford.edu/doc/dev56/pss_config.pdf) for the `pfc.spaces` directive.
If this directory does not already exist, it will be created by Pelican.
type: stringSlice
root_default: ["/run/pelican/cache/data"]
default: ["$XDG_RUNTIME_DIR/pelican/cache/data"]
components: ["cache"]
---
name: Cache.MetaLocations
description: |+
A list of filesystem paths/directories where the cache's object metadata will be stored. Values in this list may point to separate drives as long
A list of absolute filesystem paths/directories where the cache's object metadata will be stored. Values in this list may point to separate drives as long
as they're accessible by the cache service. For example, setting `Cache.MetaLocations=["/mnt/meta1", "/mnt/meta2"]` will result in
splitting cache metadata between two the mounted drives. As such, these drives should be fast storage devices, such as SSDs.
For more information, see the [xrootd oss documentation](https://xrootd.slac.stanford.edu/doc/dev56/ofs_config.pdf) for the `oss.space` directive
as well as the [xrootd pfc documentation](https://xrootd.slac.stanford.edu/doc/dev56/pss_config.pdf) for the `pfc.spaces` directive.
If this directory does not already exist, it will be created by Pelican.
type: stringSlice
root_default: ["/run/pelican/cache/meta"]
default: ["$XDG_RUNTIME_DIR/pelican/cache/meta"]
Expand Down

0 comments on commit b0ecc1e

Please sign in to comment.