From eba23bbac4f064141ec9f780846211b5fd4a85f9 Mon Sep 17 00:00:00 2001
From: Harshavardhana <harsha@minio.io>
Date: Thu, 21 Dec 2023 16:57:13 -0800
Subject: [PATCH] rename object_size -> block_size for cache subsystem (#18694)

---
 cmd/config-current.go          |  2 +-
 internal/config/cache/cache.go | 28 ++++++++++++++--------------
 internal/config/cache/help.go  |  8 ++++----
 3 files changed, 19 insertions(+), 19 deletions(-)

diff --git a/cmd/config-current.go b/cmd/config-current.go
index b13bb43b7..e8f3a303f 100644
--- a/cmd/config-current.go
+++ b/cmd/config-current.go
@@ -223,7 +223,7 @@ func initHelp() {
 		config.HelpKV{
 			Key:         config.CacheSubSys,
 			Type:        "string",
-			Description: "enable various cache optimizations on MinIO for reads",
+			Description: "enable cache plugin on MinIO for GET/HEAD requests",
 			Optional:    true,
 		},
 	}
diff --git a/internal/config/cache/cache.go b/internal/config/cache/cache.go
index 602ed4218..0a8f23010 100644
--- a/internal/config/cache/cache.go
+++ b/internal/config/cache/cache.go
@@ -1,4 +1,4 @@
-// Copyright (c) 2015-2022 MinIO, Inc.
+// Copyright (c) 2015-2023 MinIO, Inc.
 //
 // This file is part of MinIO Object Storage stack
 //
@@ -35,13 +35,13 @@ import (
 
 // Cache related keys
 const (
-	Enable     = "enable"
-	Endpoint   = "endpoint"
-	ObjectSize = "object_size"
+	Enable    = "enable"
+	Endpoint  = "endpoint"
+	BlockSize = "block_size"
 
-	EnvEnable     = "MINIO_CACHE_ENABLE"
-	EnvEndpoint   = "MINIO_CACHE_ENDPOINT"
-	EnvObjectSize = "MINIO_CACHE_OBJECT_SIZE"
+	EnvEnable    = "MINIO_CACHE_ENABLE"
+	EnvEndpoint  = "MINIO_CACHE_ENDPOINT"
+	EnvBlockSize = "MINIO_CACHE_BLOCK_SIZE"
 )
 
 // DefaultKVS - default KV config for cache settings
@@ -55,7 +55,7 @@ var DefaultKVS = config.KVS{
 		Value: "",
 	},
 	config.KV{
-		Key:   ObjectSize,
+		Key:   BlockSize,
 		Value: "",
 	},
 }
@@ -70,9 +70,9 @@ type Config struct {
 	// Etag and ModTime of an object + version
 	Endpoint string `json:"endpoint"`
 
-	// ObjectSize indicates the maximum object size below which
+	// BlockSize indicates the maximum object size below which
 	// data is cached and fetched remotely from DRAM.
-	ObjectSize int64
+	BlockSize int64
 
 	// Is the HTTP client used for communicating with mcache server
 	clnt *http.Client
@@ -90,7 +90,7 @@ func (c Config) MatchesSize(size int64) bool {
 	configLock.RLock()
 	defer configLock.RUnlock()
 
-	return c.Enable && c.ObjectSize > 0 && size <= c.ObjectSize
+	return c.Enable && c.BlockSize > 0 && size <= c.BlockSize
 }
 
 // Update updates new cache frequency
@@ -100,7 +100,7 @@ func (c *Config) Update(ncfg Config) {
 
 	c.Enable = ncfg.Enable
 	c.Endpoint = ncfg.Endpoint
-	c.ObjectSize = ncfg.ObjectSize
+	c.BlockSize = ncfg.BlockSize
 	c.clnt = ncfg.clnt
 }
 
@@ -223,12 +223,12 @@ func (c Config) Delete(bucket, key string) {
 func LookupConfig(kvs config.KVS, transport http.RoundTripper) (cfg Config, err error) {
 	cfg.Enable = env.Get(EnvEnable, kvs.GetWithDefault(Enable, DefaultKVS)) == config.EnableOn
 
-	if d := env.Get(EnvObjectSize, kvs.GetWithDefault(ObjectSize, DefaultKVS)); d != "" {
+	if d := env.Get(EnvBlockSize, kvs.GetWithDefault(BlockSize, DefaultKVS)); d != "" {
 		objectSize, err := humanize.ParseBytes(d)
 		if err != nil {
 			return cfg, err
 		}
-		cfg.ObjectSize = int64(objectSize)
+		cfg.BlockSize = int64(objectSize)
 	}
 
 	cfg.Endpoint = env.Get(EnvEndpoint, kvs.GetWithDefault(Endpoint, DefaultKVS))
diff --git a/internal/config/cache/help.go b/internal/config/cache/help.go
index 31ce940a6..7754b06d1 100644
--- a/internal/config/cache/help.go
+++ b/internal/config/cache/help.go
@@ -29,19 +29,19 @@ var (
 		config.HelpKV{
 			Key:         Enable,
 			Type:        "on|off",
-			Description: "set to enable various caching optimizations" + defaultHelpPostfix(Enable),
+			Description: "set to enable remote cache plugin" + defaultHelpPostfix(Enable),
 			Optional:    true,
 		},
 		config.HelpKV{
 			Key:         Endpoint,
 			Type:        "string",
-			Description: "remote endpoint where MinIO will cache GET/HEAD metadata values such as ETag, ModTime" + defaultHelpPostfix(Endpoint),
+			Description: "remote cache endpoint for GET/HEAD object(s) metadata, data" + defaultHelpPostfix(Endpoint),
 			Optional:    true,
 		},
 		config.HelpKV{
-			Key:         ObjectSize,
+			Key:         BlockSize,
 			Type:        "string",
-			Description: "maximum object size below which data is cached and fetched remotely from DRAM if possible" + defaultHelpPostfix(ObjectSize),
+			Description: "cache all objects below the specified block size" + defaultHelpPostfix(BlockSize),
 			Optional:    true,
 		},
 	}