Switch to running without Supervisord

As discussed in [1], this will alleviate the maintenance burden,
while waiting for [2] to get merged some day on the Devfile side.

[1] redhat-developer#5768 (comment)
[2] devfile/registry#102

Author: rm3l

pkg/binding/mock.go

@@ -34,7 +34,6 @@ func (o *DevClient) Start(
 	ignorePaths []string,
 	path string,
 	debug bool,
-	withSupervisord bool,
 ) error {
 	klog.V(4).Infoln("Creating new adapter")
 	adapter, err := adapters.NewComponentAdapter(devfileObj.GetMetadataName(), path, "app", devfileObj, platformContext)
@@ -53,7 +52,6 @@ func (o *DevClient) Start(
 		Path:            path,
 		IgnoredFiles:    ignorePaths,
 		Debug:           debug,
-		WithSupervisord: withSupervisord,
 	}
 
 	klog.V(4).Infoln("Creating inner-loop resources for the component")
@@ -73,7 +71,6 @@ func (o *DevClient) Watch(
 	h Handler,
 	ctx context.Context,
 	debug bool,
-	withSupervisord bool,
 ) error {
 
 	envSpecificInfo, err := envinfo.NewEnvSpecificInfo(path)
@@ -91,7 +88,6 @@ func (o *DevClient) Watch(
 		InitialDevfileObj:   devfileObj,
 		Debug:               debug,
 		DebugPort:           envSpecificInfo.GetDebugPort(),
-		WithSupervisord:     withSupervisord,
 	}
 
 	return o.watchClient.WatchAndPush(out, watchParameters, ctx)

pkg/dev/dev.go

@@ -15,21 +15,18 @@ import (
 type Client interface {
 	// Start the resources in devfileObj on the platformContext. It then pushes the files in path to the container.
 	// If debug is true, executes the debug command, or the run command by default.
-	// If withSupervisord is false, Supervisord is not run.
 	Start(
 		devfileObj parser.DevfileObj,
 		platformContext kubernetes.KubernetesContext,
 		ignorePaths []string,
 		path string,
 		debug bool,
-		withSupervisord bool,
 	) error
 
 	// Watch watches for any changes to the files under path while ignoring the files/directories in ignorePaths.
 	// It logs messages to out and uses the Handler h to perform push operation when anything changes in path.
 	// It uses devfileObj to notify user to restart odo dev if they change endpoint information in the devfile.
 	// If debug is true, the debug command will be started after a sync, or the run command by default.
-	// If withSupervisord is false, Supervisord is not run.
 	Watch(
 		devfileObj parser.DevfileObj,
 		path string,
@@ -38,7 +35,6 @@ type Client interface {
 		h Handler,
 		ctx context.Context,
 		debug bool,
-		withSupervisord bool,
 	) error
 }
 

pkg/dev/interface.go

@@ -7,5 +7,5 @@ import (
 // ComponentAdapter defines the functions that platform-specific adapters must implement
 type ComponentAdapter interface {
 	Push(parameters PushParameters) error
-	CheckRemoteCommandStatus(withSupervisord bool, command devfilev1.Command) error
+	CheckRemoteCommandStatus(command devfilev1.Command) error
 }

pkg/dev/mock.go

@@ -31,7 +31,6 @@ type PushParameters struct {
 	Debug                    bool                    // Runs the component in debug mode
 	DebugPort                int                     // Port used for remote debugging
 	RunModeChanged           bool                    // It determines if run mode is changed from run to debug or vice versa
-	WithSupervisord          bool                    // Whether to run with supervisord
 }
 
 // SyncParameters is a struct containing the parameters to be used when syncing a devfile component

pkg/devfile/adapters/common/interface.go

@@ -1,162 +1,29 @@
 package common
 
 import (
-	"os"
 	"path/filepath"
 	"strings"
 
-	"k8s.io/klog"
-
 	devfilev1 "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
-	parsercommon "github.com/devfile/library/pkg/devfile/parser/data/v2/common"
 )
 
-// PredefinedDevfileCommands encapsulates constants for predefined devfile commands
-type PredefinedDevfileCommands string
-
 const (
-
-	// DefaultDevfileRunCommand is a predefined devfile command for run
-	DefaultDevfileRunCommand PredefinedDevfileCommands = "devrun"
-
-	// DefaultDevfileDebugCommand is a predefined devfile command for debug
-	DefaultDevfileDebugCommand PredefinedDevfileCommands = "debugrun"
-
-	// SupervisordInitContainerName The init container name for supervisord
-	SupervisordInitContainerName = "copy-supervisord"
-
-	// Default Image that will be used containing the supervisord binary and assembly scripts
-	// use GetBootstrapperImage() function instead of this variable
-	defaultBootstrapperImage = "registry.access.redhat.com/ocp-tools-4/odo-init-container-rhel8:1.1.11"
-
 	// SharedDataVolumeName Create a custom name and (hope) that users don't use the *exact* same name in their deployment (occlient.go)
 	SharedDataVolumeName = "odo-shared-data"
 
-	// SharedDataMountPath The supervisord Mount Path for the container mounting the supervisord volume
+	// SharedDataMountPath The Mount Path for the container mounting the odo volume
 	SharedDataMountPath = "/opt/odo/"
 
-	// SupervisordBinaryPath The supervisord binary path inside the container volume mount
-	SupervisordBinaryPath = "/opt/odo/bin/supervisord"
-
-	// SupervisordConfFile The supervisord configuration file inside the container volume mount
-	SupervisordConfFile = "/opt/odo/conf/devfile-supervisor.conf"
-
-	// OdoInitImageContents The path to the odo init image contents
-	OdoInitImageContents = "/opt/odo-init/."
-
-	// ENV variable to overwrite image used to bootstrap SupervisorD in S2I and Devfile builder Image
-	bootstrapperImageEnvName = "ODO_BOOTSTRAPPER_IMAGE"
-
 	// EnvProjectsRoot is the env defined for project mount in a component container when component's mountSources=true
 	EnvProjectsRoot = "PROJECTS_ROOT"
 
-	// EnvOdoCommandRunWorkingDir is the env defined in the runtime component container which holds the work dir for the run command
-	EnvOdoCommandRunWorkingDir = "ODO_COMMAND_RUN_WORKING_DIR"
-
-	// EnvOdoCommandRun is the env defined in the runtime component container which holds the run command to be executed
-	EnvOdoCommandRun = "ODO_COMMAND_RUN"
-
-	// EnvOdoCommandDebugWorkingDir is the env defined in the runtime component container which holds the work dir for the debug command
-	EnvOdoCommandDebugWorkingDir = "ODO_COMMAND_DEBUG_WORKING_DIR"
-
-	// EnvOdoCommandDebug is the env defined in the runtime component container which holds the debug command to be executed
-	EnvOdoCommandDebug = "ODO_COMMAND_DEBUG"
-
 	// EnvDebugPort is the env defined in the runtime component container which holds the debug port for remote debugging
 	EnvDebugPort = "DEBUG_PORT"
 
 	// ShellExecutable is the shell executable
 	ShellExecutable = "/bin/sh"
-
-	// SupervisordCtlSubCommand is the supervisord sub command ctl
-	SupervisordCtlSubCommand = "ctl"
 )
 
-// GetBootstrapperImage returns the odo-init bootstrapper image
-func GetBootstrapperImage() string {
-	if env, ok := os.LookupEnv(bootstrapperImageEnvName); ok {
-		return env
-	}
-	return defaultBootstrapperImage
-}
-
-// getCommandsByGroup gets commands by the group kind
-func getCommandsByGroup(commands []devfilev1.Command, groupType devfilev1.CommandGroupKind) []devfilev1.Command {
-	var filteredCommands []devfilev1.Command
-	for _, command := range commands {
-		commandGroup := parsercommon.GetGroup(command)
-		if commandGroup != nil && commandGroup.Kind == groupType {
-			filteredCommands = append(filteredCommands, command)
-		}
-	}
-
-	return filteredCommands
-}
-
-// IsRestartRequired checks if restart required for run command
-func IsRestartRequired(hotReload bool, runModeChanged bool) bool {
-	if runModeChanged || !hotReload {
-		return true
-	}
-
-	return false
-}
-
-// IsEnvPresent checks if the env variable is present in an array of env variables
-func IsEnvPresent(envVars []devfilev1.EnvVar, envVarName string) bool {
-	for _, envVar := range envVars {
-		if envVar.Name == envVarName {
-			return true
-		}
-	}
-
-	return false
-}
-
-// IsPortPresent checks if the port is present in the endpoints array
-func IsPortPresent(endpoints []devfilev1.Endpoint, port int) bool {
-	for _, endpoint := range endpoints {
-		if endpoint.TargetPort == port {
-			return true
-		}
-	}
-
-	return false
-}
-
-// GetComponentEnvVar returns true if a list of env vars contains the specified env var
-// If the env exists, it returns the value of it
-func GetComponentEnvVar(env string, envs []devfilev1.EnvVar) string {
-	for _, envVar := range envs {
-		if envVar.Name == env {
-			return envVar.Value
-		}
-	}
-	return ""
-}
-
-// GetCommandsFromEvent returns the list of commands from the event name.
-// If the event is a composite command, it returns the sub-commands from the tree
-func GetCommandsFromEvent(commandsMap map[string]devfilev1.Command, eventName string) []string {
-	var commands []string
-
-	if command, ok := commandsMap[eventName]; ok {
-		if command.Composite != nil {
-			klog.V(4).Infof("%s is a composite command", command.Id)
-			for _, compositeSubCmd := range command.Composite.Commands {
-				klog.V(4).Infof("checking if sub-command %s is either an exec or a composite command ", compositeSubCmd)
-				subCommands := GetCommandsFromEvent(commandsMap, strings.ToLower(compositeSubCmd))
-				commands = append(commands, subCommands...)
-			}
-		} else {
-			klog.V(4).Infof("%s is an exec command", command.Id)
-			commands = append(commands, command.Id)
-		}
-	}
-
-	return commands
-}
-
 // GetCommandsMap returns a map of the command Id to the command
 func GetCommandsMap(commands []devfilev1.Command) map[string]devfilev1.Command {
 	commandMap := make(map[string]devfilev1.Command, len(commands))

pkg/devfile/adapters/common/types.go

@@ -1,7 +1,6 @@
 package common
 
 import (
-	"os"
 	"reflect"
 	"testing"
 
@@ -93,41 +92,6 @@ func TestIsPortPresent(t *testing.T) {
 
 }
 
-func TestGetBootstrapperImage(t *testing.T) {
-
-	customImage := "customimage:customtag"
-
-	tests := []struct {
-		name        string
-		customImage bool
-		wantImage   string
-	}{
-		{
-			name:        "Case 1: Default bootstrap image",
-			customImage: false,
-			wantImage:   defaultBootstrapperImage,
-		},
-		{
-			name:        "Case 2: Custom bootstrap image",
-			customImage: true,
-			wantImage:   customImage,
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			if tt.customImage {
-				os.Setenv(bootstrapperImageEnvName, customImage)
-			}
-			image := GetBootstrapperImage()
-
-			if image != tt.wantImage {
-				t.Errorf("TestGetBootstrapperImage error: bootstrap image mismatch, expected: %v got: %v", tt.wantImage, image)
-			}
-		})
-	}
-
-}
-
 func TestGetCommandsForGroup(t *testing.T) {
 
 	component := []devfilev1.Component{

pkg/devfile/adapters/common/utils.go

@@ -42,9 +42,9 @@ func (k Adapter) Push(parameters common.PushParameters) error {
 	return nil
 }
 
-// CheckRemoteCommandStatus calls the component adapter's CheckSupervisordCommandStatus
-func (k Adapter) CheckRemoteCommandStatus(withSupervisord bool, command devfilev1.Command) error {
-	err := k.componentAdapter.CheckRemoteCommandStatus(withSupervisord, command)
+// CheckRemoteCommandStatus calls the component adapter's CheckRemoteCommandStatus
+func (k Adapter) CheckRemoteCommandStatus(command devfilev1.Command) error {
+	err := k.componentAdapter.CheckRemoteCommandStatus(command)
 	if err != nil {
 		return fmt.Errorf("failed to check the status: %w", err)
 	}