LVP support for local volumes in Windows

Author: mauriciopoppe

cmd/local-volume-provisioner/main.go

@@ -87,6 +87,7 @@ func main() {
 
 	klog.Info("Starting controller\n")
 	procTable := deleter.NewProcTable()
+
 	go controller.StartLocalController(client, procTable, discoveryPeriod, &common.UserConfig{
 		Node:              node,
 		DiscoveryMap:      provisionerConfig.StorageClassConfig,

go.mod

@@ -5,6 +5,7 @@ go 1.16
 require (
 	github.com/ghodss/yaml v1.0.0
 	github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b
+	github.com/kubernetes-csi/csi-proxy/client v1.0.1
 	github.com/onsi/ginkgo v1.14.0
 	github.com/onsi/gomega v1.10.1
 	github.com/prometheus/client_golang v1.11.0

go.sum

@@ -47,6 +47,8 @@ github.com/JeffAshton/win_pdh v0.0.0-20161109143554-76bb4ee9f0ab/go.mod h1:3VYc5
 github.com/MakeNowJust/heredoc v0.0.0-20170808103936-bb23615498cd/go.mod h1:64YHyfSL2R96J44Nlwm39UHepQbyR5q10x7iYa1ks2E=
 github.com/Microsoft/go-winio v0.4.15-0.20190919025122-fc70bd9a86b5/go.mod h1:tTuCMEN+UleMWgg9dVx4Hu52b1bJo+59jBh3ajtinzw=
 github.com/Microsoft/go-winio v0.4.15/go.mod h1:tTuCMEN+UleMWgg9dVx4Hu52b1bJo+59jBh3ajtinzw=
+github.com/Microsoft/go-winio v0.4.16 h1:FtSW/jqD+l4ba5iPBj9CODVtgfYAD8w2wS923g/cFDk=
+github.com/Microsoft/go-winio v0.4.16/go.mod h1:XB6nPKklQyQ7GC9LdcBEcBl8PF76WugXOPRXwdLnMv0=
 github.com/Microsoft/hcsshim v0.8.10-0.20200715222032-5eafd1556990/go.mod h1:ay/0dTb7NsG8QMDfsRfLHgZo/6xAJShLe1+ePPflihk=
 github.com/NYTimes/gziphandler v0.0.0-20170623195520-56545f4a5d46/go.mod h1:3wb06e3pkSAbeQ52E9H9iFoQsEEwGN64994WTCIhntQ=
 github.com/NYTimes/gziphandler v1.1.1/go.mod h1:n/CVRwUEOgIxrgPvAQhUUr9oeUtvrhMomdKFjzJNB0c=
@@ -357,6 +359,8 @@ github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
 github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
 github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
+github.com/kubernetes-csi/csi-proxy/client v1.0.1 h1:BPK9e5Fy0GcDRjDc9hqu7TnouSRujG6IvbH+PXSDOsY=
+github.com/kubernetes-csi/csi-proxy/client v1.0.1/go.mod h1:URLOkEbRhOwKVvGvug6HSKRTpLSFuQ/Gt3xahDag8qc=
 github.com/libopenstorage/openstorage v1.0.0/go.mod h1:Sp1sIObHjat1BeXhfMqLZ14wnOzEhNx2YQedreMcUyc=
 github.com/liggitt/tabwriter v0.0.0-20181228230101-89fcab3d43de/go.mod h1:zAbeS9B/r2mtpb6U+EI2rYA5OAXxsYw6wTamcNW+zcE=
 github.com/lithammer/dedent v1.1.0/go.mod h1:jrXYCQtgg0nJiN+StA2KgR7w6CiQNv9Fd/Z9BP0jIOc=

pkg/common/common.go

@@ -23,6 +23,7 @@ import (
 	"os"
 	"path"
 	"path/filepath"
+	"runtime"
 	"strings"
 
 	"github.com/ghodss/yaml"
@@ -328,6 +329,8 @@ func ConfigMapDataToVolumeConfig(data map[string]string, provisionerConfig *Prov
 		if config.MountDir == "" || config.HostDir == "" {
 			return fmt.Errorf("Storage Class %v is misconfigured, missing HostDir or MountDir parameter", class)
 		}
+		config.MountDir = normalizePath(config.MountDir)
+		config.HostDir = normalizePath(config.HostDir)
 
 		if config.VolumeMode == "" {
 			config.VolumeMode = DefaultVolumeMode
@@ -354,6 +357,20 @@ func ConfigMapDataToVolumeConfig(data map[string]string, provisionerConfig *Prov
 	return nil
 }
 
+// normalizePath makes sure the given path is a valid path on Windows too
+// by making sure all instances of `/` are replaced with `\\`, and the
+// path beings with `c:`
+func normalizePath(path string) string {
+	if runtime.GOOS != "windows" {
+		return path
+	}
+	normalizedPath := strings.Replace(path, "/", "\\", -1)
+	if strings.HasPrefix(normalizedPath, "\\") {
+		normalizedPath = "c:" + normalizedPath
+	}
+	return normalizedPath
+}
+
 func insertSpaces(original string) string {
 	spaced := ""
 	for _, line := range strings.Split(original, "\n") {
@@ -425,6 +442,11 @@ func GenerateMountName(mount *MountConfig) string {
 
 // GetVolumeMode check volume mode of given path.
 func GetVolumeMode(volUtil util.VolumeUtil, fullPath string) (v1.PersistentVolumeMode, error) {
+	if runtime.GOOS == "windows" {
+		// only filesystem is supported in Windows
+		return v1.PersistentVolumeFilesystem, nil
+	}
+
 	isdir, errdir := volUtil.IsDir(fullPath)
 	if isdir {
 		return v1.PersistentVolumeFilesystem, nil

pkg/controller/controller.go

@@ -43,7 +43,7 @@ import (
 )
 
 // StartLocalController starts the sync loop for the local PV discovery and deleter
-func StartLocalController(client *kubernetes.Clientset, ptable deleter.ProcTable, discoveryPeriod time.Duration, config *common.UserConfig) {
+func StartLocalController(client *kubernetes.Clientset, ptable deleter.ProcTable, discoveryPeriod time.Duration, config *common.UserConfig) error {
 	klog.Info("Initializing volume cache\n")
 
 	var provisionerName string
@@ -62,10 +62,16 @@ func StartLocalController(client *kubernetes.Clientset, ptable deleter.ProcTable
 	// at same time don't list the apiserver simultaneously.
 	resyncPeriod := time.Duration(config.MinResyncPeriod.Seconds()*(1+rand.Float64())) * time.Second
 
+	var err error
+	volumeUtil, err := util.NewVolumeUtil()
+	if err != nil {
+		klog.Fatalf("Error initializing VolumeUtil: %v", err)
+	}
+
 	runtimeConfig := &common.RuntimeConfig{
 		UserConfig:      config,
 		Cache:           cache.NewVolumeCache(),
-		VolUtil:         util.NewVolumeUtil(),
+		VolUtil:         volumeUtil,
 		APIUtil:         util.NewAPIUtil(client),
 		Client:          client,
 		Name:            provisionerName,
@@ -77,7 +83,6 @@ func StartLocalController(client *kubernetes.Clientset, ptable deleter.ProcTable
 	populator.NewPopulator(runtimeConfig)
 
 	var jobController deleter.JobController
-	var err error
 	if runtimeConfig.UseJobForCleaning {
 		labels := map[string]string{common.NodeNameLabel: config.Node.Name}
 		jobController, err = deleter.NewJobController(labels, runtimeConfig)
@@ -114,4 +119,7 @@ func StartLocalController(client *kubernetes.Clientset, ptable deleter.ProcTable
 		discoverer.DiscoverLocalVolumes()
 		time.Sleep(discoveryPeriod)
 	}
+
+	// unreachable
+	return nil
 }

pkg/discovery/discovery.go

@@ -23,6 +23,7 @@ import (
 	"hash/fnv"
 	"net/http"
 	"path/filepath"
+	"runtime"
 	"strings"
 	"sync"
 	"time"
@@ -266,6 +267,7 @@ func (d *Discoverer) discoverVolumesAtPath(class string, config common.MountConf
 
 	// Retrieve list of mount points to iterate through discovered paths (aka files) below
 	mountPoints, err := d.RuntimeConfig.Mounter.List()
+	klog.V(4).Infof("[DEBUG] the mount points are %v", mountPoints)
 	if err != nil {
 		return fmt.Errorf("error retrieving mountpoints: %v", err)
 	}
@@ -360,10 +362,13 @@ func (d *Discoverer) discoverVolumesAtPath(class string, config common.MountConf
 				discoErrors = append(discoErrors, fmt.Errorf("path %q of filesystem mode cannot be used to create block volume", filePath))
 				continue
 			}
-			// Validate that this path is an actual mountpoint
-			if _, isMntPnt := mountPointMap[filePath]; isMntPnt == false {
-				discoErrors = append(discoErrors, fmt.Errorf("path %q is not an actual mountpoint", filePath))
-				continue
+			// TODO(mauriciopoppe): skipping the mountpoint verification in Windows, unlike Linux there's no /proc/mounts file to check
+			if runtime.GOOS != "windows" {
+				// Validate that this path is an actual mountpoint
+				if _, isMntPnt := mountPointMap[filePath]; isMntPnt == false {
+					discoErrors = append(discoErrors, fmt.Errorf("path %q is not an actual mountpoint", filePath))
+					continue
+				}
 			}
 			capacityByte, err = d.VolUtil.GetFsCapacityByte(filePath)
 			if err != nil {

pkg/util/csi_proxy_v1_windows.go

@@ -0,0 +1,93 @@
+//go:build windows
+// +build windows
+
+/*
+Copyright 2021 The Kubernetes Authors.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License 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 util
+
+import (
+	"context"
+	"fmt"
+
+	volumeapi "github.com/kubernetes-csi/csi-proxy/client/api/volume/v1"
+	volumeclient "github.com/kubernetes-csi/csi-proxy/client/groups/volume/v1"
+)
+
+// CSIProxyV1 is the CSI Proxy implementation that uses the v1 API
+type CSIProxyV1 struct {
+	VolumeClient *volumeclient.Client
+}
+
+// check that CSIProxyV1 implements CSIProxy
+var _ CSIProxy = &CSIProxyV1{}
+
+func NewCSIProxyV1() (*CSIProxyV1, error) {
+	volumeClient, err := volumeclient.NewClient()
+	if err != nil {
+		return nil, err
+	}
+	return &CSIProxyV1{
+		VolumeClient: volumeClient,
+	}, nil
+}
+
+// GetAPIVersions returns the versions of the client APIs.
+func (proxy *CSIProxyV1) GetAPIVersions() string {
+	return fmt.Sprintf(
+		"API Versions Volume: %s",
+		volumeclient.Version,
+	)
+}
+
+// GetVolumeId returns the volumeId of the volume mounted at `mountPath`
+func (proxy *CSIProxyV1) GetVolumeId(mountPath string) (volumeId string, err error) {
+	getVolumeIdFromTargetPathResponse, err := proxy.VolumeClient.GetVolumeIDFromTargetPath(
+		context.Background(),
+		&volumeapi.GetVolumeIDFromTargetPathRequest{
+			TargetPath: mountPath,
+		},
+	)
+	if err != nil {
+		return "", err
+	}
+	return getVolumeIdFromTargetPathResponse.VolumeId, nil
+}
+
+// GetVolumeStats gets the volume stats of a volume identified by `volumeId`
+func (proxy *CSIProxyV1) GetVolumeStats(volumeId string) (totalBytes int64, usedBytes int64, err error) {
+	getVolumeStatsResponse, err := proxy.VolumeClient.GetVolumeStats(
+		context.Background(),
+		&volumeapi.GetVolumeStatsRequest{
+			VolumeId: volumeId,
+		},
+	)
+	if err != nil {
+		return 0, 0, err
+	}
+	return getVolumeStatsResponse.TotalBytes, getVolumeStatsResponse.UsedBytes, nil
+}
+
+// FormatVolume formats a volume identified by `volumeId`
+func (proxy *CSIProxyV1) FormatVolume(volumeId string) (err error) {
+	_, err = proxy.VolumeClient.FormatVolume(
+		context.Background(),
+		&volumeapi.FormatVolumeRequest{
+			VolumeId: volumeId,
+		},
+	)
+	if err != nil {
+		return err
+	}
+	return nil
+}

pkg/util/csi_proxy_v1beta_windows.go

@@ -0,0 +1,93 @@
+//go:build windows
+// +build windows
+
+/*
+Copyright 2021 The Kubernetes Authors.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License 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 util
+
+import (
+	"context"
+	"fmt"
+
+	volumeapi "github.com/kubernetes-csi/csi-proxy/client/api/volume/v1beta2"
+	volumeclient "github.com/kubernetes-csi/csi-proxy/client/groups/volume/v1beta2"
+)
+
+// CSIProxyV1Beta is the CSI Proxy implementation that uses the v1 API
+type CSIProxyV1Beta struct {
+	VolumeClient *volumeclient.Client
+}
+
+// check that CSIProxyV1Beta implements CSIProxy
+var _ CSIProxy = &CSIProxyV1Beta{}
+
+func NewCSIProxyV1Beta() (*CSIProxyV1Beta, error) {
+	volumeClient, err := volumeclient.NewClient()
+	if err != nil {
+		return nil, err
+	}
+	return &CSIProxyV1Beta{
+		VolumeClient: volumeClient,
+	}, nil
+}
+
+// GetAPIVersions returns the versions of the client APIs.
+func (proxy *CSIProxyV1Beta) GetAPIVersions() string {
+	return fmt.Sprintf(
+		"API Versions Volume: %s",
+		volumeclient.Version,
+	)
+}
+
+// GetVolumeId returns the volumeId of the volume mounted at `mountPath`
+func (proxy *CSIProxyV1Beta) GetVolumeId(mountPath string) (volumeId string, err error) {
+	getVolumeIdFromTargetPathResponse, err := proxy.VolumeClient.GetVolumeIDFromMount(
+		context.Background(),
+		&volumeapi.VolumeIDFromMountRequest{
+			Mount: mountPath,
+		},
+	)
+	if err != nil {
+		return "", err
+	}
+	return getVolumeIdFromTargetPathResponse.VolumeId, nil
+}
+
+// GetVolumeStats gets the volume information
+func (proxy *CSIProxyV1Beta) GetVolumeStats(volumeId string) (totalBytes int64, usedBytes int64, err error) {
+	getVolumeStatsResponse, err := proxy.VolumeClient.VolumeStats(
+		context.Background(),
+		&volumeapi.VolumeStatsRequest{
+			VolumeId: volumeId,
+		},
+	)
+	if err != nil {
+		return 0, 0, err
+	}
+	return getVolumeStatsResponse.VolumeSize, getVolumeStatsResponse.VolumeUsedSize, nil
+}
+
+// FormatVolume formats a volume identified by `volumeId`
+func (proxy *CSIProxyV1Beta) FormatVolume(volumeId string) (err error) {
+	_, err = proxy.VolumeClient.FormatVolume(
+		context.Background(),
+		&volumeapi.FormatVolumeRequest{
+			VolumeId: volumeId,
+		},
+	)
+	if err != nil {
+		return err
+	}
+	return nil
+}