[wsman-mk2] Emit event for timed out workspaces (#17003)

Author: Furisto

components/ws-manager-mk2/controllers/suite_test.go

@@ -111,7 +111,7 @@ var _ = BeforeSuite(func() {
 	Expect(wsReconciler.SetupWithManager(k8sManager)).To(Succeed())
 
 	wsActivity = &activity.WorkspaceActivity{}
-	timeoutReconciler, err := NewTimeoutReconciler(k8sManager.GetClient(), conf, wsActivity)
+	timeoutReconciler, err := NewTimeoutReconciler(k8sManager.GetClient(), k8sManager.GetEventRecorderFor("workspace"), conf, wsActivity)
 	Expect(err).ToNot(HaveOccurred())
 	Expect(timeoutReconciler.SetupWithManager(k8sManager)).To(Succeed())
 

components/ws-manager-mk2/controllers/timeout_controller.go

@@ -9,8 +9,10 @@ import (
 	"fmt"
 	"time"
 
+	corev1 "k8s.io/api/core/v1"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/types"
+	"k8s.io/client-go/tools/record"
 	"k8s.io/client-go/util/retry"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -24,7 +26,7 @@ import (
 	workspacev1 "github.com/gitpod-io/gitpod/ws-manager/api/crd/v1"
 )
 
-func NewTimeoutReconciler(c client.Client, cfg config.Configuration, activity *wsactivity.WorkspaceActivity) (*TimeoutReconciler, error) {
+func NewTimeoutReconciler(c client.Client, recorder record.EventRecorder, cfg config.Configuration, activity *wsactivity.WorkspaceActivity) (*TimeoutReconciler, error) {
 	if cfg.HeartbeatInterval == 0 {
 		return nil, fmt.Errorf("invalid heartbeat interval, must not be 0")
 	}
@@ -39,6 +41,7 @@ func NewTimeoutReconciler(c client.Client, cfg config.Configuration, activity *w
 		activity:          activity,
 		reconcileInterval: reconcileInterval,
 		ctrlStartTime:     time.Now().UTC(),
+		recorder:          recorder,
 	}, nil
 }
 
@@ -53,6 +56,7 @@ type TimeoutReconciler struct {
 	activity          *wsactivity.WorkspaceActivity
 	reconcileInterval time.Duration
 	ctrlStartTime     time.Time
+	recorder          record.EventRecorder
 }
 
 //+kubebuilder:rbac:groups=workspace.gitpod.io,resources=workspaces,verbs=get;list;watch;create;update;patch;delete
@@ -109,6 +113,7 @@ func (r *TimeoutReconciler) Reconcile(ctx context.Context, req ctrl.Request) (re
 		return ctrl.Result{}, err
 	}
 
+	r.recorder.Event(&workspace, corev1.EventTypeNormal, "TimedOut", timedout)
 	return ctrl.Result{}, nil
 }
 

components/ws-manager-mk2/controllers/timeout_controller_test.go

@@ -15,6 +15,7 @@ import (
 	. "github.com/onsi/gomega"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
+	"k8s.io/client-go/tools/record"
 	"k8s.io/utils/pointer"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"
@@ -35,7 +36,7 @@ var _ = Describe("TimeoutController", func() {
 			// Use a fake client instead of the envtest's k8s client, such that we can add objects
 			// with custom CreationTimestamps and check timeout logic.
 			fakeClient = fake.NewClientBuilder().WithScheme(k8sClient.Scheme()).Build()
-			r, err = NewTimeoutReconciler(fakeClient, conf, &activity.WorkspaceActivity{})
+			r, err = NewTimeoutReconciler(fakeClient, record.NewFakeRecorder(100), conf, &activity.WorkspaceActivity{})
 			Expect(err).ToNot(HaveOccurred())
 		})
 
@@ -196,7 +197,7 @@ var _ = Describe("TimeoutController", func() {
 		var r *TimeoutReconciler
 		BeforeEach(func() {
 			var err error
-			r, err = NewTimeoutReconciler(k8sClient, newTestConfig(), &activity.WorkspaceActivity{})
+			r, err = NewTimeoutReconciler(k8sClient, record.NewFakeRecorder(100), newTestConfig(), &activity.WorkspaceActivity{})
 			Expect(err).ToNot(HaveOccurred())
 		})
 

components/ws-manager-mk2/main.go

@@ -148,7 +148,7 @@ func main() {
 	}
 
 	activity := &activity.WorkspaceActivity{}
-	timeoutReconciler, err := controllers.NewTimeoutReconciler(mgr.GetClient(), cfg.Manager, activity)
+	timeoutReconciler, err := controllers.NewTimeoutReconciler(mgr.GetClient(), mgr.GetEventRecorderFor("workspace"), cfg.Manager, activity)
 	if err != nil {
 		setupLog.Error(err, "unable to create timeout controller", "controller", "Timeout")
 		os.Exit(1)