[WIP] feat: add cache provider implementation

cmd/registry/config-cache.yml

@@ -5,29 +5,30 @@ log:
     service: registry
     environment: development
 storage:
-    cache:
-        blobdescriptor: redis
     filesystem:
         rootdirectory: /var/lib/registry-cache
     maintenance:
         uploadpurging:
             enabled: false
+cache:
+    blobdescriptor:
+      provider: redis
+      params:
+        addr: localhost:6379
+        pool:
+          maxidle: 16
+          maxactive: 64
+          idletimeout: 300s
+        dialtimeout: 10ms
+        readtimeout: 10ms
+        writetimeout: 10ms
 http:
     addr: :5000
     secret: asecretforlocaldevelopment
     debug:
         addr: localhost:5001
     headers:
         X-Content-Type-Options: [nosniff]
-redis:
-  addr: localhost:6379
-  pool:
-    maxidle: 16
-    maxactive: 64
-    idletimeout: 300s
-  dialtimeout: 10ms
-  readtimeout: 10ms
-  writetimeout: 10ms
 notifications:
     events:
         includereferences: true

cmd/registry/config-dev.yml

@@ -7,13 +7,14 @@ log:
 storage:
     delete:
       enabled: true
-    cache:
-        blobdescriptor: inmemory
     filesystem:
         rootdirectory: /var/lib/registry
     maintenance:
         uploadpurging:
             enabled: false
+cache:
+    blobdescriptor:
+      provider: inmemory
 http:
     addr: :5000
     debug:

cmd/registry/config-example.yml

@@ -3,10 +3,11 @@ log:
   fields:
     service: registry
 storage:
-  cache:
-    blobdescriptor: inmemory
   filesystem:
     rootdirectory: /var/lib/registry
+cache:
+  blobdescriptor:
+    provider: inmemory
 http:
   addr: :5000
   headers:

cmd/registry/main.go

@@ -8,6 +8,8 @@ import (
 	_ "github.com/distribution/distribution/v3/registry/auth/silly"
 	_ "github.com/distribution/distribution/v3/registry/auth/token"
 	_ "github.com/distribution/distribution/v3/registry/proxy"
+	_ "github.com/distribution/distribution/v3/registry/storage/cache/memory"
+	_ "github.com/distribution/distribution/v3/registry/storage/cache/redis"
 	_ "github.com/distribution/distribution/v3/registry/storage/driver/azure"
 	_ "github.com/distribution/distribution/v3/registry/storage/driver/filesystem"
 	_ "github.com/distribution/distribution/v3/registry/storage/driver/gcs"

configuration/configuration.go

@@ -55,6 +55,9 @@ type Configuration struct {
 	// Storage is the configuration for the registry's storage driver
 	Storage Storage `yaml:"storage"`
 
+	// Cache is the configuration for the registry's storage cache
+	Cache Cache `yaml:"cache"`
+
 	// Auth allows configuration of various authorization methods that may be
 	// used to gate requests.
 	Auth Auth `yaml:"auth,omitempty"`
@@ -166,9 +169,6 @@ type Configuration struct {
 	// registry events are dispatched.
 	Notifications Notifications `yaml:"notifications,omitempty"`
 
-	// Redis configures the redis pool available to the registry webapp.
-	Redis Redis `yaml:"redis,omitempty"`
-
 	Health  Health  `yaml:"health,omitempty"`
 	Catalog Catalog `yaml:"catalog,omitempty"`
 
@@ -429,8 +429,6 @@ func (storage Storage) Type() string {
 		switch k {
 		case "maintenance":
 			// allow configuration of maintenance
-		case "cache":
-			// allow configuration of caching
 		case "delete":
 			// allow configuration of delete
 		case "redirect":
@@ -507,6 +505,67 @@ func (storage Storage) MarshalYAML() (interface{}, error) {
 	return map[string]Parameters(storage), nil
 }
 
+// Cache defines the configuration for registry cache.
+type Cache map[string]Parameters
+
+// Type returns the cache type, such as memory or redis.
+func (cache Cache) Type() string {
+	// Return only key in this map
+	for k := range cache {
+		return k
+	}
+	return ""
+}
+
+// Parameters returns the Parameters map for an cache configuration
+func (cache Cache) Parameters() Parameters {
+	return cache[cache.Type()]
+}
+
+// setParameter changes the parameter at the provided key to the new value
+func (cache Cache) setParameter(key string, value interface{}) {
+	cache[cache.Type()][key] = value
+}
+
+// UnmarshalYAML implements the yaml.Unmarshaler interface
+// Unmarshals a single item map into a Storage or a string into a Storage type with no parameters
+func (cache *Cache) UnmarshalYAML(unmarshal func(interface{}) error) error {
+	var m map[string]Parameters
+	err := unmarshal(&m)
+	if err == nil {
+		if len(m) > 1 {
+			types := make([]string, 0, len(m))
+			for k := range m {
+				types = append(types, k)
+			}
+
+			// TODO(stevvooe): May want to change this slightly for
+			// authorization to allow multiple challenges.
+			return fmt.Errorf("must provide exactly one type. Provided: %v", types)
+
+		}
+		*cache = m
+		return nil
+	}
+
+	var cacheType string
+	err = unmarshal(&cacheType)
+	if err == nil {
+		*cache = Cache{cacheType: Parameters{}}
+		return nil
+	}
+
+	return err
+}
+
+// MarshalYAML implements the yaml.Marshaler interface
+func (cache Cache) MarshalYAML() (interface{}, error) {
+	if cache.Parameters() == nil {
+		return cache.Type(), nil
+	}
+	return map[string]Parameters(cache), nil
+}
+
 // Auth defines the configuration for registry authorization.
 type Auth map[string]Parameters
 

configuration/configuration_test.go

@@ -44,6 +44,25 @@ var configStruct = Configuration{
 			"path1":   "/some-path",
 		},
 	},
+	Cache: Cache{
+		"blobdescriptor": Parameters{
+			"provider": "redis",
+			"params": map[interface{}]interface{}{
+				"addr":     "localhost:6379",
+				"username": "alice",
+				"password": "123456",
+				"db":       1,
+				"pool": map[interface{}]interface{}{
+					"maxidle":     16,
+					"maxactive":   64,
+					"idletimeout": "300s",
+				},
+				"dialtimeout":  "10ms",
+				"readtimeout":  "10ms",
+				"writetimeout": "10ms",
+			},
+		},
+	},
 	Auth: Auth{
 		"silly": Parameters{
 			"realm":   "silly",
@@ -126,24 +145,6 @@ var configStruct = Configuration{
 			Disabled: false,
 		},
 	},
-	Redis: Redis{
-		Addr:     "localhost:6379",
-		Username: "alice",
-		Password: "123456",
-		DB:       1,
-		Pool: struct {
-			MaxIdle     int           `yaml:"maxidle,omitempty"`
-			MaxActive   int           `yaml:"maxactive,omitempty"`
-			IdleTimeout time.Duration `yaml:"idletimeout,omitempty"`
-		}{
-			MaxIdle:     16,
-			MaxActive:   64,
-			IdleTimeout: time.Second * 300,
-		},
-		DialTimeout:  time.Millisecond * 10,
-		ReadTimeout:  time.Millisecond * 10,
-		WriteTimeout: time.Millisecond * 10,
-	},
 }
 
 // configYamlV0_1 is a Version 0.1 yaml document representing configStruct
@@ -163,6 +164,21 @@ storage:
     int1: 42
     url1: "https://foo.example.com"
     path1: "/some-path"
+cache:
+  blobdescriptor:
+    provider: redis
+    params:
+      addr: localhost:6379
+      username: alice
+      password: "123456"
+      db: 1
+      pool:
+        maxidle: 16
+        maxactive: 64
+        idletimeout: 300s
+      dialtimeout: 10ms
+      readtimeout: 10ms
+      writetimeout: 10ms
 auth:
   silly:
     realm: silly
@@ -185,18 +201,6 @@ http:
     - /path/to/ca.pem
   headers:
     X-Content-Type-Options: [nosniff]
-redis:
-  addr: localhost:6379
-  username: alice
-  password: 123456
-  db: 1
-  pool:
-    maxidle: 16
-    maxactive: 64
-    idletimeout: 300s
-  dialtimeout: 10ms
-  readtimeout: 10ms
-  writetimeout: 10ms
 `
 
 // inmemoryConfigYamlV0_1 is a Version 0.1 yaml document specifying an inmemory
@@ -206,6 +210,21 @@ version: 0.1
 log:
   level: info
 storage: inmemory
+cache:
+  blobdescriptor:
+    provider: redis
+    params:
+      addr: localhost:6379
+      username: alice
+      password: "123456"
+      db: 1
+      pool:
+        maxidle: 16
+        maxactive: 64
+        idletimeout: 300s
+      dialtimeout: 10ms
+      readtimeout: 10ms
+      writetimeout: 10ms
 auth:
   silly:
     realm: silly
@@ -263,7 +282,6 @@ func (suite *ConfigSuite) TestParseSimple(c *check.C) {
 func (suite *ConfigSuite) TestParseInmemory(c *check.C) {
 	suite.expectedConfig.Storage = Storage{"inmemory": Parameters{}}
 	suite.expectedConfig.Log.Fields = nil
-	suite.expectedConfig.Redis = Redis{}
 
 	config, err := Parse(bytes.NewReader([]byte(inmemoryConfigYamlV0_1)))
 	c.Assert(err, check.IsNil)
@@ -283,7 +301,7 @@ func (suite *ConfigSuite) TestParseIncomplete(c *check.C) {
 	suite.expectedConfig.Auth = Auth{"silly": Parameters{"realm": "silly"}}
 	suite.expectedConfig.Notifications = Notifications{}
 	suite.expectedConfig.HTTP.Headers = nil
-	suite.expectedConfig.Redis = Redis{}
+	suite.expectedConfig.Cache = nil
 
 	// Note: this also tests that REGISTRY_STORAGE and
 	// REGISTRY_STORAGE_FILESYSTEM_ROOTDIRECTORY can be used together
@@ -536,6 +554,11 @@ func copyConfig(config Configuration) *Configuration {
 		configCopy.Storage.setParameter(k, v)
 	}
 
+	configCopy.Cache = Cache{config.Cache.Type(): Parameters{}}
+	for k, v := range config.Cache.Parameters() {
+		configCopy.Cache.setParameter(k, v)
+	}
+
 	configCopy.Auth = Auth{config.Auth.Type(): Parameters{}}
 	for k, v := range config.Auth.Parameters() {
 		configCopy.Auth.setParameter(k, v)
@@ -549,7 +572,5 @@ func copyConfig(config Configuration) *Configuration {
 		configCopy.HTTP.Headers[k] = v
 	}
 
-	configCopy.Redis = config.Redis
-
 	return configCopy
 }