Merge pull request #179 from digitalocean/awg/custom-driver-name-master

Allow a custom driver name to be specified on the commandline

README.md

@@ -203,6 +203,20 @@ $ kubectl exec -ti my-csi-app /bin/sh
 hello-world
 ```
 
+## Upgrading
+
+When upgrading to a new Kubernetes minor version, you should upgrade the CSI
+driver to match. See the table above for which driver version is used with each
+Kubernetes version.
+
+Special consideration is necessary when upgrading from Kubernetes 1.11 or
+earlier, which uses CSI driver version 0.2 or earlier. In these early releases,
+the driver name was `com.digitalocean.csi.dobs`, while in all subsequent
+releases it is `dobs.csi.digitalocean.com`. When upgrading, use the commandline
+flag `--driver-name` to force the new driver to use the old name. Failing to do
+so will cause any existing PVs to be unusable since the new driver will not
+manage them and the old driver is no longer running.
+
 ## Development
 
 Requirements:

cmd/do-csi-plugin/main.go

@@ -27,11 +27,12 @@ import (
 
 func main() {
 	var (
-		endpoint = flag.String("endpoint", "unix:///var/lib/kubelet/plugins/"+driver.DriverName+"/csi.sock", "CSI endpoint")
-		token    = flag.String("token", "", "DigitalOcean access token")
-		url      = flag.String("url", "https://api.digitalocean.com/", "DigitalOcean API URL")
-		doTag    = flag.String("do-tag", "", "Tag DigitalOcean volumes on Create/Attach")
-		version  = flag.Bool("version", false, "Print the version and exit.")
+		endpoint   = flag.String("endpoint", "unix:///var/lib/kubelet/plugins/"+driver.DefaultDriverName+"/csi.sock", "CSI endpoint")
+		token      = flag.String("token", "", "DigitalOcean access token")
+		url        = flag.String("url", "https://api.digitalocean.com/", "DigitalOcean API URL")
+		doTag      = flag.String("do-tag", "", "Tag DigitalOcean volumes on Create/Attach")
+		driverName = flag.String("driver-name", driver.DefaultDriverName, "Name for the driver")
+		version    = flag.Bool("version", false, "Print the version and exit.")
 	)
 	flag.Parse()
 
@@ -40,7 +41,7 @@ func main() {
 		os.Exit(0)
 	}
 
-	drv, err := driver.NewDriver(*endpoint, *token, *url, *doTag)
+	drv, err := driver.NewDriver(*endpoint, *token, *url, *doTag, *driverName)
 	if err != nil {
 		log.Fatalln(err)
 	}

driver/controller.go

@@ -41,10 +41,6 @@ const (
 )
 
 const (
-	// PublishInfoVolumeName is used to pass the volume name from
-	// `ControllerPublishVolume` to `NodeStageVolume or `NodePublishVolume`
-	PublishInfoVolumeName = DriverName + "/volume-name"
-
 	// minimumVolumeSizeInBytes is used to validate that the user is not trying
 	// to create a volume that is smaller than what we support
 	minimumVolumeSizeInBytes int64 = 1 * giB
@@ -304,7 +300,7 @@ func (d *Driver) ControllerPublishVolume(ctx context.Context, req *csi.Controlle
 			ll.Info("volume is already attached")
 			return &csi.ControllerPublishVolumeResponse{
 				PublishContext: map[string]string{
-					PublishInfoVolumeName: vol.Name,
+					d.publishInfoVolumeName: vol.Name,
 				},
 			}, nil
 		}
@@ -329,7 +325,7 @@ func (d *Driver) ControllerPublishVolume(ctx context.Context, req *csi.Controlle
 				}).Warn("assuming volume is attached already")
 				return &csi.ControllerPublishVolumeResponse{
 					PublishContext: map[string]string{
-						PublishInfoVolumeName: vol.Name,
+						d.publishInfoVolumeName: vol.Name,
 					},
 				}, nil
 			}
@@ -357,7 +353,7 @@ func (d *Driver) ControllerPublishVolume(ctx context.Context, req *csi.Controlle
 	ll.Info("volume is attached")
 	return &csi.ControllerPublishVolumeResponse{
 		PublishContext: map[string]string{
-			PublishInfoVolumeName: vol.Name,
+			d.publishInfoVolumeName: vol.Name,
 		},
 	}, nil
 }

driver/driver.go

@@ -36,9 +36,9 @@ import (
 )
 
 const (
-	// DriverName defines the name that is used in Kubernetes and the CSI
+	// DefaultDriverName defines the name that is used in Kubernetes and the CSI
 	// system for the canonical, official name of this plugin
-	DriverName = "dobs.csi.digitalocean.com"
+	DefaultDriverName = "dobs.csi.digitalocean.com"
 )
 
 var (
@@ -54,6 +54,11 @@ var (
 //   csi.NodeServer
 //
 type Driver struct {
+	name string
+	// publishInfoVolumeName is used to pass the volume name from
+	// `ControllerPublishVolume` to `NodeStageVolume or `NodePublishVolume`
+	publishInfoVolumeName string
+
 	endpoint     string
 	nodeId       string
 	region       string
@@ -80,7 +85,11 @@ type Driver struct {
 // NewDriver returns a CSI plugin that contains the necessary gRPC
 // interfaces to interact with Kubernetes over unix domain sockets for
 // managaing DigitalOcean Block Storage
-func NewDriver(ep, token, url, doTag string) (*Driver, error) {
+func NewDriver(ep, token, url, doTag, driverName string) (*Driver, error) {
+	if driverName == "" {
+		driverName = DefaultDriverName
+	}
+
 	tokenSource := oauth2.StaticTokenSource(&oauth2.Token{
 		AccessToken: token,
 	})
@@ -114,6 +123,9 @@ func NewDriver(ep, token, url, doTag string) (*Driver, error) {
 	})
 
 	return &Driver{
+		name:                  driverName,
+		publishInfoVolumeName: driverName + "/volume-name",
+
 		doTag:    doTag,
 		endpoint: ep,
 		nodeId:   nodeId,

driver/driver_test.go

@@ -68,6 +68,7 @@ func TestDriverSuite(t *testing.T) {
 	}
 
 	driver := &Driver{
+		name:     DefaultDriverName,
 		endpoint: endpoint,
 		nodeId:   strconv.Itoa(nodeID),
 		doTag:    doTag,

driver/identity.go

@@ -27,7 +27,7 @@ import (
 // GetPluginInfo returns metadata of the plugin
 func (d *Driver) GetPluginInfo(ctx context.Context, req *csi.GetPluginInfoRequest) (*csi.GetPluginInfoResponse, error) {
 	resp := &csi.GetPluginInfoResponse{
-		Name:          DriverName,
+		Name:          d.name,
 		VendorVersion: version,
 	}