scanner

Documentation

Index

• Constants
• Variables
• type Config
  • func LookupConfig(kvs config.KVS) (cfg Config, err error)

Constants

const (
	Speed    = "speed"
	EnvSpeed = "MINIO_SCANNER_SPEED"

	// All below are deprecated in October 2022 and
	// replaced them with a single speed parameter
	Delay            = "delay"
	MaxWait          = "max_wait"
	Cycle            = "cycle"
	EnvDelay         = "MINIO_SCANNER_DELAY"
	EnvCycle         = "MINIO_SCANNER_CYCLE"
	EnvDelayLegacy   = "MINIO_CRAWLER_DELAY"
	EnvMaxWait       = "MINIO_SCANNER_MAX_WAIT"
	EnvMaxWaitLegacy = "MINIO_CRAWLER_MAX_WAIT"
)

Compression environment variables

Variables

var DefaultKVS = config.KVS{
	config.KV{
		Key:   Speed,
		Value: "default",
	},

	config.KV{
		Key:        Delay,
		Value:      "",
		Deprecated: true,
	},

	config.KV{
		Key:        MaxWait,
		Value:      "",
		Deprecated: true,
	},

	config.KV{
		Key:        Cycle,
		Value:      "",
		Deprecated: true,
	},
}

DefaultKVS - default KV config for heal settings

var (

	// Help provides help for config values
	Help = config.HelpKVS{
		config.HelpKV{
			Key:         Speed,
			Description: `scanner speed` + defaultHelpPostfix(Speed),
			Optional:    true,
			Type:        "default|slowest|slow|fast|fastest",
		},
	}
)

Types

type Config

type Config struct {
	// Delay is the sleep multiplier.
	Delay float64 `json:"delay"`
	// MaxWait is maximum wait time between operations
	MaxWait time.Duration
	// Cycle is the time.Duration between each scanner cycles
	Cycle time.Duration
}

Config represents the heal settings.

func LookupConfig

func LookupConfig(kvs config.KVS) (cfg Config, err error)

LookupConfig - lookup config and override with valid environment settings if any.