docs: add docker-compose.override.example.yml and Rucio integration guide - #34
Merged
Merged
Conversation
…uide The RucioStager plugin (PR PanDAWMS#31) has a documented opt-in in its own docstring, but the wiring the plugin needs to actually reach a running Rucio is spread across four places: * A rucio.cfg + CA cert + OpenSSL hash symlink mounted into the three services that talk to Rucio (panda-jedi, panda-server, harvester). * A shared Docker network so the hostname 'rucio' resolves inside the panda-compose containers. * RSE-storage and per-worker-output bind mounts on the harvester service so the stager can read output files and write to the MOCK-POSIX RSE. * A rucio-clients package install in the harvester's pip line so the plugin can import UploadClient. None of that is discoverable from the panda-compose repo today; anyone opting into RucioStager has to rediscover it from scratch or copy an undocumented file from someone else's tree. Add: * docker-compose.override.example.yml — a fully documented example override that wires all three services to an external ruciodevnetwork and mounts the Rucio configs. Compose picks up docker-compose.override.yml automatically, so users copy the example, edit if needed, and rerun 'docker compose up -d'. * docs/rucio-integration.md — walks through the five opt-in steps (rucio.cfg, override, panda_queues.cfg, rucio-clients pip, restart) and points at the plugin's own docstring for the tradeoffs. * docs/_sidebar.md — link the new page under 'Integration'. * .gitignore — ignore docker-compose.override.yml so users' local edits don't accidentally get committed. No default behavior change: the override file is only picked up if the user explicitly copies the example.
wdconinc
approved these changes
Aug 27, 2026
wdconinc
left a comment
Collaborator
There was a problem hiding this comment.
Is this already something that can be exercised in CI as well? Or don't we have a docker-compose-able rucio instance yet?
Collaborator
Author
|
No, not yet, but I'm planning to build up to that point. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The RucioStager plugin (PR #31) has a documented opt-in in its own docstring, but the wiring the plugin needs to actually reach a running Rucio is spread across four places:
None of that is discoverable from the panda-compose repo today; anyone opting into RucioStager has to rediscover it from scratch or copy an undocumented file from someone else's tree.
Add:
No default behavior change: the override file is only picked up if the user explicitly copies the example.