Add a cmdline option to add extra volume tags

Add a new cli command option `--extra-volume-tags` which is a map of string to string (syntax is similar to `--node-labels` for kubelet). By default, it's an empty map which maps the the current behavior. If this option is not empty, when doing dynamic provisioning (i.e., in `CreateVolume`), we always attach the extra volume tags when calling `d.cloud.CreateDisk`.
kubernetes-sigs · Oct 31, 2019 · 06e8528 · 06e8528
1 parent 8f0b542
commit 06e8528
Show file tree

Hide file tree

Showing 12 changed files with 496 additions and 60 deletions.
diff --git a/cmd/main.go b/cmd/main.go
@@ -22,18 +22,25 @@ import (
 	"os"
 
 	"github.com/kubernetes-sigs/aws-ebs-csi-driver/pkg/driver"
+	cliflag "k8s.io/component-base/cli/flag"
 	"k8s.io/klog"
 )
 
 func main() {
 	var (
-		endpoint = flag.String("endpoint", "unix://tmp/csi.sock", "CSI Endpoint")
-		version  = flag.Bool("version", false, "Print the version and exit.")
+		version         bool
+		endpoint        string
+		extraVolumeTags map[string]string
 	)
+
+	flag.BoolVar(&version, "version", false, "Print the version and exit.")
+	flag.StringVar(&endpoint, "endpoint", driver.DefaultCSIEndpoint, "CSI Endpoint")
+	flag.Var(cliflag.NewMapStringString(&extraVolumeTags), "extra-volume-tags", "Extra volume tags to attach to each dynamically provisioned volume. It is a comma separated list of key value pairs like '<key1>=<value1>,<key2>=<value2>'")
+
 	klog.InitFlags(nil)
 	flag.Parse()
 
-	if *version {
+	if version {
 		info, err := driver.GetVersionJSON()
 		if err != nil {
 			klog.Fatalln(err)
@@ -42,7 +49,10 @@ func main() {
 		os.Exit(0)
 	}
 
-	drv, err := driver.NewDriver(*endpoint)
+	drv, err := driver.NewDriver(
+		driver.WithEndpoint(endpoint),
+		driver.WithExtraVolumeTags(extraVolumeTags),
+	)
 	if err != nil {
 		klog.Fatalln(err)
 	}

diff --git a/go.mod b/go.mod
@@ -55,6 +55,7 @@ require (
 	k8s.io/api v0.0.0
 	k8s.io/apimachinery v0.0.0
 	k8s.io/client-go v0.0.0
+	k8s.io/component-base v0.0.0
 	k8s.io/klog v0.4.0
 	k8s.io/kubernetes v1.15.2
 )

diff --git a/go.sum b/go.sum
@@ -23,6 +23,7 @@ github.com/asaskevich/govalidator v0.0.0-20180720115003-f9ffefc3facf/go.mod h1:l
 github.com/auth0/go-jwt-middleware v0.0.0-20170425171159-5493cabe49f7/go.mod h1:LWMyo4iOLWXHGdBki7NIht1kHru/0wM179h+d3g8ATM=
 github.com/aws/aws-k8s-tester/e2e/tester v0.0.0-20190907061006-260b0e114d90 h1:FRpHLOVjM/FO/sl84ilNQWATtRd1FR6uk7UUs8MUl5Y=
 github.com/aws/aws-k8s-tester/e2e/tester v0.0.0-20190907061006-260b0e114d90/go.mod h1:xCa3ZGICI7/IqtJdYjEsM3QL9vwlLHxgwSA/MD09Zgo=
+github.com/aws/aws-sdk-go v1.16.26/go.mod h1:KmX6BPdI08NWTb3/sm4ZGu5ShLoqVDhKgpiN924inxo=
 github.com/aws/aws-sdk-go v1.23.21 h1:eVJT2C99cAjZlBY8+CJovf6AwrSANzAcYNuxdCB+SPk=
 github.com/aws/aws-sdk-go v1.23.21/go.mod h1:KmX6BPdI08NWTb3/sm4ZGu5ShLoqVDhKgpiN924inxo=
 github.com/bazelbuild/bazel-gazelle v0.0.0-20181012220611-c728ce9f663e/go.mod h1:uHBSeeATKpVazAACZBDPL/Nk/UhQDDsJWDlqYJo8/Us=

diff --git a/pkg/cloud/cloud.go b/pkg/cloud/cloud.go
@@ -60,12 +60,20 @@ var (
 )
 
 // AWS provisioning limits.
-// Source: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
+// Sources:
+//   http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
+//   https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-restrictions
 const (
 	// MinTotalIOPS represents the minimum Input Output per second.
 	MinTotalIOPS = 100
 	// MaxTotalIOPS represents the maximum Input Output per second.
 	MaxTotalIOPS = 20000
+	// MaxNumTagsPerResource represents the maximum number of tags per AWS resource.
+	MaxNumTagsPerResource = 50
+	// MaxTagKeyLength represents the maximum key length for a tag.
+	MaxTagKeyLength = 128
+	// MaxTagValueLength represents the maximum value length for a tag.
+	MaxTagValueLength = 256
 )
 
 // Defaults
@@ -82,6 +90,10 @@ const (
 	VolumeNameTagKey = "CSIVolumeName"
 	// SnapshotNameTagKey is the key value that refers to the snapshot's name.
 	SnapshotNameTagKey = "CSIVolumeSnapshotName"
+	// KubernetesTagKeyPrefix is the prefix of the key value that is reserved for Kubernetes.
+	KubernetesTagKeyPrefix = "kubernetes.io"
+	// AWSTagKeyPrefix is the prefix of the key value that is reserved for AWS.
+	AWSTagKeyPrefix = "aws:"
 )
 
 var (

diff --git a/pkg/driver/constants.go b/pkg/driver/constants.go
@@ -37,3 +37,8 @@ const (
 	// KmsKeyId represents key for KMS encryption key
 	KmsKeyIdKey = "kmskeyid"
 )
+
+// constants for default command line flag values
+const (
+	DefaultCSIEndpoint = "unix://tmp/csi.sock"
+)
diff --git a/pkg/driver/controller.go b/pkg/driver/controller.go
@@ -52,19 +52,21 @@ var (
 
 // controllerService represents the controller service of CSI driver
 type controllerService struct {
-	cloud cloud.Cloud
+	cloud         cloud.Cloud
+	driverOptions *DriverOptions
 }
 
 // newControllerService creates a new controller service
 // it panics if failed to create the service
-func newControllerService() controllerService {
+func newControllerService(driverOptions *DriverOptions) controllerService {
 	cloud, err := cloud.NewCloud()
 	if err != nil {
 		panic(err)
 	}
 
 	return controllerService{
-		cloud: cloud,
+		cloud:         cloud,
+		driverOptions: driverOptions,
 	}
 }
 
@@ -140,9 +142,17 @@ func (d *controllerService) CreateVolume(ctx context.Context, req *csi.CreateVol
 
 	// create a new volume
 	zone := pickAvailabilityZone(req.GetAccessibilityRequirements())
+
+	volumeTags := map[string]string{
+		cloud.VolumeNameTagKey: volName,
+	}
+	for k, v := range d.driverOptions.extraVolumeTags {
+		volumeTags[k] = v
+	}
+
 	opts := &cloud.DiskOptions{
 		CapacityBytes:    volSizeBytes,
-		Tags:             map[string]string{cloud.VolumeNameTagKey: volName},
+		Tags:             volumeTags,
 		VolumeType:       volumeType,
 		IOPSPerGB:        iopsPerGB,
 		AvailabilityZone: zone,