617a1fa394
These updates are based on discussions had about the preferred semantics of the TopologyManager and will be reflected in changes to an upcoming PR that adds the actual TopologyManager implementation.
57 lines
1.9 KiB
Go
57 lines
1.9 KiB
Go
/*
|
|
Copyright 2019 The Kubernetes Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package topologymanager
|
|
|
|
import (
|
|
"k8s.io/api/core/v1"
|
|
"k8s.io/kubernetes/pkg/kubelet/cm/topologymanager/socketmask"
|
|
"k8s.io/kubernetes/pkg/kubelet/lifecycle"
|
|
)
|
|
|
|
//Manager interface provides methods for Kubelet to manage pod topology hints
|
|
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
|
|
}
|
|
|
|
//HintProvider interface is to be implemented by Hint Providers
|
|
type HintProvider interface {
|
|
GetTopologyHints(pod v1.Pod, container v1.Container) []TopologyHint
|
|
}
|
|
|
|
//Store interface is to allow Hint Providers to retrieve pod affinity
|
|
type Store interface {
|
|
GetAffinity(podUID string, containerName string) TopologyHint
|
|
}
|
|
|
|
//TopologyHint is a struct containing a SocketMask for a Container
|
|
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
|
|
}
|