Add ability to configure custom init containers (#1532)

* feat: configure init containers
* chore: run make update_devworkspace_api update_devworkspace_crds generate_all
* test: unit and e2e tests for init containers

Signed-off-by: Oleksii Kurinnyi <[email protected]>
Co-authored-by: Rohan Kumar <[email protected]>
Co-authored-by: Anatolii Bazko <[email protected]>
Co-authored-by: David Kwon <[email protected]>

Author: 4 people

apis/controller/v1alpha1/devworkspaceoperatorconfig_types.go

@@ -252,6 +252,9 @@ type WorkspaceConfig struct {
 	// If the feature is disabled, setting this field may cause an endless workspace start loop.
 	// +kubebuilder:validation:Optional
 	HostUsers *bool `json:"hostUsers,omitempty"`
+	// InitContainers defines a list of Kubernetes init containers that are automatically injected into all workspace pods.
+	// Typical uses cases include injecting organization tools/configs, initializing persistent home, etc.
+	InitContainers []corev1.Container `json:"initContainers,omitempty"`
 }
 
 type WebhookConfig struct {

apis/controller/v1alpha1/zz_generated.deepcopy.go

@@ -22,6 +22,7 @@ import (
 	"strings"
 	"time"
 
+	"github.com/devfile/devworkspace-operator/pkg/library/initcontainers"
 	"github.com/devfile/devworkspace-operator/pkg/library/ssh"
 
 	dw "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
@@ -369,6 +370,48 @@ func (r *DevWorkspaceReconciler) Reconcile(ctx context.Context, req ctrl.Request
 		devfilePodAdditions.InitContainers = append([]corev1.Container{*projectClone}, devfilePodAdditions.InitContainers...)
 	}
 
+	// Inject operator-configured init containers
+	if workspace.Config != nil && workspace.Config.Workspace != nil && len(workspace.Config.Workspace.InitContainers) > 0 {
+		// Check if init-persistent-home should be disabled
+		disableHomeInit := pointer.BoolDeref(workspace.Config.Workspace.PersistUserHome.DisableInitContainer, constants.DefaultDisableHomeInitContainer)
+
+		// Filter init containers from config based on workspace settings
+		patches := []corev1.Container{}
+		for _, container := range workspace.Config.Workspace.InitContainers {
+			// Special handling for init-persistent-home
+			if container.Name == constants.HomeInitComponentName {
+				// Skip if persistent home is disabled
+				if !home.PersistUserHomeEnabled(workspace) {
+					reqLogger.Info("Skipping init-persistent-home container: persistent home is disabled")
+					continue
+				}
+				// Skip if init container is explicitly disabled
+				if disableHomeInit {
+					reqLogger.Info("Skipping init-persistent-home container: DisableInitContainer is true")
+					continue
+				}
+			}
+			patches = append(patches, container)
+		}
+
+		// Perform strategic merge
+		merged, err := initcontainers.MergeInitContainers(devfilePodAdditions.InitContainers, patches)
+		if err != nil {
+			return r.failWorkspace(workspace, fmt.Sprintf("Failed to merge init containers: %s", err), metrics.ReasonBadRequest, reqLogger, &reconcileStatus), nil
+		}
+
+		// Ensure init-persistent-home container has correct fields after merge
+		for i := range merged {
+			if merged[i].Name == constants.HomeInitComponentName {
+				if err := home.EnsureHomeInitContainerFields(&merged[i]); err != nil {
+					return r.failWorkspace(workspace, fmt.Sprintf("Failed to configure %s container: %s", constants.HomeInitComponentName, err), metrics.ReasonBadRequest, reqLogger, &reconcileStatus), nil
+				}
+			}
+		}
+
+		devfilePodAdditions.InitContainers = merged
+	}
+
 	// Add ServiceAccount tokens into devfile containers
 	if err := wsprovision.ProvisionServiceAccountTokensInto(devfilePodAdditions, workspace); err != nil {
 		return r.failWorkspace(workspace, fmt.Sprintf("Failed to mount ServiceAccount tokens to workspace: %s", err), metrics.ReasonBadRequest, reqLogger, &reconcileStatus), nil

controllers/workspace/devworkspace_controller.go

@@ -150,6 +150,14 @@ var _ = Describe("DevWorkspace Controller", func() {
 				return err == nil
 			}, timeout, interval).Should(BeTrue(), "DevWorkspace should exist in cluster")
 
+			By("Waiting for the first DevWorkspace to have its ID set")
+			Eventually(func() (string, error) {
+				if err := k8sClient.Get(ctx, dwNamespacedName, createdDW); err != nil {
+					return "", err
+				}
+				return createdDW.Status.DevWorkspaceId, nil
+			}, timeout, interval).Should(Equal("test-workspace-id"), "First DevWorkspace should have ID set from override annotation")
+
 			By("Creating a DevWorkspace that duplicates the workspace ID of the first")
 			Expect(k8sClient.Create(ctx, devworkspace2)).Should(Succeed())
 			defer deleteDevWorkspace(devworkspace2.Name)
@@ -407,6 +415,13 @@ var _ = Describe("DevWorkspace Controller", func() {
 			createObject(gitCredentials)
 			defer deleteObject(gitCredentials)
 
+			By("Waiting for DevWorkspaceRouting to be created")
+			dwr := &controllerv1alpha1.DevWorkspaceRouting{}
+			dwrName := common.DevWorkspaceRoutingName(workspaceID)
+			Eventually(func() error {
+				return k8sClient.Get(ctx, namespacedName(dwrName, testNamespace), dwr)
+			}, timeout, interval).Should(Succeed(), "DevWorkspaceRouting should be created")
+
 			By("Manually making Routing ready to continue")
 			markRoutingReady(testURL, common.DevWorkspaceRoutingName(workspaceID))