verify

Documentation

Index

• Constants
• func MustVerifyIfEnabled(cfg Config)
• func Verify(cfg Config) error
• func VerifyIfEnabled(cfg Config) error
• type Config

Constants

const ENV_VERIFY_VALUE_STORAGE_WAL verify.VerificationType = "storage_wal"

Functions

func MustVerifyIfEnabled

func MustVerifyIfEnabled(cfg Config)

MustVerifyIfEnabled performs verification according to ETCD_VERIFY env settings and exits in case of found problems. See Verify for more information.

func Verify

func Verify(cfg Config) error

Verify performs consistency checks of given etcd data-directory. The errors are reported as the returned error, but for some situations the function can also panic. The function is expected to work on not-in-use data model, i.e. no file-locks should be taken. Verify does not modified the data.

func VerifyIfEnabled

func VerifyIfEnabled(cfg Config) error

VerifyIfEnabled performs verification according to ETCD_VERIFY env settings. See Verify for more information.

Types

type Config

type Config struct {
	// DataDir is a root directory where the data being verified are stored.
	DataDir string

	// ExactIndex requires consistent_index in backend exactly match the last committed WAL entry.
	// Usually backend's consistent_index needs to be <= WAL.commit, but for backups the match
	// is expected to be exact.
	ExactIndex bool

	Logger *zap.Logger
}