diff --git a/content/en/docs/components/training/user-guides/managedby.md b/content/en/docs/components/training/user-guides/managedby.md new file mode 100644 index 0000000000..e8bdb7261f --- /dev/null +++ b/content/en/docs/components/training/user-guides/managedby.md @@ -0,0 +1,65 @@ ++++ +title = "spec.managedBy" +Desciption = "Using managedBy field for MultiKueue" +weight = 60 ++++ + +## Overview + +The `spec.managedBy` field is a new feature introduced in the Kubeflow Training Operator to support a more robust multi-cluster job dispatching by [MultiKueue](https://kueue.sigs.k8s.io/docs/concepts/multikueue/). + +## Prerequisites + +1. Ensure that you have the latest version of the Kubeflow Training Operator installed. +2. Make sure Kueue is compiled against the new operator to leverage the `spec.managedBy` field. + +## Usage + +To use the `spec.managedBy` field in your training jobs, include it in the job specification as shown below: + +```yaml +apiVersion: "kubeflow.org/v1" +kind: "TFJob" +metadata: + name: "example-tfjob" +spec: + managedBy: "kueue.x-k8s.io/multikueue" + tfReplicaSpecs: + ... +``` + +Example + +Here is a complete example of a TensorFlow job using the spec.managedBy field: + +```YAML +apiVersion: "kubeflow.org/v1" +kind: "TFJob" +metadata: + name: "example-tfjob" +spec: + managedBy: "kueue.x-k8s.io/multikueue" + tfReplicaSpecs: + Chief: + replicas: 1 + template: + spec: + containers: + - name: tensorflow + image: tensorflow/tensorflow:latest + args: ["python", "model.py"] + Worker: + replicas: 2 + template: + spec: + containers: + - name: tensorflow + image: tensorflow/tensorflow:latest + args: ["python", "model.py"] +``` + +## What's next? + +For more details on setting up and using MultiKueue with the Kubeflow Training Operator, refer to the following documentation pages: + +- [Kueue/Kubeflow](https://kueue.sigs.k8s.io/docs/tasks/run/multikueue/kubeflow/) \ No newline at end of file