-
Notifications
You must be signed in to change notification settings - Fork 58
Add documentation on transmogrifier #607
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should also link this document to the transmogrifier
entry in https://rucio.cern.ch/documentation/started/main_components/daemons/, so that this more detailed documentation can be easily found from there
Also added documentation on Subscriptions that is more exhaustive as https://github.com/rucio/documentation/blob/main/docs/started/concepts/subscriptions.md , so maybe the latter one needs to be replaced |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You should also add {"type": "autogenerated", "dirName": "operator_subscriptions"},
to sidebars.json
in order to have this show up in the sidebar
## Summary | ||
|
||
The transmogrifier daemon is central to Rucio’s automated data management, ensuring that new data is promptly and correctly distributed according to organizational policies and user-defined subscriptions. Its sophisticated logic—including split, chained, and algorithmic rule selection—supports even the most advanced data placement strategies, while robust error handling and metrics allow for reliable, scalable operation. | ||
|
||
--- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm still in favour of removing this as I don't think it adds anything that's not already in the Purpose section above, but I can understand that this might be a subjective opinion. Maybe we can get someone else to review this as well to give their opinion
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would definitely be good to either unify this with https://rucio.github.io/documentation/started/concepts/subscriptions/, or to have https://rucio.github.io/documentation/started/concepts/subscriptions/ point to this operator_subscriptions/subscriptions
page as a sort of 'extended explanation on subscriptions'. If we want to keep these two pages separate, it would be best to name them two different things for clarity (e.g. https://rucio.github.io/documentation/started/concepts/subscriptions/ could be renamed to 'introduction to subscriptions') - but I think it'd make more sense to just have a single page for consistency
- **Retroactive:** Whether the subscription should apply to pre-existing data. | ||
- **Lifetime:** Optional duration (in days) for the subscription to remain active. | ||
- **Priority:** Determines the order in which subscriptions are processed. | ||
- **State:** Subscriptions can be ACTIVE, NEW, INACTIVE, or UPDATED. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can also be BROKEN
for what I see in db/sqla/constants
, not sure if we also mention this.
## Further Reading | ||
|
||
- [Transmogrifier details and implementation](transmogrifier.md) | ||
- [Rucio Data Management Documentation](https://rucio.readthedocs.io/en/latest/) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is the old Rucio docs link, it just says "The Rucio documentation has been migrated to https://rucio.cern.ch/documentation."
No description provided.