devel: better support for runtime integration #43
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,139 @@ | ||
| /* | ||
| Copyright © 2021-2022 The CDI 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 cdi | ||
|
|
||
| import ( | ||
| "strings" | ||
|
|
||
| "github.com/pkg/errors" | ||
| ) | ||
|
|
||
| const ( | ||
| // AnnotationPrefix is the prefix for CDI container annotation keys. | ||
| AnnotationPrefix = "cdi.k8s.io/" | ||
| ) | ||
|
|
||
| // UpdateAnnotations updates annotations with a plugin-specific CDI device | ||
| // injection request for the given devices. Upon any error a non-nil error | ||
| // is returned and annotations are left intact. By convention plugin should | ||
| // be in the format of "vendor.device-type". | ||
| func UpdateAnnotations(annotations map[string]string, plugin string, deviceID string, devices []string) (map[string]string, error) { | ||
| key, err := AnnotationKey(plugin, deviceID) | ||
| if err != nil { | ||
| return annotations, errors.Wrap(err, "CDI annotation failed") | ||
| } | ||
| if _, ok := annotations[key]; ok { | ||
| return annotations, errors.Errorf("CDI annotation failed, key %q used", key) | ||
| } | ||
| value, err := AnnotationValue(devices) | ||
| if err != nil { | ||
| return annotations, errors.Wrap(err, "CDI annotation failed") | ||
| } | ||
|
|
||
| if annotations == nil { | ||
| annotations = make(map[string]string) | ||
| } | ||
| annotations[key] = value | ||
|
|
||
| return annotations, nil | ||
| } | ||
|
|
||
| // ParseAnnotations parses annotations for CDI device injection requests. | ||
klihub marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| // The keys and devices from all such requests are collected into slices | ||
| // which are returned as the result. All devices are expected to be fully | ||
| // qualified CDI device names. If any device fails this check empty slices | ||
| // are returned along with a non-nil error. The annotations are expected | ||
| // to be formatted by, or in a compatible fashion to UpdateAnnotations(). | ||
| func ParseAnnotations(annotations map[string]string) ([]string, []string, error) { | ||
| var ( | ||
| keys []string | ||
| devices []string | ||
| ) | ||
|
|
||
| for key, value := range annotations { | ||
| if !strings.HasPrefix(key, AnnotationPrefix) { | ||
| continue | ||
| } | ||
| for _, d := range strings.Split(value, ",") { | ||
| if !IsQualifiedName(d) { | ||
| return nil, nil, errors.Errorf("invalid CDI device name %q", d) | ||
| } | ||
| devices = append(devices, d) | ||
| } | ||
| keys = append(keys, key) | ||
| } | ||
|
|
||
| return keys, devices, nil | ||
| } | ||
|
|
||
| // AnnotationKey returns a unique annotation key for an device allocation | ||
| // by a K8s device plugin. pluginName should be in the format of | ||
| // "vendor.device-type". deviceID is the ID of the device the plugin is | ||
| // allocating. It is used to make sure that the generated key is unique | ||
| // even if multiple allocations by a single plugin needs to be annotated. | ||
| func AnnotationKey(pluginName, deviceID string) (string, error) { | ||
| const maxNameLen = 63 | ||
|
There was a problem hiding this comment. Question: Where does this limit come from? There was a problem hiding this comment. IIRC, it comes from k8s annotation/label name limits. |
||
|
|
||
| if pluginName == "" { | ||
| return "", errors.New("invalid plugin name, empty") | ||
| } | ||
| if deviceID == "" { | ||
| return "", errors.New("invalid deviceID, empty") | ||
|
|
||
| } | ||
|
|
||
| name := pluginName + "_" + strings.ReplaceAll(deviceID, "/", "_") | ||
|
|
||
| if len(name) > maxNameLen { | ||
| return "", errors.Errorf("invalid plugin+deviceID %q, too long", name) | ||
| } | ||
|
|
||
| if c := rune(name[0]); !isAlphaNumeric(c) { | ||
| return "", errors.Errorf("invalid name %q, first '%c' should be alphanumeric", | ||
| name, c) | ||
| } | ||
| if len(name) > 2 { | ||
| for _, c := range name[1 : len(name)-1] { | ||
| switch { | ||
| case isAlphaNumeric(c): | ||
| case c == '_' || c == '-' || c == '.': | ||
| default: | ||
| return "", errors.Errorf("invalid name %q, invalid charcter '%c'", | ||
| name, c) | ||
| } | ||
| } | ||
| } | ||
| if c := rune(name[len(name)-1]); !isAlphaNumeric(c) { | ||
| return "", errors.Errorf("invalid name %q, last '%c' should be alphanumeric", | ||
|
There was a problem hiding this comment. Why is this a requirement? Is the only hard requirement not that the string cannot end on (or contain) There was a problem hiding this comment. I would argue that we need to be as unrestrictive as possible here. The motivation being that we are looking to support multiple plugin vendors / implementations which may have vastly different ways of representing device IDs and / or plugin names. Requiring that these change or that different "variants" be tracked seems like unnecessary additional overhead. |
||
| name, c) | ||
| } | ||
|
Comment on lines
+104
to
+122
There was a problem hiding this comment. Is this not just the same as |
||
|
|
||
| return AnnotationPrefix + name, nil | ||
| } | ||
|
|
||
| // AnnotationValue returns an annotation value for the given devices. | ||
| func AnnotationValue(devices []string) (string, error) { | ||
| value, sep := "", "" | ||
| for _, d := range devices { | ||
| if _, _, _, err := ParseQualifiedName(d); err != nil { | ||
| return "", err | ||
| } | ||
| value += sep + d | ||
| sep = "," | ||
| } | ||
|
|
||
| return value, nil | ||
|
Comment on lines
+129
to
+138
There was a problem hiding this comment. What about: Note, we could also just call |
||
| } | ||
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.
Uh oh!
There was an error while loading. Please reload this page.