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 CodecFactoryOptionsMutators for codecfactory #3048

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Chaunceyctx
Copy link

@Chaunceyctx Chaunceyctx commented Dec 28, 2024

What does this do, and why do we need it?

we have a production scenario:

the CRD field declared in the v1 version of the controller includes field A. However, when we upgrade the v1 controller to v2, field A is removed from the corresponding CRD(we make some changes to this CRD).

So we want the controller to realize this error during data deserialization, so we need to switch the corresponding serializer to strict mode.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Dec 28, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Chaunceyctx
Once this PR has been reviewed and has the lgtm label, please assign alvaroaleman for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found 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
Copy link
Contributor

Welcome @Chaunceyctx!

It looks like this is your first PR to kubernetes-sigs/controller-runtime 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/controller-runtime has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Dec 28, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @Chaunceyctx. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Dec 28, 2024
@Chaunceyctx
Copy link
Author

/ping gently @vincepri @sbueringer PTAL, thanks a lot :)

@Chaunceyctx
Copy link
Author

/ping gently @troy0820

@@ -150,7 +153,7 @@ func newClient(config *rest.Config, options Options) (*client, error) {
config: config,
scheme: options.Scheme,
mapper: options.Mapper,
codecs: serializer.NewCodecFactory(options.Scheme),
codecs: serializer.NewCodecFactory(options.Scheme, options.CodecFactoryOptionsMutators...),
Copy link
Member

Choose a reason for hiding this comment

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

What is the user-facing difference in impact between configuring strict here vs. using client.WithFieldValdation to set FieldValidation in the Options structs?

Is it that the latter only affects Create/Update/patch?

Copy link
Author

Choose a reason for hiding this comment

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

What is the user-facing difference in impact between configuring strict here vs. using client.WithFieldValdation to set FieldValidation in the Options structs?

Is it that the latter only affects Create/Update/patch?

@sbueringer thanks a lot for feedback :) Yes, FieldValidation will be used in CreateOptions/UpdateOptions/PatchOptions. And these Options will tell apiserver how to select mode of decodeSerializer(strict or not strict), like: https://github.com/kubernetes/kubernetes/blob/6746df77f2376c6bc1fd0de767d2a94e6bd6cec1/staging/src/k8s.io/apiserver/pkg/endpoints/handlers/update.go#L109

So client also need to know how to select mode of decodeSerializer and use strict mode of decodeSerializer to avoid the aforementioned issue.

I will address failed ci job.

@sbueringer
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jan 2, 2025
@k8s-ci-robot
Copy link
Contributor

@Chaunceyctx: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-controller-runtime-apidiff 6d063ae link false /test pull-controller-runtime-apidiff

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@Chaunceyctx
Copy link
Author

@sbueringer excuse me, could you give me some hints to address this failed ci job? I am a noob for go-apidiff tool

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants