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

Improve the API generated docs for managedBy #565

Merged
merged 1 commit into from
May 10, 2024
Merged

Improve the API generated docs for managedBy #565

merged 1 commit into from
May 10, 2024

Conversation

mimowo
Copy link
Contributor

@mimowo mimowo commented May 9, 2024

/kind documentation

  • mention this is immutable (motivated by the thread)
  • describe validation rules as in k/k for Job link

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels May 9, 2024
@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label May 9, 2024
@netlify Netlify
Copy link

netlify bot commented May 9, 2024 •
edited
Loading

✅ Deploy Preview for kubernetes-sigs-jobset canceled.

Name Link
🔨 Latest commit ab6f0f4
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-sigs-jobset/deploys/663ccb4564fa8f0008bcfe31

@mimowo
Copy link
Contributor Author

mimowo commented May 9, 2024

/cc @tenzen-y @danielvegamyhre @kannon92

@k8s-ci-robot k8s-ci-robot requested a review from tenzen-y May 9, 2024 12:58
@mimowo mimowo mentioned this pull request May 9, 2024
Merged
@mimowo mimowo force-pushed the improve-docs-jobset branch from 8f6e0dd to ab6f0f4 Compare May 9, 2024 13:10
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 9, 2024
tenzen-y
tenzen-y reviewed May 9, 2024
View reviewed changes
Copy link
Member

@tenzen-y tenzen-y left a comment

Choose a reason for hiding this comment

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

LGTM
Thank you!

api/jobset/v1alpha2/jobset_types.go
// by RFC 1123. All characters trailing the first "/" must be valid HTTP Path
// characters as defined by RFC 3986. The value cannot exceed 63 characters.
// The field is immutable.
// +optional
ManagedBy *string `json:"managedBy,omitempty"`
Copy link
Member

Choose a reason for hiding this comment

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

This is just curious. Why we don't use CEL validation instead of webhook validation here?

jobset/pkg/webhooks/jobset_webhook.go

Line 231 in 7752a36

errs = append(errs, apivalidation.ValidateImmutableField(mungedSpec.ManagedBy, oldJS.Spec.ManagedBy, field.NewPath("spec").Child("managedBy"))...)

Copy link
Contributor

Choose a reason for hiding this comment

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

No specific reason for using webhook validation here. We can look into migrating to CEL as a follow up.

Copy link
Member

Choose a reason for hiding this comment

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

I see. Thank you.

@danielvegamyhre
Copy link
Contributor

/lgtm
/approve

Thanks for improving the documentation here!

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 10, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: danielvegamyhre, mimowo

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 10, 2024
@k8s-ci-robot k8s-ci-robot merged commit 11f7ae6 into kubernetes-sigs:main May 10, 2024
12 checks passed
@danielvegamyhre danielvegamyhre mentioned this pull request Aug 19, 2024
Closed
20 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tenzen-y tenzen-y tenzen-y left review comments

@danielvegamyhre danielvegamyhre Awaiting requested review from danielvegamyhre

@kannon92 kannon92 Awaiting requested review from kannon92

Assignees

@danielvegamyhre danielvegamyhre

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@mimowo @danielvegamyhre @k8s-ci-robot @tenzen-y