rucio / rucio/documentation

S3 Storage Configuration documentation requires improvements

Open
#629 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
4
Forks
71
Avg merge
2d 1h
Merged PRs (30d)
11

Description

I tried to use the S3 Storage Configuration official documentation and my experience is that is doesn't allow to get a working S3 RSE. Among the issues experienced (thanks for the help on Mattermost!), I identified:

  • lfn2pfn_algorithm must be defined at creation time (not sure how) as it cannot be changed once it is set (according to https://rucio.github.io/documentation/operator/configuration_parameters/#rse-settings) and in fact is refused by rucio rse update (or its rucio-admin equivalent).
  • s3_url_style must be set to path, except if the RSE is in Amazon
  • impl must set to rucio.rse.protocols.gfal.NoRename instead of the suggested rucio.rse.protocols.gfal.Default in the documentation mentioned above

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked S3 Storage Configuration page and the RSE settings documentation, then compare the listed options with the rucio rse update behavior described in the issue. Update the documentation to explain when lfn2pfn_algorithm must be set and to correct the s3_url_style and impl examples; done means the documented steps can produce a working S3 RSE.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.