⚠️ Update klog dependency to v2

[stmcginnis]

What this PR does / why we need it:
This switches klog usage over to klog v2.5.0 to match the current
version being used in k/k.

This should also address some issues we're seeing that have since been
fixed in klog between the quite old v1.0.0 and v2.5.0

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

[k8s-ci-robot]

Welcome @stmcginnis!

It looks like this is your first PR to kubernetes-sigs/cluster-api 🎉. 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/cluster-api 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]

Hi @stmcginnis. 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/test-infra repository.

[neolit123]

/ok-to-test

[neolit123]

cc @enyinna1234

[neolit123]

i didn't check the CI errors here, but you are probably going to have to update the go.mod/sum files too.

[stmcginnis]

Yep, go.mod and go.sum are included here. Need to look through them all, but first one looks like maybe a pull error. Maybe something going on causing them all to fail?

Will investigate.

[vincepri]

We should move controller runtime first to klog v2, if we haven't already.

[detiber]

We should move controller runtime first to klog v2, if we haven't already.

I don't think controller-runtime uses klog directly, only github.com/go-logr/logr and zap. I'd expect anything using klog would be through transitive dependencies.

[stmcginnis]

Thanks @vincepri and @detiber. From my understanding, this should be fine. But I'm still pretty new to the code, so if there is anywhere else I should look to verify things or get other parts updated, just let me know. Happy to take a look!

[stmcginnis]

Indeed, it would appear controller-runtime had already switch to klog v2:

https://github.com/kubernetes-sigs/controller-runtime/blob/85527dfb53483d218ce87733abd3093b1c05c618/go.sum#L795

[stmcginnis]

/test pull-cluster-api-test-main

Appears to have hit #4184

[detiber]

Running make modules should clean up the error in the pull-cluster-api-verify job

[stmcginnis]

Thanks! Looks like that didn't do it though - pretty much had run those manually. Glad to know about it though.

Looks like I may need to run make generate? Will see once it finally finishes running.

[stmcginnis]

Hah, I take that back. Running make modules initially didn't show any local changes for me. But after reverting this apparently very bad make generate changes, I ran it again and now it does actually show a change in test/infrastructure/docker/go.sum. 🤷

[vincepri]

/lgtm

[vincepri]

/milestone v0.4.0
/retitle ⚠️ Update klog dependency to v2

[stmcginnis]

It's my understanding that it should not have an impact on providers. klog and klogv2 should be able to be used together, it's just the path through the code that consuming code will take to ultimately get to the logging.

[CecileRobertMichon]

@vincepri why did you mark the change as breaking?

[vincepri]

It'd be great actually if we document that we've switched to v2 (hence my marking this PR as ⚠️). When mixed, klog's flags are not going to work across packages. For example, logtostderr or log to file, and any other flag (even verbosity) would only be respected for the flags that are being registered in the main.go, while the rest of the codebase is going to use what's the default.

Hope the above example makes sense, happy to provide more details.

[stmcginnis]

Oh, great point @vincepri, I hadn't thought of that.

Where should this be documented? Happy to add some notification about the v2 requirement. I see docs/developer, but that currently only has release information.

I will also look at proposing updates to any of the other upstream cluster-api-* repos.

[CecileRobertMichon]

@stmcginnis https://github.com/kubernetes-sigs/cluster-api/blob/master/docs/book/src/developer/providers/v1alpha3-to-v1alpha4.md

[vincepri]

/approve
/lgtm

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vincepri

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:

• OWNERS [vincepri]

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