feat: add configuration for custom user agent (#965)

Author: aramase

go.sum

@@ -313,6 +313,7 @@ golang.org/x/mobile v0.0.0-20190312151609-d3739f865fa6/go.mod h1:z+o9i4GpDbdi3rU
 golang.org/x/mobile v0.0.0-20190719004257-d2bd2a29d028/go.mod h1:E/iHnbuqvinMTCcRqshq8CkpyQDoeVncDDYHnLhea+o=
 golang.org/x/mod v0.0.0-20190513183733-4bf6d317e70e/go.mod h1:mXi4GBBbnImb6dmsKGUJ2LatrhH/nqhxcFungHvyanc=
 golang.org/x/mod v0.1.0/go.mod h1:0QHyrYULN0/3qlju5TqG8bIK38QM8yzMo5ekMj3DlcY=
+golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee h1:WG0RUwxtNT4qqaXX3DPA8zHFNm/D9xaBpxzHt1WcA/E=
 golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg=
 golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
 golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=

manifest_staging/charts/aad-pod-identity/README.md

@@ -289,6 +289,7 @@ The following tables list the configurable parameters of the aad-pod-identity ch
 | `rbac.allowAccessToSecrets`               | NMI requires permissions to get secrets when service principal (type: 1) is used in AzureIdentity. If using only MSI (type: 0) in AzureIdentity, secret get permission can be disabled by setting this to false.                                                                                                              | `true`                                                         |
 | `azureIdentities`                         | Map of azure identities and azure identity bindings resources to create. The map key is the `AzureIdentity` name.                                                                                                                                                                                                             | `{}`                                                           |
 | `installCRDs`                             | If true, install necessary custom resources                                                                                                                                                                                                                                                                                   | `false`                                                        |
+| `customUserAgent`                         | Custom user agent to add to ADAL, ARM and Kubernetes API server requests                                                                                                                                                                                                                                                      | `""`                                                           |
 
 ## Troubleshooting
 

manifest_staging/charts/aad-pod-identity/templates/mic-deployment.yaml

@@ -89,6 +89,9 @@ spec:
           {{- if .Values.mic.identityAssignmentReconcileInterval }}
           - --identity-assignment-reconcile-interval={{ .Values.mic.identityAssignmentReconcileInterval }}
           {{- end }}
+          {{- if .Values.customUserAgent }}
+          - --custom-user-agent={{ .Values.customUserAgent }}
+          {{- end }}
         {{- if not .Values.adminsecret }}
         securityContext:
           runAsUser: 0

manifest_staging/charts/aad-pod-identity/templates/nmi-daemonset.yaml

@@ -107,6 +107,9 @@ spec:
           {{- if semverCompare ">= 1.7.0-0" .Values.nmi.tag }}
           - --kubelet-config={{ .Values.nmi.kubeletConfig }}
           {{- end }}
+          {{- if .Values.customUserAgent }}
+          - --custom-user-agent={{ .Values.customUserAgent }}
+          {{- end }}
         env:
           {{- if semverCompare "<= 1.6.1-0" .Values.nmi.tag }}
           - name: HOST_IP

manifest_staging/charts/aad-pod-identity/values.yaml

@@ -245,3 +245,7 @@ azureIdentities:
 
 # If true, install necessary custom resources.
 installCRDs: false
+
+# If provided, the userAgent string will be appended to the pod identity user agents for all
+# ADAL, ARM and Kube API server requests.
+customUserAgent: ""

test/e2e/framework/helm/helm_helpers.go

@@ -12,6 +12,7 @@ import (
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
+	"golang.org/x/mod/semver"
 )
 
 const (
@@ -101,6 +102,11 @@ func generateValueArgs(config *framework.Config) []string {
 		fmt.Sprintf("--set=nmi.tag=%s", config.NMIVersion),
 	}
 
+	// TODO (aramase) bump this to compare against v1.7.3 after next release
+	if semver.Compare(config.MICVersion, "v1.7.2") > 1 && semver.Compare(config.NMIVersion, "v1.7.2") > 1 {
+		args = append(args, fmt.Sprintf("--set=customUserAgent=pi-e2e"))
+	}
+
 	if config.ImmutableUserMSIs != "" {
 		args = append(args, fmt.Sprintf("--set=mic.immutableUserMSIs=%s", config.ImmutableUserMSIs))
 	}

version/version.go

@@ -1,26 +1,32 @@
 package version
 
 import (
+	"flag"
 	"fmt"
 	"os"
 )
 
-// BuildDate is the date when the binary was built
-var BuildDate string
+var (
+	// BuildDate is the date when the binary was built
+	BuildDate string
+	// GitCommit is the commit hash when the binary was built
+	GitCommit string
+	// MICVersion is the version of the MIC component
+	MICVersion string
+	// NMIVersion is the version of the NMI component
+	NMIVersion string
 
-// GitCommit is the commit hash when the binary was built
-var GitCommit string
-
-// MICVersion is the version of the MIC component
-var MICVersion string
-
-// NMIVersion is the version of the NMI component
-var NMIVersion string
+	// custom user agent to append for adal and arm calls
+	customUserAgent = flag.String("custom-user-agent", "", "User agent to append in addition to pod identity component and versions.")
+)
 
 // GetUserAgent is used to get the user agent string which is then provided to adal
 // to use as the extended user agent header.
 // The format is: aad-pod-identity/<component - either NMI or MIC>/<Version of component>/<Git commit>/<Build date>
 func GetUserAgent(component, version string) string {
+	if *customUserAgent != "" {
+		return fmt.Sprintf("aad-pod-identity/%s/%s/%s/%s %s", component, version, GitCommit, BuildDate, *customUserAgent)
+	}
 	return fmt.Sprintf("aad-pod-identity/%s/%s/%s/%s", component, version, GitCommit, BuildDate)
 }
 

version/version_test.go

@@ -16,3 +16,36 @@ func TestVersion(t *testing.T) {
 		t.Fatalf("got unexpected user agent string: %s. Expected: %s.", gotUserAgentStr, expectedUserAgentStr)
 	}
 }
+
+func TestGetUserAgent(t *testing.T) {
+	BuildDate = "now"
+	GitCommit = "commit"
+	NMIVersion = "version"
+
+	tests := []struct {
+		name              string
+		customUserAgent   string
+		expectedUserAgent string
+	}{
+		{
+			name:              "default NMI user agent",
+			customUserAgent:   "",
+			expectedUserAgent: "aad-pod-identity/NMI/version/commit/now",
+		},
+		{
+			name:              "default NMI user agent and custom user agent",
+			customUserAgent:   "managedBy:aks",
+			expectedUserAgent: "aad-pod-identity/NMI/version/commit/now managedBy:aks",
+		},
+	}
+
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			customUserAgent = &test.customUserAgent
+			actualUserAgent := GetUserAgent("NMI", NMIVersion)
+			if !strings.EqualFold(test.expectedUserAgent, actualUserAgent) {
+				t.Fatalf("got unexpected user agent string: %s. Expected: %s.", test.expectedUserAgent, actualUserAgent)
+			}
+		})
+	}
+}