Switch logging implementation from zap to klog v2 for consistency

This commit removes the dependencies on go.uber.org/zap and
sigs.k8s.io/controller-runtime/pkg/log/zap, replacing them with
klog v2. Other Metal3 controllers—including CAPM3, Ironic, and IPAM—
already use klog v2, so this change aligns the logging approach across
the project and ensures a consistent logging format.

Signed-off-by: Feruzjon Muyassarov <[email protected]>

Author: fmuyassarov

go.mod

@@ -14,7 +14,6 @@ require (
 	github.com/prometheus/client_golang v1.23.2
 	github.com/stretchr/testify v1.11.1
 	go.etcd.io/etcd/client/pkg/v3 v3.6.6
-	go.uber.org/zap v1.27.0
 	k8s.io/api v0.34.2
 	k8s.io/apimachinery v0.34.2
 	k8s.io/client-go v0.34.2
@@ -77,6 +76,7 @@ require (
 	go.opentelemetry.io/otel/trace v1.35.0 // indirect
 	go.opentelemetry.io/proto/otlp v1.5.0 // indirect
 	go.uber.org/multierr v1.11.0 // indirect
+	go.uber.org/zap v1.27.0 // indirect
 	go.yaml.in/yaml/v2 v2.4.2 // indirect
 	go.yaml.in/yaml/v3 v3.0.4 // indirect
 	golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56 // indirect

main.go

@@ -36,16 +36,15 @@ import (
 	"github.com/metal3-io/baremetal-operator/pkg/secretutils"
 	"github.com/metal3-io/baremetal-operator/pkg/version"
 	ironicv1alpha1 "github.com/metal3-io/ironic-standalone-operator/api/v1alpha1"
-	"go.uber.org/zap/zapcore"
 	k8sruntime "k8s.io/apimachinery/pkg/runtime"
 	clientgoscheme "k8s.io/client-go/kubernetes/scheme"
 	_ "k8s.io/client-go/plugin/pkg/client/auth/gcp"
 	cliflag "k8s.io/component-base/cli/flag"
+	"k8s.io/klog/v2"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/cache"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/healthz"
-	"sigs.k8s.io/controller-runtime/pkg/log/zap"
 	"sigs.k8s.io/controller-runtime/pkg/metrics/filters"
 	metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
 	"sigs.k8s.io/controller-runtime/pkg/webhook"
@@ -65,7 +64,7 @@ type TLSOptions struct {
 
 var (
 	scheme               = k8sruntime.NewScheme()
-	setupLog             = ctrl.Log.WithName("setup")
+	setupLog             = klog.NewKlogr().WithName("setup")
 	healthAddr           string
 	tlsOptions           = TLSOptions{}
 	tlsSupportedVersions = []string{TLSVersion12, TLSVersion13}
@@ -177,14 +176,7 @@ func main() {
 
 	flag.Parse()
 
-	logOpts := zap.Options{}
-	if devLogging {
-		logOpts.Development = true
-		logOpts.TimeEncoder = zapcore.ISO8601TimeEncoder
-	} else {
-		logOpts.TimeEncoder = zapcore.EpochTimeEncoder
-	}
-	ctrl.SetLogger(zap.New(zap.UseFlagOptions(&logOpts)))
+	ctrl.SetLogger(klog.NewKlogr())
 
 	printVersion()
 
@@ -206,16 +198,16 @@ func main() {
 	watchNamespaces := make(map[string]cache.Config)
 
 	if strings.Contains(watchNamespace, ",") {
-		setupLog.Info("Manager set up with multiple namespaces to watch", "namespaces", watchNamespace)
+		klog.Info("Manager set up with multiple namespaces to watch", "namespaces", watchNamespace)
 		namespaces := strings.Split(watchNamespace, ",")
 		for _, namespace := range namespaces {
 			watchNamespaces[namespace] = cache.Config{}
 		}
 	} else if watchNamespace != "" {
-		setupLog.Info("Manager set up to watch a single namespace", "namespace", watchNamespace)
+		klog.Info("Manager set up to watch a single namespace", "namespace", watchNamespace)
 		watchNamespaces[watchNamespace] = cache.Config{}
 	} else {
-		setupLog.Info("Manager set up with cluster scope")
+		klog.Info("Manager set up with cluster scope")
 	}
 
 	// Setup cache options
@@ -302,13 +294,14 @@ func main() {
 
 	var provisionerFactory provisioner.Factory
 	if runInTestMode {
-		ctrl.Log.Info("using test provisioner")
+		klog.Info("using test provisioner")
 		provisionerFactory = &fixture.Fixture{}
 	} else if runInDemoMode {
-		ctrl.Log.Info("using demo provisioner")
+		klog.Info("using demo provisioner")
 		provisionerFactory = &demo.Demo{}
 	} else {
-		provLog := zap.New(zap.UseFlagOptions(&logOpts)).WithName("provisioner")
+		provLog := klog.NewKlogr().WithName("provisioner")
+		ctrl.SetLogger(provLog)
 		// Check if we should use Ironic CR integration
 		if ironicName != "" && ironicNamespace != "" {
 			provisionerFactory, err = ironic.NewProvisionerFactoryWithClient(provLog, preprovImgEnable,
@@ -330,7 +323,7 @@ func main() {
 
 	if err = (&metal3iocontroller.BareMetalHostReconciler{
 		Client:             mgr.GetClient(),
-		Log:                ctrl.Log.WithName("controllers").WithName("BareMetalHost"),
+		Log:                ctrl.Log.WithName("BareMetalHost"),
 		ProvisionerFactory: provisionerFactory,
 		APIReader:          mgr.GetAPIReader(),
 	}).SetupWithManager(mgr, preprovImgEnable, maxConcurrency); err != nil {
@@ -341,7 +334,7 @@ func main() {
 	if preprovImgEnable {
 		imgReconciler := metal3iocontroller.PreprovisioningImageReconciler{
 			Client:        mgr.GetClient(),
-			Log:           ctrl.Log.WithName("controllers").WithName("PreprovisioningImage"),
+			Log:           ctrl.Log.WithName("PreprovisioningImage"),
 			APIReader:     mgr.GetAPIReader(),
 			Scheme:        mgr.GetScheme(),
 			ImageProvider: imageprovider.NewDefaultImageProvider(),
@@ -357,7 +350,7 @@ func main() {
 
 	if err = (&metal3iocontroller.HostFirmwareSettingsReconciler{
 		Client:             mgr.GetClient(),
-		Log:                ctrl.Log.WithName("controllers").WithName("HostFirmwareSettings"),
+		Log:                ctrl.Log.WithName("HostFirmwareSettings"),
 		ProvisionerFactory: provisionerFactory,
 	}).SetupWithManager(mgr, maxConcurrency); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "HostFirmwareSettings")
@@ -366,7 +359,7 @@ func main() {
 
 	if err = (&metal3iocontroller.BMCEventSubscriptionReconciler{
 		Client:             mgr.GetClient(),
-		Log:                ctrl.Log.WithName("controllers").WithName("BMCEventSubscription"),
+		Log:                ctrl.Log.WithName("BMCEventSubscription"),
 		ProvisionerFactory: provisionerFactory,
 	}).SetupWithManager(mgr, maxConcurrency); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "BMCEventSubscription")
@@ -375,7 +368,7 @@ func main() {
 
 	if err = (&metal3iocontroller.HostFirmwareComponentsReconciler{
 		Client:             mgr.GetClient(),
-		Log:                ctrl.Log.WithName("controllers").WithName("HostFirmwareComponents"),
+		Log:                ctrl.Log.WithName("HostFirmwareComponents"),
 		ProvisionerFactory: provisionerFactory,
 	}).SetupWithManager(mgr, maxConcurrency); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "HostFirmwareComponents")
@@ -384,7 +377,7 @@ func main() {
 
 	if err = (&metal3iocontroller.DataImageReconciler{
 		Client:             mgr.GetClient(),
-		Log:                ctrl.Log.WithName("controllers").WithName("DataImage"),
+		Log:                ctrl.Log.WithName("DataImage"),
 		ProvisionerFactory: provisionerFactory,
 	}).SetupWithManager(mgr, maxConcurrency); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "DataImage")
@@ -397,7 +390,7 @@ func main() {
 		setupWebhooks(mgr)
 	}
 
-	setupLog.Info("starting manager")
+	klog.Info("starting manager")
 	if err := mgr.Start(ctrl.SetupSignalHandler()); err != nil {
 		setupLog.Error(err, "problem running manager")
 		os.Exit(1)
@@ -439,7 +432,7 @@ func GetTLSOptionOverrideFuncs(options TLSOptions) ([]func(*tls.Config), error)
 	// Cipher suites should not be set if empty.
 	if tlsMinVersion >= tls.VersionTLS13 &&
 		options.TLSCipherSuites != "" {
-		setupLog.Info("warning: Cipher suites should not be set for TLS version 1.3. Ignoring ciphers")
+		klog.Info("warning: Cipher suites should not be set for TLS version 1.3. Ignoring ciphers")
 		options.TLSCipherSuites = ""
 	}
 
@@ -454,7 +447,7 @@ func GetTLSOptionOverrideFuncs(options TLSOptions) ([]func(*tls.Config), error)
 		for _, cipher := range tlsCipherSuites {
 			for _, insecureCipherName := range insecureCipherValues {
 				if insecureCipherName == cipher {
-					setupLog.Info(fmt.Sprintf("warning: use of insecure cipher '%s' detected.", cipher))
+					klog.Infof("warning: use of insecure cipher '%s' detected.", cipher)
 				}
 			}
 		}

pkg/provisioner/fixture/fixture.go

@@ -8,10 +8,10 @@ import (
 	metal3api "github.com/metal3-io/baremetal-operator/apis/metal3.io/v1alpha1"
 	"github.com/metal3-io/baremetal-operator/pkg/hardwareutils/bmc"
 	"github.com/metal3-io/baremetal-operator/pkg/provisioner"
-	logz "sigs.k8s.io/controller-runtime/pkg/log/zap"
+	"k8s.io/klog/v2"
 )
 
-var log = logz.New().WithName("provisioner").WithName("fixture")
+var log = klog.NewKlogr().WithName("provisioner").WithName("fixture")
 var deprovisionRequeueDelay = time.Second * 10
 var provisionRequeueDelay = time.Second * 10
 var inspectionRequeueDelay = time.Second * 2

pkg/provisioner/ironic/factory.go

@@ -93,19 +93,18 @@ func (f *ironicProvisionerFactory) init(havePreprovImgBuilder bool) error {
 	}
 
 	tlsConf := loadTLSConfigFromEnv()
-
 	f.log.Info("ironic settings from environment variables",
-		"endpoint", ironicEndpoint,
-		"ironicAuthType", ironicAuth.Type,
-		"deployKernelURL", f.config.deployKernelURL,
-		"deployRamdiskURL", f.config.deployRamdiskURL,
-		"deployISOURL", f.config.deployISOURL,
-		"liveISOForcePersistentBootDevice", f.config.liveISOForcePersistentBootDevice,
-		"CACertFile", tlsConf.TrustedCAFile,
-		"ClientCertFile", tlsConf.ClientCertificateFile,
-		"ClientPrivKeyFile", tlsConf.ClientPrivateKeyFile,
-		"TLSInsecure", tlsConf.InsecureSkipVerify,
-		"SkipClientSANVerify", tlsConf.SkipClientSANVerify,
+		"\n  endpoint", ironicEndpoint,
+		"\n  ironicAuthType", ironicAuth.Type,
+		"\n  deployKernelURL", f.config.deployKernelURL,
+		"\n  deployRamdiskURL", f.config.deployRamdiskURL,
+		"\n  deployISOURL", f.config.deployISOURL,
+		"\n  liveISOForcePersistentBootDevice", f.config.liveISOForcePersistentBootDevice,
+		"\n  CACertFile", tlsConf.TrustedCAFile,
+		"\n  ClientCertFile", tlsConf.ClientCertificateFile,
+		"\n  ClientPrivKeyFile", tlsConf.ClientPrivateKeyFile,
+		"\n  TLSInsecure", tlsConf.InsecureSkipVerify,
+		"\n  SkipClientSANVerify", tlsConf.SkipClientSANVerify,
 	)
 
 	f.clientIronic, err = clients.IronicClient(ironicEndpoint, ironicAuth, tlsConf)