Skip to content
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

Document queues better #691

Open
hjoliver opened this issue Feb 19, 2024 · 1 comment
Open

Document queues better #691

hjoliver opened this issue Feb 19, 2024 · 1 comment
Milestone

Comments

@hjoliver
Copy link
Member

hjoliver commented Feb 19, 2024

I've had a few users confused about overlapping queue assignments. The current documentation is a bit too minimal.

The salient points:

Cylc can in principle support different types of queue, but at the moment we only have simple non-overlapping FIFO queues:

  • The "default" queue applies to all tasks that have not been assigned to other queues.
  • Assigning by family name is just shorthand for assigning the member tasks.
  • A given task can only belong to a single queue, so if you assign one to multiple queues only the latest assignment sticks.
  • Tasks only get queued when they are ready to run
  • Queued tasks get released (on a FIFO basis) when the number of active (submitted or running) members drops under the queue limit
@hjoliver hjoliver added this to the 8.3.x milestone Feb 19, 2024
@oliver-sanders
Copy link
Member

Suggest documenting this in the queue implementation docstring and autoducmenting it from cylc-doc.

We could also document the base class in the "plugins" section of the docs to assist with queue plugin development. Note we don't have an entry point for queues as yet.

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

No branches or pull requests

2 participants