feat: [CI-11723]: introduced RUN_ON_HOST_ONLY flag

Author: devkimittal

cli/server/server.go

@@ -93,7 +93,7 @@ func (c *serverCommand) run(*kingpin.ParseContext) error {
 	if loadedConfig.Server.SkipPrepareServer {
 		logrus.Infoln("skipping prepare server eg install docker / git")
 	} else {
-		setup.PrepareSystem()
+		setup.PrepareSystem(&loadedConfig)
 	}
 	// starts the http server.
 	err = serverInstance.Start(ctx)

config/config.go

@@ -17,6 +17,7 @@ type Config struct {
 	Runner struct {
 		Volumes       []string `envconfig:"CI_MOUNT_VOLUMES"`
 		NetworkDriver string   `envconfig:"NETWORK_DRIVER"`
+		RunOnHostOnly bool     `envconfig:"RUN_ON_HOST_ONLY"`
 	}
 
 	Server struct {

engine/docker/docker.go

@@ -208,8 +208,10 @@ func (e *Docker) Destroy(ctx context.Context, pipelineConfig *spec.PipelineConfi
 	}
 
 	// cleanup the network
-	if err := e.client.NetworkRemove(ctx, pipelineConfig.Network.ID); err != nil {
-		logrus.WithField("network", pipelineConfig.Network.ID).WithField("error", err).Warnln("failed to remove network")
+	if e.IsDockerEnabled(pipelineConfig) {
+		if err := e.client.NetworkRemove(ctx, pipelineConfig.Network.ID); err != nil {
+			logrus.WithField("network", pipelineConfig.Network.ID).WithField("error", err).Warnln("failed to remove network")
+		}
 	}
 
 	e.mu.Lock()
@@ -223,6 +225,13 @@ func (e *Docker) Destroy(ctx context.Context, pipelineConfig *spec.PipelineConfi
 	return nil
 }
 
+func (e *Docker) IsDockerEnabled(pipelineConfig *spec.PipelineConfig) bool {
+	if pipelineConfig.EnableDockerSetup == nil || *pipelineConfig.EnableDockerSetup {
+		return true
+	}
+	return false
+}
+
 // Run runs the pipeline step.
 func (e *Docker) Run(ctx context.Context, pipelineConfig *spec.PipelineConfig, step *spec.Step,
 	output io.Writer) (*runtime.State, error) {

engine/engine.go

@@ -70,7 +70,7 @@ func (e *Engine) Setup(ctx context.Context, pipelineConfig *spec.PipelineConfig)
 	e.pipelineConfig = pipelineConfig
 	e.mu.Unlock()
 	// required to support m1 where docker isn't installed.
-	if e.pipelineConfig.EnableDockerSetup == nil || *e.pipelineConfig.EnableDockerSetup {
+	if e.docker.IsDockerEnabled(e.pipelineConfig) {
 		return e.docker.Setup(ctx, pipelineConfig)
 	}
 	return nil

handler/health.go

@@ -25,7 +25,7 @@ func HandleHealth() http.HandlerFunc {
 			DockerInstalled: dockerOK,
 			GitInstalled:    gitOK,
 			LiteEngineLog:   setup.GetLiteEngineLog(instanceInfo),
-			OK:              dockerOK && gitOK,
+			OK:              true,
 		}
 		WriteJSON(w, response, http.StatusOK)
 	}

handler/setup.go

@@ -48,8 +48,13 @@ func HandleSetup(config *config.Config) http.HandlerFunc {
 			return
 		}
 		id := s.ID
+		if config.Runner.RunOnHostOnly {
+			mountDockerSocket := false
+			s.MountDockerSocket = &mountDockerSocket
+		}
 
 		updateVolumes(s)
+		s.Envs["WORKSPACE"] = getWorkSpacePath(s)
 
 		// Add ti volume where all the TI related data (CG, Agent logs, config) will be stored
 		// Add this dir to TIConfig for uploading the data
@@ -162,6 +167,17 @@ func updateVolumes(r api.SetupRequest) {
 	}
 }
 
+func getWorkSpacePath(r api.SetupRequest) string {
+	for _, v := range r.Volumes {
+		if v.HostPath != nil {
+			if v.HostPath.ID == "harness" {
+				return v.HostPath.Path
+			}
+		}
+	}
+	return ""
+}
+
 func getSharedVolume() *spec.Volume {
 	return &spec.Volume{
 		HostPath: &spec.VolumeHostPath{

handler/step.go

@@ -38,6 +38,11 @@ func HandleStartStep(config *config.Config) http.HandlerFunc {
 			return
 		}
 
+		if config.Runner.RunOnHostOnly {
+			mountDockerSocket := false
+			s.MountDockerSocket = &mountDockerSocket
+		}
+
 		if s.MountDockerSocket == nil || *s.MountDockerSocket { // required to support m1 where docker isn't installed.
 			s.Volumes = append(s.Volumes, getDockerSockVolumeMount())
 		}

setup/setup.go

@@ -9,6 +9,7 @@ import (
 	"os/exec"
 	"runtime"
 
+	"github.com/harness/harness-docker-runner/config"
 	"github.com/sirupsen/logrus"
 )
 
@@ -21,12 +22,12 @@ func GetInstanceInfo() InstanceInfo {
 	return InstanceInfo{osType: osType}
 }
 
-func PrepareSystem() {
+func PrepareSystem(c *config.Config) {
 	instanceInfo := GetInstanceInfo()
 	if !GitInstalled(instanceInfo) {
 		installGit(instanceInfo)
 	}
-	if !DockerInstalled(instanceInfo) {
+	if !c.Runner.RunOnHostOnly && !DockerInstalled(instanceInfo) {
 		installDocker(instanceInfo)
 	}
 }