state

Documentation

Index

• func GetVPod(key types.NamespacedName, vpods []scheduler.VPod) scheduler.VPod
• func OrdinalFromPodName(podName string) int32
• func PodNameFromOrdinal(name string, ordinal int32) string
• func ToJSONable(ps map[types.NamespacedName]map[string]int32) map[string]map[string]int32
• type State
  • func (s *State) Free(ordinal int32) int32
  • func (s *State) FreeCapacity() int32
  • func (s *State) IsSchedulablePod(ordinal int32) bool
  • func (s *State) MarshalJSON() ([]byte, error)
  • func (s *State) SetFree(ordinal int32, value int32)
  • func (s *State) TotalExpectedVReplicas() int32
  • func (s *State) TotalPending() int32
• type StateAccessor
  • func NewStateBuilder(sfsname string, lister scheduler.VPodLister, podCapacity int32, ...) StateAccessor

Functions

func GetVPod

func GetVPod(key types.NamespacedName, vpods []scheduler.VPod) scheduler.VPod

Get retrieves the VPod from the vpods lister for a given namespace and name.

func OrdinalFromPodName

func OrdinalFromPodName(podName string) int32

func PodNameFromOrdinal

func PodNameFromOrdinal(name string, ordinal int32) string

func ToJSONable

func ToJSONable(ps map[types.NamespacedName]map[string]int32) map[string]map[string]int32

Types

type State

type State struct {
	// free tracks the free capacity of each pod.
	FreeCap []int32

	// schedulable pods tracks the pods that aren't being evicted.
	SchedulablePods []int32

	// LastOrdinal is the ordinal index corresponding to the last statefulset replica
	// with placed vpods.
	LastOrdinal int32

	// Pod capacity.
	Capacity int32

	// Replicas is the (cached) number of statefulset replicas.
	Replicas int32

	StatefulSetName string

	PodLister corev1.PodNamespaceLister

	// Stores for each vpod, a map of podname to number of vreplicas placed on that pod currently
	PodSpread map[types.NamespacedName]map[string]int32

	// Pending tracks the number of virtual replicas that haven't been scheduled yet
	// because there wasn't enough free capacity.
	Pending map[types.NamespacedName]int32

	// ExpectedVReplicaByVPod is the expected virtual replicas for each vpod key
	ExpectedVReplicaByVPod map[types.NamespacedName]int32
}

state provides information about the current scheduling of all vpods It is used by for the scheduler and the autoscaler

func (*State) Free

func (s *State) Free(ordinal int32) int32

Free safely returns the free capacity at the given ordinal

func (*State) FreeCapacity

func (s *State) FreeCapacity() int32

FreeCapacity returns the number of vreplicas that can be used, up to the last ordinal

func (*State) IsSchedulablePod

func (s *State) IsSchedulablePod(ordinal int32) bool

func (*State) MarshalJSON

func (s *State) MarshalJSON() ([]byte, error)

func (*State) SetFree

func (s *State) SetFree(ordinal int32, value int32)

SetFree safely sets the free capacity at the given ordinal

func (*State) TotalExpectedVReplicas

func (s *State) TotalExpectedVReplicas() int32

func (*State) TotalPending

func (s *State) TotalPending() int32

type StateAccessor

type StateAccessor interface {
	// State returns the current state (snapshot) about placed vpods
	// Take into account reserved vreplicas and update `reserved` to reflect
	// the current state.
	State(ctx context.Context) (*State, error)
}

func NewStateBuilder

func NewStateBuilder(sfsname string, lister scheduler.VPodLister, podCapacity int32, podlister corev1.PodNamespaceLister, statefulSetCache *scheduler.ScaleCache) StateAccessor

NewStateBuilder returns a StateAccessor recreating the state from scratch each time it is requested