minio/docs/disk-caching
Harshavardhana ee4a6a823d Migrate config to KV data format (#8392)
- adding oauth support to MinIO browser (#8400) by @kanagaraj
- supports multi-line get/set/del for all config fields
- add support for comments, allow toggle
- add extensive validation of config before saving
- support MinIO browser to support proper claims, using STS tokens
- env support for all config parameters, legacy envs are also
  supported with all documentation now pointing to latest ENVs
- preserve accessKey/secretKey from FS mode setups
- add history support implements three APIs
  - ClearHistory
  - RestoreHistory
  - ListHistory
- add help command support for each config parameters
- all the bug fixes after migration to KV, and other bug
  fixes encountered during testing.
2019-10-22 22:59:13 -07:00
..
DESIGN.md Migrate config to KV data format (#8392) 2019-10-22 22:59:13 -07:00
README.md Migrate config to KV data format (#8392) 2019-10-22 22:59:13 -07:00

README.md

Disk Cache Quickstart Guide Slack

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 gateway with cache

Disk caching can be enabled by setting the cache environment variables for MinIO gateway . cache environment variables takes the mounted drive(s) or directory paths, cache expiry duration (in days) and any wildcard patterns to exclude from being cached.

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 s3 gateway setup. Cache max usage is restricted to 80% of disk capacity in this example.

export MINIO_CACHE="on"
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_QUOTA=80
minio gateway s3

3. Test your setup

To test this setup, access the MinIO gateway via browser or mc. Youll see the uploaded files are accessible from all the MinIO endpoints.

Explore Further