mirror of
https://github.com/hanzo-ml/kuberay.git
synced 2026-10-30 19:48:47 +00:00
* [RayJob][Fix] Use --no-wait for job submission to avoid carrying the error return code to the log tailing (#3216) * [RayJob][Fix] Use --no-wait for job submission to avoid carrying the error return code to the log tailing Signed-off-by: Rueian <[email protected]> * [RayJob][Fix] Use --no-wait for job submission to avoid carrying the error return code to the log tailing Signed-off-by: Rueian <[email protected]> * chore: update comments Signed-off-by: Rueian <[email protected]> * chore: add a comment about bash -e Signed-off-by: Rueian <[email protected]> --------- Signed-off-by: Rueian <[email protected]> * kubectl ray job submit: provide entrypoint (#3186) * [kubectl-plugin] Add head/worker node selector option (#3228) * add node selector option for kubectl plugin create cluster Signed-off-by: Troy Chiu <[email protected]> * nit Signed-off-by: Troy Chiu <[email protected]> --------- Signed-off-by: Troy Chiu <[email protected]> * add node selector option for kubectl plugin create worker group (#3235) * add node selector option for kubectl plugin create work group Signed-off-by: Troy Chiu <[email protected]> * nit Signed-off-by: Troy Chiu <[email protected]> * code review: fix usage Signed-off-by: Troy Chiu <[email protected]> --------- Signed-off-by: Troy Chiu <[email protected]> * [kubectl-plugin] remove CPU limits by default (#3243) Signed-off-by: Andrew Sy Kim <[email protected]> * [Chore][CI] Limit the release-image-build github workflow to only take tag as input (#3117) * remove all inputs from workflow_dispatch Signed-off-by: Tina Wu <[email protected]> * use tag only Signed-off-by: Tina Wu <[email protected]> * align case Signed-off-by: Tina Wu <[email protected]> * change sha Signed-off-by: Tina Wu <[email protected]> * extract tag * lint fix Signed-off-by: Tina Wu <[email protected]> * update github_env Signed-off-by: Tina Wu <[email protected]> * directly take tag Signed-off-by: Tina Wu <[email protected]> * add env, Signed-off-by: Tina Wu <[email protected]> * directly use tag Signed-off-by: Tina Wu <[email protected]> * use env. when in script Signed-off-by: Tina Wu <[email protected]> * env.tag when with Signed-off-by: Tina Wu <[email protected]> * use env.tag for all Signed-off-by: Tina Wu <[email protected]> --------- Signed-off-by: Tina Wu <[email protected]> Co-authored-by: tinaxfwu <[email protected]> * [CI] Remove create tag step from release (#3249) Signed-off-by: Chi-Sheng Liu <[email protected]> --------- Signed-off-by: Rueian <[email protected]> Signed-off-by: Troy Chiu <[email protected]> Signed-off-by: Andrew Sy Kim <[email protected]> Signed-off-by: Tina Wu <[email protected]> Signed-off-by: Chi-Sheng Liu <[email protected]> Co-authored-by: Rueian <[email protected]> Co-authored-by: Spencer Peterson <[email protected]> Co-authored-by: Troy Chiu <[email protected]> Co-authored-by: Tina Wu <[email protected]> Co-authored-by: tinaxfwu <[email protected]> Co-authored-by: Chi-Sheng Liu <[email protected]>
194 lines
6.9 KiB
Go
194 lines
6.9 KiB
Go
package create
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
|
|
"github.com/spf13/cobra"
|
|
"k8s.io/cli-runtime/pkg/genericclioptions"
|
|
"k8s.io/client-go/rest"
|
|
|
|
"github.com/ray-project/kuberay/kubectl-plugin/pkg/util"
|
|
"github.com/ray-project/kuberay/kubectl-plugin/pkg/util/client"
|
|
|
|
rayv1 "github.com/ray-project/kuberay/ray-operator/apis/ray/v1"
|
|
|
|
corev1 "k8s.io/api/core/v1"
|
|
"k8s.io/apimachinery/pkg/api/resource"
|
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
|
cmdutil "k8s.io/kubectl/pkg/cmd/util"
|
|
"k8s.io/kubectl/pkg/util/templates"
|
|
)
|
|
|
|
const (
|
|
resourceNvidiaGPU = "nvidia.com/gpu"
|
|
)
|
|
|
|
type CreateWorkerGroupOptions struct {
|
|
configFlags *genericclioptions.ConfigFlags
|
|
ioStreams *genericclioptions.IOStreams
|
|
workerNodeSelectors map[string]string
|
|
clusterName string
|
|
groupName string
|
|
rayVersion string
|
|
image string
|
|
workerCPU string
|
|
workerGPU string
|
|
workerMemory string
|
|
workerReplicas int32
|
|
workerMinReplicas int32
|
|
workerMaxReplicas int32
|
|
}
|
|
|
|
var (
|
|
createWorkerGroupLong = templates.LongDesc(`
|
|
Adds a worker group to an existing Ray cluster.
|
|
`)
|
|
|
|
createWorkerGroupExample = templates.Examples(fmt.Sprintf(`
|
|
# Create a worker group in an existing Ray cluster with defaults
|
|
kubectl ray create workergroup example-group --ray-cluster sample-cluster
|
|
|
|
# Create a worker group in an existing Ray cluster
|
|
kubectl ray create workergroup example-group --ray-cluster sample-cluster --image %s --worker-cpu 2 --worker-memory 5Gi
|
|
`, util.RayImage))
|
|
)
|
|
|
|
func NewCreateWorkerGroupOptions(streams genericclioptions.IOStreams) *CreateWorkerGroupOptions {
|
|
return &CreateWorkerGroupOptions{
|
|
configFlags: genericclioptions.NewConfigFlags(true),
|
|
ioStreams: &streams,
|
|
}
|
|
}
|
|
|
|
func NewCreateWorkerGroupCommand(streams genericclioptions.IOStreams) *cobra.Command {
|
|
options := NewCreateWorkerGroupOptions(streams)
|
|
cmdFactory := cmdutil.NewFactory(options.configFlags)
|
|
// Silence warnings to avoid messages like 'unknown field "spec.headGroupSpec.template.metadata.creationTimestamp"'
|
|
// See https://github.com/kubernetes/kubernetes/issues/67610 for more details.
|
|
rest.SetDefaultWarningHandler(rest.NoWarnings{})
|
|
|
|
cmd := &cobra.Command{
|
|
Use: "workergroup (WORKERGROUP) [(-r|--ray-cluster) RAYCLUSTER]",
|
|
Short: "Create worker group in an existing Ray cluster",
|
|
Long: createWorkerGroupLong,
|
|
Example: createWorkerGroupExample,
|
|
SilenceUsage: true,
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
if err := options.Complete(cmd, args); err != nil {
|
|
return err
|
|
}
|
|
if err := options.Validate(); err != nil {
|
|
return err
|
|
}
|
|
return options.Run(cmd.Context(), cmdFactory)
|
|
},
|
|
}
|
|
|
|
cmd.Flags().StringVarP(&options.clusterName, "ray-cluster", "c", "", "Ray cluster to add a worker group to")
|
|
cmd.Flags().StringVar(&options.rayVersion, "ray-version", util.RayVersion, "Ray version to use")
|
|
cmd.Flags().StringVar(&options.image, "image", fmt.Sprintf("rayproject/ray:%s", options.rayVersion), "container image to use")
|
|
cmd.Flags().Int32Var(&options.workerReplicas, "worker-replicas", 1, "desired replicas")
|
|
cmd.Flags().Int32Var(&options.workerMinReplicas, "worker-min-replicas", 1, "minimum number of replicas")
|
|
cmd.Flags().Int32Var(&options.workerMaxReplicas, "worker-max-replicas", 10, "maximum number of replicas")
|
|
cmd.Flags().StringVar(&options.workerCPU, "worker-cpu", "2", "number of CPUs in each replica")
|
|
cmd.Flags().StringVar(&options.workerGPU, "worker-gpu", "0", "number of GPUs in each replica")
|
|
cmd.Flags().StringVar(&options.workerMemory, "worker-memory", "4Gi", "amount of memory in each replica")
|
|
cmd.Flags().StringToStringVar(&options.workerNodeSelectors, "worker-node-selectors", nil, "Node selectors to apply to all worker pods in this worker group (e.g. --worker-node-selectors cloud.google.com/gke-accelerator=nvidia-l4,cloud.google.com/gke-nodepool=my-node-pool)")
|
|
|
|
options.configFlags.AddFlags(cmd.Flags())
|
|
return cmd
|
|
}
|
|
|
|
func (options *CreateWorkerGroupOptions) Complete(cmd *cobra.Command, args []string) error {
|
|
if *options.configFlags.Namespace == "" {
|
|
*options.configFlags.Namespace = "default"
|
|
}
|
|
|
|
if len(args) != 1 {
|
|
return cmdutil.UsageErrorf(cmd, "%s", cmd.Use)
|
|
}
|
|
options.groupName = args[0]
|
|
|
|
if options.image == "" {
|
|
options.image = fmt.Sprintf("rayproject/ray:%s", options.rayVersion)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (options *CreateWorkerGroupOptions) Validate() error {
|
|
config, err := options.configFlags.ToRawKubeConfigLoader().RawConfig()
|
|
if err != nil {
|
|
return fmt.Errorf("Error retrieving raw config: %w", err)
|
|
}
|
|
if !util.HasKubectlContext(config, options.configFlags) {
|
|
return fmt.Errorf("no context is currently set, use %q or %q to select a new one", "--context", "kubectl config use-context <context>")
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (options *CreateWorkerGroupOptions) Run(ctx context.Context, factory cmdutil.Factory) error {
|
|
k8sClient, err := client.NewClient(factory)
|
|
if err != nil {
|
|
return fmt.Errorf("failed to create client: %w", err)
|
|
}
|
|
|
|
rayCluster, err := k8sClient.RayClient().RayV1().RayClusters(*options.configFlags.Namespace).Get(ctx, options.clusterName, metav1.GetOptions{})
|
|
if err != nil {
|
|
return fmt.Errorf("error getting Ray cluster: %w", err)
|
|
}
|
|
|
|
newRayCluster := rayCluster.DeepCopy()
|
|
|
|
newRayCluster.Spec.WorkerGroupSpecs = append(newRayCluster.Spec.WorkerGroupSpecs, createWorkerGroupSpec(options))
|
|
|
|
newRayCluster, err = k8sClient.RayClient().RayV1().RayClusters(*options.configFlags.Namespace).Update(ctx, newRayCluster, metav1.UpdateOptions{})
|
|
if err != nil {
|
|
return fmt.Errorf("error updating Ray cluster with new worker group: %w", err)
|
|
}
|
|
|
|
fmt.Printf("Updated Ray cluster %s/%s with new worker group\n", newRayCluster.Namespace, newRayCluster.Name)
|
|
return nil
|
|
}
|
|
|
|
func createWorkerGroupSpec(options *CreateWorkerGroupOptions) rayv1.WorkerGroupSpec {
|
|
podTemplate := corev1.PodTemplateSpec{
|
|
Spec: corev1.PodSpec{
|
|
Containers: []corev1.Container{
|
|
{
|
|
Name: "ray-worker",
|
|
Image: options.image,
|
|
Resources: corev1.ResourceRequirements{
|
|
Requests: corev1.ResourceList{
|
|
corev1.ResourceCPU: resource.MustParse(options.workerCPU),
|
|
corev1.ResourceMemory: resource.MustParse(options.workerMemory),
|
|
},
|
|
Limits: corev1.ResourceList{
|
|
corev1.ResourceCPU: resource.MustParse(options.workerCPU),
|
|
corev1.ResourceMemory: resource.MustParse(options.workerMemory),
|
|
},
|
|
},
|
|
},
|
|
},
|
|
NodeSelector: options.workerNodeSelectors,
|
|
},
|
|
}
|
|
|
|
gpuResource := resource.MustParse(options.workerGPU)
|
|
if !gpuResource.IsZero() {
|
|
podTemplate.Spec.Containers[0].Resources.Requests[corev1.ResourceName(resourceNvidiaGPU)] = gpuResource
|
|
podTemplate.Spec.Containers[0].Resources.Limits[corev1.ResourceName(resourceNvidiaGPU)] = gpuResource
|
|
}
|
|
|
|
return rayv1.WorkerGroupSpec{
|
|
GroupName: options.groupName,
|
|
Replicas: &options.workerReplicas,
|
|
MinReplicas: &options.workerMinReplicas,
|
|
MaxReplicas: &options.workerMaxReplicas,
|
|
RayStartParams: map[string]string{},
|
|
Template: podTemplate,
|
|
}
|
|
}
|