github/kubernetes
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

style: update comments in topology manager

Browse Source
This commit is contained in:
draveness
2020-10-20 18:14:44 +08:00
parent 6d3ccd8e6c
commit 60d3f99b1f
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
pkg/kubelet/cm/topologymanager/topology_manager.go
View File

@@ -39,18 +39,18 @@ const (
maxAllowableNUMANodes = 8 maxAllowableNUMANodes = 8
) )
//Manager interface provides methods for Kubelet to manage pod topology hints // Manager interface provides methods for Kubelet to manage pod topology hints
type Manager interface { type Manager interface {
//Manager implements pod admit handler interface // PodAdmitHandler is implemented by Manager
lifecycle.PodAdmitHandler lifecycle.PodAdmitHandler
//Adds a hint provider to manager to indicate the hint provider // AddHintProvider adds a hint provider to manager to indicate the hint provider
//wants to be consoluted when making topology hints // wants to be consulted with when making topology hints
AddHintProvider(HintProvider) AddHintProvider(HintProvider)
//Adds pod to Manager for tracking // AddContainer adds pod to Manager for tracking
AddContainer(pod *v1.Pod, containerID string) error AddContainer(pod *v1.Pod, containerID string) error
//Removes pod from Manager tracking // RemoveContainer removes pod from Manager tracking
RemoveContainer(containerID string) error RemoveContainer(containerID string) error
//Interface for storing pod topology hints // Store is the interface for storing pod topology hints
Store Store
} }
@@ -90,7 +90,7 @@ type Store interface {
GetAffinity(podUID string, containerName string) TopologyHint GetAffinity(podUID string, containerName string) TopologyHint
} }
//TopologyHint is a struct containing the NUMANodeAffinity for a Container // TopologyHint is a struct containing the NUMANodeAffinity for a Container
type TopologyHint struct { type TopologyHint struct {
NUMANodeAffinity bitmask.BitMask NUMANodeAffinity bitmask.BitMask
// Preferred is set to true when the NUMANodeAffinity encodes a preferred // Preferred is set to true when the NUMANodeAffinity encodes a preferred
@@ -121,7 +121,7 @@ func (th *TopologyHint) LessThan(other TopologyHint) bool {
var _ Manager = &manager{} var _ Manager = &manager{}
//NewManager creates a new TopologyManager based on provided policy // NewManager creates a new TopologyManager based on provided policy
func NewManager(topology []cadvisorapi.Node, topologyPolicyName string) (Manager, error) { func NewManager(topology []cadvisorapi.Node, topologyPolicyName string) (Manager, error) {
klog.Infof("[topologymanager] Creating topology manager with %s policy", topologyPolicyName) klog.Infof("[topologymanager] Creating topology manager with %s policy", topologyPolicyName)