Skip to content

Commit

Permalink
external workload based support
Browse files Browse the repository at this point in the history
  • Loading branch information
kannon92 committed Jan 23, 2025
1 parent 5e63a1e commit 88d0551
Show file tree
Hide file tree
Showing 11 changed files with 44 additions and 46 deletions.
7 changes: 3 additions & 4 deletions site/content/en/docs/tasks/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,16 @@ batch user is a researcher, AI/ML engineer, data scientist, among others.

As a batch user, you can learn how to:
- [Run a Kueue managed batch/Job](run/jobs).
- [Run a Kueue managed Flux MiniCluster](run/flux_miniclusters).
- [Run a Kueue managed Kubeflow Job](run/kubeflow).
Kueue supports MPIJob v2beta1, PyTorchJob, TFJob, XGBoostJob, PaddleJob, and MXJob.
- [Run a Kueue managed KubeRay RayJob](run/rayjobs).
- [Run a Kueue managed KubeRay RayCluster](run/rayclusters).
- [Run a Kueue managed AppWrapper](run/appwrappers).
- [Submit Kueue jobs from Python](run/python_jobs).
- [Run a Kueue managed plain Pod](run/plain_pods).
- [Run a Kueue managed JobSet](run/jobsets).
- [Submit jobs to MultiKueue](run/multikueue).
- [Support external workloads](run/external-workloads)
Kueue allows one to use the pod integration with external workloads that are not part of Kueue.
- [Support external workloads](run/external_workloads).
Kueue allows one to use existing integrations to support external workloads.

### Serving user

Expand All @@ -65,6 +63,7 @@ As a platform developer, you can learn how to:
- [Integrate a custom Job with Kueue](dev/integrate_a_custom_job).
- [Enable pprof endpoints](dev/enabling_pprof_endpoints).
- [Develop a custom AdmissionCheck Controller](dev/develop-acc).
- [Integration a custom workload with existing frameworks](dev/external_frameworks)

## Troubleshooting

Expand Down
10 changes: 10 additions & 0 deletions site/content/en/docs/tasks/dev/external_frameworks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "External Frameworks"
weight: 8
date: 2025-01-17
description: >
How to run Kueue with external frameworks
---

See [external frameworks](/docs/tasks/run/external_workloads) for examples of using existing
integrations to integrate external frameworks.
10 changes: 0 additions & 10 deletions site/content/en/docs/tasks/dev/pod_based_workload.md

This file was deleted.

23 changes: 0 additions & 23 deletions site/content/en/docs/tasks/run/external-workloads/index.md

This file was deleted.

23 changes: 23 additions & 0 deletions site/content/en/docs/tasks/run/external_workloads/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---

title: "Supporting External Frameworks"
linkTitle: "External Frameworks"
weight: 6
date: 2025-01-23
description: >
How to run Kueue with external frameworks
no_list: true
---

The tasks below show you how to build a custom integration.
You can use AppWrapper, job-based workloads and pod-based workloads.

### [AppWrapper](https://project-codeflare.github.io/appwrapper/) Integration
- [Run a workload using Appwrappers](/docs/tasks/run/external_workloads/appwrappers).
- [Run a custom workload using Appwrappers](/docs/tasks/run/external_workloads/wrapped_custom_workload).

### Job-based Workloads Integration
- [Run a Flux Miniclusters using job integration](/docs/tasks/run/external_workloads/flux_miniclusters).

### Pod-Based Workloads Integration
- [Run an Argo Workflow using pod integration](/docs/tasks/run/external_workloads/pod_based_workloads/argo_workflow).
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Run An AppWrapper"
linkTitle: "AppWrappers"
date: 2025-01-08
weight: 6
description: >
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Run An Argo Workflow"
date: 2024-01-03
date: 2025-01-23
weight: 7
description: >
Integrate Kueue with Argo Workflows.
Expand Down
14 changes: 7 additions & 7 deletions site/static/_redirects
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,17 @@
/docs/tasks/enabling_pprof_endpoints /docs/tasks/dev/enabling_pprof_endpoints 301
/docs/tasks/integrate_a_custom_job /docs/tasks/dev/integrate_a_custom_job 301

/docs/tasks/run_flux_minicluster /docs/tasks/run/flux_miniclusters 301
/docs/tasks/run_jobs /docs/tasks/run/jobs 301
/docs/tasks/run_jobsets /docs/tasks/run/jobsets 301
/docs/tasks/run_kubeflow_jobs /docs/tasks/run/kubeflow 301
/docs/tasks/run_plain_pods /docs/tasks/run/plain_pods 301
/docs/tasks/run_rayclusters /docs/tasks/run/rayclusters 301
/docs/tasks/run_rayjobs /docs/tasks/run/rayjobs 301
/docs/tasks/run_jobs /docs/tasks/run/jobs 301
/docs/tasks/run_jobsets /docs/tasks/run/jobsets 301
/docs/tasks/run_kubeflow_jobs /docs/tasks/run/kubeflow 301
/docs/tasks/run_plain_pods /docs/tasks/run/plain_pods 301
/docs/tasks/run_rayclusters /docs/tasks/run/rayclusters 301
/docs/tasks/run_rayjobs /docs/tasks/run/rayjobs 301

/docs/tasks/run_kubeflow_jobs/run_mpijobs /docs/tasks/run/kubeflow/mpijobs 301
/docs/tasks/run_kubeflow_jobs/run_mxjobs /docs/tasks/run/kubeflow/mxjobs 301
/docs/tasks/run_kubeflow_jobs/run_paddlejobs /docs/tasks/run/kubeflow/paddlejobs 301
/docs/tasks/run_kubeflow_jobs/run_pytorchjobs /docs/tasks/run/kubeflow/pytorchjobs 301
/docs/tasks/run_kubeflow_jobs/run_tfjobs /docs/tasks/run/kubeflow/tfjobs 301
/docs/tasks/run_kubeflow_jobs/run_xgboostjobs /docs/tasks/run/kubeflow/xgboostjobs 301

0 comments on commit 88d0551

Please sign in to comment.