-
Notifications
You must be signed in to change notification settings - Fork 38.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Kubelet eviction flag parsers and tests #24750
Merged
k8s-github-robot
merged 1 commit into
kubernetes:master
from
derekwaynecarr:kubelet_eviction_flag_parsing
May 9, 2016
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
/* | ||
Copyright 2016 The Kubernetes Authors All rights reserved. | ||
|
||
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 eviction is responsible for enforcing eviction thresholds to maintain | ||
// node stability. | ||
package eviction |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,164 @@ | ||
/* | ||
Copyright 2016 The Kubernetes Authors All rights reserved. | ||
|
||
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 eviction | ||
|
||
import ( | ||
"fmt" | ||
"strings" | ||
"time" | ||
|
||
"k8s.io/kubernetes/pkg/api" | ||
"k8s.io/kubernetes/pkg/api/resource" | ||
"k8s.io/kubernetes/pkg/util/sets" | ||
) | ||
|
||
const ( | ||
unsupportedEvictionSignal = "unsupported eviction signal %v" | ||
) | ||
|
||
// signalToResource maps a Signal to its associated Resource. | ||
var signalToResource = map[Signal]api.ResourceName{ | ||
SignalMemoryAvailable: api.ResourceMemory, | ||
} | ||
|
||
// validSignal returns true if the signal is supported. | ||
func validSignal(signal Signal) bool { | ||
_, found := signalToResource[signal] | ||
return found | ||
} | ||
|
||
// ParseThresholdConfig parses the flags for thresholds. | ||
func ParseThresholdConfig(evictionHard, evictionSoft, evictionSoftGracePeriod string) ([]Threshold, error) { | ||
results := []Threshold{} | ||
|
||
hardThresholds, err := parseThresholdStatements(evictionHard) | ||
if err != nil { | ||
return nil, err | ||
} | ||
results = append(results, hardThresholds...) | ||
|
||
softThresholds, err := parseThresholdStatements(evictionSoft) | ||
if err != nil { | ||
return nil, err | ||
} | ||
gracePeriods, err := parseGracePeriods(evictionSoftGracePeriod) | ||
if err != nil { | ||
return nil, err | ||
} | ||
for i := range softThresholds { | ||
signal := softThresholds[i].Signal | ||
period, found := gracePeriods[signal] | ||
if !found { | ||
return nil, fmt.Errorf("grace period must be specified for the soft eviction threshold %v", signal) | ||
} | ||
softThresholds[i].GracePeriod = period | ||
} | ||
results = append(results, softThresholds...) | ||
return results, nil | ||
} | ||
|
||
// parseThresholdStatements parses the input statements into a list of Threshold objects. | ||
func parseThresholdStatements(expr string) ([]Threshold, error) { | ||
if len(expr) == 0 { | ||
return nil, nil | ||
} | ||
results := []Threshold{} | ||
statements := strings.Split(expr, ",") | ||
signalsFound := sets.NewString() | ||
for _, statement := range statements { | ||
result, err := parseThresholdStatement(statement) | ||
if err != nil { | ||
return nil, err | ||
} | ||
if signalsFound.Has(string(result.Signal)) { | ||
return nil, fmt.Errorf("found duplicate eviction threshold for signal %v", result.Signal) | ||
} | ||
signalsFound.Insert(string(result.Signal)) | ||
results = append(results, result) | ||
} | ||
return results, nil | ||
} | ||
|
||
// parseThresholdStatement parses a threshold statement. | ||
func parseThresholdStatement(statement string) (Threshold, error) { | ||
tokens2Operator := map[string]ThresholdOperator{ | ||
"<": OpLessThan, | ||
} | ||
var ( | ||
operator ThresholdOperator | ||
parts []string | ||
) | ||
for token := range tokens2Operator { | ||
parts = strings.Split(statement, token) | ||
// if we got a token, we know this was the operator... | ||
if len(parts) > 1 { | ||
operator = tokens2Operator[token] | ||
break | ||
} | ||
} | ||
if len(operator) == 0 || len(parts) != 2 { | ||
return Threshold{}, fmt.Errorf("invalid eviction threshold syntax %v, expected <signal><operator><value>", statement) | ||
} | ||
signal := Signal(parts[0]) | ||
if !validSignal(signal) { | ||
return Threshold{}, fmt.Errorf(unsupportedEvictionSignal, signal) | ||
} | ||
|
||
quantity, err := resource.ParseQuantity(parts[1]) | ||
if err != nil { | ||
return Threshold{}, err | ||
} | ||
return Threshold{ | ||
Signal: signal, | ||
Operator: operator, | ||
Value: *quantity, | ||
}, nil | ||
} | ||
|
||
// parseGracePeriods parses the grace period statements | ||
func parseGracePeriods(expr string) (map[Signal]time.Duration, error) { | ||
if len(expr) == 0 { | ||
return nil, nil | ||
} | ||
results := map[Signal]time.Duration{} | ||
statements := strings.Split(expr, ",") | ||
for _, statement := range statements { | ||
parts := strings.Split(statement, "=") | ||
if len(parts) != 2 { | ||
return nil, fmt.Errorf("invalid eviction grace period syntax %v, expected <signal>=<duration>", statement) | ||
} | ||
signal := Signal(parts[0]) | ||
if !validSignal(signal) { | ||
return nil, fmt.Errorf(unsupportedEvictionSignal, signal) | ||
} | ||
|
||
gracePeriod, err := time.ParseDuration(parts[1]) | ||
if err != nil { | ||
return nil, err | ||
} | ||
if gracePeriod < 0 { | ||
return nil, fmt.Errorf("invalid eviction grace period specified: %v, must be a positive value", parts[1]) | ||
} | ||
|
||
// check against duplicate statements | ||
if _, found := results[signal]; found { | ||
return nil, fmt.Errorf("duplicate eviction grace period specified for %v", signal) | ||
} | ||
results[signal] = gracePeriod | ||
} | ||
return results, nil | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,142 @@ | ||
/* | ||
Copyright 2016 The Kubernetes Authors All rights reserved. | ||
|
||
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 eviction | ||
|
||
import ( | ||
"testing" | ||
"time" | ||
|
||
"k8s.io/kubernetes/pkg/api/resource" | ||
) | ||
|
||
func TestParseThresholdConfig(t *testing.T) { | ||
gracePeriod, _ := time.ParseDuration("30s") | ||
testCases := map[string]struct { | ||
evictionHard string | ||
evictionSoft string | ||
evictionSoftGracePeriod string | ||
expectErr bool | ||
expectThresholds []Threshold | ||
}{ | ||
"no values": { | ||
evictionHard: "", | ||
evictionSoft: "", | ||
evictionSoftGracePeriod: "", | ||
expectErr: false, | ||
expectThresholds: []Threshold{}, | ||
}, | ||
"all flag values": { | ||
evictionHard: "memory.available<150Mi", | ||
evictionSoft: "memory.available<300Mi", | ||
evictionSoftGracePeriod: "memory.available=30s", | ||
expectErr: false, | ||
expectThresholds: []Threshold{ | ||
{ | ||
Signal: SignalMemoryAvailable, | ||
Operator: OpLessThan, | ||
Value: resource.MustParse("150Mi"), | ||
}, | ||
{ | ||
Signal: SignalMemoryAvailable, | ||
Operator: OpLessThan, | ||
Value: resource.MustParse("300Mi"), | ||
GracePeriod: gracePeriod, | ||
}, | ||
}, | ||
}, | ||
"invalid-signal": { | ||
evictionHard: "mem.available<150Mi", | ||
evictionSoft: "", | ||
evictionSoftGracePeriod: "", | ||
expectErr: true, | ||
expectThresholds: []Threshold{}, | ||
}, | ||
"duplicate-signal": { | ||
evictionHard: "memory.available<150Mi,memory.available<100Mi", | ||
evictionSoft: "", | ||
evictionSoftGracePeriod: "", | ||
expectErr: true, | ||
expectThresholds: []Threshold{}, | ||
}, | ||
"valid-and-invalid-signal": { | ||
evictionHard: "memory.available<150Mi,invalid.foo<150Mi", | ||
evictionSoft: "", | ||
evictionSoftGracePeriod: "", | ||
expectErr: true, | ||
expectThresholds: []Threshold{}, | ||
}, | ||
"soft-no-grace-period": { | ||
evictionHard: "", | ||
evictionSoft: "memory.available<150Mi", | ||
evictionSoftGracePeriod: "", | ||
expectErr: true, | ||
expectThresholds: []Threshold{}, | ||
}, | ||
"soft-neg-grace-period": { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: Can you add one test case that takes in an invalid resource along with memory? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
evictionHard: "", | ||
evictionSoft: "memory.available<150Mi", | ||
evictionSoftGracePeriod: "memory.available=-30s", | ||
expectErr: true, | ||
expectThresholds: []Threshold{}, | ||
}, | ||
} | ||
for testName, testCase := range testCases { | ||
thresholds, err := ParseThresholdConfig(testCase.evictionHard, testCase.evictionSoft, testCase.evictionSoftGracePeriod) | ||
if testCase.expectErr != (err != nil) { | ||
t.Errorf("Err not as expected, test: %v, error expected: %v, actual: %v", testName, testCase.expectErr, err) | ||
} | ||
if !thresholdsEqual(testCase.expectThresholds, thresholds) { | ||
t.Errorf("thresholds not as expected, test: %v, expected: %v, actual: %v", testName, testCase.expectThresholds, thresholds) | ||
} | ||
} | ||
} | ||
|
||
func thresholdsEqual(expected []Threshold, actual []Threshold) bool { | ||
if len(expected) != len(actual) { | ||
return false | ||
} | ||
for _, aThreshold := range expected { | ||
equal := false | ||
for _, bThreshold := range actual { | ||
if thresholdEqual(aThreshold, bThreshold) { | ||
equal = true | ||
} | ||
} | ||
if !equal { | ||
return false | ||
} | ||
} | ||
for _, aThreshold := range actual { | ||
equal := false | ||
for _, bThreshold := range expected { | ||
if thresholdEqual(aThreshold, bThreshold) { | ||
equal = true | ||
} | ||
} | ||
if !equal { | ||
return false | ||
} | ||
} | ||
return true | ||
} | ||
|
||
func thresholdEqual(a Threshold, b Threshold) bool { | ||
return a.GracePeriod == b.GracePeriod && | ||
a.Operator == b.Operator && | ||
a.Signal == b.Signal && | ||
a.Value.Cmp(b.Value) == 0 | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we check for duplicates for hard and soft thresholds as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think so, we could check that if you have:
hard=memory.available<X
soft=memory.available<Y
We could verify that X > Y, but not sure its worth the complication if we expose more operators.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What if the label includes multiple
hard=memory.available<X
sections?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
see https://github.com/kubernetes/kubernetes/pull/24750/files#diff-d1674863b3df010b8b90a347f6bec9b2R68
this part of the code is handling grace periods, so the check you asked for is not in this part of the code.