fix: accept all docker memory units in resource values
Memory values with uppercase or other docker-supported units such as `1G`, `512M` or `1GiB` are now passed to docker unchanged instead of having an extra `m` appended, and the k3s scheduler interprets memory values with the same binary units so a value means the same thing on both schedulers. Invalid `--memory` and `--memory-swap` values are now rejected by `resource:limit` and `resource:reserve`. Closes #9153.
This commit is contained in:
13 files changed
+382
-30
No files matched your search
@@ -2,25 +2,38 @@ package resource
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"github.com/dokku/dokku/plugins/common"
|
||||
)
|
||||
|
||||
func addMemorySuffixForDocker(key string, value string) string {
|
||||
if key == "memory" {
|
||||
hasSuffix := false
|
||||
suffixes := []string{"b", "k", "m", "g", "KB", "MB", "GB", "B"}
|
||||
for _, suffix := range suffixes {
|
||||
if strings.HasSuffix(value, suffix) {
|
||||
hasSuffix = true
|
||||
}
|
||||
// validateResourceValue returns an error if the value is not valid for the given resource key
|
||||
func validateResourceValue(key string, value string) error {
|
||||
switch key {
|
||||
case "memory":
|
||||
if !common.IsValidMemoryValue(value) {
|
||||
return fmt.Errorf("Invalid memory value '%s': must be a number with an optional unit suffix of b, k, m, g, t or p", value)
|
||||
}
|
||||
if !hasSuffix {
|
||||
value = value + "m"
|
||||
case "memory-swap":
|
||||
if value != "-1" && !common.IsValidMemoryValue(value) {
|
||||
return fmt.Errorf("Invalid memory-swap value '%s': must be -1 or a number with an optional unit suffix of b, k, m, g, t or p", value)
|
||||
}
|
||||
}
|
||||
return value
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// formatResourceValueForDocker validates a resource value and formats it for use as a docker flag value.
|
||||
// Memory values without a unit default to megabytes
|
||||
func formatResourceValueForDocker(key string, value string) (string, error) {
|
||||
if err := validateResourceValue(key, value); err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
if key == "memory" && common.IsUnitlessMemoryValue(value) {
|
||||
value = value + "m"
|
||||
}
|
||||
|
||||
return value, nil
|
||||
}
|
||||
|
||||
func clearByResourceType(appName string, processType string, resourceType string) {
|
||||
@@ -88,6 +101,16 @@ func setResourceType(appName string, processType string, r Resource, resourceTyp
|
||||
return nil
|
||||
}
|
||||
|
||||
for key, value := range resources {
|
||||
if value == "" || value == "clear" {
|
||||
continue
|
||||
}
|
||||
|
||||
if err := validateResourceValue(key, value); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
noun := "limits"
|
||||
if resourceType == "reserve" {
|
||||
noun = "reservation"
|
||||
|
||||
@@ -0,0 +1,55 @@
|
||||
package resource
|
||||
|
||||
import (
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestFormatResourceValueForDocker(t *testing.T) {
|
||||
testCases := []struct {
|
||||
name string
|
||||
key string
|
||||
value string
|
||||
expected string
|
||||
wantErr bool
|
||||
}{
|
||||
{name: "unitless memory defaults to megabytes", key: "memory", value: "100", expected: "100m"},
|
||||
{name: "unitless decimal memory defaults to megabytes", key: "memory", value: "1.5", expected: "1.5m"},
|
||||
{name: "lowercase memory unit", key: "memory", value: "512m", expected: "512m"},
|
||||
{name: "uppercase megabyte unit", key: "memory", value: "512M", expected: "512M"},
|
||||
{name: "uppercase gigabyte unit", key: "memory", value: "1G", expected: "1G"},
|
||||
{name: "uppercase kilobyte unit", key: "memory", value: "1024K", expected: "1024K"},
|
||||
{name: "terabyte unit", key: "memory", value: "1t", expected: "1t"},
|
||||
{name: "two letter unit", key: "memory", value: "512MB", expected: "512MB"},
|
||||
{name: "binary unit", key: "memory", value: "1GiB", expected: "1GiB"},
|
||||
{name: "byte unit", key: "memory", value: "100b", expected: "100b"},
|
||||
{name: "memory rejects negative values", key: "memory", value: "-1", wantErr: true},
|
||||
{name: "memory rejects extra arguments", key: "memory", value: "100G --foo", wantErr: true},
|
||||
{name: "memory rejects invalid units", key: "memory", value: "1Gm", wantErr: true},
|
||||
{name: "unlimited memory-swap", key: "memory-swap", value: "-1", expected: "-1"},
|
||||
{name: "unitless memory-swap stays in bytes", key: "memory-swap", value: "512", expected: "512"},
|
||||
{name: "uppercase memory-swap unit", key: "memory-swap", value: "2G", expected: "2G"},
|
||||
{name: "memory-swap rejects invalid units", key: "memory-swap", value: "1x", wantErr: true},
|
||||
{name: "memory-swap rejects other negative values", key: "memory-swap", value: "-2", wantErr: true},
|
||||
{name: "other keys are passed through", key: "cpus", value: "1.5", expected: "1.5"},
|
||||
}
|
||||
|
||||
for _, testCase := range testCases {
|
||||
t.Run(testCase.name, func(t *testing.T) {
|
||||
value, err := formatResourceValueForDocker(testCase.key, testCase.value)
|
||||
if testCase.wantErr {
|
||||
if err == nil {
|
||||
t.Fatalf("expected an error for %s=%s, got %s", testCase.key, testCase.value, value)
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected error for %s=%s: %v", testCase.key, testCase.value, err)
|
||||
}
|
||||
|
||||
if value != testCase.expected {
|
||||
t.Fatalf("expected %s, got %s", testCase.expected, value)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -71,22 +71,30 @@ func TriggerDockerArgsProcessDeploy(appName string, processType string) error {
|
||||
}
|
||||
}
|
||||
|
||||
var args strings.Builder
|
||||
for key, value := range limits {
|
||||
if value == "" {
|
||||
continue
|
||||
}
|
||||
value = addMemorySuffixForDocker(key, value)
|
||||
fmt.Printf(" --%s=%s ", key, value)
|
||||
value, err := formatResourceValueForDocker(key, value)
|
||||
if err != nil {
|
||||
return fmt.Errorf("Unable to apply resource limits for %s: %w", appName, err)
|
||||
}
|
||||
fmt.Fprintf(&args, " --%s=%s ", key, value)
|
||||
}
|
||||
|
||||
for key, value := range reservations {
|
||||
if value == "" {
|
||||
continue
|
||||
}
|
||||
value = addMemorySuffixForDocker(key, value)
|
||||
fmt.Printf(" --%s-reservation=%s ", key, value)
|
||||
value, err := formatResourceValueForDocker(key, value)
|
||||
if err != nil {
|
||||
return fmt.Errorf("Unable to apply resource reservations for %s: %w", appName, err)
|
||||
}
|
||||
fmt.Fprintf(&args, " --%s-reservation=%s ", key, value)
|
||||
}
|
||||
|
||||
fmt.Print(args.String())
|
||||
fmt.Print(string(stdin))
|
||||
return nil
|
||||
}
|
||||
@@ -136,14 +144,19 @@ func TriggerDockerArgsProcessBuild(appName string, builderType string) error {
|
||||
limits[flagName] = value
|
||||
}
|
||||
|
||||
var args strings.Builder
|
||||
for key, value := range limits {
|
||||
if value == "" {
|
||||
continue
|
||||
}
|
||||
value = addMemorySuffixForDocker(key, value)
|
||||
fmt.Printf(" --%s=%s ", key, value)
|
||||
value, err := formatResourceValueForDocker(key, value)
|
||||
if err != nil {
|
||||
return fmt.Errorf("Unable to apply build resource limits for %s: %w", appName, err)
|
||||
}
|
||||
fmt.Fprintf(&args, " --%s=%s ", key, value)
|
||||
}
|
||||
|
||||
fmt.Print(args.String())
|
||||
fmt.Print(string(stdin))
|
||||
return nil
|
||||
}
|
||||
|
||||
Reference in new issue
Block a user