-
Notifications
You must be signed in to change notification settings - Fork 738
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Unify code structure of training job api (#1300)
* Add docs, register in job apis - Clean up register.go and use reference in groupversion_info.go (generated by kubebuilder) instead - Add doc.go and register.go for framework missing them - Remove global tag “+k8s:deepcopy-gen=package,register” and this should be taken care of by controller-gen. Signed-off-by: Jiaxin Shan <seedjeffwan@gmail.com> * Generate defaults and openapi for all frameworks 1. Update codegen scripts to generate defaulters and openapi spec for all frameworks 2. Create defaults.go for framework which miss it. Signed-off-by: Jiaxin Shan <seedjeffwan@gmail.com> * Add Kind in constants.go Signed-off-by: Jiaxin Shan <seedjeffwan@gmail.com> * Update update-codegen to generate openapi-gen Signed-off-by: Jiaxin Shan <seedjeffwan@gmail.com> * Run goimports to format the files * Add Plural and Singular to apis constants.go Signed-off-by: Jiaxin Shan <seedjeffwan@gmail.com>
- Loading branch information
Showing
48 changed files
with
42,481 additions
and
158 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,107 @@ | ||
// Copyright 2018 The Kubeflow Authors | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
package v1 | ||
|
||
import ( | ||
"strings" | ||
|
||
commonv1 "github.com/kubeflow/common/pkg/apis/common/v1" | ||
|
||
v1 "k8s.io/api/core/v1" | ||
"k8s.io/apimachinery/pkg/runtime" | ||
) | ||
|
||
// Int32 is a helper routine that allocates a new int32 value | ||
// to store v and returns a pointer to it. | ||
func Int32(v int32) *int32 { | ||
return &v | ||
} | ||
|
||
func addDefaultingFuncs(scheme *runtime.Scheme) error { | ||
return RegisterDefaults(scheme) | ||
} | ||
|
||
// setDefaultPort sets the default ports for mxnet container. | ||
func setDefaultPort(spec *v1.PodSpec) { | ||
index := 0 | ||
for i, container := range spec.Containers { | ||
if container.Name == DefaultContainerName { | ||
index = i | ||
break | ||
} | ||
} | ||
|
||
hasMXJobPort := false | ||
for _, port := range spec.Containers[index].Ports { | ||
if port.Name == DefaultPortName { | ||
hasMXJobPort = true | ||
break | ||
} | ||
} | ||
if !hasMXJobPort { | ||
spec.Containers[index].Ports = append(spec.Containers[index].Ports, v1.ContainerPort{ | ||
Name: DefaultPortName, | ||
ContainerPort: DefaultPort, | ||
}) | ||
} | ||
} | ||
|
||
func setDefaultReplicas(spec *commonv1.ReplicaSpec) { | ||
if spec.Replicas == nil { | ||
spec.Replicas = Int32(1) | ||
} | ||
if spec.RestartPolicy == "" { | ||
spec.RestartPolicy = DefaultRestartPolicy | ||
} | ||
} | ||
|
||
// setTypeNamesToCamelCase sets the name of all replica types from any case to correct case. | ||
func setTypeNamesToCamelCase(mxJob *MXJob) { | ||
setTypeNameToCamelCase(mxJob, MXReplicaTypeScheduler) | ||
setTypeNameToCamelCase(mxJob, MXReplicaTypeServer) | ||
setTypeNameToCamelCase(mxJob, MXReplicaTypeWorker) | ||
} | ||
|
||
// setTypeNameToCamelCase sets the name of the replica type from any case to correct case. | ||
// E.g. from server to Server; from WORKER to Worker. | ||
func setTypeNameToCamelCase(mxJob *MXJob, typ commonv1.ReplicaType) { | ||
for t := range mxJob.Spec.MXReplicaSpecs { | ||
if strings.EqualFold(string(t), string(typ)) && t != typ { | ||
spec := mxJob.Spec.MXReplicaSpecs[t] | ||
delete(mxJob.Spec.MXReplicaSpecs, t) | ||
mxJob.Spec.MXReplicaSpecs[typ] = spec | ||
return | ||
} | ||
} | ||
} | ||
|
||
// SetDefaults_MXJob sets any unspecified values to defaults. | ||
func SetDefaults_MXJob(mxjob *MXJob) { | ||
// Set default cleanpod policy to All. | ||
if mxjob.Spec.RunPolicy.CleanPodPolicy == nil { | ||
all := commonv1.CleanPodPolicyAll | ||
mxjob.Spec.RunPolicy.CleanPodPolicy = &all | ||
} | ||
|
||
// Update the key of MXReplicaSpecs to camel case. | ||
setTypeNamesToCamelCase(mxjob) | ||
|
||
for _, spec := range mxjob.Spec.MXReplicaSpecs { | ||
// Set default replicas to 1. | ||
setDefaultReplicas(spec) | ||
// Set default port to mxnet container. | ||
setDefaultPort(&spec.Template.Spec) | ||
} | ||
} |
Oops, something went wrong.