-
Notifications
You must be signed in to change notification settings - Fork 786
Unify code structure of training job api #1300
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.
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
Merged
google-oss-robot
merged 6 commits into
kubeflow:all-in-one-operator
from
Jeffwan:cleanup_apis
Jul 14, 2021
Merged
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
3f95290
Add docs, register in job apis
Jeffwan 7ddf016
Generate defaults and openapi for all frameworks
Jeffwan 26f2f21
Add Kind in constants.go
Jeffwan 15e4bb5
Update update-codegen to generate openapi-gen
Jeffwan 9fa6efe
Run goimports to format the files
Jeffwan b1d6843
Add Plural and Singular to apis constants.go
Jeffwan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.