algo

Documentation

Overview

Package algo implements different types of placement algorithms

Index

• func NewAlgorithm(opts placement.Options) placement.Algorithm
• type PlacementHelper
  • func NewPlacementHelper(p placement.Placement, opts placement.Options) PlacementHelper

Functions

func NewAlgorithm

func NewAlgorithm(opts placement.Options) placement.Algorithm

NewAlgorithm returns a placement algorithm with given options

Types

type PlacementHelper

type PlacementHelper interface {
	// Instances returns the list of instances managed by the PlacementHelper.
	Instances() []placement.Instance

	// CanMoveShard checks if the shard can be moved from the instance to the target isolation group.
	CanMoveShard(shard uint32, fromInstance placement.Instance, toIsolationGroup string) bool
}

PlacementHelper helps the algorithm to place shards.

func NewPlacementHelper

func NewPlacementHelper(p placement.Placement, opts placement.Options) PlacementHelper

NewPlacementHelper returns a placement helper