Skip to content
This repository has been archived by the owner on Apr 2, 2023. It is now read-only.

Custom plugins documentation #130

Merged
merged 3 commits into from
Jan 5, 2021
Merged

Custom plugins documentation #130

merged 3 commits into from
Jan 5, 2021

Conversation

lenhattan86
Copy link
Collaborator

Added docs/features/custom-plugins.md
Updated docs/README.md

@ridv ridv added this to the 0.24.0 milestone Jan 5, 2021
@ridv ridv merged commit 6af85b4 into aurora-scheduler:master Jan 5, 2021
@ridv ridv changed the title Custom plugins doc Custom plugins documentation Jan 5, 2021
Copy link
Contributor

@mauri mauri left a comment

Choose a reason for hiding this comment

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

nice! added a few comments to state the purpose of the plugin more explicitly.

@ridv
Copy link
Contributor

ridv commented Jan 6, 2021

nice! added a few comments to state the purpose of the plugin more explicitly.

Awesome! I'll make sure they get added 😃

Comment on lines +4 to +7
OfferSet
--------
OfferSet holds all offers for the scheduler. OfferSet is customizable via Interface `org.apache.aurora.scheduler.offers.OfferSet`.
This interface is injectable via the '-offer_set_module' flag.
Copy link
Contributor

Choose a reason for hiding this comment

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

The purpose of "OfferSet" as a plugin is a bit elusive here. Could you add a few sentences about its purpose and how it relates with other offer related parameters in the scheduler? (i.e. be able to have more flexibility in the filtering/ordering of the offers when offer_order is insufficient?).

Additionally given that the OfferSet interface is a bit lacking on documentation, add a few notes here about its life cycle. I.e. when add(), remove(), or getOrdered() are invoked by the scheduler; and how is that related with offer_filter_duration, min_offer_hold_time, etc.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

will do some research and add them. thanks @mauri

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we can borrow some words from the original proposal: https://docs.google.com/document/d/1fVHLt9AF-YbOCVCDMQmi5DATVusn-tqY8DldKbjVEm0/edit

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants