Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[kjobctl] Move common SLURM_envs to container env vars. #3285

Closed
wants to merge 1 commit into from
Closed

[kjobctl] Move common SLURM_envs to container env vars. #3285

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
190 changes: 123 additions & 67 deletions cmd/experimental/kjobctl/pkg/builder/slurm_builder.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ import (
"k8s.io/utils/ptr"

"sigs.k8s.io/kueue/cmd/experimental/kjobctl/apis/v1alpha1"
"sigs.k8s.io/kueue/cmd/experimental/kjobctl/pkg/constants"
"sigs.k8s.io/kueue/cmd/experimental/kjobctl/pkg/parser"
)

Expand Down Expand Up @@ -81,6 +82,8 @@ var (
type slurmBuilder struct {
*Builder

jobTemplate *v1alpha1.JobTemplate

objectName string
scriptContent string
template *template.Template
Expand Down Expand Up @@ -109,7 +112,14 @@ func (b *slurmBuilder) validateGeneral() error {
return nil
}

func (b *slurmBuilder) complete() error {
func (b *slurmBuilder) complete(ctx context.Context) error {
jobTemplate, err := b.kjobctlClientset.KjobctlV1alpha1().JobTemplates(b.profile.Namespace).
Get(ctx, string(b.mode.Template), metav1.GetOptions{})
if err != nil {
return err
}
b.jobTemplate = jobTemplate

content, err := os.ReadFile(b.script)
if err != nil {
return err
Expand Down Expand Up @@ -186,24 +196,18 @@ func (b *slurmBuilder) build(ctx context.Context) (runtime.Object, []runtime.Obj
return nil, nil, err
}

if err := b.complete(); err != nil {
if err := b.complete(ctx); err != nil {
return nil, nil, err
}

template, err := b.kjobctlClientset.KjobctlV1alpha1().JobTemplates(b.profile.Namespace).
Get(ctx, string(b.mode.Template), metav1.GetOptions{})
if err != nil {
return nil, nil, err
}

objectMeta := b.buildObjectMeta(template.Template.ObjectMeta)
objectMeta := b.buildObjectMeta(b.jobTemplate.Template.ObjectMeta)
objectMeta.GenerateName = ""
objectMeta.Name = b.objectName

job := &batchv1.Job{
TypeMeta: metav1.TypeMeta{Kind: "Job", APIVersion: "batch/v1"},
ObjectMeta: objectMeta,
Spec: template.Template.Spec,
Spec: b.jobTemplate.Template.Spec,
}
job.Spec.CompletionMode = ptr.To(batchv1.IndexedCompletion)
job.Spec.Template.Spec.Subdomain = b.objectName
Expand All @@ -215,7 +219,7 @@ func (b *slurmBuilder) build(ctx context.Context) (runtime.Object, []runtime.Obj
VolumeSource: corev1.VolumeSource{
ConfigMap: &corev1.ConfigMapVolumeSource{
LocalObjectReference: corev1.LocalObjectReference{
Name: b.objectName,
Name: fmt.Sprintf("%s-scripts", b.objectName),
},
Items: []corev1.KeyToPath{
{
Expand Down Expand Up @@ -255,6 +259,13 @@ func (b *slurmBuilder) build(ctx context.Context) (runtime.Object, []runtime.Obj
},
},
},
EnvFrom: []corev1.EnvFromSource{{
ConfigMapRef: &corev1.ConfigMapEnvSource{
LocalObjectReference: corev1.LocalObjectReference{
Name: fmt.Sprintf("%s-env", b.objectName),
},
},
}},
VolumeMounts: []corev1.VolumeMount{
{
Name: "slurm-scripts",
Expand Down Expand Up @@ -386,6 +397,13 @@ func (b *slurmBuilder) build(ctx context.Context) (runtime.Object, []runtime.Obj
Name: "JOB_CONTAINER_INDEX",
Value: strconv.FormatInt(int64(i), 10),
})
job.Spec.Template.Spec.Containers[i].EnvFrom = append(job.Spec.Template.Spec.Containers[i].EnvFrom, corev1.EnvFromSource{
ConfigMapRef: &corev1.ConfigMapEnvSource{
LocalObjectReference: corev1.LocalObjectReference{
Name: fmt.Sprintf("%s-env", b.objectName),
},
},
})
}

if b.nodes != nil {
Expand All @@ -411,27 +429,117 @@ func (b *slurmBuilder) build(ctx context.Context) (runtime.Object, []runtime.Obj
b.cpusPerGpu = resource.NewQuantity(cpusPerGpu, b.cpusOnNode.Format)
}

initEntrypointScript, err := b.buildInitEntrypointScript()
scriptsConfigMap, err := b.buildScriptsConfigMap()
if err != nil {
return nil, nil, err
}

return job, []runtime.Object{scriptsConfigMap, b.buildEnvConfigMap(), b.buildService()}, nil
}

func (b *slurmBuilder) buildScriptsConfigMap() (*corev1.ConfigMap, error) {
objectMeta := metav1.ObjectMeta{
Name: fmt.Sprintf("%s-scripts", b.objectName),
Namespace: b.profile.Namespace,
Labels: make(map[string]string, 2),
}

if b.profile != nil {
objectMeta.Labels[constants.ProfileLabel] = b.profile.Name
}

if b.mode != nil {
objectMeta.Labels[constants.ModeLabel] = string(b.mode.Name)
}

initEntrypointScript, err := b.buildInitEntrypointScript()
if err != nil {
return nil, err
}

entrypointScript, err := b.buildEntrypointScript()
if err != nil {
return nil, nil, err
return nil, err
}

configMap := &corev1.ConfigMap{
return &corev1.ConfigMap{
TypeMeta: metav1.TypeMeta{Kind: "ConfigMap", APIVersion: "v1"},
ObjectMeta: objectMeta,
Data: map[string]string{
slurmInitEntrypointFilename: initEntrypointScript,
slurmEntrypointFilename: entrypointScript,
slurmScriptFilename: b.scriptContent,
},
}, nil
}

func (b *slurmBuilder) buildEnvConfigMap() *corev1.ConfigMap {
objectMeta := metav1.ObjectMeta{
Name: fmt.Sprintf("%s-env", b.objectName),
Namespace: b.profile.Namespace,
Labels: make(map[string]string, 2),
}

if b.profile != nil {
objectMeta.Labels[constants.ProfileLabel] = b.profile.Name
}

if b.mode != nil {
objectMeta.Labels[constants.ModeLabel] = string(b.mode.Name)
}

nTasks := ptr.Deref(b.nTasks, 1)
nodes := ptr.Deref(b.nodes, 1)

nodeList := make([]string, nodes)
for i := int32(0); i < nodes; i++ {
nodeList[i] = fmt.Sprintf("%s-%d.%s", b.objectName, i, b.objectName)
}

return &corev1.ConfigMap{
TypeMeta: metav1.TypeMeta{Kind: "ConfigMap", APIVersion: "v1"},
ObjectMeta: objectMeta,
Data: map[string]string{
"SLURM_ARRAY_JOB_ID": strconv.Itoa(slurmArrayJobID),
"SLURM_ARRAY_TASK_COUNT": strconv.Itoa(b.arrayIndexes.Count()),
"SLURM_ARRAY_TASK_MAX": fmt.Sprint(b.arrayIndexes.Max()),
"SLURM_ARRAY_TASK_MIN": fmt.Sprint(b.arrayIndexes.Min()),
"SLURM_TASKS_PER_NODE": fmt.Sprint(nTasks),
"SLURM_CPUS_PER_TASK": getValueOrEmpty(b.cpusPerTask),
"SLURM_CPUS_ON_NODE": getValueOrEmpty(b.cpusOnNode),
"SLURM_JOB_CPUS_PER_NODE": getValueOrEmpty(b.cpusOnNode),
"SLURM_CPUS_PER_GPU": getValueOrEmpty(b.cpusPerGpu),
"SLURM_MEM_PER_CPU": getValueOrEmpty(b.memPerCPU),
"SLURM_MEM_PER_GPU": getValueOrEmpty(b.memPerGPU),
"SLURM_MEM_PER_NODE": getValueOrEmpty(b.totalMemPerNode),
"SLURM_GPUS": getValueOrEmpty(b.totalGpus),
"SLURM_NTASKS": fmt.Sprint(nTasks),
"SLURM_NTASKS_PER_NODE": fmt.Sprint(nTasks),
"SLURM_NPROCS": fmt.Sprint(nTasks),
"SLURM_NNODES": fmt.Sprint(nodes),
"SLURM_SUBMIT_DIR": slurmScriptsPath,
"SLURM_JOB_NODELIST": strings.Join(nodeList, ","),
"SLURM_JOB_FIRST_NODE": nodeList[0],
},
}
}

func (b *slurmBuilder) buildService() *corev1.Service {
objectMeta := metav1.ObjectMeta{
Name: b.objectName,
Namespace: b.profile.Namespace,
Labels: make(map[string]string, 2),
}

service := &corev1.Service{
if b.profile != nil {
objectMeta.Labels[constants.ProfileLabel] = b.profile.Name
}

if b.mode != nil {
objectMeta.Labels[constants.ModeLabel] = string(b.mode.Name)
}

return &corev1.Service{
TypeMeta: metav1.TypeMeta{Kind: "Service", APIVersion: "v1"},
ObjectMeta: objectMeta,
Spec: corev1.ServiceSpec{
Expand All @@ -441,8 +549,6 @@ func (b *slurmBuilder) build(ctx context.Context) (runtime.Object, []runtime.Obj
},
},
}

return job, []runtime.Object{configMap, service}, nil
}

func (b *slurmBuilder) buildArrayIndexes() string {
Expand Down Expand Up @@ -480,40 +586,11 @@ type slurmInitEntrypointScript struct {
EnvsPath string
SlurmEnvFilename string

SlurmArrayJobID int32
SlurmArrayTaskCount int32
SlurmArrayTaskMax int32
SlurmArrayTaskMin int32
SlurmTasksPerNode int32
SlurmCPUsPerTask string
SlurmCPUsOnNode string
SlurmJobCPUsPerNode string
SlurmCPUsPerGPU string
SlurmMemPerCPU string
SlurmMemPerGPU string
SlurmMemPerNode string
SlurmGPUs string
SlurmNTasks int32
SlurmNTasksPerNode int32
SlurmNProcs int32
SlurmNNodes int32
SlurmSubmitDir string
SlurmJobNodeList string
SlurmJobFirstNode string

FirstNodeIP bool
FirstNodeIPTimeoutSeconds int32
}

func (b *slurmBuilder) buildInitEntrypointScript() (string, error) {
nTasks := ptr.Deref(b.nTasks, 1)
nodes := ptr.Deref(b.nodes, 1)

nodeList := make([]string, nodes)
for i := int32(0); i < nodes; i++ {
nodeList[i] = fmt.Sprintf("%s-%d.%s", b.objectName, i, b.objectName)
}

scriptValues := slurmInitEntrypointScript{
ArrayIndexes: b.buildArrayIndexes(),

Expand All @@ -523,27 +600,6 @@ func (b *slurmBuilder) buildInitEntrypointScript() (string, error) {
EnvsPath: slurmEnvsPath,
SlurmEnvFilename: slurmSlurmEnvFilename,

SlurmArrayJobID: slurmArrayJobID,
SlurmArrayTaskCount: int32(b.arrayIndexes.Count()),
SlurmArrayTaskMax: b.arrayIndexes.Max(),
SlurmArrayTaskMin: b.arrayIndexes.Min(),
SlurmTasksPerNode: nTasks,
SlurmCPUsPerTask: getValueOrEmpty(b.cpusPerTask),
SlurmCPUsOnNode: getValueOrEmpty(b.cpusOnNode),
SlurmJobCPUsPerNode: getValueOrEmpty(b.cpusOnNode),
SlurmCPUsPerGPU: getValueOrEmpty(b.cpusPerGpu),
SlurmMemPerCPU: getValueOrEmpty(b.memPerCPU),
SlurmMemPerGPU: getValueOrEmpty(b.memPerGPU),
SlurmMemPerNode: getValueOrEmpty(b.totalMemPerNode),
SlurmGPUs: getValueOrEmpty(b.totalGpus),
SlurmNTasks: nTasks,
SlurmNTasksPerNode: nTasks,
SlurmNProcs: nTasks,
SlurmNNodes: nodes,
SlurmSubmitDir: slurmScriptsPath,
SlurmJobNodeList: strings.Join(nodeList, ","),
SlurmJobFirstNode: nodeList[0],

FirstNodeIP: b.firstNodeIP,
FirstNodeIPTimeoutSeconds: int32(b.firstNodeIPTimeout.Seconds()),
}
Expand Down
Loading