Add disk based edge caching support. (#5182)

This PR adds disk based edge caching support for minio server. Cache settings can be configured in config.json to take list of disk drives, cache expiry in days and file patterns to exclude from cache or via environment variables MINIO_CACHE_DRIVES, MINIO_CACHE_EXCLUDE and MINIO_CACHE_EXPIRY Design assumes that Atime support is enabled and the list of cache drives is fixed. - Objects are cached on both GET and PUT/POST operations. - Expiry is used as hint to evict older entries from cache, or if 80% of cache capacity is filled. - When object storage backend is down, GET, LIST and HEAD operations fetch object seamlessly from cache. Current Limitations - Bucket policies are not cached, so anonymous operations are not supported in offline mode. - Objects are distributed using deterministic hashing among list of cache drives specified.If one or more drives go offline, or cache drive configuration is altered - performance could degrade to linear lookup. Fixes #4026
2025-11-07 04:42:56 -05:00 · 2018-03-28 14:14:06 -07:00
parent 2f9354b17e
commit a3e806ed61
60 changed files with 3544 additions and 82 deletions
--- a/cmd/gateway/azure/gateway-azure.go
+++ b/cmd/gateway/azure/gateway-azure.go
@@ -72,6 +72,11 @@ ENVIRONMENT VARIABLES:
  BROWSER:
     MINIO_BROWSER: To disable web browser access, set this value to "off".

+  CACHE:
+     MINIO_CACHE_DRIVES: List of cache drives delimited by ";"
+     MINIO_CACHE_EXCLUDE: List of cache exclusion patterns delimited by ";"
+     MINIO_CACHE_EXPIRY: Cache expiry duration in days
+
  UPDATE:
     MINIO_UPDATE: To turn off in-place upgrades, set this value to "off".

@@ -89,6 +94,14 @@ EXAMPLES:
      $ export MINIO_SECRET_KEY=azureaccountkey
      $ {{.HelpName}} https://azure.example.com

+  3. Start minio gateway server for Azure Blob Storage backend with edge caching enabled.
+      $ export MINIO_ACCESS_KEY=azureaccountname
+      $ export MINIO_SECRET_KEY=azureaccountkey
+      $ export MINIO_CACHE_DRIVES="/home/drive1;/home/drive2;/home/drive3;/home/drive4"
+      $ export MINIO_CACHE_EXCLUDE="bucket1/*;*.png"
+      $ export MINIO_CACHE_EXPIRY=40
+      $ {{.HelpName}}
+
 `

 	minio.RegisterGatewayCommand(cli.Command{
--- a/cmd/gateway/b2/gateway-b2.go
+++ b/cmd/gateway/b2/gateway-b2.go
@@ -63,6 +63,11 @@ ENVIRONMENT VARIABLES:
  BROWSER:
     MINIO_BROWSER: To disable web browser access, set this value to "off".

+  CACHE:
+     MINIO_CACHE_DRIVES: List of cache drives delimited by ";"
+     MINIO_CACHE_EXCLUDE: List of cache exclusion patterns delimited by ";"
+     MINIO_CACHE_EXPIRY: Cache expiry duration in days
+
  UPDATE:
     MINIO_UPDATE: To turn off in-place upgrades, set this value to "off".

@@ -74,6 +79,14 @@ EXAMPLES:
      $ export MINIO_ACCESS_KEY=accountID
      $ export MINIO_SECRET_KEY=applicationKey
      $ {{.HelpName}}
+
+  2. Start minio gateway server for B2 backend with edge caching enabled.
+      $ export MINIO_ACCESS_KEY=accountID
+      $ export MINIO_SECRET_KEY=applicationKey
+      $ export MINIO_CACHE_DRIVES="/home/drive1;/home/drive2;/home/drive3;/home/drive4"
+      $ export MINIO_CACHE_EXCLUDE="bucket1/*;*.png"
+      $ export MINIO_CACHE_EXPIRY=40
+      $ {{.HelpName}}
 `
 	minio.RegisterGatewayCommand(cli.Command{
 		Name:               b2Backend,
--- a/cmd/gateway/gcs/gateway-gcs.go
+++ b/cmd/gateway/gcs/gateway-gcs.go
@@ -109,6 +109,11 @@ ENVIRONMENT VARIABLES:
  BROWSER:
     MINIO_BROWSER: To disable web browser access, set this value to "off".

+  CACHE:
+     MINIO_CACHE_DRIVES: List of cache drives delimited by ";"
+     MINIO_CACHE_EXCLUDE: List of cache exclusion patterns delimited by ";"
+     MINIO_CACHE_EXPIRY: Cache expiry duration in days
+
  UPDATE:
     MINIO_UPDATE: To turn off in-place upgrades, set this value to "off".

@@ -125,6 +130,15 @@ EXAMPLES:
      $ export MINIO_ACCESS_KEY=accesskey
      $ export MINIO_SECRET_KEY=secretkey
      $ {{.HelpName}} mygcsprojectid
+
+  2. Start minio gateway server for GCS backend with edge caching enabled.
+      $ export GOOGLE_APPLICATION_CREDENTIALS=/path/to/credentials.json
+      $ export MINIO_ACCESS_KEY=accesskey
+      $ export MINIO_SECRET_KEY=secretkey
+      $ export MINIO_CACHE_DRIVES="/home/drive1;/home/drive2;/home/drive3;/home/drive4"
+      $ export MINIO_CACHE_EXCLUDE="bucket1/*;*.png"
+      $ export MINIO_CACHE_EXPIRY=40
+      $ {{.HelpName}} mygcsprojectid
 `

 	minio.RegisterGatewayCommand(cli.Command{
--- a/cmd/gateway/manta/gateway-manta.go
+++ b/cmd/gateway/manta/gateway-manta.go
@@ -74,6 +74,11 @@ ENVIRONMENT VARIABLES:
  DOMAIN:
     MINIO_DOMAIN: To enable virtual-host-style requests. Set this value to Minio host domain name.

+  CACHE:
+     MINIO_CACHE_DRIVES: List of cache drives delimited by ";"
+     MINIO_CACHE_EXCLUDE: List of cache exclusion patterns delimited by ";"
+     MINIO_CACHE_EXPIRY: Cache expiry duration in days
+
 EXAMPLES:
  1. Start minio gateway server for Manta Object Storage backend.
      $ export MINIO_ACCESS_KEY=manta_account_name
@@ -90,6 +95,14 @@ EXAMPLES:
      $ export MINIO_SECRET_KEY=manta_key_id
      $ export MANTA_KEY_MATERIAL=~/.ssh/custom_rsa
      $ {{.HelpName}}
+
+  4. Start minio gateway server for Manta Object Storage backend with edge caching enabled.
+      $ export MINIO_ACCESS_KEY=manta_account_name
+      $ export MINIO_SECRET_KEY=manta_key_id
+      $ export MINIO_CACHE_DRIVES="/home/drive1;/home/drive2;/home/drive3;/home/drive4"
+      $ export MINIO_CACHE_EXCLUDE="bucket1/*;*.png"
+      $ export MINIO_CACHE_EXPIRY=40
+      $ {{.HelpName}}
 `

 	minio.RegisterGatewayCommand(cli.Command{
--- a/cmd/gateway/nas/gateway-nas.go
+++ b/cmd/gateway/nas/gateway-nas.go
@@ -50,6 +50,11 @@ ENVIRONMENT VARIABLES:
  BROWSER:
     MINIO_BROWSER: To disable web browser access, set this value to "off".

+  CACHE:
+     MINIO_CACHE_DRIVES: List of cache drives delimited by ";"
+     MINIO_CACHE_EXCLUDE: List of cache exclusion patterns delimited by ";"
+     MINIO_CACHE_EXPIRY: Cache expiry duration in days
+
  UPDATE:
     MINIO_UPDATE: To turn off in-place upgrades, set this value to "off".

@@ -61,6 +66,14 @@ EXAMPLES:
      $ export MINIO_ACCESS_KEY=accesskey
      $ export MINIO_SECRET_KEY=secretkey
      $ {{.HelpName}} /shared/nasvol
+ 
+  2. Start minio gateway server for NAS with edge caching enabled.
+      $ export MINIO_ACCESS_KEY=accesskey			
+      $ export MINIO_SECRET_KEY=secretkey
+      $ export MINIO_CACHE_DRIVES="/home/drive1;/home/drive2;/home/drive3;/home/drive4"
+      $ export MINIO_CACHE_EXCLUDE="bucket1/*;*.png"
+      $ export MINIO_CACHE_EXPIRY=40
+      $ {{.HelpName}} /shared/nasvol
 `

 	minio.RegisterGatewayCommand(cli.Command{
--- a/cmd/gateway/oss/gateway-oss.go
+++ b/cmd/gateway/oss/gateway-oss.go
@@ -70,6 +70,11 @@ ENVIRONMENT VARIABLES:

  DOMAIN:
     MINIO_DOMAIN: To enable virtual-host-style requests. Set this value to Minio host domain name.
+	
+  CACHE:
+     MINIO_CACHE_DRIVES: List of cache drives delimited by ";"
+     MINIO_CACHE_EXCLUDE: List of cache exclusion patterns delimited by ";"
+     MINIO_CACHE_EXPIRY: Cache expiry duration in days

 EXAMPLES:
  1. Start minio gateway server for Aliyun OSS backend.
@@ -81,6 +86,14 @@ EXAMPLES:
      $ export MINIO_ACCESS_KEY=Q3AM3UQ867SPQQA43P2F
      $ export MINIO_SECRET_KEY=zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG
      $ {{.HelpName}} https://oss.example.com
+
+  3. Start minio gateway server for Aliyun OSS backend with edge caching enabled.
+      $ export MINIO_ACCESS_KEY=accesskey
+      $ export MINIO_SECRET_KEY=secretkey
+      $ export MINIO_CACHE_DRIVES="/home/drive1;/home/drive2;/home/drive3;/home/drive4"
+      $ export MINIO_CACHE_EXCLUDE="bucket1/*;*.png"
+      $ export MINIO_CACHE_EXPIRY=40
+      $ {{.HelpName}}
 `

 	minio.RegisterGatewayCommand(cli.Command{
--- a/cmd/gateway/s3/gateway-s3.go
+++ b/cmd/gateway/s3/gateway-s3.go
@@ -56,6 +56,11 @@ ENVIRONMENT VARIABLES:
  BROWSER:
     MINIO_BROWSER: To disable web browser access, set this value to "off".

+  CACHE:
+     MINIO_CACHE_DRIVES: List of cache drives delimited by ";"
+     MINIO_CACHE_EXCLUDE: List of cache exclusion patterns delimited by ";"
+     MINIO_CACHE_EXPIRY: Cache expiry duration in days
+
  UPDATE:
     MINIO_UPDATE: To turn off in-place upgrades, set this value to "off".

@@ -72,6 +77,14 @@ EXAMPLES:
      $ export MINIO_ACCESS_KEY=Q3AM3UQ867SPQQA43P2F
      $ export MINIO_SECRET_KEY=zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG
      $ {{.HelpName}} https://play.minio.io:9000
+
+  3. Start minio gateway server for AWS S3 backend with edge caching enabled.
+      $ export MINIO_ACCESS_KEY=accesskey
+      $ export MINIO_SECRET_KEY=secretkey
+      $ export MINIO_CACHE_DRIVES="/home/drive1;/home/drive2;/home/drive3;/home/drive4"
+      $ export MINIO_CACHE_EXCLUDE="bucket1/*;*.png"
+      $ export MINIO_CACHE_EXPIRY=40
+      $ {{.HelpName}}
 `

 	minio.RegisterGatewayCommand(cli.Command{
--- a/cmd/gateway/sia/gateway-sia.go
+++ b/cmd/gateway/sia/gateway-sia.go
@@ -73,6 +73,11 @@ ENVIRONMENT VARIABLES: (Default values in parenthesis)
  BROWSER:
     MINIO_BROWSER: To disable web browser access, set this value to "off".

+  CACHE:
+     MINIO_CACHE_DRIVES: List of cache drives delimited by ";"
+     MINIO_CACHE_EXCLUDE: List of cache exclusion patterns delimited by ";"
+     MINIO_CACHE_EXPIRY: Cache expiry duration in days
+
  UPDATE:
     MINIO_UPDATE: To turn off in-place upgrades, set this value to "off".

@@ -85,6 +90,12 @@ ENVIRONMENT VARIABLES: (Default values in parenthesis)
 EXAMPLES:
  1. Start minio gateway server for Sia backend.
      $ {{.HelpName}}
+
+  2. Start minio gateway server for Sia backend with edge caching enabled.
+      $ export MINIO_CACHE_DRIVES="/home/drive1;/home/drive2;/home/drive3;/home/drive4"
+      $ export MINIO_CACHE_EXCLUDE="bucket1/*;*.png"
+      $ export MINIO_CACHE_EXPIRY=40
+      $ {{.HelpName}}
 `

 	minio.RegisterGatewayCommand(cli.Command{