snapshotoffload

type LocalStore struct {
	// contains filtered or unexported fields
}

type Manifest struct {
	SchemaVersion  int               `json:"schema_version"`
	CreatedAt      time.Time         `json:"created_at"`
	SourceCluster  string            `json:"source_cluster,omitempty"`
	GroupID        uint64            `json:"group_id"`
	SnapshotIndex  uint64            `json:"snapshot_index"`
	SnapshotTerm   uint64            `json:"snapshot_term"`
	ConfState      ManifestConfState `json:"conf_state"`
	Payload        PayloadDescriptor `json:"payload"`
	BinaryVersion  string            `json:"binary_version,omitempty"`
	ManifestKey    string            `json:"manifest_key"`
	ManifestSHA256 string            `json:"manifest_sha256,omitempty"`
}

type ManifestConfState struct {
	Voters         []uint64 `json:"voters,omitempty"`
	Learners       []uint64 `json:"learners,omitempty"`
	VotersOutgoing []uint64 `json:"voters_outgoing,omitempty"`
	LearnersNext   []uint64 `json:"learners_next,omitempty"`
	AutoLeave      bool     `json:"auto_leave,omitempty"`
}

type ObjectInfo struct {
	Key  string
	Size int64
	// SHA256 is optional for metadata-only Head/Get paths; PutObject returns it
	// when the writer verified the committed content.
	SHA256               string
	ServerSideEncryption string
	SSEKMSKeyID          string
}

type ObjectStore interface {
	PutObject(ctx context.Context, key string, body io.Reader, opts PutOptions) (ObjectInfo, error)
	GetObject(ctx context.Context, key string) (io.ReadCloser, ObjectInfo, error)
	HeadObject(ctx context.Context, key string) (ObjectInfo, bool, error)
}

type OffloadGroup struct {
	GroupID uint64
	DataDir string
	// IsLeader is the cheap pre-check made before opening the snapshot.
	IsLeader func() bool
	// VerifyLeader is the authoritative check, re-run immediately before the
	// manifest is committed. See PublishOptions.VerifyLeader.
	VerifyLeader func(context.Context) error
}

type PayloadDescriptor struct {
	Key          string `json:"key"`
	Bytes        int64  `json:"bytes"`
	SHA256       string `json:"sha256"`
	SourceCRC32C uint32 `json:"source_crc32c"`
}

type PublishOptions struct {
	Store         ObjectStore
	DataDir       string
	Prefix        string
	GroupID       uint64
	SourceCluster string
	BinaryVersion string
	CreatedAt     time.Time
	SpoolDir      string
	// VerifyLeader, when set, is re-checked immediately before the manifest is
	// committed. §4 requires leadership to hold at that instant, not merely when
	// the snapshot was opened: spooling a multi-gigabyte payload takes long
	// enough to lose an election. Failing here can leave an unreferenced
	// content-addressed payload, which GC reclaims, but never a committed
	// manifest naming a snapshot this node no longer had the right to publish.
	VerifyLeader func(context.Context) error
	// SkipIfNotNewerThan suppresses the publish when the persisted
	// snapshot's index is not greater than this value. Zero disables
	// the check.
	//
	// The comparison happens after the export is opened but BEFORE
	// the payload is spooled, which is the whole point: a scheduler
	// that ticks every 15 minutes over an unchanged snapshot would
	// otherwise re-read, re-hash and re-fsync a multi-gigabyte
	// payload every tick just to discover the object store already
	// has it.
	SkipIfNotNewerThan uint64
}

type PutOptions struct {
	Size        int64
	SHA256      string
	ContentType string
}

type RestoreOptions struct {
	Store       ObjectStore
	ManifestKey string
	Manifest    *Manifest
	DataDir     string
	Peers       []etcdraftengine.Peer
}

type S3ObjectClient interface {
	PutObject(context.Context, *s3.PutObjectInput, ...func(*s3.Options)) (*s3.PutObjectOutput, error)
	GetObject(context.Context, *s3.GetObjectInput, ...func(*s3.Options)) (*s3.GetObjectOutput, error)
	HeadObject(context.Context, *s3.HeadObjectInput, ...func(*s3.Options)) (*s3.HeadObjectOutput, error)
	CreateMultipartUpload(context.Context, *s3.CreateMultipartUploadInput, ...func(*s3.Options)) (*s3.CreateMultipartUploadOutput, error)
	UploadPart(context.Context, *s3.UploadPartInput, ...func(*s3.Options)) (*s3.UploadPartOutput, error)
	CompleteMultipartUpload(context.Context, *s3.CompleteMultipartUploadInput, ...func(*s3.Options)) (*s3.CompleteMultipartUploadOutput, error)
	AbortMultipartUpload(context.Context, *s3.AbortMultipartUploadInput, ...func(*s3.Options)) (*s3.AbortMultipartUploadOutput, error)
}

type S3Store struct {
	// contains filtered or unexported fields
}

type S3StoreConfig struct {
	Client                 S3ObjectClient
	Bucket                 string
	Region                 string
	Endpoint               string
	Profile                string
	ForcePathStyle         bool
	AccessKeyID            string
	SecretAccessKey        string
	SessionToken           string
	ServerSideEncryption   string
	SSEKMSKeyID            string
	DisableChecksumHeaders bool
}

type Scheduler struct {
	// contains filtered or unexported fields
}

type SchedulerObserver interface {
	ObserveSnapshotOffloadPublished(groupID, index uint64, payloadBytes int64, elapsed time.Duration)
	ObserveSnapshotOffloadSkipped(groupID uint64, reason string)
	ObserveSnapshotOffloadFailed(groupID uint64, err error)
}

type SchedulerOption func(*Scheduler)