heal

Documentation

Index

• Constants
• Variables
• type Config
  • func LookupConfig(kvs config.KVS) (cfg Config, err error)
  • func (opts Config) BitrotScanCycle() (d time.Duration)
  • func (opts *Config) Update(nopts Config)
  • func (opts Config) Wait(currentIO func() int, activeListeners func() int)

Constants

const (
	Bitrot  = "bitrotscan"
	Sleep   = "max_sleep"
	IOCount = "max_io"

	EnvBitrot  = "MINIO_HEAL_BITROTSCAN"
	EnvSleep   = "MINIO_HEAL_MAX_SLEEP"
	EnvIOCount = "MINIO_HEAL_MAX_IO"
)

Compression environment variables

Variables

var DefaultKVS = config.KVS{
	config.KV{
		Key:   Bitrot,
		Value: config.EnableOff,
	},
	config.KV{
		Key:   Sleep,
		Value: "1s",
	},
	config.KV{
		Key:   IOCount,
		Value: "100",
	},
}

DefaultKVS - default KV config for heal settings

var (

	// Help provides help for config values
	Help = config.HelpKVS{
		config.HelpKV{
			Key:         Bitrot,
			Description: `perform bitrot scan on disks when checking objects during scanner` + defaultHelpPostfix(Bitrot),
			Optional:    true,
			Type:        "on|off",
		},
		config.HelpKV{
			Key:         Sleep,
			Description: `maximum sleep duration between objects to slow down heal operation` + defaultHelpPostfix(Sleep),
			Optional:    true,
			Type:        "duration",
		},
		config.HelpKV{
			Key:         IOCount,
			Description: `maximum IO requests allowed between objects to slow down heal operation` + defaultHelpPostfix(IOCount),
			Optional:    true,
			Type:        "int",
		},
	}
)

Help template for caching feature.

Types

type Config

type Config struct {
	// Bitrot will perform bitrot scan on local disk when checking objects.
	Bitrot string `json:"bitrotscan"`

	// maximum sleep duration between objects to slow down heal operation.
	Sleep   time.Duration `json:"sleep"`
	IOCount int           `json:"iocount"`
	// contains filtered or unexported fields
}

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.

func (Config) BitrotScanCycle

func (opts Config) BitrotScanCycle() (d time.Duration)

BitrotScanCycle returns the configured cycle for the scanner healing -1 for not enabled

0 for contiunous bitrot scanning

>0 interval duration between cycles

func (*Config) Update

func (opts *Config) Update(nopts Config)

Update updates opts with nopts

func (Config) Wait

func (opts Config) Wait(currentIO func() int, activeListeners func() int)

Wait waits for IOCount to go down or max sleep to elapse before returning. usually used in healing paths to wait for specified amount of time to throttle healing.