placement

type ClusterMappingProviderOptions interface {
	// Logger is the logger to use
	Logger(logger xlog.Logger) ClusterMappingProviderOptions
	GetLogger() xlog.Logger

	// Clock is the clock to use
	Clock(clock clock.Clock) ClusterMappingProviderOptions
	GetClock() clock.Clock
}

type CommitOptions interface {
	// RolloutDelay is the amount of time to wait for the configuration to be
	// distributed across all interested listeners
	GetRolloutDelay() time.Duration
	RolloutDelay(t time.Duration) CommitOptions

	// TransitionDelay is the amount of time to wait for the cluster to converge
	// on the same state after a transition
	GetTransitionDelay() time.Duration
	TransitionDelay(t time.Duration) CommitOptions
}

type StoragePlacement interface {
	// AddDatabase adds a new database to handle a set of retention periods
	AddDatabase(db schema.DatabaseProperties) error

	// JoinCluster adds a new cluster to an existing database and rebalances
	// shards onto that cluster
	JoinCluster(db string, c schema.ClusterProperties, config proto.Message) error

	// DecommissionCluster marks a cluster as being decomissioned, moving
	// its shards to other clusters.  Read traffic will continue to be directed
	// to this cluster until the max retention period for this database expires
	DecommissionCluster(db, c string) error

	// UpdateClusterConfig updates the configurtion for a cluster
	UpdateClusterConfig(db, c string, config proto.Message) error

	// CommitChanges commits and propagates any unapplied changes
	CommitChanges(version int, opts CommitOptions) error

	// GetPendingChanges gets pending placement changes
	GetPendingChanges() (int, *schema.Placement, *schema.PlacementChanges, error)
}

type StoragePlacementOptions interface {
	// Clock is the clock to use in placement
	GetClock() clock.Clock
	Clock(c clock.Clock) StoragePlacementOptions

	// Logger is the logger to use in placement
	GetLogger() xlog.Logger
	Logger(l xlog.Logger) StoragePlacementOptions
}