Add implementation of CSI-Driver for Windows (#3)

* Added the first cut of the implementation for the CSIDriver.

* Cleaned the branch with unneeded vendor files.

---------

Co-authored-by: Saurabh Chakravarty <[email protected]>

Author: 2 people

agent/app/agent_unix.go

@@ -159,7 +159,7 @@ func (agent *ecsAgent) startEBSWatcher(
 ) {
 	if agent.ebsWatcher == nil {
 		seelog.Debug("Creating new EBS watcher...")
-		agent.ebsWatcher = ebs.NewWatcher(agent.ctx, state, taskEngine, dockerClient)
+		agent.ebsWatcher = ebs.NewWatcher(agent.ctx, state, taskEngine, dockerClient, agent.cfg.CSIDriverSocketPath)
 		go agent.ebsWatcher.Start()
 	}
 }

agent/app/agent_windows.go

@@ -108,7 +108,7 @@ func (agent *ecsAgent) startEBSWatcher(
 ) {
 	if agent.ebsWatcher == nil {
 		seelog.Debug("Creating new EBS watcher...")
-		agent.ebsWatcher = ebs.NewWatcher(agent.ctx, state, taskEngine, dockerClient)
+		agent.ebsWatcher = ebs.NewWatcher(agent.ctx, state, taskEngine, dockerClient, agent.cfg.CSIDriverSocketPath)
 		go agent.ebsWatcher.Start()
 	}
 }

agent/config/config_unix.go

@@ -60,6 +60,8 @@ const (
 	minimumContainerCreateTimeout = 1 * time.Minute
 	// default docker inactivity time is extra time needed on container extraction
 	defaultImagePullInactivityTimeout = 1 * time.Minute
+	// default socket filepath is "/var/run/ecs/ebs-csi-driver/csi-driver.sock"
+	defaultCSIDriverSocketPath = "/var/run/ecs/ebs-csi-driver/csi-driver.sock"
 )
 
 // DefaultConfig returns the default configuration for Linux
@@ -112,6 +114,7 @@ func DefaultConfig() Config {
 		RuntimeStatsLogFile:                 defaultRuntimeStatsLogFile,
 		EnableRuntimeStats:                  BooleanDefaultFalse{Value: NotSet},
 		ShouldExcludeIPv6PortBinding:        BooleanDefaultTrue{Value: ExplicitlyEnabled},
+		CSIDriverSocketPath:                 defaultCSIDriverSocketPath,
 	}
 }
 

agent/config/config_unix_test.go

@@ -77,6 +77,7 @@ func TestConfigDefault(t *testing.T) {
 	assert.False(t, cfg.EnableRuntimeStats.Enabled(), "Default EnableRuntimeStats set incorrectly")
 	assert.True(t, cfg.ShouldExcludeIPv6PortBinding.Enabled(), "Default ShouldExcludeIPv6PortBinding set incorrectly")
 	assert.False(t, cfg.FSxWindowsFileServerCapable.Enabled(), "Default FSxWindowsFileServerCapable set incorrectly")
+	assert.Equal(t, "/var/run/ecs/ebs-csi-driver/csi-driver.sock", cfg.CSIDriverSocketPath, "Default CSIDriverSocketPath set incorrectly")
 }
 
 // TestConfigFromFile tests the configuration can be read from file

agent/config/config_windows.go

@@ -97,6 +97,7 @@ func DefaultConfig() Config {
 
 	programFiles := utils.DefaultIfBlank(os.Getenv("ProgramFiles"), `C:\Program Files`)
 	ecsBinaryDir := filepath.Join(programFiles, "Amazon", "ECS")
+	defaultCSIDriverSocketPath := filepath.Join(ecsBinaryDir, "ebs-csi-driver", "csi-driver.sock")
 
 	platformVariables := PlatformVariables{
 		CPUUnbounded:    BooleanDefaultFalse{Value: ExplicitlyDisabled},
@@ -157,6 +158,7 @@ func DefaultConfig() Config {
 		RuntimeStatsLogFile:                 filepath.Join(ecsRoot, defaultRuntimeStatsLogFile),
 		EnableRuntimeStats:                  BooleanDefaultFalse{Value: NotSet},
 		ShouldExcludeIPv6PortBinding:        BooleanDefaultTrue{Value: ExplicitlyEnabled},
+		CSIDriverSocketPath:                 defaultCSIDriverSocketPath,
 	}
 }
 

agent/config/config_windows_test.go

@@ -73,6 +73,7 @@ func TestConfigDefault(t *testing.T) {
 	assert.False(t, cfg.EnableRuntimeStats.Enabled(), "Default EnableRuntimeStats set incorrectly")
 	assert.True(t, cfg.ShouldExcludeIPv6PortBinding.Enabled(), "Default ShouldExcludeIPv6PortBinding set incorrectly")
 	assert.True(t, cfg.FSxWindowsFileServerCapable.Enabled(), "Default FSxWindowsFileServerCapable set incorrectly")
+	assert.Equal(t, "C:\\Program Files\\Amazon\\ECS\\ebs-csi-driver\\csi-driver.sock", cfg.CSIDriverSocketPath, "Default CSIDriverSocketPath set incorrectly")
 }
 
 func TestConfigIAMTaskRolesReserves80(t *testing.T) {

agent/config/types.go

@@ -384,4 +384,8 @@ type Config struct {
 	// cgroup setting at the ECS task level.
 	// see https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html#pid
 	TaskPidsLimit int
+
+	// CSIDriverSocketPath specifies the path that the CSI driver socket file is located at.
+	// Defaults to "/var/run/ecs/ebs-csi-driver/csi-driver.sock"
+	CSIDriverSocketPath string
 }

agent/ebs/watcher.go

@@ -59,11 +59,11 @@ type EBSWatcher struct {
 func NewWatcher(ctx context.Context,
 	state dockerstate.TaskEngineState,
 	taskEngine ecsengine.TaskEngine,
-	dockerClient dockerapi.DockerClient) *EBSWatcher {
+	dockerClient dockerapi.DockerClient,
+	csiDriverSocketPath string) *EBSWatcher {
 	derivedContext, cancel := context.WithCancel(ctx)
 	discoveryClient := apiebs.NewDiscoveryClient(derivedContext)
-	// TODO pull this socket out into config
-	csiClient := csi.NewCSIClient("/var/run/ecs/ebs-csi-driver/csi-driver.sock")
+	csiClient := csi.NewCSIClient(csiDriverSocketPath)
 	return &EBSWatcher{
 		ctx:             derivedContext,
 		cancel:          cancel,

agent/ebs/watcher_linux_test.go

@@ -0,0 +1,21 @@
+//go:build linux && unit
+// +build linux,unit
+
+// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License"). You may
+// not use this file except in compliance with the License. A copy of the
+// License is located at
+//
+//	http://aws.amazon.com/apache2.0/
+//
+// or in the "license" file accompanying this file. This file is distributed
+// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+// express or implied. See the License for the specific language governing
+// permissions and limitations under the License.
+
+package ebs
+
+const (
+	CSIDriverSocketPath = "/var/run/ecs/ebs-csi-driver/csi-driver.sock"
+)

agent/ebs/watcher_test.go

@@ -737,7 +737,7 @@ func TestTick(t *testing.T) {
 				tc.setDiscoveryClientExpectations(discoveryClient)
 			}
 
-			watcher := NewWatcher(context.Background(), taskEngineState, taskEngine, dockerClient)
+			watcher := NewWatcher(context.Background(), taskEngineState, taskEngine, dockerClient, CSIDriverSocketPath)
 			watcher.discoveryClient = discoveryClient
 			watcher.tick()