mirror of
https://github.com/minio/minio.git
synced 2025-02-23 19:42:30 -05:00
a3e806ed61
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
138 lines
3.8 KiB
Go
138 lines
3.8 KiB
Go
/*
|
|
* Minio Cloud Storage, (C) 2018 Minio, Inc.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
package nas
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/minio/cli"
|
|
"github.com/minio/minio-go/pkg/policy"
|
|
minio "github.com/minio/minio/cmd"
|
|
"github.com/minio/minio/pkg/auth"
|
|
)
|
|
|
|
const (
|
|
nasBackend = "nas"
|
|
)
|
|
|
|
func init() {
|
|
const nasGatewayTemplate = `NAME:
|
|
{{.HelpName}} - {{.Usage}}
|
|
|
|
USAGE:
|
|
{{.HelpName}} {{if .VisibleFlags}}[FLAGS]{{end}} PATH
|
|
{{if .VisibleFlags}}
|
|
FLAGS:
|
|
{{range .VisibleFlags}}{{.}}
|
|
{{end}}{{end}}
|
|
PATH:
|
|
path to NAS mount point.
|
|
|
|
ENVIRONMENT VARIABLES:
|
|
ACCESS:
|
|
MINIO_ACCESS_KEY: Username or access key of minimum 3 characters in length.
|
|
MINIO_SECRET_KEY: Password or secret key of minimum 8 characters in length.
|
|
|
|
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".
|
|
|
|
DOMAIN:
|
|
MINIO_DOMAIN: To enable virtual-host-style requests. Set this value to Minio host domain name.
|
|
|
|
EXAMPLES:
|
|
1. Start minio gateway server for NAS backend.
|
|
$ 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{
|
|
Name: nasBackend,
|
|
Usage: "Network-attached storage (NAS).",
|
|
Action: nasGatewayMain,
|
|
CustomHelpTemplate: nasGatewayTemplate,
|
|
HideHelpCommand: true,
|
|
})
|
|
}
|
|
|
|
// Handler for 'minio gateway nas' command line.
|
|
func nasGatewayMain(ctx *cli.Context) {
|
|
// Validate gateway arguments.
|
|
host := ctx.Args().First()
|
|
if host == "help" {
|
|
cli.ShowCommandHelpAndExit(ctx, nasBackend, 1)
|
|
}
|
|
// Validate gateway arguments.
|
|
minio.StartGateway(ctx, &NAS{host})
|
|
}
|
|
|
|
// NAS implements Gateway.
|
|
type NAS struct {
|
|
host string
|
|
}
|
|
|
|
// Name implements Gateway interface.
|
|
func (g *NAS) Name() string {
|
|
return nasBackend
|
|
}
|
|
|
|
// NewGatewayLayer returns nas gatewaylayer.
|
|
func (g *NAS) NewGatewayLayer(creds auth.Credentials) (minio.ObjectLayer, error) {
|
|
var err error
|
|
newObject, err := minio.NewFSObjectLayer(g.host)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return &nasObjects{newObject.(*minio.FSObjects)}, nil
|
|
}
|
|
|
|
// Production - nas gateway is production ready.
|
|
func (g *NAS) Production() bool {
|
|
return true
|
|
}
|
|
|
|
// nasObjects implements gateway for Minio and S3 compatible object storage servers.
|
|
type nasObjects struct {
|
|
*minio.FSObjects
|
|
}
|
|
|
|
// IsNotificationSupported returns whether notifications are applicable for this layer.
|
|
func (l *nasObjects) IsNotificationSupported() bool {
|
|
return false
|
|
}
|
|
|
|
// GetBucketPolicy will get policy on bucket
|
|
func (l *nasObjects) GetBucketPolicy(ctx context.Context, bucket string) (policy.BucketAccessPolicy, error) {
|
|
return minio.ReadBucketPolicy(bucket, l)
|
|
}
|