mirror of
https://github.com/vmware-tanzu/velero.git
synced 2025-12-23 14:25:22 +00:00
de8962ea18
* Use a helper function when querying w/ backup label Setting or querying for a backup label name should always pass the value through the GetValidName function. This change passes query uses of the backup label value through the GetValidName function by introducing 2 new helpers, one for making a Selector, one for making a ListOptions. It also removes functions returning the same data, but under unecessarily specific names. Signed-off-by: Nolan Brubaker <brubakern@vmware.com> * Document using the label.GetValidName function Signed-off-by: Nolan Brubaker <brubakern@vmware.com> * Update copyright year Signed-off-by: Nolan Brubaker <brubakern@vmware.com> * Clarify labels.GetValidName and annotations Signed-off-by: Nolan Brubaker <brubakern@vmware.com> * Move functions to pkg/label Signed-off-by: Nolan Brubaker <brubakern@vmware.com> * Fix function comments Signed-off-by: Nolan Brubaker <brubakern@vmware.com>
64 lines
2.4 KiB
Go
64 lines
2.4 KiB
Go
/*
|
|
Copyright 2019 the Velero contributors.
|
|
|
|
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 label
|
|
|
|
import (
|
|
"crypto/sha256"
|
|
"fmt"
|
|
|
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
|
"k8s.io/apimachinery/pkg/labels"
|
|
"k8s.io/apimachinery/pkg/util/validation"
|
|
|
|
velerov1api "github.com/vmware-tanzu/velero/pkg/apis/velero/v1"
|
|
)
|
|
|
|
// GetValidName converts an input string to valid kubernetes label string in accordance to rfc1035 DNS Label spec
|
|
// (https://github.com/kubernetes/community/blob/master/contributors/design-proposals/architecture/identifiers.md)
|
|
// Length of the label is adjusted basis the DNS1035LabelMaxLength (defined at k8s.io/apimachinery/pkg/util/validation)
|
|
// If length exceeds, we trim the label name to contain only max allowed characters
|
|
// Additionally, the last 6 characters of the label name are replaced by the first 6 characters of the sha256 of original label
|
|
func GetValidName(label string) string {
|
|
if len(label) <= validation.DNS1035LabelMaxLength {
|
|
return label
|
|
}
|
|
|
|
sha := sha256.Sum256([]byte(label))
|
|
strSha := fmt.Sprintf("%x", sha)
|
|
charsFromLabel := validation.DNS1035LabelMaxLength - 6
|
|
if charsFromLabel < 0 {
|
|
// Derive the label name from sha hash in case the DNS1035LabelMaxLength is less than 6
|
|
return string(strSha[validation.DNS1035LabelMaxLength])
|
|
}
|
|
|
|
return label[:charsFromLabel] + strSha[:6]
|
|
}
|
|
|
|
// NewSelectorForBackup returns a Selector based on the backup name.
|
|
// This is useful for interacting with Listers that need a Selector.
|
|
func NewSelectorForBackup(name string) labels.Selector {
|
|
return labels.SelectorFromSet(map[string]string{velerov1api.BackupNameLabel: GetValidName(name)})
|
|
}
|
|
|
|
// NewListOptionsForBackup returns a ListOptions based on the backup name.
|
|
// This is useful for interacting with client-go clients that needs a ListOptions.
|
|
func NewListOptionsForBackup(name string) metav1.ListOptions {
|
|
return metav1.ListOptions{
|
|
LabelSelector: fmt.Sprintf("%s=%s", velerov1api.BackupNameLabel, GetValidName(name)),
|
|
}
|
|
}
|