fix(vm): give actionable guidance in agent and class condition messages

- guest agent not responding / version unsupported: tell the user to install/start/update the agent in the guest OS
- VirtualMachineClass not found: advise specifying an existing class in spec.virtualMachineClassName (full resource name, period)
- sizing-policy mismatch: drop the doubled prefix, lead with the VirtualMachine, keep the concrete details and existing guidance

Signed-off-by: Pavel Tishkov <pavel.tishkov@flant.com>

Author: fl64

images/virtualization-artifact/pkg/controller/service/size_policy_service.go

@@ -65,7 +65,7 @@ func (s *SizePolicyService) CheckVMMatchedSizePolicy(vm *v1alpha2.VirtualMachine
 	}
 
 	if len(errs) > 0 {
-		return fmt.Errorf("sizing policy validation has failed: %w: %w", errors.Join(errs...), ErrSizingPolicyValidation)
+		return fmt.Errorf("does not match the VirtualMachineClass sizing policy: %w: %w", errors.Join(errs...), ErrSizingPolicyValidation)
 	}
 
 	return nil

images/virtualization-artifact/pkg/controller/vm/internal/agent.go

@@ -95,7 +95,7 @@ func (h *AgentHandler) syncAgentReady(vm *v1alpha2.VirtualMachine, kvvmi *virtv1
 			case metav1.ConditionTrue:
 				cb.Status(status).Reason(vmcondition.ReasonAgentReady).Message(c.Message)
 			case metav1.ConditionFalse:
-				cb.Status(status).Reason(vmcondition.ReasonAgentNotReady).Message(c.Message)
+				cb.Status(status).Reason(vmcondition.ReasonAgentNotReady).Message("The guest agent is not responding. Make sure the guest agent is installed and running in the guest OS.")
 			}
 
 			return
@@ -104,7 +104,7 @@ func (h *AgentHandler) syncAgentReady(vm *v1alpha2.VirtualMachine, kvvmi *virtv1
 
 	cb.Status(metav1.ConditionFalse).
 		Reason(vmcondition.ReasonAgentNotReady).
-		Message("Failed to connect to VM Agent.")
+		Message("The guest agent is not responding. Make sure the guest agent is installed and running in the guest OS.")
 }
 
 func (h *AgentHandler) syncAgentVersionNotSupport(vm *v1alpha2.VirtualMachine, kvvmi *virtv1.VirtualMachineInstance) {
@@ -138,7 +138,7 @@ func (h *AgentHandler) syncAgentVersionNotSupport(vm *v1alpha2.VirtualMachine, k
 	for _, c := range kvvmi.Status.Conditions {
 		status := conditionStatus(string(c.Status))
 		if c.Type == virtv1.VirtualMachineInstanceUnsupportedAgent && status == metav1.ConditionTrue {
-			cb.Status(status).Reason(vmcondition.ReasonAgentNotSupported).Message("The guest agent version is not supported.")
+			cb.Status(status).Reason(vmcondition.ReasonAgentNotSupported).Message("The guest agent version is not supported. Update the guest agent in the guest OS.")
 			return
 		}
 	}

images/virtualization-artifact/pkg/controller/vm/internal/class.go

@@ -78,7 +78,7 @@ func (h *ClassHandler) Handle(ctx context.Context, s state.VirtualMachineState)
 	if class != nil && class.Status.Phase == v1alpha2.ClassPhaseReady {
 		if (class.Spec.CPU.Type == v1alpha2.CPUTypeDiscovery || class.Spec.CPU.Type == v1alpha2.CPUTypeFeatures) && len(class.Status.CpuFeatures.Enabled) == 0 {
 			mgr.Update(cb.
-				Message("No enabled processor features found").
+				Message("The VirtualMachineClass has no enabled CPU features.").
 				Reason(vmcondition.ReasonClassNotReady).
 				Status(metav1.ConditionFalse).
 				Condition())
@@ -90,10 +90,10 @@ func (h *ClassHandler) Handle(ctx context.Context, s state.VirtualMachineState)
 		return reconcile.Result{}, nil
 	}
 	className := current.Spec.VirtualMachineClassName
-	msg := fmt.Sprintf("VirtualMachineClassName %q is not ready", className)
+	msg := fmt.Sprintf("VirtualMachineClass %q is not ready yet.", className)
 	reason := vmcondition.ReasonClassNotReady
 	if class == nil {
-		msg = fmt.Sprintf("VirtualMachineClassName %q not found", className)
+		msg = fmt.Sprintf("VirtualMachineClass %q not found. Specify an existing VirtualMachineClass in spec.virtualMachineClassName.", className)
 		h.recorder.Event(changed, corev1.EventTypeWarning, reason.String(), "VirtualMachineClass not available: waiting for the VirtualMachineClass")
 		log.Info("VirtualMachineClass not available: waiting for the VirtualMachineClass")
 	}

images/virtualization-artifact/pkg/controller/vm/internal/size_policy.go

@@ -72,7 +72,7 @@ func (h *SizePolicyHandler) Handle(ctx context.Context, s state.VirtualMachineSt
 
 	switch {
 	case vmClass == nil:
-		cb.Message(fmt.Sprintf("VirtualMachineClass %q not found.", changed.Spec.VirtualMachineClassName)).
+		cb.Message(fmt.Sprintf("VirtualMachineClass %q not found. Specify an existing VirtualMachineClass in spec.virtualMachineClassName.", changed.Spec.VirtualMachineClassName)).
 			Reason(vmcondition.ReasonVirtualMachineClassNotFound).
 			Status(metav1.ConditionFalse)
 	case vmClass.Status.Phase == v1alpha2.ClassPhaseTerminating:
@@ -82,7 +82,7 @@ func (h *SizePolicyHandler) Handle(ctx context.Context, s state.VirtualMachineSt
 	default:
 		err = h.service.CheckVMMatchedSizePolicy(changed, vmClass)
 		if err != nil {
-			cb.Message(fmt.Sprintf("Size policy matching errors: %s.", err.Error())).
+			cb.Message(fmt.Sprintf("The VirtualMachine %s.", err.Error())).
 				Reason(vmcondition.ReasonSizingPolicyNotMatched).
 				Status(metav1.ConditionFalse)
 		}