cache

Documentation

Index

• type BinderCache
  • func New(handler commoncache.CacheHandler) BinderCache

Types

type BinderCache

type BinderCache interface {
	commoncache.ClusterEventsHandler

	// Dump takes a snapshot of the current cache. This is used for debugging
	// purposes only and shouldn't be confused with UpdateSnapshot function.
	// This method is expensive, and should be only used in non-critical path.
	Dump() *commoncache.Dump

	// GetPod returns the pod from the cache with the same namespace and the
	// same name of the specified pod.
	GetPod(pod *v1.Pod) (*v1.Pod, error)
	GetNodeInfo(nodename string) framework.NodeInfo

	// IsAssumedPod returns true if the pod is assumed and not expired.
	IsAssumedPod(pod *v1.Pod) (bool, error)

	// FinishBinding signals that cache for assumed pod can be expired
	FinishBinding(pod *v1.Pod) error

	// AssumePod assumes a pod scheduled and aggregates the pod's information into its node.
	// The implementation also decides the policy to expire pod before being confirmed (receiving Add event).
	// After expiration, its information would be subtracted.
	AssumePod(podInfo *framework.CachePodInfo) error
	// ForgetPod removes an assumed pod from cache.
	ForgetPod(podInfo *framework.CachePodInfo) error

	// FindStore finds a common store in cache by store name.
	FindStore(storeName commonstore.StoreName) commonstore.Store

	GetUnitSchedulingStatus(unitKey string) unitstatus.SchedulingStatus
	SetUnitSchedulingStatus(unitKey string, status unitstatus.SchedulingStatus)
	GetUnitStatus(unitKey string) unitstatus.UnitStatus

	// Marks a pod to be deleted eventually
	MarkPodToDelete(pod, preemptor *v1.Pod) error
	RemoveDeletePodMarker(pod, preemptor *v1.Pod) error
	RemoveDeletePodMarkerByKey(podKey, preemptorKey string) error
	// check is pod is marked to delete
	IsPodMarkedToDelete(pod *v1.Pod) (bool, error)

	// for resource reservation
	GetAvailablePlaceholderPod(pod *v1.Pod) (*v1.Pod, error)
}

BinderCache collects pods' information and provides node-level aggregated information. It's intended for generic scheduler to do efficient lookup. BinderCache's operations are pod centric. It does incremental updates based on pod events. Pod events are sent via network. We don't have guaranteed delivery of all events: We use Reflector to list and watch from remote. Reflector might be slow and do a relist, which would lead to missing events.

State Machine of a pod's events in scheduler's cache:

+-------------------------------------------+  +----+
|                            Add            |  |    |
|                                           |  |    | Update
+      Assume                Add            v  v    |

Initial +--------> Assumed +------------+---> Added <--+

^                +   +               |       +
|                |   |               |       |
|                |   |           Add |       | Remove
|                |   |               |       |
|                |   |               +       |
+----------------+   +-----------> Expired   +----> Deleted
      Forget             Expire

Note that an assumed pod can expire, because if we haven't received Add event notifying us for a while, there might be some problems and we shouldn't keep the pod in cache anymore.

Note that "Initial", "Expired", and "Deleted" pods do not actually exist in cache. Based on existing use cases, we are making the following assumptions:

• No pod would be assumed twice
• A pod could be added without going through scheduler. In this case, we will see Add but not Assume event.
• If a pod wasn't added, it wouldn't be removed or updated.
• Both "Expired" and "Deleted" are valid end states. In case of some problems, e.g. network issue, a pod might have changed its state (e.g. added and deleted) without delivering notification to the cache.

func New

func New(handler commoncache.CacheHandler) BinderCache

New returns a BinderCache implementation. It automatically starts a go routine that manages expiration of assumed pods. "ttl" is how long the assumed pod will get expired. "stop" is the channel that would close the background goroutine. "schedulerName" identifies the scheduler