Skip to content

docs: add docker-compose.override.example.yml and Rucio integration guide - #34

Merged
veprbl merged 1 commit into
PanDAWMS:mainfrom
veprbl:pr/ruico_stager_docs
Aug 28, 2026
Merged

docs: add docker-compose.override.example.yml and Rucio integration guide#34
veprbl merged 1 commit into
PanDAWMS:mainfrom
veprbl:pr/ruico_stager_docs

Conversation

@veprbl

@veprbl veprbl commented Aug 27, 2026

Copy link
Copy Markdown
Collaborator

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:

  • 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.

…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.
@veprbl
veprbl requested a review from wdconinc August 27, 2026 17:38

@wdconinc wdconinc left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this already something that can be exercised in CI as well? Or don't we have a docker-compose-able rucio instance yet?

@veprbl

veprbl commented Aug 27, 2026

Copy link
Copy Markdown
Collaborator Author

No, not yet, but I'm planning to build up to that point.

@veprbl
veprbl merged commit ce16321 into PanDAWMS:main Aug 28, 2026
1 check passed
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