Merge pull request kubernetes-sigs#665 from CecileRobertMichon/user-agent

k8s-ci-robot · web-flow · commit 5a7bedf05cb5 · 2020-06-01T14:42:14.000-07:00
✨Add version to user-agent for Azure API calls
diff --git a/cloud/defaults.go b/cloud/defaults.go
@@ -22,6 +22,7 @@ import (
 	"github.com/blang/semver"
 	"github.com/pkg/errors"
 	infrav1 "sigs.k8s.io/cluster-api-provider-azure/api/v1alpha3"
+	"sigs.k8s.io/cluster-api-provider-azure/version"
 )
 
 const (
@@ -31,8 +32,6 @@ const (
 	DefaultInternalLBIPAddress = "10.0.0.100"
 	// DefaultAzureDNSZone is the default provided azure dns zone
 	DefaultAzureDNSZone = "cloudapp.azure.com"
-	// UserAgent used for communicating with azure
-	UserAgent = "cluster-api-azure-services"
 )
 
 const (
@@ -127,3 +126,8 @@ func GetDefaultUbuntuImage(k8sVersion string) (*infrav1.Image, error) {
 
 	return defaultImage, nil
 }
+
+// UserAgent specifies a string to append to the agent identifier.
+func UserAgent() string {
+	return fmt.Sprintf("cluster-api-provider-azure/%s", version.Get().String())
+}
diff --git a/cloud/services/agentpools/client.go b/cloud/services/agentpools/client.go
@@ -49,7 +49,7 @@ func NewClient(subscriptionID string, authorizer autorest.Authorizer) *AzureClie
 func newAgentPoolsClient(subscriptionID string, authorizer autorest.Authorizer) containerservice.AgentPoolsClient {
 	agentPoolsClient := containerservice.NewAgentPoolsClient(subscriptionID)
 	agentPoolsClient.Authorizer = authorizer
-	agentPoolsClient.AddToUserAgent(azure.UserAgent)
+	agentPoolsClient.AddToUserAgent(azure.UserAgent())
 	return agentPoolsClient
 }
 
diff --git a/cloud/services/availabilityzones/client.go b/cloud/services/availabilityzones/client.go
@@ -46,7 +46,7 @@ func NewClient(subscriptionID string, authorizer autorest.Authorizer) *AzureClie
 func newResourceSkusClient(subscriptionID string, authorizer autorest.Authorizer) compute.ResourceSkusClient {
 	skusClient := compute.NewResourceSkusClient(subscriptionID)
 	skusClient.Authorizer = authorizer
-	skusClient.AddToUserAgent(azure.UserAgent)
+	skusClient.AddToUserAgent(azure.UserAgent())
 	return skusClient
 }
 
diff --git a/cloud/services/disks/client.go b/cloud/services/disks/client.go
@@ -46,7 +46,7 @@ func NewClient(subscriptionID string, authorizer autorest.Authorizer) *AzureClie
 func newDisksClient(subscriptionID string, authorizer autorest.Authorizer) compute.DisksClient {
 	disksClient := compute.NewDisksClient(subscriptionID)
 	disksClient.Authorizer = authorizer
-	disksClient.AddToUserAgent(azure.UserAgent)
+	disksClient.AddToUserAgent(azure.UserAgent())
 	return disksClient
 }
 
diff --git a/cloud/services/groups/client.go b/cloud/services/groups/client.go
@@ -48,7 +48,7 @@ func NewClient(subscriptionID string, authorizer autorest.Authorizer) *AzureClie
 func newGroupsClient(subscriptionID string, authorizer autorest.Authorizer) resources.GroupsClient {
 	groupsClient := resources.NewGroupsClient(subscriptionID)
 	groupsClient.Authorizer = authorizer
-	groupsClient.AddToUserAgent(azure.UserAgent)
+	groupsClient.AddToUserAgent(azure.UserAgent())
 	return groupsClient
 }
 
diff --git a/cloud/services/inboundnatrules/client.go b/cloud/services/inboundnatrules/client.go
@@ -48,7 +48,7 @@ func NewClient(subscriptionID string, authorizer autorest.Authorizer) *AzureClie
 func newInboundNatRulesClient(subscriptionID string, authorizer autorest.Authorizer) network.InboundNatRulesClient {
 	inboundNatRulesClient := network.NewInboundNatRulesClient(subscriptionID)
 	inboundNatRulesClient.Authorizer = authorizer
-	inboundNatRulesClient.AddToUserAgent(azure.UserAgent)
+	inboundNatRulesClient.AddToUserAgent(azure.UserAgent())
 	return inboundNatRulesClient
 }
 
diff --git a/cloud/services/internalloadbalancers/client.go b/cloud/services/internalloadbalancers/client.go
@@ -48,7 +48,7 @@ func NewClient(subscriptionID string, authorizer autorest.Authorizer) *AzureClie
 func newLoadBalancersClient(subscriptionID string, authorizer autorest.Authorizer) network.LoadBalancersClient {
 	loadBalancersClient := network.NewLoadBalancersClient(subscriptionID)
 	loadBalancersClient.Authorizer = authorizer
-	loadBalancersClient.AddToUserAgent(azure.UserAgent)
+	loadBalancersClient.AddToUserAgent(azure.UserAgent())
 	return loadBalancersClient
 }
 
diff --git a/cloud/services/managedclusters/client.go b/cloud/services/managedclusters/client.go
@@ -51,7 +51,7 @@ func NewClient(subscriptionID string, authorizer autorest.Authorizer) *AzureClie
 func newManagedClustersClient(subscriptionID string, authorizer autorest.Authorizer) containerservice.ManagedClustersClient {
 	managedClustersClient := containerservice.NewManagedClustersClient(subscriptionID)
 	managedClustersClient.Authorizer = authorizer
-	managedClustersClient.AddToUserAgent(azure.UserAgent)
+	managedClustersClient.AddToUserAgent(azure.UserAgent())
 	return managedClustersClient
 }
 
diff --git a/cloud/services/networkinterfaces/client.go b/cloud/services/networkinterfaces/client.go
@@ -48,7 +48,7 @@ func NewClient(subscriptionID string, authorizer autorest.Authorizer) *AzureClie
 func newInterfacesClient(subscriptionID string, authorizer autorest.Authorizer) network.InterfacesClient {
 	nicClient := network.NewInterfacesClient(subscriptionID)
 	nicClient.Authorizer = authorizer
-	nicClient.AddToUserAgent(azure.UserAgent)
+	nicClient.AddToUserAgent(azure.UserAgent())
 	return nicClient
 }
 
diff --git a/cloud/services/publicips/client.go b/cloud/services/publicips/client.go
@@ -48,7 +48,7 @@ func NewClient(subscriptionID string, authorizer autorest.Authorizer) *AzureClie
 func newPublicIPAddressesClient(subscriptionID string, authorizer autorest.Authorizer) network.PublicIPAddressesClient {
 	publicIPsClient := network.NewPublicIPAddressesClient(subscriptionID)
 	publicIPsClient.Authorizer = authorizer
-	publicIPsClient.AddToUserAgent(azure.UserAgent)
+	publicIPsClient.AddToUserAgent(azure.UserAgent())
 	return publicIPsClient
 }
 
diff --git a/cloud/services/publicloadbalancers/client.go b/cloud/services/publicloadbalancers/client.go
@@ -48,7 +48,7 @@ func NewClient(subscriptionID string, authorizer autorest.Authorizer) *AzureClie
 func newLoadBalancersClient(subscriptionID string, authorizer autorest.Authorizer) network.LoadBalancersClient {
 	loadBalancersClient := network.NewLoadBalancersClient(subscriptionID)
 	loadBalancersClient.Authorizer = authorizer
-	loadBalancersClient.AddToUserAgent(azure.UserAgent)
+	loadBalancersClient.AddToUserAgent(azure.UserAgent())
 	return loadBalancersClient
 }
 
diff --git a/cloud/services/resourceskus/client.go b/cloud/services/resourceskus/client.go
@@ -51,7 +51,7 @@ func NewClient(subscriptionID string, authorizer autorest.Authorizer) *AzureClie
 func newResourceSkusClient(subscriptionID string, authorizer autorest.Authorizer) compute.ResourceSkusClient {
 	c := compute.NewResourceSkusClient(subscriptionID)
 	c.Authorizer = authorizer
-	_ = c.AddToUserAgent(azure.UserAgent) // intentionally ignore error as it doesn't matter
+	_ = c.AddToUserAgent(azure.UserAgent()) // intentionally ignore error as it doesn't matter
 	return c
 }
 
diff --git a/cloud/services/roleassignments/client.go b/cloud/services/roleassignments/client.go
@@ -46,7 +46,7 @@ func NewClient(subscriptionID string, authorizer autorest.Authorizer) *AzureClie
 func newRoleAssignmentClient(subscriptionID string, authorizer autorest.Authorizer) authorization.RoleAssignmentsClient {
 	roleClient := authorization.NewRoleAssignmentsClient(subscriptionID)
 	roleClient.Authorizer = authorizer
-	roleClient.AddToUserAgent(azure.UserAgent)
+	roleClient.AddToUserAgent(azure.UserAgent())
 	return roleClient
 }
 
diff --git a/cloud/services/routetables/client.go b/cloud/services/routetables/client.go
@@ -48,7 +48,7 @@ func NewClient(subscriptionID string, authorizer autorest.Authorizer) *AzureClie
 func newRouteTablesClient(subscriptionID string, authorizer autorest.Authorizer) network.RouteTablesClient {
 	routeTablesClient := network.NewRouteTablesClient(subscriptionID)
 	routeTablesClient.Authorizer = authorizer
-	routeTablesClient.AddToUserAgent(azure.UserAgent)
+	routeTablesClient.AddToUserAgent(azure.UserAgent())
 	return routeTablesClient
 }
 
diff --git a/cloud/services/scalesets/client.go b/cloud/services/scalesets/client.go
@@ -59,23 +59,23 @@ func NewClient(subscriptionID string, authorizer autorest.Authorizer) *AzureClie
 func newVirtualMachineScaleSetVMsClient(subscriptionID string, authorizer autorest.Authorizer) compute.VirtualMachineScaleSetVMsClient {
 	c := compute.NewVirtualMachineScaleSetVMsClient(subscriptionID)
 	c.Authorizer = authorizer
-	_ = c.AddToUserAgent(azure.UserAgent) // intentionally ignore error as it doesn't matter
+	_ = c.AddToUserAgent(azure.UserAgent()) // intentionally ignore error as it doesn't matter
 	return c
 }
 
 // newVirtualMachineScaleSetsClient creates a new vmss client from subscription ID.
 func newVirtualMachineScaleSetsClient(subscriptionID string, authorizer autorest.Authorizer) compute.VirtualMachineScaleSetsClient {
 	c := compute.NewVirtualMachineScaleSetsClient(subscriptionID)
 	c.Authorizer = authorizer
-	_ = c.AddToUserAgent(azure.UserAgent) // intentionally ignore error as it doesn't matter
+	_ = c.AddToUserAgent(azure.UserAgent()) // intentionally ignore error as it doesn't matter
 	return c
 }
 
 // newPublicIPsClient creates a new publicIPs client from subscription ID.
 func newPublicIPsClient(subscriptionID string, authorizer autorest.Authorizer) network.PublicIPAddressesClient {
 	c := network.NewPublicIPAddressesClient(subscriptionID)
 	c.Authorizer = authorizer
-	_ = c.AddToUserAgent(azure.UserAgent) // intentionally ignore error as it doesn't matter
+	_ = c.AddToUserAgent(azure.UserAgent()) // intentionally ignore error as it doesn't matter
 	return c
 }
 
diff --git a/cloud/services/securitygroups/client.go b/cloud/services/securitygroups/client.go
@@ -18,6 +18,7 @@ package securitygroups
 
 import (
 	"context"
+
 	"github.com/Azure/azure-sdk-for-go/services/network/mgmt/2019-06-01/network"
 	"github.com/Azure/go-autorest/autorest"
 	azure "sigs.k8s.io/cluster-api-provider-azure/cloud"
@@ -47,7 +48,7 @@ func NewClient(subscriptionID string, authorizer autorest.Authorizer) *AzureClie
 func newSecurityGroupsClient(subscriptionID string, authorizer autorest.Authorizer) network.SecurityGroupsClient {
 	securityGroupsClient := network.NewSecurityGroupsClient(subscriptionID)
 	securityGroupsClient.Authorizer = authorizer
-	securityGroupsClient.AddToUserAgent(azure.UserAgent)
+	securityGroupsClient.AddToUserAgent(azure.UserAgent())
 	return securityGroupsClient
 }
 
diff --git a/cloud/services/subnets/client.go b/cloud/services/subnets/client.go
@@ -48,7 +48,7 @@ func NewClient(subscriptionID string, authorizer autorest.Authorizer) *AzureClie
 func newSubnetsClient(subscriptionID string, authorizer autorest.Authorizer) network.SubnetsClient {
 	subnetsClient := network.NewSubnetsClient(subscriptionID)
 	subnetsClient.Authorizer = authorizer
-	subnetsClient.AddToUserAgent(azure.UserAgent)
+	subnetsClient.AddToUserAgent(azure.UserAgent())
 	return subnetsClient
 }
 
diff --git a/cloud/services/virtualmachineextensions/client.go b/cloud/services/virtualmachineextensions/client.go
@@ -48,7 +48,7 @@ func NewClient(subscriptionID string, authorizer autorest.Authorizer) *AzureClie
 func newVirtualMachineExtensionsClient(subscriptionID string, authorizer autorest.Authorizer) compute.VirtualMachineExtensionsClient {
 	vmExtClient := compute.NewVirtualMachineExtensionsClient(subscriptionID)
 	vmExtClient.Authorizer = authorizer
-	vmExtClient.AddToUserAgent(azure.UserAgent)
+	vmExtClient.AddToUserAgent(azure.UserAgent())
 	return vmExtClient
 }
 
diff --git a/cloud/services/virtualmachines/client.go b/cloud/services/virtualmachines/client.go
@@ -48,7 +48,7 @@ func NewClient(subscriptionID string, authorizer autorest.Authorizer) *AzureClie
 func newVirtualMachinesClient(subscriptionID string, authorizer autorest.Authorizer) compute.VirtualMachinesClient {
 	vmClient := compute.NewVirtualMachinesClient(subscriptionID)
 	vmClient.Authorizer = authorizer
-	vmClient.AddToUserAgent(azure.UserAgent)
+	vmClient.AddToUserAgent(azure.UserAgent())
 	return vmClient
 }
 
diff --git a/cloud/services/virtualnetworks/client.go b/cloud/services/virtualnetworks/client.go
@@ -49,7 +49,7 @@ func NewClient(subscriptionID string, authorizer autorest.Authorizer) *AzureClie
 func newVirtualNetworksClient(subscriptionID string, authorizer autorest.Authorizer) network.VirtualNetworksClient {
 	vnetsClient := network.NewVirtualNetworksClient(subscriptionID)
 	vnetsClient.Authorizer = authorizer
-	vnetsClient.AddToUserAgent(azure.UserAgent)
+	vnetsClient.AddToUserAgent(azure.UserAgent())
 	return vnetsClient
 }
 

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ func NewClient(subscriptionID string, authorizer autorest.Authorizer) *AzureClie`
`49`	`49`	`func newAgentPoolsClient(subscriptionID string, authorizer autorest.Authorizer) containerservice.AgentPoolsClient {`
`50`	`50`	`agentPoolsClient := containerservice.NewAgentPoolsClient(subscriptionID)`
`51`	`51`	`agentPoolsClient.Authorizer = authorizer`
`52`		`- agentPoolsClient.AddToUserAgent(azure.UserAgent)`
	`52`	`+ agentPoolsClient.AddToUserAgent(azure.UserAgent())`
`53`	`53`	`return agentPoolsClient`
`54`	`54`	`}`
`55`	`55`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ func NewClient(subscriptionID string, authorizer autorest.Authorizer) *AzureClie`
`46`	`46`	`func newResourceSkusClient(subscriptionID string, authorizer autorest.Authorizer) compute.ResourceSkusClient {`
`47`	`47`	`skusClient := compute.NewResourceSkusClient(subscriptionID)`
`48`	`48`	`skusClient.Authorizer = authorizer`
`49`		`- skusClient.AddToUserAgent(azure.UserAgent)`
	`49`	`+ skusClient.AddToUserAgent(azure.UserAgent())`
`50`	`50`	`return skusClient`
`51`	`51`	`}`
`52`	`52`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ func NewClient(subscriptionID string, authorizer autorest.Authorizer) *AzureClie`
`48`	`48`	`func newGroupsClient(subscriptionID string, authorizer autorest.Authorizer) resources.GroupsClient {`
`49`	`49`	`groupsClient := resources.NewGroupsClient(subscriptionID)`
`50`	`50`	`groupsClient.Authorizer = authorizer`
`51`		`- groupsClient.AddToUserAgent(azure.UserAgent)`
	`51`	`+ groupsClient.AddToUserAgent(azure.UserAgent())`
`52`	`52`	`return groupsClient`
`53`	`53`	`}`
`54`	`54`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ func NewClient(subscriptionID string, authorizer autorest.Authorizer) *AzureClie`
`51`	`51`	`func newManagedClustersClient(subscriptionID string, authorizer autorest.Authorizer) containerservice.ManagedClustersClient {`
`52`	`52`	`managedClustersClient := containerservice.NewManagedClustersClient(subscriptionID)`
`53`	`53`	`managedClustersClient.Authorizer = authorizer`
`54`		`- managedClustersClient.AddToUserAgent(azure.UserAgent)`
	`54`	`+ managedClustersClient.AddToUserAgent(azure.UserAgent())`
`55`	`55`	`return managedClustersClient`
`56`	`56`	`}`
`57`	`57`