Use apimachinery/pkg/util/cache for caching

Signed-off-by: Stephen Hoekstra <[email protected]>

Author: shoekstra

docs/deploy/configurations.md

@@ -71,7 +71,7 @@ Currently, you can set only 1 namespace to watch in this flag. See [this Kuberne
 |aws-api-throttle                       | AWS Throttle Config             | [default value](#default-throttle-config ) | throttle settings for AWS APIs, format: serviceID1:operationRegex1=rate:burst,serviceID2:operationRegex2=rate:burst |
 |aws-max-retries                        | int                             | 10              | Maximum retries for AWS APIs |
 |aws-region                             | string                          | [instance metadata](#instance-metadata)    | AWS Region for the kubernetes cluster |
-|aws-vpc-cache-duration                 | string                          | 10m             | Length of time in minutes to cache VPC info |
+|aws-vpc-cache-ttl                      | string                          | 10m             | Length of time in minutes to cache VPC info |
 |aws-vpc-id                             | string                          | [instance metadata](#instance-metadata)    | ID of the AWS VPC where Load Balancer resources will be created |
 |cluster-name                           | string                          |                 | Kubernetes cluster name|
 |default-tags                           | stringMap                       |                 | AWS Tags that will be applied to all AWS resources managed by this controller. Specified Tags takes highest priority |

go.mod

@@ -10,7 +10,6 @@ require (
 	github.com/google/go-cmp v0.5.6
 	github.com/onsi/ginkgo v1.16.4
 	github.com/onsi/gomega v1.16.0
-	github.com/patrickmn/go-cache v2.1.0+incompatible
 	github.com/pkg/errors v0.9.1
 	github.com/prometheus/client_golang v1.11.0
 	github.com/spf13/pflag v1.0.5

go.sum

@@ -643,9 +643,6 @@ github.com/openzipkin/zipkin-go v0.2.1/go.mod h1:NaW6tEwdmWMaCDZzg8sh+IBNOxHMPnh
 github.com/openzipkin/zipkin-go v0.2.2/go.mod h1:NaW6tEwdmWMaCDZzg8sh+IBNOxHMPnhQw8ySjnjRyN4=
 github.com/pact-foundation/pact-go v1.0.4/go.mod h1:uExwJY4kCzNPcHRj+hCR/HBbOOIwwtUjcrb0b5/5kLM=
 github.com/pascaldekloe/goe v0.0.0-20180627143212-57f6aae5913c/go.mod h1:lzWF7FIEvWOWxwDKqyGYQf6ZUaNfKdP144TG7ZOy1lc=
-github.com/patrickmn/go-cache v1.0.0 h1:3gD5McaYs9CxjyK5AXGcq8gdeCARtd/9gJDUvVeaZ0Y=
-github.com/patrickmn/go-cache v2.1.0+incompatible h1:HRMgzkcYKYpi3C8ajMPV8OFXaaRUnok+kx1WdO15EQc=
-github.com/patrickmn/go-cache v2.1.0+incompatible/go.mod h1:3Qf8kWWT7OJRJbdiICTKqZju1ZixQ/KpMGzzAfe6+WQ=
 github.com/pborman/uuid v1.2.0 h1:J7Q5mO4ysT1dv8hyrUGHb9+ooztCXu1D8MY8DZYsu3g=
 github.com/pborman/uuid v1.2.0/go.mod h1:X/NO0urCmaxf9VXbdlT7C2Yzkj2IKimNn4k+gtPdI/k=
 github.com/pelletier/go-toml v1.2.0/go.mod h1:5z9KED0ma1S8pY6P1sdut58dfprrGBbd/94hg7ilaic=

main.go

@@ -103,7 +103,7 @@ func main() {
 	sgManager := networking.NewDefaultSecurityGroupManager(cloud.EC2(), ctrl.Log)
 	sgReconciler := networking.NewDefaultSecurityGroupReconciler(sgManager, ctrl.Log)
 	azInfoProvider := networking.NewDefaultAZInfoProvider(cloud.EC2(), ctrl.Log.WithName("az-info-provider"))
-	vpcInfoProvider := networking.NewDefaultVPCInfoProvider(cloud.VpcCacheDuration(), cloud.EC2(), ctrl.Log.WithName("vpc-info-provider"))
+	vpcInfoProvider := networking.NewDefaultVPCInfoProvider(cloud.EC2(), ctrl.Log.WithName("vpc-info-provider"), cloud.VpcCacheTTL())
 	subnetResolver := networking.NewDefaultSubnetsResolver(azInfoProvider, cloud.EC2(), cloud.VpcID(), controllerCFG.ClusterName, ctrl.Log.WithName("subnets-resolver"))
 	vpcResolver := networking.NewDefaultVPCResolver(cloud.EC2(), cloud.VpcID(), ctrl.Log.WithName("vpc-resolver"))
 	tgbResManager := targetgroupbinding.NewDefaultResourceManager(mgr.GetClient(), cloud.ELBV2(), cloud.EC2(),

pkg/aws/cloud.go

@@ -43,8 +43,8 @@ type Cloud interface {
 	// ID of VPC to create load balancers in
 	VpcID() string
 
-	// VPC cache duration in minutes
-	VpcCacheDuration() time.Duration
+	// VPC cache TTL in minutes
+	VpcCacheTTL() time.Duration
 }
 
 // NewCloud constructs new Cloud implementation.
@@ -155,6 +155,6 @@ func (c *defaultCloud) VpcID() string {
 	return c.cfg.VpcID
 }
 
-func (c *defaultCloud) VpcCacheDuration() time.Duration {
-	return c.cfg.VpcCacheDuration
+func (c *defaultCloud) VpcCacheTTL() time.Duration {
+	return c.cfg.VpcCacheTTL
 }

pkg/aws/cloud_config.go

@@ -8,16 +8,16 @@ import (
 )
 
 const (
-	flagAWSRegion           = "aws-region"
-	flagAWSAPIEndpoints     = "aws-api-endpoints"
-	flagAWSAPIThrottle      = "aws-api-throttle"
-	flagAWSVpcID            = "aws-vpc-id"
-	flagAWSVpcCacheDuration = "aws-vpc-cache-duration"
-	flagAWSMaxRetries       = "aws-max-retries"
-	defaultVpcID            = ""
-	defaultRegion           = ""
-	defaultAPIMaxRetries    = 10
-	defaultVpcCacheDuration = time.Minute * 10
+	flagAWSRegion        = "aws-region"
+	flagAWSAPIEndpoints  = "aws-api-endpoints"
+	flagAWSAPIThrottle   = "aws-api-throttle"
+	flagAWSVpcID         = "aws-vpc-id"
+	flagAWSVpcCacheTTL   = "aws-vpc-cache-ttl"
+	flagAWSMaxRetries    = "aws-max-retries"
+	defaultVpcID         = ""
+	defaultRegion        = ""
+	defaultAPIMaxRetries = 10
+	defaultVpcCacheTTL   = time.Minute * 10
 )
 
 type CloudConfig struct {
@@ -30,8 +30,8 @@ type CloudConfig struct {
 	// ID of VPC to create load balancers in
 	VpcID string
 
-	// VPC cache duration in minutes
-	VpcCacheDuration time.Duration
+	// VPC cache TTL in minutes
+	VpcCacheTTL time.Duration
 
 	// Max retries configuration for AWS APIs
 	MaxRetries int
@@ -44,7 +44,7 @@ func (cfg *CloudConfig) BindFlags(fs *pflag.FlagSet) {
 	fs.StringVar(&cfg.Region, flagAWSRegion, defaultRegion, "AWS Region for the kubernetes cluster")
 	fs.Var(cfg.ThrottleConfig, flagAWSAPIThrottle, "throttle settings for AWS APIs, format: serviceID1:operationRegex1=rate:burst,serviceID2:operationRegex2=rate:burst")
 	fs.StringVar(&cfg.VpcID, flagAWSVpcID, defaultVpcID, "AWS ID of VPC to create load balancers in")
-	fs.DurationVar(&cfg.VpcCacheDuration, flagAWSVpcCacheDuration, defaultVpcCacheDuration, "VPC cache duration in minutes")
+	fs.DurationVar(&cfg.VpcCacheTTL, flagAWSVpcCacheTTL, defaultVpcCacheTTL, "VPC cache TTL in minutes")
 	fs.IntVar(&cfg.MaxRetries, flagAWSMaxRetries, defaultAPIMaxRetries, "Maximum retries for AWS APIs")
 	fs.StringToStringVar(&cfg.AWSEndpoints, flagAWSAPIEndpoints, nil, "Custom AWS endpoint configuration, format: serviceID1=URL1,serviceID2=URL2")
 }

pkg/networking/vpc_info_provider.go

@@ -8,7 +8,7 @@ import (
 	awssdk "github.com/aws/aws-sdk-go/aws"
 	ec2sdk "github.com/aws/aws-sdk-go/service/ec2"
 	"github.com/go-logr/logr"
-	"github.com/patrickmn/go-cache"
+	"k8s.io/apimachinery/pkg/util/cache"
 	"sigs.k8s.io/aws-load-balancer-controller/pkg/aws/services"
 )
 
@@ -18,11 +18,12 @@ type VPCInfoProvider interface {
 }
 
 // NewDefaultVPCInfoProvider constructs new defaultVPCInfoProvider.
-func NewDefaultVPCInfoProvider(cacheDuration time.Duration, ec2Client services.EC2, logger logr.Logger) *defaultVPCInfoProvider {
+func NewDefaultVPCInfoProvider(ec2Client services.EC2, logger logr.Logger, vpcInfoCacheTTL time.Duration) *defaultVPCInfoProvider {
 	return &defaultVPCInfoProvider{
 		ec2Client:         ec2Client,
-		vpcInfoCache:      cache.New(time.Duration(cacheDuration)*time.Minute, 10*time.Minute),
+		vpcInfoCache:      cache.NewExpiring(),
 		vpcInfoCacheMutex: sync.RWMutex{},
+		vpcInfoCacheTTL:   vpcInfoCacheTTL,
 		logger:            logger,
 	}
 }
@@ -32,8 +33,9 @@ var _ VPCInfoProvider = &defaultVPCInfoProvider{}
 // default implementation for VPCInfoProvider.
 type defaultVPCInfoProvider struct {
 	ec2Client         services.EC2
-	vpcInfoCache      *cache.Cache
+	vpcInfoCache      *cache.Expiring
 	vpcInfoCacheMutex sync.RWMutex
+	vpcInfoCacheTTL   time.Duration
 
 	logger logr.Logger
 }
@@ -57,19 +59,18 @@ func (p *defaultVPCInfoProvider) fetchVPCInfoFromCache() *ec2sdk.Vpc {
 	p.vpcInfoCacheMutex.RLock()
 	defer p.vpcInfoCacheMutex.RUnlock()
 
-	vpcInfo, found := p.vpcInfoCache.Get("vpcInfo")
-	if !found {
-		return nil
+	if rawCacheItem, exists := p.vpcInfoCache.Get("vpcInfo"); exists {
+		return rawCacheItem.(*ec2sdk.Vpc)
 	}
 
-	return vpcInfo.(*ec2sdk.Vpc)
+	return nil
 }
 
 func (p *defaultVPCInfoProvider) saveVPCInfoToCache(vpcInfo *ec2sdk.Vpc) {
 	p.vpcInfoCacheMutex.Lock()
 	defer p.vpcInfoCacheMutex.Unlock()
 
-	p.vpcInfoCache.SetDefault("vpcInfo", vpcInfo)
+	p.vpcInfoCache.Set("vpcInfo", vpcInfo, p.vpcInfoCacheTTL)
 }
 
 // fetchVPCInfoFromAWS will fetch VPC info from the AWS API.

pkg/networking/vpc_info_provider_test.go

@@ -63,7 +63,7 @@ func Test_defaultVPCInfoProvider_FetchVPCInfo(t *testing.T) {
 	defer ctrl.Finish()
 
 	ec2Client := services.NewMockEC2(ctrl)
-	p := NewDefaultVPCInfoProvider(10*time.Minute, ec2Client, &log.NullLogger{})
+	p := NewDefaultVPCInfoProvider(ec2Client, &log.NullLogger{}, 10*time.Minute)
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {