Implemented progress tracking for storage migrations

- Added progress tracking for storage migrations
- Added completed out of total virtual machines
  column to migration plan status
- Modified migplan conditions to better indicate
  the actual state of the plan
- Updated the kubernetes client to 1.34

Signed-off-by: Alexander Wels <awels@redhat.com>

Author: awels

Makefile

@@ -109,6 +109,7 @@ manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and Cust
 	# Remove the datavolumetemplatespecs CRD because it is not needed
 	rm config/crd/bases/kubevirt.io_datavolumetemplatespecs.yaml
 	$(CONTROLLER_GEN) crd paths="./vendor/kubevirt.io/containerized-data-importer-api/pkg/apis/core/v1beta1/..." output:crd:artifacts:config=config/crd/bases
+	$(CONTROLLER_GEN) crd paths="./vendor/github.com/openshift/api/route/v1" output:crd:artifacts:config=config/crd/bases
 
 .PHONY: generate
 generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.

api/migrationcontroller/v1alpha1/conditions.go

@@ -14,6 +14,7 @@ import (
 const (
 	ReconcileFailed = "ReconcileFailed"
 	Ready           = "Ready"
+	Progressing     = "Progressing"
 	Running         = "Running"
 	Failed          = "Failed"
 	Succeeded       = "Succeeded"

api/migrationcontroller/v1alpha1/virtualmachinestoragemigration_types.go

@@ -53,10 +53,15 @@ type Phase string
 // VirtualMachineStorageMigrationStatus defines the observed state of VirtualMachineStorageMigration
 type VirtualMachineStorageMigrationStatus struct {
 	Conditions          `json:",inline"`
-	Phase               Phase    `json:"phase,omitempty"`
-	Errors              []string `json:"errors,omitempty"`
-	RunningMigrations   []string `json:"runningMigrations,omitempty"`
-	CompletedMigrations []string `json:"completedMigrations,omitempty"`
+	Phase               Phase                            `json:"phase,omitempty"`
+	Errors              []string                         `json:"errors,omitempty"`
+	RunningMigrations   []RunningVirtualMachineMigration `json:"runningMigrations,omitempty"`
+	CompletedMigrations []string                         `json:"completedMigrations,omitempty"`
+}
+
+type RunningVirtualMachineMigration struct {
+	Name     string `json:"name"`
+	Progress string `json:"progress,omitempty"`
 }
 
 // +kubebuilder:object:root=true
@@ -65,8 +70,7 @@ type VirtualMachineStorageMigrationStatus struct {
 // VirtualMachineStorageMigration is the Schema for the virtualmachinestoragemigrations API
 // +k8s:openapi-gen=true
 // +genclient
-// +kubebuilder:printcolumn:name="Ready",type=string,JSONPath=".status.conditions[?(@.type=='Ready')].status"
-// +kubebuilder:printcolumn:name="Plan",type=string,JSONPath=".spec.migPlanRef.name"
+// +kubebuilder:printcolumn:name="Plan",type=string,JSONPath=".spec.virtualMachineStorageMigrationPlanRef.name"
 // +kubebuilder:printcolumn:name="Phase",type=string,JSONPath=".status.phase"
 // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"
 type VirtualMachineStorageMigration struct {
@@ -132,18 +136,19 @@ func HasFinalizer(object metav1.Object, value string) bool {
 // SetFinalizer adds the passed in finalizer to the migration
 func (r *VirtualMachineStorageMigration) AddFinalizer(finalizer string, log logr.Logger) {
 	if HasFinalizer(r, finalizer) {
-		log.Info("Finalizer already exists", "finalizer", finalizer)
+		log.V(5).Info("Finalizer already exists", "finalizer", finalizer)
 		return
 	}
 	r.Finalizers = append(r.Finalizers, finalizer)
-	log.Info("Added finalizer", "finalizer", finalizer)
+	log.V(5).Info("Added finalizer", "finalizer", finalizer)
 }
 
 // RemoveFinalizer removes the passed in finalizer from the migration
-func (r *VirtualMachineStorageMigration) RemoveFinalizer(finalizer string) {
+func (r *VirtualMachineStorageMigration) RemoveFinalizer(finalizer string, log logr.Logger) {
 	for i, f := range r.Finalizers {
 		if f == finalizer {
 			r.Finalizers = append(r.Finalizers[:i], r.Finalizers[i+1:]...)
+			log.V(5).Info("Removed finalizer", "finalizer", finalizer)
 			break
 		}
 	}

api/migrationcontroller/v1alpha1/virtualmachinestoragemigrationplan_types.go

@@ -81,6 +81,8 @@ type VirtualMachineStorageMigrationPlanDestinationPVC struct {
 
 // MigPlanStatus defines the observed state of MigPlan
 type VirtualMachineStorageMigrationPlanStatus struct {
+	// The number of virtual machines that have been completed out of the total number of virtual machines.
+	CompletedOutOf string `json:"completedOutOf,omitempty"`
 	// Ready migrations are migrations that are ready to be started.
 	ReadyMigrations []VirtualMachineStorageMigrationPlanStatusVirtualMachine `json:"readyMigrations,omitempty"`
 	// Invalid migrations are migrations that are invalid and cannot be started.
@@ -111,7 +113,9 @@ func (r *VirtualMachineStorageMigrationPlan) GetSuffix() string {
 // VirtualMachineStorageMigrationPlan is the Schema for the virtualmachinestoragemigrationplans API
 // +genclient
 // +k8s:openapi-gen=true
-// +kubebuilder:printcolumn:name="Phase",type=string,JSONPath=".status.phase"
+// +kubebuilder:printcolumn:name="Ready",type=string,JSONPath=".status.conditions[?(@.type=='Ready')].status"
+// +kubebuilder:printcolumn:name="Progressing",type=string,JSONPath=".status.conditions[?(@.type=='Progressing')].status"
+// +kubebuilder:printcolumn:name="Completed VMs",type=string,JSONPath=".status.completedOutOf"
 // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"
 type VirtualMachineStorageMigrationPlan struct {
 	metav1.TypeMeta   `json:",inline"`

api/migrationcontroller/v1alpha1/zz_generated.deepcopy.go

@@ -29,6 +29,7 @@ import (
 	"k8s.io/apimachinery/pkg/runtime"
 	utilruntime "k8s.io/apimachinery/pkg/util/runtime"
 	clientgoscheme "k8s.io/client-go/kubernetes/scheme"
+	"k8s.io/client-go/rest"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/certwatcher"
 	"sigs.k8s.io/controller-runtime/pkg/healthz"
@@ -37,6 +38,7 @@ import (
 	metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
 	"sigs.k8s.io/controller-runtime/pkg/webhook"
 
+	routev1 "github.com/openshift/api/route/v1"
 	virtv1 "kubevirt.io/api/core/v1"
 	cdiv1 "kubevirt.io/containerized-data-importer-api/pkg/apis/core/v1beta1"
 
@@ -55,7 +57,7 @@ func init() {
 	utilruntime.Must(clientgoscheme.AddToScheme(scheme))
 	utilruntime.Must(virtv1.AddToScheme(scheme))
 	utilruntime.Must(cdiv1.AddToScheme(scheme))
-
+	utilruntime.Must(routev1.AddToScheme(scheme))
 	utilruntime.Must(migrations.AddToScheme(scheme))
 	// +kubebuilder:scaffold:scheme
 }
@@ -184,7 +186,10 @@ func main() {
 		})
 	}
 
-	mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), ctrl.Options{
+	cfg := ctrl.GetConfigOrDie()
+	cfg.WarningHandler = rest.NoWarnings{}
+
+	mgr, err := ctrl.NewManager(cfg, ctrl.Options{
 		Scheme:                 scheme,
 		Metrics:                metricsServerOptions,
 		WebhookServer:          webhookServer,
@@ -212,6 +217,7 @@ func main() {
 		Client:        mgr.GetClient(),
 		Scheme:        mgr.GetScheme(),
 		EventRecorder: mgr.GetEventRecorderFor("storagemigplan-controller"),
+		Log:           ctrl.Log.WithName("storagemigplan-controller"),
 	}).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "StorageMigrationPlan")
 		os.Exit(1)
@@ -220,6 +226,7 @@ func main() {
 		Client:        mgr.GetClient(),
 		Scheme:        mgr.GetScheme(),
 		EventRecorder: mgr.GetEventRecorderFor("storagemig-controller"),
+		Log:           ctrl.Log.WithName("storagemig-controller"),
 	}).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "StorageMigration")
 		os.Exit(1)

cmd/main.go

@@ -141,7 +141,7 @@ spec:
                       Claims lists the names of resources, defined in spec.resourceClaims,
                       that are used by this container.
 
-                      This is an alpha field and requires enabling the
+                      This field depends on the
                       DynamicResourceAllocation feature gate.
 
                       This field is immutable. It can only be set for containers.
@@ -371,7 +371,7 @@ spec:
                       Claims lists the names of resources, defined in spec.resourceClaims,
                       that are used by this container.
 
-                      This is an alpha field and requires enabling the
+                      This field depends on the
                       DynamicResourceAllocation feature gate.
 
                       This field is immutable. It can only be set for containers.