Routing errors propagation

apis/controller/v1alpha1/devworkspacerouting_types.go

@@ -52,6 +52,8 @@ type DevWorkspaceRoutingStatus struct {
 	ExposedEndpoints map[string]ExposedEndpointList `json:"exposedEndpoints,omitempty"`
 	// Routing reconcile phase
 	Phase DevWorkspaceRoutingPhase `json:"phase,omitempty"`
+	// Message is a user-readable message explaining the current phase (e.g. reason for failure)
+	Message string `json:"message,omitempty"`
 }
 
 // Valid phases for devworkspacerouting
@@ -83,6 +85,9 @@ type ExposedEndpointList []ExposedEndpoint
 // +k8s:openapi-gen=true
 // +kubebuilder:subresource:status
 // +kubebuilder:resource:path=devworkspaceroutings,scope=Namespaced,shortName=dwr
+// +kubebuilder:printcolumn:name="DevWorkspace ID",type="string",JSONPath=".spec.devworkspaceId",description="The owner DevWorkspace's unique id"
+// +kubebuilder:printcolumn:name="Phase",type="string",JSONPath=".status.phase",description="The current phase"
+// +kubebuilder:printcolumn:name="Info",type="string",JSONPath=".status.message",description="Additional info about DevWorkspaceRouting state"
 type DevWorkspaceRouting struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`

controllers/controller/devworkspacerouting/devworkspacerouting_controller.go

@@ -15,6 +15,7 @@ package devworkspacerouting
 import (
 	"context"
 	"errors"
+	"fmt"
 	"time"
 
 	"github.com/devfile/devworkspace-operator/controllers/controller/devworkspacerouting/solvers"
@@ -82,17 +83,15 @@ func (r *DevWorkspaceRoutingReconciler) Reconcile(req ctrl.Request) (ctrl.Result
 	reqLogger.Info("Reconciling DevWorkspaceRouting")
 
 	if instance.Spec.RoutingClass == "" {
-		reqLogger.Info("DevWorkspaceRouting without an explicit routing class is invalid", "name", instance.Name, "namespace", instance.Namespace)
-		return reconcile.Result{}, r.markRoutingFailed(instance)
+		return reconcile.Result{}, r.markRoutingFailed(instance, "DevWorkspaceRouting requires field routingClass to be set")
 	}
 
 	solver, err := r.SolverGetter.GetSolver(r.Client, instance.Spec.RoutingClass)
 	if err != nil {
 		if errors.Is(err, solvers.RoutingNotSupported) {
 			return reconcile.Result{}, nil
 		}
-		reqLogger.Error(err, "Invalid routing class for DevWorkspace")
-		return reconcile.Result{}, r.markRoutingFailed(instance)
+		return reconcile.Result{}, r.markRoutingFailed(instance, fmt.Sprintf("Invalid routingClass for DevWorkspace: %s", err))
 	}
 
 	// Check if the DevWorkspaceRouting instance is marked to be deleted, which is
@@ -128,13 +127,13 @@ func (r *DevWorkspaceRoutingReconciler) Reconcile(req ctrl.Request) (ctrl.Result
 				duration = 1 * time.Second
 			}
 			reqLogger.Info("controller not ready for devworkspace routing. Retrying", "DelayMs", duration.Milliseconds())
-			return reconcile.Result{RequeueAfter: duration}, nil
+			return reconcile.Result{RequeueAfter: duration}, r.reconcileStatus(instance, nil, nil, false, "Waiting for DevWorkspaceRouting controller to be ready")
 		}
 
 		var invalid *solvers.RoutingInvalid
 		if errors.As(err, &invalid) {
 			reqLogger.Error(invalid, "routing controller considers routing invalid")
-			return reconcile.Result{}, r.markRoutingFailed(instance)
+			return reconcile.Result{}, r.markRoutingFailed(instance, fmt.Sprintf("Unable to provision networking for DevWorkspace: %s", invalid))
 		}
 
 		// generic error, just fail the reconciliation
@@ -173,9 +172,12 @@ func (r *DevWorkspaceRoutingReconciler) Reconcile(req ctrl.Request) (ctrl.Result
 	}
 
 	servicesInSync, clusterServices, err := r.syncServices(instance, services)
-	if err != nil || !servicesInSync {
+	if err != nil {
+		reqLogger.Error(err, "Error syncing services")
+		return reconcile.Result{Requeue: true}, r.reconcileStatus(instance, nil, nil, false, "Preparing services")
+	} else if !servicesInSync {
 		reqLogger.Info("Services not in sync")
-		return reconcile.Result{Requeue: true}, err
+		return reconcile.Result{Requeue: true}, r.reconcileStatus(instance, nil, nil, false, "Preparing services")
 	}
 
 	clusterRoutingObj := solvers.RoutingObjects{
@@ -184,27 +186,33 @@ func (r *DevWorkspaceRoutingReconciler) Reconcile(req ctrl.Request) (ctrl.Result
 
 	if infrastructure.IsOpenShift() {
 		routesInSync, clusterRoutes, err := r.syncRoutes(instance, routes)
-		if err != nil || !routesInSync {
+		if err != nil {
+			reqLogger.Error(err, "Error syncing routes")
+			return reconcile.Result{Requeue: true}, r.reconcileStatus(instance, nil, nil, false, "Preparing routes")
+		} else if !routesInSync {
 			reqLogger.Info("Routes not in sync")
-			return reconcile.Result{Requeue: true}, err
+			return reconcile.Result{Requeue: true}, r.reconcileStatus(instance, nil, nil, false, "Preparing routes")
 		}
 		clusterRoutingObj.Routes = clusterRoutes
 	} else {
 		ingressesInSync, clusterIngresses, err := r.syncIngresses(instance, ingresses)
-		if err != nil || !ingressesInSync {
+		if err != nil {
+			reqLogger.Error(err, "Error syncing ingresses")
+			return reconcile.Result{Requeue: true}, r.reconcileStatus(instance, nil, nil, false, "Preparing ingresses")
+		} else if !ingressesInSync {
 			reqLogger.Info("Ingresses not in sync")
-			return reconcile.Result{Requeue: true}, err
+			return reconcile.Result{Requeue: true}, r.reconcileStatus(instance, nil, nil, false, "Preparing ingresses")
 		}
 		clusterRoutingObj.Ingresses = clusterIngresses
 	}
 
 	exposedEndpoints, endpointsAreReady, err := solver.GetExposedEndpoints(instance.Spec.Endpoints, clusterRoutingObj)
 	if err != nil {
-		reqLogger.Error(err, "Could not get exposed endpoints for workspace")
-		return reconcile.Result{}, r.markRoutingFailed(instance)
+		reqLogger.Error(err, "Could not get exposed endpoints for devworkspace")
+		return reconcile.Result{}, r.markRoutingFailed(instance, fmt.Sprintf("Could not get exposed endpoints for DevWorkspace: %s", err))
 	}
 
-	return reconcile.Result{}, r.reconcileStatus(instance, routingObjects, exposedEndpoints, endpointsAreReady)
+	return reconcile.Result{}, r.reconcileStatus(instance, &routingObjects, exposedEndpoints, endpointsAreReady, "")
 }
 
 // setFinalizer ensures a finalizer is set on a devWorkspaceRouting instance; no-op if finalizer is already present.
@@ -244,19 +252,22 @@ func (r *DevWorkspaceRoutingReconciler) finalize(solver solvers.RoutingSolver, i
 	return nil
 }
 
-func (r *DevWorkspaceRoutingReconciler) markRoutingFailed(instance *controllerv1alpha1.DevWorkspaceRouting) error {
+func (r *DevWorkspaceRoutingReconciler) markRoutingFailed(instance *controllerv1alpha1.DevWorkspaceRouting, message string) error {
+	instance.Status.Message = message
 	instance.Status.Phase = controllerv1alpha1.RoutingFailed
 	return r.Status().Update(context.TODO(), instance)
 }
 
 func (r *DevWorkspaceRoutingReconciler) reconcileStatus(
 	instance *controllerv1alpha1.DevWorkspaceRouting,
-	routingObjects solvers.RoutingObjects,
+	routingObjects *solvers.RoutingObjects,
 	exposedEndpoints map[string]controllerv1alpha1.ExposedEndpointList,
-	endpointsReady bool) error {
+	endpointsReady bool,
+	message string) error {
 
 	if !endpointsReady {
 		instance.Status.Phase = controllerv1alpha1.RoutingPreparing
+		instance.Status.Message = message
 		return r.Status().Update(context.TODO(), instance)
 	}
 	if instance.Status.Phase == controllerv1alpha1.RoutingReady &&
@@ -265,6 +276,7 @@ func (r *DevWorkspaceRoutingReconciler) reconcileStatus(
 		return nil
 	}
 	instance.Status.Phase = controllerv1alpha1.RoutingReady
+	instance.Status.Message = "DevWorkspaceRouting prepared"
 	instance.Status.PodAdditions = routingObjects.PodAdditions
 	instance.Status.ExposedEndpoints = exposedEndpoints
 	return r.Status().Update(context.TODO(), instance)

controllers/workspace/devworkspace_controller.go

@@ -209,11 +209,14 @@ func (r *DevWorkspaceReconciler) Reconcile(req ctrl.Request) (reconcileResult ct
 	routingStatus := provision.SyncRoutingToCluster(workspace, clusterAPI)
 	if !routingStatus.Continue {
 		if routingStatus.FailStartup {
-			// TODO: Propagate failure reason from devWorkspaceRouting
-			return r.failWorkspace(workspace, "Failed to install network objects required for devworkspace", reqLogger, &reconcileStatus)
+			return r.failWorkspace(workspace, routingStatus.Message, reqLogger, &reconcileStatus)
 		}
 		reqLogger.Info("Waiting on routing to be ready")
-		reconcileStatus.setConditionFalse(dw.DevWorkspaceRoutingReady, "Preparing networking")
+		message := "Preparing networking"
+		if routingStatus.Message != "" {
+			message = routingStatus.Message
+		}
+		reconcileStatus.setConditionFalse(dw.DevWorkspaceRoutingReady, message)
 		return reconcile.Result{Requeue: routingStatus.Requeue}, routingStatus.Err
 	}
 	reconcileStatus.setConditionTrue(dw.DevWorkspaceRoutingReady, "")

controllers/workspace/provision/routing.go

@@ -98,10 +98,7 @@ func SyncRoutingToCluster(
 		clusterRouting.Annotations = specRouting.Annotations
 		clusterRouting.Spec = specRouting.Spec
 		err := clusterAPI.Client.Update(context.TODO(), clusterRouting)
-		if err != nil {
-			if errors.IsConflict(err) {
-				return RoutingProvisioningStatus{ProvisioningStatus: ProvisioningStatus{Requeue: true}}
-			}
+		if err != nil && !errors.IsConflict(err) {
 			return RoutingProvisioningStatus{ProvisioningStatus: ProvisioningStatus{Err: err}}
 		}
 		return RoutingProvisioningStatus{
@@ -111,14 +108,15 @@ func SyncRoutingToCluster(
 
 	if clusterRouting.Status.Phase == v1alpha1.RoutingFailed {
 		return RoutingProvisioningStatus{
-			ProvisioningStatus: ProvisioningStatus{FailStartup: true},
+			ProvisioningStatus: ProvisioningStatus{FailStartup: true, Message: clusterRouting.Status.Message},
 		}
 	}
 	if clusterRouting.Status.Phase != v1alpha1.RoutingReady {
 		return RoutingProvisioningStatus{
 			ProvisioningStatus: ProvisioningStatus{
 				Continue: false,
 				Requeue:  false,
+				Message:  clusterRouting.Status.Message,
 			},
 		}
 	}

deploy/deployment/kubernetes/combined.yaml

@@ -19,7 +19,20 @@ spec:
     singular: devworkspacerouting
   scope: Namespaced
   versions:
-  - name: v1alpha1
+  - additionalPrinterColumns:
+    - description: The owner DevWorkspace's unique id
+      jsonPath: .spec.devworkspaceId
+      name: DevWorkspace ID
+      type: string
+    - description: The current phase
+      jsonPath: .status.phase
+      name: Phase
+      type: string
+    - description: Additional info about DevWorkspaceRouting state
+      jsonPath: .status.message
+      name: Info
+      type: string
+    name: v1alpha1
     schema:
       openAPIV3Schema:
         description: DevWorkspaceRouting is the Schema for the devworkspaceroutings
@@ -164,6 +177,10 @@ spec:
                   type: array
                 description: Machine name to exposed endpoint map
                 type: object
+              message:
+                description: Message is a user-readable message explaining the current
+                  phase (e.g. reason for failure)
+                type: string
               phase:
                 description: Routing reconcile phase
                 type: string

deploy/deployment/kubernetes/objects/devworkspaceroutings.controller.devfile.io.CustomResourceDefinition.yaml

@@ -19,7 +19,20 @@ spec:
     singular: devworkspacerouting
   scope: Namespaced
   versions:
-  - name: v1alpha1
+  - additionalPrinterColumns:
+    - description: The owner DevWorkspace's unique id
+      jsonPath: .spec.devworkspaceId
+      name: DevWorkspace ID
+      type: string
+    - description: The current phase
+      jsonPath: .status.phase
+      name: Phase
+      type: string
+    - description: Additional info about DevWorkspaceRouting state
+      jsonPath: .status.message
+      name: Info
+      type: string
+    name: v1alpha1
     schema:
       openAPIV3Schema:
         description: DevWorkspaceRouting is the Schema for the devworkspaceroutings
@@ -164,6 +177,10 @@ spec:
                   type: array
                 description: Machine name to exposed endpoint map
                 type: object
+              message:
+                description: Message is a user-readable message explaining the current
+                  phase (e.g. reason for failure)
+                type: string
               phase:
                 description: Routing reconcile phase
                 type: string

deploy/deployment/openshift/combined.yaml

@@ -19,7 +19,20 @@ spec:
     singular: devworkspacerouting
   scope: Namespaced
   versions:
-  - name: v1alpha1
+  - additionalPrinterColumns:
+    - description: The owner DevWorkspace's unique id
+      jsonPath: .spec.devworkspaceId
+      name: DevWorkspace ID
+      type: string
+    - description: The current phase
+      jsonPath: .status.phase
+      name: Phase
+      type: string
+    - description: Additional info about DevWorkspaceRouting state
+      jsonPath: .status.message
+      name: Info
+      type: string
+    name: v1alpha1
     schema:
       openAPIV3Schema:
         description: DevWorkspaceRouting is the Schema for the devworkspaceroutings
@@ -164,6 +177,10 @@ spec:
                   type: array
                 description: Machine name to exposed endpoint map
                 type: object
+              message:
+                description: Message is a user-readable message explaining the current
+                  phase (e.g. reason for failure)
+                type: string
               phase:
                 description: Routing reconcile phase
                 type: string

deploy/deployment/openshift/objects/devworkspaceroutings.controller.devfile.io.CustomResourceDefinition.yaml

@@ -19,7 +19,20 @@ spec:
     singular: devworkspacerouting
   scope: Namespaced
   versions:
-  - name: v1alpha1
+  - additionalPrinterColumns:
+    - description: The owner DevWorkspace's unique id
+      jsonPath: .spec.devworkspaceId
+      name: DevWorkspace ID
+      type: string
+    - description: The current phase
+      jsonPath: .status.phase
+      name: Phase
+      type: string
+    - description: Additional info about DevWorkspaceRouting state
+      jsonPath: .status.message
+      name: Info
+      type: string
+    name: v1alpha1
     schema:
       openAPIV3Schema:
         description: DevWorkspaceRouting is the Schema for the devworkspaceroutings
@@ -164,6 +177,10 @@ spec:
                   type: array
                 description: Machine name to exposed endpoint map
                 type: object
+              message:
+                description: Message is a user-readable message explaining the current
+                  phase (e.g. reason for failure)
+                type: string
               phase:
                 description: Routing reconcile phase
                 type: string