Skip to content

Add S3 storage and multi-hop transfer tutorial with resource files#744

Closed
alessio94 wants to merge 5 commits into
rucio:mainfrom
alessio94:alessio94-s3-tutorial-v2
Closed

Add S3 storage and multi-hop transfer tutorial with resource files#744
alessio94 wants to merge 5 commits into
rucio:mainfrom
alessio94:alessio94-s3-tutorial-v2

Conversation

@alessio94
Copy link
Copy Markdown

This PR supersedes #739 and addresses the feedback:

  • Adds tutorial section on configuring S3 storage and multi-hop transfers
  • Includes script files in hidden folder docs/operator/_resources/rucio-playground/ (as .txt since it was suggested that "the .sh could be rather nefarious looking")
  • Removes external CERNBox link in favor of repo files
  • Removes redundant "Rucio Documentation" link
    Thanks for the feedback
    @voetberg @rdimaio

alessio94 and others added 5 commits February 11, 2026 15:17
This tutorial provides a comprehensive guide for setting up a Rucio test environment using Docker Compose, detailing prerequisites, environment management, configuration, and data management scripts for effective data replication and multi-hop transfers.
@voetberg
Copy link
Copy Markdown
Contributor

A few notes:

  • I recommend not including that NB, it just means we need to update both the documentation page and the NB if there are changes.
  • None of these scripts are anywhere close to too big to include inline - I think it's fine to just include them in the doc itself to make copy-pasting easier
  • A lot of the comments on the scripts are not very descriptive, so it would be much easier to just describe them inline.
  • Your method of just executing things directly in docker instead of entering an interactive session more difficult to follow than it needs to be. You can just assume the user already is within a rucio admin env if they're reading this as operator documentation
  • This is also nominally about setting up s3 storage, not a from-scratch way to set up rucio, please don't include things like initializing environments

alessio94 added a commit to alessio94/documentation-rucio that referenced this pull request Mar 23, 2026
Addresses feedback from PR rucio#744:
- Remove Jupyter notebook
- Inline script content directly as code blocks
- Replace inline script comments with prose descriptions
- Remove docker exec wrapping; assume reader is in a Rucio admin environment
- Narrow scope to S3 RSE setup only; remove environment initialization steps
@voetberg
Copy link
Copy Markdown
Contributor

Closing because this is superseded by #766

@voetberg voetberg closed this Mar 31, 2026
alessio94 added a commit to alessio94/documentation-rucio that referenced this pull request May 13, 2026
Added detailed instructions for configuring S3 storage and multi-hop transfers in Rucio, including setting up MinIO instances, registering RSEs, and verifying the setup.

This PR supersedes rucio#744, rucio#739, and rucio#766.

Addresses feedback from PR rucio#766.

Thanks for the review, @voetberg. I have implemented the requested documentation changes:

- Updated the introduction to reflect that `rucio` and `rucio-admin` have been merged since Rucio 38, and that admin access is now handled through permission policies.
- Reduced the duplicated MinIO RSE registration commands to a loop over `MINIO1` and `MINIO2`.
- Added explanatory comments for the RSE attributes used in the S3 protocol configuration.
- Reworked the `rse-accounts.cfg` section to separate the commands used to generate the file from the rendered configuration output, using a `console` block for the inspected file content.
- Simplified the explanation of RSE distances and added a Mermaid diagram to make the multi-hop topology clearer.
- Removed the Jupyter notebook material from the documentation, keeping the demo setup focused on the operator workflow.
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.

2 participants