k8sutil: Ensure rook version label has valid syntax
Replace any invalid characters and ensure length and format for the rook version label, to avoid problems with version strings that contain illegal characters (common characters that aren't valid in labels would be + and ~, for example). Kubernetes label syntax: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set Fixes: #3434 Signed-off-by: Kristoffer Grönlund <kgronlund@suse.com>
This commit is contained in:
1 parent
6e91054422
commit
6ff69a4e72
2 files changed
+41
-1
No files matched your search
@@ -20,6 +20,7 @@ package k8sutil
|
||||
import (
|
||||
"crypto/md5"
|
||||
"fmt"
|
||||
"regexp"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
@@ -138,6 +139,30 @@ func deleteResourceAndWait(namespace, name, resourceType string,
|
||||
// will result in the deployment/daemonset/ect. recreating all of its pods even if an update
|
||||
// wouldn't otherwise be required. Upgrading unnecessarily increases risk for loss of data
|
||||
// reliability, even if only briefly.
|
||||
//
|
||||
// Note that the label may not match the version string exactly, since some characters used
|
||||
// in version strings are illegal in pod labels.
|
||||
func addRookVersionLabel(labels map[string]string) {
|
||||
labels[RookVersionLabelKey] = rookversion.Version
|
||||
label := rookversion.Version
|
||||
labels[RookVersionLabelKey] = validateLabelValue(label)
|
||||
}
|
||||
|
||||
// validateLabelValue replaces any invalid characters
|
||||
// in the input string with a replacement character,
|
||||
// and enforces other limitations for k8s label values.
|
||||
//
|
||||
// See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set
|
||||
func validateLabelValue(value string) string {
|
||||
repl := "-"
|
||||
maxlen := 63
|
||||
re := regexp.MustCompile("[^a-z0-9A-Z._-]")
|
||||
// restrict label value to valid character set
|
||||
sanitized := re.ReplaceAllLiteralString(value, repl)
|
||||
// ensure value begins and ends with a valid character
|
||||
sanitized = strings.TrimRight(strings.TrimLeft(sanitized, ".-_"), ".-_")
|
||||
// limit length
|
||||
if len(sanitized) > maxlen {
|
||||
sanitized = sanitized[:maxlen]
|
||||
}
|
||||
return sanitized
|
||||
}
|
||||
@@ -51,3 +51,18 @@ func TestTruncateNodeName(t *testing.T) {
|
||||
assert.Equal(t, result, TruncateNodeName(params[0], params[1]))
|
||||
}
|
||||
}
|
||||
|
||||
func TestValidateLabelValue(t *testing.T) {
|
||||
// The key is the result, and the value is the input.
|
||||
tests := map[string]string{
|
||||
"": "",
|
||||
"1.0": "1.0",
|
||||
"1.0.0-git1697.ga265cdfd": "1.0.0+git1697.ga265cdfd",
|
||||
"this-entry-is-more-than-63-characters-long-so-it-will-be-trunca": "this-entry-is-more-than-63-characters-long-so-it-will-be-truncated",
|
||||
"1": ".1.",
|
||||
}
|
||||
|
||||
for result, input := range tests {
|
||||
assert.Equal(t, result, validateLabelValue(input))
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user