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.

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

Add validation for verifying that the CustomJob (e.g., TFJob) name meets DNS1035 #1748

Merged

Conversation

tenzen-y
Copy link
Member

@tenzen-y tenzen-y commented Jan 31, 2023

Signed-off-by: Yuki Iwai yuki.iwai.tz@gmail.com

What this PR does / why we need it:
I added validation for verifying that the CustomJob (e.g., TFJob) name meets DNS1035.
Also, I refactored unit tests for validation.

Which issue(s) this PR fixes (optional, in Fixes #<issue number>, #<issue number>, ... format, will close the issue(s) when PR gets merged):
Fixes #1745

Checklist:

  • Docs included if any changes are user facing

…ets DNS1035

Signed-off-by: Yuki Iwai <yuki.iwai.tz@gmail.com>
@tenzen-y
Copy link
Member Author

/assign @johnugeorge @zw0610

@coveralls
Copy link

coveralls commented Jan 31, 2023

Pull Request Test Coverage Report for Build 4056733428

  • 54 of 56 (96.43%) changed or added relevant lines in 10 files are covered.
  • 10 unchanged lines in 4 files lost coverage.
  • Overall coverage increased (+0.7%) to 39.535%

Changes Missing Coverage Covered Lines Changed/Added Lines %
pkg/controller.v1/mxnet/mxjob_controller.go 0 1 0.0%
pkg/controller.v1/xgboost/xgboostjob_controller.go 0 1 0.0%
Files with Coverage Reduction New Missed Lines %
pkg/apis/kubeflow.org/v1/pytorch_validation.go 2 90.91%
pkg/apis/kubeflow.org/v1/tensorflow_validation.go 2 75.0%
pkg/apis/kubeflow.org/v1/xgboost_validation.go 2 91.84%
pkg/controller.v1/mpi/mpijob_controller.go 4 76.79%
Totals Coverage Status
Change from base Build 4012132598: 0.7%
Covered Lines: 2735
Relevant Lines: 6918

💛 - Coveralls

@tenzen-y tenzen-y changed the title Add validation for verifying that the CustomJob (e.g., TFJob) name meet DNS1035 Add validation for verifying that the CustomJob (e.g., TFJob) name meets DNS1035 Jan 31, 2023
@tenzen-y
Copy link
Member Author

@johnugeorge Do we need to cherry-pick this commit to the v1.6 branch?

@johnugeorge
Copy link
Member

johnugeorge commented Jan 31, 2023

Thanks @tenzen-y for this.
Since rc0 manifests have already merged for Kubeflow testing, shall we take this up for next release ? What do you think?We can merge it to master anyways

@tenzen-y
Copy link
Member Author

Thanks @tenzen-y for this. Since rc0 manifests have already merged for Kubeflow testing, shall we take this up for next release ? What do you think?We can merge it to master anyways

I'm ok with taking this up for the next release since #1745 is not the critical bug.

@zw0610
Copy link
Member

zw0610 commented Feb 1, 2023

I could be wrong. The code changes introduced by this pr seems a bit tremendous to me.

Another approach might be: skipping changes under pkg/apis and adding apimachineryvalidation.NameIsDNS1035Label to each job controller files under pkg/controller.v1 for job controllers that will generate Service.

However, I agree with the idea to change from validating job spec to validating the entire job. Maybe after the recent release, we can focus on a refactor version of training operator and introduce this new validating idea.

@tenzen-y
Copy link
Member Author

tenzen-y commented Feb 1, 2023

Another approach might be: skipping changes under pkg/apis and adding apimachineryvalidation.NameIsDNS1035Label to each job controller files under pkg/controller.v1 for job controllers that will generate Service.

Does that mean we want to introduce your another approach to the next training-operator release (v1.6)?

Maybe after the recent release, we can focus on a refactor version of training operator and introduce this new validating idea.

We will not include this improvement in the next training-operator (v1.6) release. So this commit is merged only to the master branch and this becomes the improvement for the long term.

@zw0610

@tenzen-y
Copy link
Member Author

tenzen-y commented Feb 1, 2023

I'm ok with taking this up for the next release since #1745 is not the critical bug.

The above next release meant v1.7, not v1.6.

@zw0610
Copy link
Member

zw0610 commented Feb 1, 2023

Does that mean we want to introduce your another approach to the next training-operator release (v1.6)?

No, what I commented is just to provide another possible to address the naming issue, which I believe could leads to less code changes. But it's just a suggestion and I'm OK with the approach in commit 68b582a

@tenzen-y

@tenzen-y
Copy link
Member Author

tenzen-y commented Feb 1, 2023

Does that mean we want to introduce your another approach to the next training-operator release (v1.6)?

No, what I commented is just to provide another possible to address the naming issue, which I believe could leads to less code changes. But it's just a suggestion and I'm OK with the approach in commit 68b582a

@tenzen-y

@zw0610, I see. I would take my approach since this approach has been more tested and is safer than adding apimachineryvalidation.NameIsDNS1035Label to reconciler.

@zw0610
Copy link
Member

zw0610 commented Feb 1, 2023

Good.
/lgtm

@google-oss-prow google-oss-prow bot added the lgtm label Feb 1, 2023
Copy link
Member

@terrytangyuan terrytangyuan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

/lgtm
/approve

@google-oss-prow
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tenzen-y, terrytangyuan

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@google-oss-prow google-oss-prow bot merged commit aae672f into kubeflow:master Feb 1, 2023
@tenzen-y tenzen-y deleted the add-validation-for-service branch February 1, 2023 17:24
google-oss-prow bot pushed a commit that referenced this pull request Feb 13, 2023
* Add validation for verifying that the CustomJob (e.g., TFJob) name meets DNS1035 (#1748)

Signed-off-by: Yuki Iwai <yuki.iwai.tz@gmail.com>

* Fix the success condition of the job in PyTorchJob's Elastic mode. (#1752)

Signed-off-by: Syulin7 <735122171@qq.com>

* Set the default value of CleanPodPolicy to None (#1754)

Signed-off-by: Syulin7 <735122171@qq.com>

* Update mpijob_controller.go (#1755)

fix typo TFJob, should be MPIJob

---------

Signed-off-by: Yuki Iwai <yuki.iwai.tz@gmail.com>
Signed-off-by: Syulin7 <735122171@qq.com>
Co-authored-by: Yuki Iwai <yuki.iwai.tz@gmail.com>
Co-authored-by: yu lin <37265556+Syulin7@users.noreply.github.com>
Co-authored-by: Yasser Shalabi <yassershalabi@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants