Mark the AddSshAgentPostStartEvent as experimental feature

Signed-off-by: ivinokur <[email protected]>

Author: vinokurig

controllers/workspace/devworkspace_controller.go

@@ -65,6 +65,8 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 	"sigs.k8s.io/controller-runtime/pkg/source"
 
+	"github.com/devfile/devworkspace-operator/pkg/config"
+
 	dw "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
 	wsDefaults "github.com/devfile/devworkspace-operator/pkg/library/defaults"
 )
@@ -131,20 +133,20 @@ func (r *DevWorkspaceReconciler) Reconcile(ctx context.Context, req ctrl.Request
 	}
 
 	reconcileStatus := currentStatus{}
-	config, err := wkspConfig.ResolveConfigForWorkspace(rawWorkspace, clusterAPI.Client)
+	workspaceConfig, err := wkspConfig.ResolveConfigForWorkspace(rawWorkspace, clusterAPI.Client)
 	if err != nil {
 		reconcileStatus.addWarning(fmt.Sprint("Error applying external DevWorkspace-Operator configuration: ", err.Error()))
-		config = wkspConfig.GetGlobalConfig()
+		workspaceConfig = wkspConfig.GetGlobalConfig()
 	}
-	configString := wkspConfig.GetCurrentConfigString(config)
+	configString := wkspConfig.GetCurrentConfigString(workspaceConfig)
 	workspace := &common.DevWorkspaceWithConfig{}
 	workspace.DevWorkspace = rawWorkspace
-	workspace.Config = config
+	workspace.Config = workspaceConfig
 
 	reqLogger = reqLogger.WithValues(constants.DevWorkspaceIDLoggerKey, workspace.Status.DevWorkspaceId)
 	reqLogger.Info("Reconciling Workspace", "resolvedConfig", configString)
 
-	// Inject ca certificates to the http client, if the certificates configmap is created and defined in the config.
+	// Inject ca certificates to the http client, if the certificates configmap is created and defined in the workspaceConfig.
 	InjectCertificates(r.Client, r.Log)
 
 	// Check if the DevWorkspaceRouting instance is marked to be deleted, which is
@@ -281,9 +283,12 @@ func (r *DevWorkspaceReconciler) Reconcile(ctx context.Context, req ctrl.Request
 	}
 	workspace.Spec.Template = *flattenedWorkspace
 
-	err = ssh.AddSshAgentPostStartEvent(&workspace.Spec.Template)
-	if err != nil {
-		return r.failWorkspace(workspace, "Failed to add ssh-agent post start event", metrics.ReasonWorkspaceEngineFailure, reqLogger, &reconcileStatus), nil
+	// Include to experimental features list because it is not clear how to handle post start events in containers without sh.
+	if *config.GetGlobalConfig().EnableExperimentalFeatures {
+		err = ssh.AddSshAgentPostStartEvent(&workspace.Spec.Template)
+		if err != nil {
+			return r.failWorkspace(workspace, "Failed to add ssh-agent post start event", metrics.ReasonWorkspaceEngineFailure, reqLogger, &reconcileStatus), nil
+		}
 	}
 
 	reconcileStatus.setConditionTrue(conditions.DevWorkspaceResolved, "Resolved plugins and parents from DevWorkspace")
@@ -345,9 +350,9 @@ func (r *DevWorkspaceReconciler) Reconcile(ctx context.Context, req ctrl.Request
 		Resources: workspace.Config.Workspace.ProjectCloneConfig.Resources,
 	}
 	if workspace.Config.Workspace.ProjectCloneConfig.ImagePullPolicy != "" {
-		projectCloneOptions.PullPolicy = config.Workspace.ProjectCloneConfig.ImagePullPolicy
+		projectCloneOptions.PullPolicy = workspaceConfig.Workspace.ProjectCloneConfig.ImagePullPolicy
 	} else {
-		projectCloneOptions.PullPolicy = corev1.PullPolicy(config.Workspace.ImagePullPolicy)
+		projectCloneOptions.PullPolicy = corev1.PullPolicy(workspaceConfig.Workspace.ImagePullPolicy)
 	}
 	if projectClone, err := projects.GetProjectCloneInitContainer(&workspace.Spec.Template, projectCloneOptions, workspace.Config.Routing.ProxyConfig); err != nil {
 		return r.failWorkspace(workspace, fmt.Sprintf("Failed to set up project-clone init container: %s", err), metrics.ReasonInfrastructureFailure, reqLogger, &reconcileStatus), nil

docs/additional-configuration.adoc

@@ -225,6 +225,7 @@ you must add the following in your `~/.bashrc`:
 ----
 [ -f $HOME/ssh-environment ] && source $HOME/ssh-environment
 ----
+*Note:*  This is an experimental feature and is controlled by the `DevWorkspaceOperatorConfig.EnableExperimentalFeatures` option.
 
 3. Annotate the secret to configure automatic mounting to DevWorkspaces
 +