[Feat] Add Ray Cron Job #4159
[Feat] Add Ray Cron Job #4159
Conversation
machichima
requested review from
MortalHappiness,
andrewsykim,
kevin85421 and
rueian
as code owners
| func constructRayJob(cronJob *rayv1.RayCronJob) *rayv1.RayJob { | ||
| rayJob := &rayv1.RayJob{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: fmt.Sprintf("%s-%s", cronJob.Name, rand.String(5)), | ||
| Namespace: cronJob.Namespace, | ||
| Labels: map[string]string{ | ||
| "ray.io/cronjob-name": cronJob.Name, | ||
| }, | ||
| }, | ||
| Spec: *cronJob.Spec.JobTemplate.DeepCopy(), | ||
| } | ||
| return rayJob | ||
| } |
There was a problem hiding this comment.
I think we should set an OwnerReference in order to do the garbage collection by k8s.
There was a problem hiding this comment.
Yes! Just added. Thank you for pointing this out!
| // RayCronJob is the Schema for the raycronjobs API | ||
| type RayCronJob struct { | ||
| metav1.TypeMeta `json:",inline"` | ||
| Spec RayCronJobSpec `json:"spec,omitempty"` | ||
| Status RayCronJobStatus `json:"status,omitempty"` | ||
| metav1.ObjectMeta `json:"metadata,omitempty"` | ||
| } |
There was a problem hiding this comment.
I think we should keep TypeMeta and ObjectMeta at the top, with Spec and Status grouped below.
kuberay/ray-operator/apis/ray/v1/raycluster_types.go
Lines 378 to 387 in 32c1d1b
kuberay/ray-operator/apis/ray/v1/rayservice_types.go
Lines 219 to 225 in 32c1d1b
| // The overall state of the RayCronJob. | ||
| type ScheduleStatus string | ||
|
|
||
| const ( | ||
| StatusNew ScheduleStatus = "" | ||
| StatusScheduled ScheduleStatus = "Scheduled" | ||
| StatusValidationFailed ScheduleStatus = "ValidationFailed" | ||
| ) |
There was a problem hiding this comment.
I haven’t seen ScheduleStatus being used anywhere yet. Is this something that will be added later?
| type RayCronJobSpec struct { | ||
| // JobTemplate defines the job spec that will be created by cron scheduling | ||
| JobTemplate *RayJobSpec `json:"jobTemplate"` | ||
| // Schedule is the cron schedule string | ||
| Schedule string `json:"schedule"` | ||
| } |
There was a problem hiding this comment.
Not sure if this is alright, but I think we should introduce a separate struct (e.g. RayJobTemplateSpec) to hold both the metadata and the spec for the generated RayJob, similar to how Kubernetes models JobTemplateSpec in CronJob.
This would allow users to specify metadata inside jobTemplate, which we can then propagate to the created RayJob. It also keeps the API aligned with common Kubernetes patterns.
WDYT?
2 participants
Why are these changes needed?
Support cron job scheduling. Following this design docs and implement milestone 1 in this PR
Main changes:
RayCronJobCRD and controllerRayCronJobTest
Apply the sample YAML
ray-operator/config/samples/ray-cronjob.sample.yaml. RayJobs are being scheduled every minute:Trigger validation error
Related issue number
Following comment: #2426 (comment)
Closes #2426
Checks