Skip to content

Commit

Permalink
Added LimitsChecker that provides hints for limits
Browse files Browse the repository at this point in the history
To allow admission controller to set limits on containers if needed
because LimitRange in namespace with default and max ratio.
This feature have to be explicitly enabled by passing the flag `--allow-to-adjust-limits`
  • Loading branch information
safanaj committed May 10, 2019
1 parent 750001f commit cb63756
Show file tree
Hide file tree
Showing 5 changed files with 527 additions and 13 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,245 @@
/*
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 logic

import (
"k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/resource"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/client-go/informers"

v1_listers "k8s.io/client-go/listers/core/v1"
)

// LimitsHints provide hinted limits that respect limit range max ratio
type LimitsHints interface {
IsNil() bool
RequestsExceedsRatio(indexOfContainer int, resourceName v1.ResourceName) bool
HintedLimit(indexOfContainer int, resourceName v1.ResourceName) resource.Quantity
}

// LimitRangeHints implements LimitsHints interface
type LimitRangeHints struct {
requestsExceedsRatio []map[v1.ResourceName]bool
limitsRespectingRatio []v1.ResourceList
}

var _ LimitsHints = &LimitRangeHints{}

// LimitsChecker checks for LimitRange and if container needs limits to be set
type LimitsChecker interface {
NeedsLimits(*v1.Pod, []ContainerResources) LimitsHints
}

// IsNil return true if there is no hints to set limits
func (lrh *LimitRangeHints) IsNil() bool {
return lrh == (*LimitRangeHints)(nil)
}

// RequestsExceedsRatio return true if limits have to be set to respect limit range max ratio
func (lrh *LimitRangeHints) RequestsExceedsRatio(indexOfContainer int, resourceName v1.ResourceName) bool {
if !lrh.IsNil() {
yes, ok := lrh.requestsExceedsRatio[indexOfContainer][resourceName]
return ok && yes
}
return false
}

// HintedLimit return the limit Quantity that respect the limit range max ration
func (lrh *LimitRangeHints) HintedLimit(indexOfContainer int, resourceName v1.ResourceName) resource.Quantity {
if !lrh.IsNil() {
limit, ok := lrh.limitsRespectingRatio[indexOfContainer][resourceName]
if ok {
return limit
}
return resource.Quantity{}
}
return resource.Quantity{}
}

type neverNeedsLimitsChecker struct{}

var _ LimitsChecker = &neverNeedsLimitsChecker{}

func (lc *neverNeedsLimitsChecker) NeedsLimits(pod *v1.Pod, containersResources []ContainerResources) LimitsHints {
return LimitsHints((*LimitRangeHints)(nil))
}

type limitsChecker struct {
limitrangeLister v1_listers.LimitRangeLister
}

var _ LimitsChecker = &limitsChecker{}

// NewLimitsChecker create a LimitsChecker
func NewLimitsChecker(f informers.SharedInformerFactory) LimitsChecker {
if f != nil {
limitrangeLister := f.Core().V1().LimitRanges().Lister()
stopCh := make(chan struct{})
f.Start(stopCh)
for _, ok := range f.WaitForCacheSync(stopCh) {
if !ok {
if ok := f.Core().V1().LimitRanges().Informer().HasSynced(); !ok {
return &neverNeedsLimitsChecker{}
}
}
}
return &limitsChecker{limitrangeLister}
}
return &neverNeedsLimitsChecker{}
}

type interestingData struct {
MaxLimitRequestRatio v1.ResourceList
Default v1.ResourceList
}

func (id *interestingData) parse(lri *v1.LimitRangeItem) {
if value, hasCPU := lri.MaxLimitRequestRatio[v1.ResourceCPU]; hasCPU {
if id.MaxLimitRequestRatio == nil {
id.MaxLimitRequestRatio = make(v1.ResourceList)
}
if maxRatio, exists := id.MaxLimitRequestRatio[v1.ResourceCPU]; !exists || maxRatio.Cmp(value) > 0 {
id.MaxLimitRequestRatio[v1.ResourceCPU] = *value.Copy()
}
}
if value, hasMemory := lri.MaxLimitRequestRatio[v1.ResourceMemory]; hasMemory {
if id.MaxLimitRequestRatio == nil {
id.MaxLimitRequestRatio = make(v1.ResourceList)
}
if maxRatio, exists := id.MaxLimitRequestRatio[v1.ResourceMemory]; !exists || maxRatio.Cmp(value) > 0 {
id.MaxLimitRequestRatio[v1.ResourceMemory] = *value.Copy()
}
}
if value, hasCPU := lri.Default[v1.ResourceCPU]; hasCPU {
if id.Default == nil {
id.Default = make(v1.ResourceList)
}
if _, exists := id.Default[v1.ResourceCPU]; !exists {
id.Default[v1.ResourceCPU] = *value.Copy()
}
}
if value, hasMemory := lri.Default[v1.ResourceMemory]; hasMemory {
if id.Default == nil {
id.Default = make(v1.ResourceList)
}
if _, exists := id.Default[v1.ResourceMemory]; !exists {
id.Default[v1.ResourceMemory] = *value.Copy()
}
}
}

func (lc *limitsChecker) getLimitRangeItem(pod *v1.Pod) (ret *v1.LimitRangeItem) {
ret = nil
limitranges, err := lc.limitrangeLister.
LimitRanges(pod.GetNamespace()).
List(labels.Everything())
if err == nil {
id := &interestingData{}
foundInterstingData := false
for _, lr := range limitranges {
for _, lri := range lr.Spec.Limits {
if lri.Type != v1.LimitTypeContainer && lri.Type != v1.LimitTypePod {
continue
}
if lri.MaxLimitRequestRatio == nil &&
lri.Default == nil {
continue
}
foundInterstingData = true
id.parse(&lri)
}
}
if foundInterstingData {
ret = &v1.LimitRangeItem{
MaxLimitRequestRatio: id.MaxLimitRequestRatio,
Default: id.Default,
}
}
}
return ret
}

func (lc *limitsChecker) NeedsLimits(pod *v1.Pod, containersResources []ContainerResources) LimitsHints {
lri := lc.getLimitRangeItem(pod)

if lri == (*v1.LimitRangeItem)(nil) {
return LimitsHints((*LimitRangeHints)(nil))
}

lrh := &LimitRangeHints{
requestsExceedsRatio: make([]map[v1.ResourceName]bool, len(containersResources)),
limitsRespectingRatio: make([]v1.ResourceList, len(containersResources)),
}
needsLimits := false

for i, cr := range containersResources {
lrh.requestsExceedsRatio[i] = make(map[v1.ResourceName]bool)
lrh.limitsRespectingRatio[i] = make(v1.ResourceList)
for name, value := range cr.Requests {
var ctrLimit *resource.Quantity
if pod.Spec.Containers[i].Resources.Limits != nil {
if q, hasLimit := pod.Spec.Containers[i].Resources.Limits[name]; hasLimit {
ctrLimit = &q
}
}
if q, hasDefault := lri.Default[name]; hasDefault && ctrLimit == nil {
ctrLimit = &q
}
if ctrLimit == nil {
// no limits for this container, neither default will be set
continue
}

if ratio, hasRatio := lri.MaxLimitRequestRatio[name]; hasRatio {
dl := *ctrLimit
dlv := dl.Value()
vv := value.Value()
useMilli := false
if dlv <= resource.MaxMilliValue &&
vv <= resource.MaxMilliValue &&
name == v1.ResourceCPU {
dlv = dl.MilliValue()
vv = value.MilliValue()
useMilli = true
}

futureRatio := float64(dlv) / float64(vv)
maxRatio := float64(ratio.Value())

if futureRatio > maxRatio {
needsLimits = true
lrh.requestsExceedsRatio[i][name] = true
l := int64(float64(vv) * maxRatio)
if useMilli {
if l > resource.MaxMilliValue {
l = resource.MaxMilliValue
}
lrh.limitsRespectingRatio[i][name] = *resource.NewMilliQuantity(l, value.Format)
} else {
lrh.limitsRespectingRatio[i][name] = *resource.NewQuantity(l, value.Format)
}
}
}
}
}

if !needsLimits {
lrh = nil
}
return LimitsHints(lrh)
}
Loading

0 comments on commit cb63756

Please sign in to comment.