Add annotations to CreateSandbox request #8960
Merged
Conversation
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
dcantah
force-pushed
the
sandbox-annotations
branch
2 times, most recently
from
cd637c5
to
60cdec6
Compare
An oft employed scheme for a lot of our APIs is to include an annotations field which is just a map of string to string. This usually allows folks using the API to send over metadata or auxiliary information without needing to get a new field added (especially where the field might not make sense for it to be a standalone field). I think having annotations for CreateSandbox make sense for this same use case. Signed-off-by: Danny Canter <danny@dcantah.dev>
Following the addition of annotations to the grpc/ttrpc API surface, follow suit with adding annotations to the controller api surface. Signed-off-by: Danny Canter <danny@dcantah.dev>
dcantah
force-pushed
the
sandbox-annotations
branch
from
60cdec6
to
def5ff3
Compare
|
What type of information would be stored in the annotations? We more commonly use "labels" in our API and storage layer. The difference between the two is labels are often used or interpreted by containerd plugins (gc labels, filtering labels, plugin features) while annotations are mostly metadata that just gets passed or inherited as part of another structure. |
|
@dmcgowan I was thinking "feature" toggles or other info related to actually running the workload. For instance this might've been used before the netnspath field was added to send over that info while someone explored its viability, or if it needed to be a full field |
dmcgowan
approved these changes
Aug 22, 2023
mxpv
reviewed
Aug 23, 2023
mxpv
approved these changes
Aug 23, 2023
dmcgowan
changed the title
dmcgowan
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
An oft employed scheme for a lot of our APIs is to include an
annotations field which is just a map of string to string. This
usually allows folks using the API to send over metadata or auxiliary
information without needing to get a new field added (especially where
the field might not make sense for it to be a standalone field). I think
having annotations for CreateSandbox makes sense for this same use case.