S3 Storage Configuration documentation requires improvements
Open
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_algorithmmust 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 byrucio rse update(or itsrucio-adminequivalent).s3_url_stylemust be set topath, except if the RSE is in Amazonimplmust set torucio.rse.protocols.gfal.NoRenameinstead of the suggestedrucio.rse.protocols.gfal.Defaultin the documentation mentioned above
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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