Merge pull request #128 from sp-yduck/feature/klog

use klog to align other capi projects

Author: sp-yduck

cloud/scheduler/scheduler.go

@@ -58,13 +58,13 @@ func (m *Manager) GetOrCreateScheduler(client *proxmox.Service) *Scheduler {
 	sched, ok := m.table[*schedID]
 	if !ok {
 		// create and register new scheduler
-		m.params.Logger.V(5).Info("registering new scheduler")
+		m.params.Logger.V(4).Info("registering new scheduler")
 		sched := m.NewScheduler(client)
-		sched.logger = sched.logger.WithValues("scheduler ID", *schedID)
+		sched.logger = sched.logger.WithValues("schedulerID", &schedID)
 		m.table[*schedID] = sched
 		return sched
 	}
-	sched.logger.V(5).Info("using existing scheduler")
+	sched.logger.V(4).Info("using existing scheduler")
 	return sched
 }
 
@@ -193,13 +193,13 @@ func (s *Scheduler) Stop() {
 // retrieve one qemuSpec from queue and try to create
 // new qemu according to the qemuSpec
 func (s *Scheduler) ScheduleOne(ctx context.Context) {
+	s.logger.Info("getting next qemu from scheduling queue")
 	qemu, shutdown := s.schedulingQueue.Get()
 	if shutdown {
 		return
 	}
 	config := qemu.Config()
 	qemuCtx := qemu.Context()
-	s.logger = s.logger.WithValues("qemu", config.Name)
 	s.logger.Info("scheduling qemu")
 
 	state := framework.NewCycleState()
@@ -257,6 +257,8 @@ func (s *Scheduler) WaitStatus(ctx context.Context, config *api.VirtualMachineCr
 
 // create new qemu with given spec and context
 func (s *Scheduler) CreateQEMU(ctx context.Context, config *api.VirtualMachineCreateOptions) (framework.SchedulerResult, error) {
+	s.logger = s.logger.WithValues("qemu", config.Name)
+	s.logger.Info("adding qemu to scheduler queue")
 	// add qemu spec into the queue
 	s.schedulingQueue.Add(ctx, config)
 

cloud/services/compute/instance/cloudinit.go

@@ -30,6 +30,9 @@ func (s *Service) reconcileCloudInit(ctx context.Context) error {
 
 // delete CloudConfig
 func (s *Service) deleteCloudConfig(ctx context.Context) error {
+	log := log.FromContext(ctx)
+	log.Info("deleting cloud config file")
+
 	storageName := s.scope.GetClusterStorage().Name
 	path := userSnippetPath(s.scope.Name())
 	volumeID := fmt.Sprintf("%s:%s", storageName, path)

cloud/services/compute/instance/image.go

@@ -20,14 +20,15 @@ const (
 // reconcileBootDevice
 func (s *Service) reconcileBootDevice(ctx context.Context, vm *proxmox.VirtualMachine) error {
 	log := log.FromContext(ctx)
-	log.Info("reconcile boot device")
+	log.Info("reconciling boot device")
 
 	// os image
 	if err := s.setCloudImage(ctx); err != nil {
 		return err
 	}
 
-	// volume
+	// boot disk
+	log.Info("resizing boot disk")
 	if err := vm.ResizeVolume(ctx, bootDvice, s.scope.GetHardware().Disk); err != nil {
 		return err
 	}

cloud/services/compute/instance/qemu.go

@@ -35,6 +35,8 @@ func (s *Service) reconcileQEMU(ctx context.Context) (*proxmox.VirtualMachine, e
 
 // get QEMU gets proxmox vm from vmid
 func (s *Service) getQEMU(ctx context.Context) (*proxmox.VirtualMachine, error) {
+	log := log.FromContext(ctx)
+	log.Info("getting qemu from vmid")
 	vmid := s.scope.GetVMID()
 	if vmid != nil {
 		return s.client.VirtualMachine(ctx, *vmid)
@@ -44,12 +46,14 @@ func (s *Service) getQEMU(ctx context.Context) (*proxmox.VirtualMachine, error)
 
 func (s *Service) createQEMU(ctx context.Context) (*proxmox.VirtualMachine, error) {
 	log := log.FromContext(ctx)
+	log.Info("creating qemu")
 
 	if err := s.ensureStorageAvailable(ctx); err != nil {
 		return nil, err
 	}
 
 	// create qemu
+	log.Info("making qemu spec")
 	vmoption := s.generateVMOptions()
 	// bind annotation key-values to context
 	schedCtx := framework.ContextWithMap(ctx, s.scope.Annotations())

cloud/services/compute/instance/reconcile.go

@@ -33,14 +33,15 @@ func (s *Service) Reconcile(ctx context.Context) error {
 		return err
 	}
 
-	log.Info(fmt.Sprintf("Reconciled instance: bios-uuid=%s", *uuid))
+	log.Info("updating instance status")
 	if err := s.scope.SetProviderID(*uuid); err != nil {
 		return err
 	}
 	s.scope.SetInstanceStatus(infrav1.InstanceStatus(instance.VM.Status))
 	s.scope.SetNodeName(instance.Node)
 	s.scope.SetVMID(instance.VM.VMID)
 
+	log.Info("updating instance config status")
 	config, err := instance.GetConfig(ctx)
 	if err != nil {
 		return err
@@ -54,6 +55,7 @@ func (s *Service) Delete(ctx context.Context) error {
 	log := log.FromContext(ctx)
 	log.Info("Deleting instance resources")
 
+	log.Info("trying to get qemu")
 	instance, err := s.getQEMU(ctx)
 	if err != nil {
 		if !rest.IsNotFound(err) {
@@ -164,7 +166,7 @@ func (s *Service) createInstance(ctx context.Context) (*proxmox.VirtualMachine,
 
 func ensureRunning(ctx context.Context, instance proxmox.VirtualMachine) error {
 	log := log.FromContext(ctx)
-	// ensure instance is running
+	log.Info("ensuring qemu is running")
 	switch instance.VM.Status {
 	case api.ProcessStatusRunning:
 		return nil
@@ -186,6 +188,7 @@ func ensureRunning(ctx context.Context, instance proxmox.VirtualMachine) error {
 
 func ensureStoppedOrPaused(ctx context.Context, instance proxmox.VirtualMachine) error {
 	log := log.FromContext(ctx)
+	log.Info("ensuring qemus is stopped or paused")
 	switch instance.VM.Status {
 	case api.ProcessStatusRunning:
 		if err := instance.Stop(ctx, api.VirtualMachineStopOption{}); err != nil {

cloud/services/compute/instance/storage.go

@@ -6,10 +6,13 @@ import (
 	"strings"
 
 	"github.com/sp-yduck/proxmox-go/api"
+	"sigs.k8s.io/controller-runtime/pkg/log"
 )
 
 // make sure storage exists and supports "images" type of content
 func (s *Service) ensureStorageAvailable(ctx context.Context) error {
+	log := log.FromContext(ctx)
+	log.Info("ensuring storage is available")
 	storageName := s.scope.GetStorage()
 	if storageName == "" { // no storage specified, find available storage
 		storage, err := s.findVMStorage(ctx)
@@ -19,6 +22,7 @@ func (s *Service) ensureStorageAvailable(ctx context.Context) error {
 		storageName = storage.Storage
 		s.scope.SetStorage(storageName)
 	} else { // storage specified, check if it supports "images" type of content
+		log.Info("checking if specified storage supports image type of content")
 		storage, err := s.client.RESTClient().GetStorage(ctx, storageName)
 		if err != nil {
 			return err
@@ -32,6 +36,8 @@ func (s *Service) ensureStorageAvailable(ctx context.Context) error {
 
 // get one storage supporting "images" type of content
 func (s *Service) findVMStorage(ctx context.Context) (*api.Storage, error) {
+	log := log.FromContext(ctx)
+	log.Info("finding available storage")
 	storages, err := s.client.RESTClient().GetStorages(ctx)
 	if err != nil {
 		return nil, err

cmd/main.go

@@ -23,53 +23,58 @@ import (
 	// Import all Kubernetes client auth plugins (e.g. Azure, GCP, OIDC, etc.)
 	// to ensure that exec-entrypoint and run can make use of them.
 	_ "k8s.io/client-go/plugin/pkg/client/auth"
+	"k8s.io/klog/v2"
 
 	"k8s.io/apimachinery/pkg/runtime"
 	utilruntime "k8s.io/apimachinery/pkg/util/runtime"
 	clientgoscheme "k8s.io/client-go/kubernetes/scheme"
+	cliflag "k8s.io/component-base/cli/flag"
+	"k8s.io/component-base/logs"
+	logsv1 "k8s.io/component-base/logs/api/v1"
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/healthz"
-	"sigs.k8s.io/controller-runtime/pkg/log/zap"
 
 	infrastructurev1beta1 "github.com/sp-yduck/cluster-api-provider-proxmox/api/v1beta1"
 	"github.com/sp-yduck/cluster-api-provider-proxmox/cloud/scheduler"
 	controller "github.com/sp-yduck/cluster-api-provider-proxmox/controllers"
+	"github.com/spf13/pflag"
 	//+kubebuilder:scaffold:imports
 )
 
 var (
 	scheme   = runtime.NewScheme()
 	setupLog = ctrl.Log.WithName("setup")
+
+	// flags
+	metricsAddr          string
+	enableLeaderElection bool
+	probeAddr            string
+	pluginConfig         string
+	logOptions           = logs.NewOptions()
 )
 
 func init() {
 	utilruntime.Must(clientgoscheme.AddToScheme(scheme))
 
 	utilruntime.Must(infrastructurev1beta1.AddToScheme(scheme))
-	utilruntime.Must(infrastructurev1beta1.AddToScheme(scheme))
-	_ = clusterv1.AddToScheme(scheme)
+	utilruntime.Must(clusterv1.AddToScheme(scheme))
+
 	//+kubebuilder:scaffold:scheme
 }
 
 func main() {
-	var metricsAddr string
-	var enableLeaderElection bool
-	var probeAddr string
-	var pluginConfig string
-	flag.StringVar(&metricsAddr, "metrics-bind-address", ":8080", "The address the metric endpoint binds to.")
-	flag.StringVar(&probeAddr, "health-probe-bind-address", ":8081", "The address the probe endpoint binds to.")
-	flag.BoolVar(&enableLeaderElection, "leader-elect", false,
-		"Enable leader election for controller manager. "+
-			"Enabling this will ensure there is only one active controller manager.")
-	flag.StringVar(&pluginConfig, "scheduler-plugin-config", "", "The config file path for qemu-scheduler plugins")
-	opts := zap.Options{
-		Development: true,
-	}
-	opts.BindFlags(flag.CommandLine)
-	flag.Parse()
-
-	ctrl.SetLogger(zap.New(zap.UseFlagOptions(&opts)))
+	InitFlags(pflag.CommandLine)
+	pflag.CommandLine.SetNormalizeFunc(cliflag.WordSepNormalizeFunc)
+	pflag.CommandLine.AddGoFlagSet(flag.CommandLine)
+	// Set log level 2 as default.
+	// if err := pflag.CommandLine.Set("v", "2"); err != nil {
+	// 	setupLog.Error(err, "failed to set log level: %v")
+	// 	os.Exit(1)
+	// }
+	pflag.Parse()
+
+	ctrl.SetLogger(klog.Background())
 
 	mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), ctrl.Options{
 		Scheme:                 scheme,
@@ -96,7 +101,7 @@ func main() {
 	}
 	schedManager, err := scheduler.NewManager(
 		scheduler.SchedulerParams{
-			Logger:           zap.New(zap.UseFlagOptions(&opts)),
+			Logger:           klog.Background(),
 			PluginConfigFile: pluginConfig,
 		},
 	)
@@ -137,3 +142,14 @@ func main() {
 		os.Exit(1)
 	}
 }
+
+func InitFlags(fs *pflag.FlagSet) {
+	logsv1.AddFlags(logOptions, fs)
+
+	fs.StringVar(&metricsAddr, "metrics-bind-address", ":8080", "The address the metric endpoint binds to.")
+	fs.StringVar(&probeAddr, "health-probe-bind-address", ":8081", "The address the probe endpoint binds to.")
+	fs.BoolVar(&enableLeaderElection, "leader-elect", false,
+		"Enable leader election for controller manager. "+
+			"Enabling this will ensure there is only one active controller manager.")
+	fs.StringVar(&pluginConfig, "scheduler-plugin-config", "", "The config file path for qemu-scheduler plugins")
+}

go.mod

@@ -9,10 +9,13 @@ require (
 	github.com/onsi/gomega v1.29.0
 	github.com/pkg/errors v0.9.1
 	github.com/sp-yduck/proxmox-go v0.0.0-20231028112758-ef366c611274
+	github.com/spf13/pflag v1.0.5
 	gopkg.in/yaml.v3 v3.0.1
 	k8s.io/api v0.27.2
 	k8s.io/apimachinery v0.27.2
 	k8s.io/client-go v0.27.2
+	k8s.io/component-base v0.27.2
+	k8s.io/klog/v2 v2.90.1
 	k8s.io/utils v0.0.0-20230209194617-a36077c30491
 	sigs.k8s.io/cluster-api v1.5.3
 	sigs.k8s.io/cluster-api/test v1.5.3
@@ -93,7 +96,6 @@ require (
 	github.com/spf13/cast v1.5.1 // indirect
 	github.com/spf13/cobra v1.7.0 // indirect
 	github.com/spf13/jwalterweatherman v1.1.0 // indirect
-	github.com/spf13/pflag v1.0.5 // indirect
 	github.com/spf13/viper v1.16.0 // indirect
 	github.com/stoewer/go-strcase v1.2.0 // indirect
 	github.com/subosito/gotenv v1.4.2 // indirect
@@ -120,8 +122,6 @@ require (
 	k8s.io/apiextensions-apiserver v0.27.2 // indirect
 	k8s.io/apiserver v0.27.2 // indirect
 	k8s.io/cluster-bootstrap v0.27.2 // indirect
-	k8s.io/component-base v0.27.2 // indirect
-	k8s.io/klog/v2 v2.90.1 // indirect
 	k8s.io/kube-openapi v0.0.0-20230501164219-8b0f38b5fd1f // indirect
 	sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
 	sigs.k8s.io/kind v0.20.0 // indirect