Use short name for tag value in development mode #810
Closed
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
pietern
requested review from
andrewnester,
lennartkats-db and
shreyas-goenka
| r.Jobs[i].Tags["dev"] = b.Config.Workspace.CurrentUser.DisplayName | ||
| // Note: tag values in jobs must match the following pattern: | ||
| // ^(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$ | ||
| r.Jobs[i].Tags["dev"] = b.Config.Workspace.CurrentUser.ShortName |
There was a problem hiding this comment.
Shouldn't we just do something like
to make the name match this mold?There was a problem hiding this comment.
We should, working on a fix. The allowed patterns vary per cloud so the change is a little more involved.
There was a problem hiding this comment.
Sounds good. +1 for merging this for now.
andrewnester
approved these changes
Sep 27, 2023
|
Fixes #809 |
lennartkats-db
approved these changes
Sep 28, 2023
This was referenced Sep 28, 2023
|
This is superseded by a more robust fix #821. |
github-merge-queue bot
pushed a commit
that referenced
this pull request
Sep 29, 2023
## Changes Prompted by the proposed fix for a tagging-related problem in #810, I investigated how tag validation works. This turned out to be quite a bit more complex than anticipated. Tags at the job level (or cluster level) are passed through to the underlying compute infrastructure and as such are tested against cloud-specific validation rules. GCP appears to be the most restrictive. It would be disappointing to always restrict to `\w+`, so this package implements validation and normalization rules for each cloud. It can pick the right cloud to use using a Go SDK configuration. ## Tests Exhaustive unit tests. The regular expressions were pulled by #814.
github-merge-queue bot
pushed a commit
that referenced
this pull request
Oct 2, 2023
## Changes The jobs backend propagates job tags to the underlying cloud provider's resources. As such, they need to match the constraints a cloud provider places on tag values. The display name can contain anything. With this change, we modify the tag value to equal the short name as used in the name prefix. Additionally, we leverage tag normalization as introduced in #819 to make sure characters that aren't accepted are removed before using the value as a tag value. This is a new stab at #810 and should completely eliminate this class of problems. ## Tests Tests pass.
hectorcast-db
pushed a commit
that referenced
this pull request
Oct 13, 2023
## Changes Prompted by the proposed fix for a tagging-related problem in #810, I investigated how tag validation works. This turned out to be quite a bit more complex than anticipated. Tags at the job level (or cluster level) are passed through to the underlying compute infrastructure and as such are tested against cloud-specific validation rules. GCP appears to be the most restrictive. It would be disappointing to always restrict to `\w+`, so this package implements validation and normalization rules for each cloud. It can pick the right cloud to use using a Go SDK configuration. ## Tests Exhaustive unit tests. The regular expressions were pulled by #814.
hectorcast-db
pushed a commit
that referenced
this pull request
Oct 13, 2023
## Changes The jobs backend propagates job tags to the underlying cloud provider's resources. As such, they need to match the constraints a cloud provider places on tag values. The display name can contain anything. With this change, we modify the tag value to equal the short name as used in the name prefix. Additionally, we leverage tag normalization as introduced in #819 to make sure characters that aren't accepted are removed before using the value as a tag value. This is a new stab at #810 and should completely eliminate this class of problems. ## Tests Tests pass.
This pull request was closed.
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.
Changes
The jobs API expects tag values to match the regex
^(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$. The display name can contain anything. With this change we modify the tag value to equal the short name as used in the name prefix.This won't work in all cases because the short name can contain accents but is strictly better than the display name.
A better solution adds a separate property to the user struct with some kind of normalized display name, or normalized tag value name, that always strictly matches the regex above.
Tests
Tests pass.