Skip to content

Conversation

@Soap2G
Copy link
Contributor

@Soap2G Soap2G commented Jan 9, 2026

Closes #709

Documentation on setting up and configuring Rucio Storage Elements (RSEs) from an operator's perspective. Includes:

  • Overview of RSE types (POSIX, WebDAV, Disk, Tape)
  • Two setup methods: CLI and Python API with side-by-side examples
  • Configuration examples for each RSE type
  • WebDAV setup with Apache configuration and davs protocol
  • EOS disk RSE with https and root protocols
  • CTA tape RSE configuration with staging timeouts
  • RSE attributes, protocols, and account limits reference
  • Best practices and common pitfalls
  • Quick reference commands

The examples use the latest rucio CLI commands

@Soap2G Soap2G self-assigned this Jan 9, 2026
@voetberg
Copy link
Contributor

voetberg commented Jan 9, 2026

Overall all these changes are really good!!

Only thing I didn't comment on directly in the body of the review is that we might want to mention how rse specific limits work vs account only limits

@Soap2G
Copy link
Contributor Author

Soap2G commented Jan 12, 2026

@voetberg Added a few fixes in 317c0db.

Also, I stumbled upon https://rucio.github.io/documentation/operator/configuration/#creating-new-rses; should I add a link to there pointing to this page?

@voetberg
Copy link
Contributor

@voetberg Added a few fixes in 317c0db.

Also, I stumbled upon https://rucio.github.io/documentation/operator/configuration/#creating-new-rses; should I add a link to there pointing to this page?

I would say this PR completely supersedes that page, and I would link to this page and drastically reduce what's on the config params page. (Maybe just summarizing into a TL;DR with "add rse", "add rse attribute", "add rse protocol", "add account limit")

If you would like, I can take that over and you can just link your page there with something like "An in-depth guide to configuring RSEs can be found here"

@Soap2G
Copy link
Contributor Author

Soap2G commented Jan 12, 2026

@voetberg Added a few fixes in 317c0db.
Also, I stumbled upon https://rucio.github.io/documentation/operator/configuration/#creating-new-rses; should I add a link to there pointing to this page?

I would say this PR completely supersedes that page, and I would link to this page and drastically reduce what's on the config params page. (Maybe just summarizing into a TL;DR with "add rse", "add rse attribute", "add rse protocol", "add account limit")

If you would like, I can take that over and you can just link your page there with something like "An in-depth guide to configuring RSEs can be found here"

Cool, then I'll let you take care of the summary, while I'll just link this page in there. As soon as I have some info about istape, I'll finish up this. Thanks!!

@panta-123
Copy link
Contributor

panta-123 commented Jan 12, 2026

@Soap2G , there seem to be existing section in doc title "Creating new RSEs"
https://rucio.cern.ch/documentation/operator/configuration#creating-new-rses

Quota stuff is also discussed in here: https://rucio.cern.ch/documentation/operator/configuration/#setting-quota-and-permissions

We should consolidate the two and have a single place to have these information.

So I would think:
We put all these info into https://rucio.cern.ch/documentation/operator/configuration/ or put link to the new docs file into there.

@Soap2G
Copy link
Contributor Author

Soap2G commented Jan 14, 2026

@Soap2G , there seem to be existing section in doc title "Creating new RSEs" https://rucio.cern.ch/documentation/operator/configuration#creating-new-rses

Quota stuff is also discussed in here: https://rucio.cern.ch/documentation/operator/configuration/#setting-quota-and-permissions

We should consolidate the two and have a single place to have these information.

So I would think: We put all these info into https://rucio.cern.ch/documentation/operator/configuration/ or put link to the new docs file into there.

See this comment; Maggie will take care of that once the page is up.

@Soap2G
Copy link
Contributor Author

Soap2G commented Jan 16, 2026

@voetberg @panta-123 We should be ready to go, with the reminder of merging the redundant RSE-related pages after this is done.

@voetberg
Copy link
Contributor

@Soap2G Please rebase to grab the pre-commit ci!

Soap2G and others added 4 commits January 19, 2026 13:40
Documentation on setting up and configuring Rucio Storage
Elements (RSEs) from an operator's perspective. Includes:

- Overview of RSE types (POSIX, WebDAV, Disk, Tape)
- Two setup methods: CLI and Python API with side-by-side examples
- Configuration examples for each RSE type
- WebDAV setup with Apache configuration and davs protocol
- EOS disk RSE with https and root protocols
- CTA tape RSE configuration with staging timeouts
- RSE attributes, protocols, and account limits reference
- Best practices and common pitfalls
- Quick reference commands

The examples use the latest `rucio` CLI commands

Co-authored-by: Nikita Avdeev <naavdeev.astro@gmail.com>
Co-authored-by: Luis Antonio Obis Aparicio <luis.antonio.obis@gmail.com>
…nstead of core

Used RSEClient class for rse operations, and AccountLimitClient for account.
Additionally added a paragraph about configuration concepts.
Removed istape from RSE config guide, as it's not needed by Rucio
and it can be replaced by rse_type.

Additionally, added a clearer description of istape in the attributes page.
@Soap2G Soap2G force-pushed the gguerrie-rse-docs branch from d46af70 to f80b901 Compare January 19, 2026 12:41
@Soap2G
Copy link
Contributor Author

Soap2G commented Jan 19, 2026

@Soap2G Please rebase to grab the pre-commit ci!

Hey @voetberg, done 😁

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add RSE operator docs

4 participants