rucio / rucio/documentation

Clear differenciation of LFN, PFN, and DID in API documentation for declaring bad replica

Open
#628 0 comments 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

When using the py client to declare a replica bad, there is a difference between using a LFN/DID and a PFN. LFN/DID will trigger the necromancer daemon, but using a PFN will trigger the minos daemon after it is added to the bad_pfns table.

This difference should be included in documentation and a reason for picking either action.

Reported by @yuyiguo

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 API documentation for declaring a replica bad and trace the py client actions for LFN/DID versus PFN. Document which daemon each action triggers, including the bad_pfns table path, and explain when to choose either action.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.