github.com/kubeflow/training-operator@v1.7.0/pkg/apis/kubeflow.org/v1/paddlepaddle_defautls.go (about)

     1  // Copyright 2022 The Kubeflow Authors
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package v1
    16  
    17  import (
    18  	corev1 "k8s.io/api/core/v1"
    19  	"k8s.io/apimachinery/pkg/runtime"
    20  )
    21  
    22  func addPaddleDefaultingFuncs(scheme *runtime.Scheme) error {
    23  	return RegisterDefaults(scheme)
    24  }
    25  
    26  // setPaddleDefaultPort sets the default ports for paddle container.
    27  func setPaddleDefaultPort(spec *corev1.PodSpec) {
    28  	index := getDefaultContainerIndex(spec, PaddleJobDefaultContainerName)
    29  	if ok := hasDefaultPort(spec, index, PaddleJobDefaultPortName); !ok {
    30  		setDefaultPort(spec, PaddleJobDefaultPortName, PaddleJobDefaultPort, index)
    31  	}
    32  }
    33  
    34  func setPaddleElasticPolicy(paddleJob *PaddleJob) {
    35  	if paddleJob.Spec.ElasticPolicy != nil {
    36  		if paddleJob.Spec.ElasticPolicy.MaxReplicas != nil &&
    37  			paddleJob.Spec.ElasticPolicy.MinReplicas != nil {
    38  			return
    39  		} else if paddleJob.Spec.ElasticPolicy.MaxReplicas != nil {
    40  			// Set MinRepliacs to elasticPolicy.MaxReplicas.
    41  			paddleJob.Spec.ElasticPolicy.MinReplicas = paddleJob.Spec.ElasticPolicy.MaxReplicas
    42  		} else if paddleJob.Spec.ElasticPolicy.MinReplicas != nil {
    43  			paddleJob.Spec.ElasticPolicy.MaxReplicas = paddleJob.Spec.ElasticPolicy.MinReplicas
    44  		} else {
    45  			workerReplicas := paddleJob.Spec.PaddleReplicaSpecs[PaddleJobReplicaTypeWorker].Replicas
    46  			// Set Min and Max to worker.spec.Replicas.
    47  			paddleJob.Spec.ElasticPolicy.MaxReplicas = workerReplicas
    48  			paddleJob.Spec.ElasticPolicy.MinReplicas = workerReplicas
    49  		}
    50  	}
    51  }
    52  
    53  // setPaddleTypeNamesToCamelCase sets the name of all replica types from any case to correct case.
    54  func setPaddleTypeNamesToCamelCase(paddleJob *PaddleJob) {
    55  	replicaTypes := []ReplicaType{
    56  		PaddleJobReplicaTypeMaster,
    57  		PaddleJobReplicaTypeWorker,
    58  	}
    59  	for _, replicaType := range replicaTypes {
    60  		setTypeNameToCamelCase(paddleJob.Spec.PaddleReplicaSpecs, replicaType)
    61  	}
    62  }
    63  
    64  // SetDefaults_PaddleJob sets any unspecified values to defaults.
    65  func SetDefaults_PaddleJob(job *PaddleJob) {
    66  	// Set default cleanpod policy to None.
    67  	if job.Spec.RunPolicy.CleanPodPolicy == nil {
    68  		job.Spec.RunPolicy.CleanPodPolicy = CleanPodPolicyPointer(CleanPodPolicyNone)
    69  	}
    70  
    71  	// Update the key of PaddleReplicaSpecs to camel case.
    72  	setPaddleTypeNamesToCamelCase(job)
    73  
    74  	for _, spec := range job.Spec.PaddleReplicaSpecs {
    75  		setDefaultReplicas(spec, 1)
    76  		setDefaultRestartPolicy(spec, PaddleJobDefaultRestartPolicy)
    77  		setPaddleDefaultPort(&spec.Template.Spec)
    78  	}
    79  	// Set default elastic policy.
    80  	setPaddleElasticPolicy(job)
    81  }