topologymanager

Documentation

Index

• Constants
• type HintProvider
• type Manager
• type Policy
  • func NewPreferredPolicy() Policy
  • func NewStrictPolicy() Policy
• type Store
• type TopologyHint

Constants

const PolicyPreferred string = "preferred"

PolicyPreferred policy name.

const PolicyStrict string = "strict"

PolicyStrict policy name.

Types

type HintProvider

type HintProvider interface {
	GetTopologyHints(pod v1.Pod, container v1.Container) []TopologyHint
}

HintProvider interface is to be implemented by Hint Providers

type Manager

type Manager interface {
	//Manager implements pod admit handler interface
	lifecycle.PodAdmitHandler
	//Adds a hint provider to manager to indicate the hint provider
	//wants to be consoluted when making topology hints
	AddHintProvider(HintProvider)
	//Adds pod to Manager for tracking
	AddContainer(pod *v1.Pod, containerID string) error
	//Removes pod from Manager tracking
	RemoveContainer(containerID string) error
	//Interface for storing pod topology hints
	Store
}

Manager interface provides methods for Kubelet to manage pod topology hints

type Policy

type Policy interface {
	//Returns Policy Name
	Name() string
	//Returns Pod Admit Handler Response based on hints and policy type
	CanAdmitPodResult(admit bool) lifecycle.PodAdmitResult
}

Policy interface for Topology Manager Pod Admit Result

func NewPreferredPolicy

func NewPreferredPolicy() Policy

NewPreferredPolicy returns preferred policy.

func NewStrictPolicy

func NewStrictPolicy() Policy

NewStrictPolicy returns strict policy.

type Store

type Store interface {
	GetAffinity(podUID string, containerName string) TopologyHint
}

Store interface is to allow Hint Providers to retrieve pod affinity

type TopologyHint

type TopologyHint struct {
	SocketAffinity socketmask.SocketMask
	// Preferred is set to true when the SocketMask encodes a preferred
	// allocation for the Container. It is set to false otherwise.
	Preferred bool
}

TopologyHint is a struct containing a SocketMask for a Container