minio/docs/disk-caching

Disk Cache Quickstart Guide

Disk caching feature here refers to the use of caching disks to store content closer to the tenants. For instance, if you access an object from a lets say gateway azure setup and download the object that gets cached, each subsequent request on the object gets served directly from the cache drives until it expires. This feature allows MinIO users to have

• Object to be delivered with the best possible performance.
• Dramatic improvements for time to first byte for any object.

Get started

1. Prerequisites

Install MinIO - MinIO Quickstart Guide.

2. Run MinIO with cache

Disk caching can be enabled by updating the cache config settings for MinIO server. Config cache settings takes the mounted drive(s) or directory paths, cache expiry duration (in days) and any wildcard patterns to exclude from being cached.

"cache": {
	"drives": ["/mnt/drive1", "/mnt/drive2", "/mnt/drive3"],
	"expiry": 90,
	"exclude": ["*.pdf","mybucket/*"],
	"maxuse" : 70,
},

To update the configuration, use mc admin config get command to get the current configuration file for the minio cluster in json format, and save it locally.

$ mc admin config get myminio/ > /tmp/myconfig

After updating the cache configuration in /tmp/myconfig , use mc admin config set command to update the configuration for the cluster.Restart the MinIO server to put the changes into effect.

$ mc admin config set myminio < /tmp/myconfig

The cache settings may also be set through environment variables. When set, environment variables override any cache config settings for MinIO server. Following example uses /mnt/drive1, /mnt/drive2 ,/mnt/cache1 ... /mnt/cache3 for caching, with expiry up to 90 days while excluding all objects under bucket mybucket and all objects with '.pdf' as extension while starting a standalone erasure coded setup. Cache max usage is restricted to 80% of disk capacity in this example.

export MINIO_CACHE_DRIVES="/mnt/drive1;/mnt/drive2;/mnt/cache{1...3}"
export MINIO_CACHE_EXPIRY=90
export MINIO_CACHE_EXCLUDE="*.pdf;mybucket/*"
export MINIO_CACHE_MAXUSE=80
minio server /export{1...24}

3. Test your setup

To test this setup, access the MinIO server via browser or mc. You’ll see the uploaded files are accessible from the all the MinIO endpoints.

Explore Further

• Disk cache design
• Use mc with MinIO Server
• Use aws-cli with MinIO Server
• Use s3cmd with MinIO Server
• Use minio-go SDK with MinIO Server
• The MinIO documentation website