Skip to content

docs: enhance Koord-Queue documentation with multi-framework job support#326

Merged
ZiMengSheng merged 1 commit into
koordinator-sh:mainfrom
KunWuLuan:main
May 7, 2026
Merged

docs: enhance Koord-Queue documentation with multi-framework job support#326
ZiMengSheng merged 1 commit into
koordinator-sh:mainfrom
KunWuLuan:main

Conversation

@KunWuLuan
Copy link
Copy Markdown
Member

  • Add job suspension type comparison table with 7 job types and their support status

    • Kubernetes Job, TFJob, PyTorchJob, Argo Workflow (Supported)
    • SparkApplication (WIP)
    • XGBoostJob, PaddleJob (Not Supported Yet)
  • Add Argo Workflow usage example and working principle explanation

    • Use koord-queue-suspend template for job suspension
    • Detailed explanation of queue management conditions
  • Add TFJob and PyTorchJob usage examples

    • Use quota.scheduling.koordinator.sh/name label for queue binding
    • Control job suspension via spec.runPolicy.suspend
  • Supplement Kubeflow Jobs working principle documentation

    • QueueUnit auto-creation process
    • Job dequeue and execution mechanism
  • Synchronize updates between English and Chinese documentation

@koordinator-bot koordinator-bot Bot requested review from ZiMengSheng and hormes May 3, 2026 02:26
- Add job suspension type comparison table with 7 job types and their support status
  * Kubernetes Job, TFJob, PyTorchJob, Argo Workflow (Supported)
  * SparkApplication (WIP)
  * XGBoostJob, PaddleJob (Not Supported Yet)

- Add Argo Workflow usage example and working principle explanation
  * Use koord-queue-suspend template for job suspension
  * Detailed explanation of queue management conditions

- Add TFJob and PyTorchJob usage examples
  * Use quota.scheduling.koordinator.sh/name label for queue binding
  * Control job suspension via spec.runPolicy.suspend

- Supplement Kubeflow Jobs working principle documentation
  * QueueUnit auto-creation process
  * Job dequeue and execution mechanism

- Synchronize updates between English and Chinese documentation

Signed-off-by: KunWuLuan <30817980+KunWuLuan@users.noreply.github.com>
Copy link
Copy Markdown
Member

@ZiMengSheng ZiMengSheng left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

@koordinator-bot
Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ZiMengSheng

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ZiMengSheng ZiMengSheng merged commit 3e86006 into koordinator-sh:main May 7, 2026
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants