Automated generic deprecation warning #21689

divysinghvi · 2025-10-03T16:29:06Z

We were previously were creating warnings for each driver deprecated driver which was causing too much repetative code
warnDriverDeprecated() function automatically warns if the current driver is marked deprecated

Before

func hyperkitDeprecationWarning(driverName string) {
	if !driver.IsHyperKit(driverName) {
		return
	}
	out.WarningT(`The 'hyperkit' driver is deprecated and will be removed in a future release.
    You can use alternative drivers such as 'vfkit', 'qemu', or 'docker'.
    https://minikube.sigs.k8s.io/docs/drivers/vfkit/
    https://minikube.sigs.k8s.io/docs/drivers/qemu/
    https://minikube.sigs.k8s.io/docs/drivers/docker/
	`)
}

we had to create new function for each deprecated driver

After

❗  The 'hyperkit' driver is deprecated and will be removed in a future release.
    You can use alternative drivers: qemu2, vfkit, krunkit, parallels, docker, podman, ssh, hyperkit, virtualbox.

automated warning for deprecated drivers
adds to #21631

k8s-ci-robot · 2025-10-03T16:29:12Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: divysinghvi
Once this PR has been reviewed and has the lgtm label, please assign spowelljr for approval. For more information see the 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:

OWNERS

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 · 2025-10-03T16:29:16Z

Hi @divysinghvi. Thanks for your PR.

I'm waiting for a kubernetes 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.

minikube-bot · 2025-10-03T16:30:03Z

Can one of the admins verify this patch?

nirs

I like the idea!

nirs · 2025-10-03T17:24:33Z

cmd/minikube/cmd/start.go

+func warnDriverDeprecated(driverName string) {
+	if driverName == "" {
 		return
 	}


empty driver means the driver was not selected by the user. Do we want to warn only about driver selected by the user?

My bad i don't think warning for empty driver should be part of this function

sure, we should not warn about empty driverName, and the check achieve this. But can get this for free by getting the driver and return on missing driver.

nirs · 2025-10-03T17:31:53Z

cmd/minikube/cmd/start.go

-func hyperkitDeprecationWarning(driverName string) {
-	if !driver.IsHyperKit(driverName) {
-		return
+	for _, d := range registry.List() {


Looping over all drivers is not needed, since we have the driver name. I think we better get the driver from the registry and check if the driver is deprecated.

Can we done using:

d := registry.Driver(driverName) if d.Name == "" { // fail, no such driver } If d.Priority == registry.Deprecated { // show warning }

Note that with driverName "" we will get a DriverDef with empty name, and this is not an error, so we should not fail, just return.

The check for valid driver should be done before we call this function, for example if a user makes a typo in the driver name, or the driver is not available on this OS.

nirs · 2025-10-03T17:34:29Z

cmd/minikube/cmd/start.go

+			if a == driverName {
+				out.WarningT("The '{{.name}}' driver is deprecated and will be removed in a future release.\n    You can use alternative drivers: {{.drivers}}.", out.V{"name": d.Name, "drivers": strings.Join(driver.SupportedDrivers(), ", ")})
+				return
+			}


It does not make sense to iterate over all drivers and check both driver name and all aliases. The registry keeps a map of drivers by name and alias, so getting a driver should be a single map lookup using the name and if not found a second map lookup using the alias.

nirs · 2025-10-03T17:37:59Z

cmd/minikube/cmd/start.go

+
+		// match driver name
+		if d.Name == driverName {
+			out.WarningT("The '{{.name}}' driver is deprecated and will be removed in a future release.\n    You can use alternative drivers: {{.drivers}}.", out.V{"name": d.Name, "drivers": strings.Join(driver.SupportedDrivers(), ", ")})


SupportedDrivers() return results based on current OS? Is it sorted by priority?

Previously we used:

You can use alternative drivers such as 'vfkit', 'qemu', or 'docker'

This is the wanted order, using driver priority (vfkit is the preferred driver) and preferring vm drivers since on macOS all drivers need a vm. We want to keep this order. If SupportedDrivers() does not return the drivers in the right order for the current OS, we need to improve it before using it here.

is it is priority sorted The 'hyperkit' driver is deprecated and will be removed in a future release.
You can use alternative drivers: qemu2, vfkit, krunkit, parallels, docker, podman, ssh, hyperkit, virtualbox. this is a real result i did added hyperkit and virtualbox to it for testing on my local system rest they won't be visible since they will be deprecated

The order is wrong - vfkit is the preferred driver and should be first, not qemu. This is the native driver for macOS. qemu on macOS is poorly maintained and should not be the preferred driver.

Also the hyperkit driver appears in the list of alternatives which is wrong - the hyperkit driver is not an alternative to itself.

We need to create AlternativeDrivers() function - SupportedDrivers() is not the right way.

nirs · 2025-10-03T17:48:09Z

Before

func hyperkitDeprecationWarning(driverName string) {
	if !driver.IsHyperKit(driverName) {
		return
	}
	out.WarningT(`The 'hyperkit' driver is deprecated and will be removed in a future release.
    You can use alternative drivers such as 'vfkit', 'qemu', or 'docker'.
    https://minikube.sigs.k8s.io/docs/drivers/vfkit/
    https://minikube.sigs.k8s.io/docs/drivers/qemu/
    https://minikube.sigs.k8s.io/docs/drivers/docker/
	`)
}

After

❗  The 'hyperkit' driver is deprecated and will be removed in a future release.
    You can use alternative drivers: qemu2, vfkit, krunkit, parallels, docker, podman, ssh, hyperkit, virtualbox.

The new warning does not include links to the alternative drivers docs. Why did you remove the links? This is not required change for adding automated deprecated warnings. Please do not mix unrelated changes.

If you want to remove the links please open an issue and we can discuss this there.

divysinghvi · 2025-10-03T17:56:46Z

@nirs thanks for the comment will keep in mind not to mix unrelated things , but i don't understand like https://minikube.sigs.k8s.io/docs/drivers/vfkit/
https://minikube.sigs.k8s.io/docs/drivers/qemu/
https://minikube.sigs.k8s.io/docs/drivers/docker/
since these are mainly valid for the mac os only right but when we are trying to be do generalised warning won't it be bad to include specific driver link that might be unrelated to that OS like links will vary for other OS if i deprecated a windows driver? what do you think

nirs · 2025-10-03T18:12:50Z

@nirs thanks for the comment will keep in mind not to mix unrelated things , but i don't understand like https://minikube.sigs.k8s.io/docs/drivers/vfkit/ https://minikube.sigs.k8s.io/docs/drivers/qemu/ https://minikube.sigs.k8s.io/docs/drivers/docker/

What do you mean by "I don't understand like .."?

since these are mainly valid for the mac os only right but when we are trying to be do generalised warning won't it be bad to include specific driver link that might be unrelated to that OS like links will vary for other OS if i deprecated a windows driver? what do you think

The warning is generated - it is not static, so it should never include drivers which are not available on the current OS, and all the links to the docs will also be generated, so they will always be relevant to the current os.

A DriverDef should include Name and DocURL. In this warning we should get list of alternative drivers, which should be drivers which are not deprecated or discouraged, and available on the current OS and architecture.

For example when running on darwin/arm64 we should not recommend drivers which available only on amd64. So we should not have such a long list of alternative as you show in your example.

We can generate the links form the Driver.DockURLs - in the same order of the alternative drivers.

divysinghvi · 2025-10-03T18:29:28Z

Thanks for explaining now i understand it way better i was a bit confused , and also the long list is also useless also since have the Driver.DockURLs it would be way easier to create docs link did not knew about that

Created warnDriverDeprecated function

2ba29ce

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Oct 3, 2025

k8s-ci-robot requested review from ComradeProgrammer and prezha October 3, 2025 16:29

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 Oct 3, 2025

k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Oct 3, 2025

Code fix

7be0e00

nirs reviewed Oct 3, 2025

View reviewed changes

Automated generic deprecation warning #21689

Are you sure you want to change the base?

Automated generic deprecation warning #21689

Conversation

divysinghvi commented Oct 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Before

After

Uh oh!

k8s-ci-robot commented Oct 3, 2025

Uh oh!

k8s-ci-robot commented Oct 3, 2025

Uh oh!

minikube-bot commented Oct 3, 2025

Uh oh!

nirs left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nirs Oct 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nirs commented Oct 3, 2025

Before

After

Uh oh!

divysinghvi commented Oct 3, 2025

Uh oh!

nirs commented Oct 3, 2025

Uh oh!

divysinghvi commented Oct 3, 2025

Uh oh!

Uh oh!

divysinghvi commented Oct 3, 2025 •

edited

Loading

nirs Oct 3, 2025 •

edited

Loading