sigs.k8s.io/kueue@v0.6.2/site/content/en/docs/tasks/run_kubeflow_jobs/run_xgboostjobs.md (about)

     1  ---
     2  title: "Run a XGBoostJob"
     3  date: 2023-09-14
     4  weight: 6
     5  description: >
     6    Run a Kueue scheduled XGBoostJob
     7  ---
     8  
     9  This page shows how to leverage Kueue's scheduling and resource management capabilities when running [Training Operator](https://www.kubeflow.org/docs/components/training/xgboost/) XGBoostJobs.
    10  
    11  This guide is for [batch users](/docs/tasks#batch-user) that have a basic understanding of Kueue. For more information, see [Kueue's overview](/docs/overview).
    12  
    13  ## Before you begin
    14  
    15  Check [administer cluster quotas](/docs/tasks/administer_cluster_quotas) for details on the initial cluster setup.
    16  
    17  Check [the Training Operator installation guide](https://github.com/kubeflow/training-operator#installation).
    18  
    19  Note that the minimum requirement training-operator version is v1.7.0.
    20  
    21  You can [modify kueue configurations from installed releases](/docs/installation#install-a-custom-configured-released-version) to include XGBoostJobs as an allowed workload.
    22  
    23  ## XGBoostJob definition
    24  
    25  ### a. Queue selection
    26  
    27  The target [local queue](/docs/concepts/local_queue) should be specified in the `metadata.labels` section of the XGBoostJob configuration.
    28  
    29  ```yaml
    30  metadata:
    31    labels:
    32      kueue.x-k8s.io/queue-name: user-queue
    33  ```
    34  
    35  ### b. Optionally set Suspend field in XGBoostJobs
    36  
    37  ```yaml
    38  spec:
    39    runPolicy:
    40      suspend: true
    41  ```
    42  
    43  By default, Kueue will set `suspend` to true via webhook and unsuspend it when the XGBoostJob is admitted.
    44  
    45  ## Sample XGBoostJob
    46  
    47  This example is based on https://github.com/kubeflow/training-operator/blob/afba76bc5a168cbcbc8685c7661f36e9b787afd1/examples/xgboost/xgboostjob.yaml.
    48  
    49  {{< include "examples/jobs/sample-xgboostjob.yaml" "yaml" >}}