add custom useragent to all aws requests

kubernetes-sigs · Jun 1, 2021 · a17ddc8 · a17ddc8
1 parent 7f908fc
commit a17ddc8
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 2 deletions.
diff --git a/Makefile b/Makefile
@@ -18,7 +18,7 @@ VERSION=v1.0.0
 VERSION_AMAZONLINUX=$(VERSION)-amazonlinux
 GIT_COMMIT?=$(shell git rev-parse HEAD)
 BUILD_DATE?=$(shell date -u +"%Y-%m-%dT%H:%M:%SZ")
-LDFLAGS?="-X ${PKG}/pkg/driver.driverVersion=${VERSION} -X ${PKG}/pkg/driver.gitCommit=${GIT_COMMIT} -X ${PKG}/pkg/driver.buildDate=${BUILD_DATE} -s -w"
+LDFLAGS?="-X ${PKG}/pkg/driver.driverVersion=${VERSION} -X ${PKG}/pkg/cloud.driverVersion=${VERSION} -X ${PKG}/pkg/driver.gitCommit=${GIT_COMMIT} -X ${PKG}/pkg/driver.buildDate=${BUILD_DATE} -s -w"
 GO111MODULE=on
 GOPROXY=direct
 GOPATH=$(shell go env GOPATH)

diff --git a/charts/aws-ebs-csi-driver/Chart.yaml b/charts/aws-ebs-csi-driver/Chart.yaml
@@ -2,7 +2,7 @@ apiVersion: v1
 appVersion: "1.0.0"
 name: aws-ebs-csi-driver
 description: A Helm chart for AWS EBS CSI Driver
-version: 1.2.0
+version: 1.3.0
 kubeVersion: ">=1.17.0-0"
 home: https://github.com/kubernetes-sigs/aws-ebs-csi-driver
 sources:

diff --git a/charts/aws-ebs-csi-driver/templates/controller.yaml b/charts/aws-ebs-csi-driver/templates/controller.yaml
@@ -79,6 +79,8 @@ spec:
             - --logtostderr
             - --v=2
           env:
+            - name: CSI_DRIVER_NAME
+              value: {{ .Chart.Name }}
             - name: CSI_ENDPOINT
               value: unix:///var/lib/csi/sockets/pluginproxy/csi.sock
             - name: CSI_NODE_NAME

diff --git a/deploy/kubernetes/base/controller.yaml b/deploy/kubernetes/base/controller.yaml
@@ -39,6 +39,8 @@ spec:
             - --logtostderr
             - --v=2
           env:
+            - name: CSI_DRIVER_NAME
+              value: aws-ebs-csi-driver
             - name: CSI_ENDPOINT
               value: unix:///var/lib/csi/sockets/pluginproxy/csi.sock
             - name: CSI_NODE_NAME

diff --git a/pkg/cloud/cloud.go b/pkg/cloud/cloud.go
@@ -153,6 +153,9 @@ var (
 	VolumeNotBeingModified = fmt.Errorf("volume is not being modified")
 )
 
+// Set during build time via -ldflags
+var driverVersion string
+
 // Disk represents a EBS volume
 type Disk struct {
 	VolumeID         string
@@ -239,6 +242,9 @@ func newEC2Cloud(region string, awsSdkDebugLog bool) (Cloud, error) {
 		awsConfig.WithLogLevel(aws.LogDebugWithRequestErrors)
 	}
 
+	// Set the env var so that the session appends custom user agent string
+	os.Setenv("AWS_EXECUTION_ENV", userAgent())
+
 	svc := ec2.New(session.Must(session.NewSession(awsConfig)))
 	svc.Handlers.AfterRetry.PushFrontNamed(request.NamedHandler{
 		Name: "recordThrottledRequestsHandler",
@@ -1191,3 +1197,11 @@ func capIOPS(volumeType string, requestedCapacityGiB int64, requstedIOPSPerGB, m
 	}
 	return iops, nil
 }
+
+func userAgent() string {
+	appName := os.Getenv("CSI_DRIVER_NAME")
+	if len(appName) == 0 {
+		appName = "aws-ebs-csi-driver"
+	}
+	return appName + "-" + driverVersion
+}