Replace slash and period with underscore for label names #237
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
jackatbancast
force-pushed
the
snake-case-console-label-keys
branch
from
fb9490a to
8900ec0
Compare
VSpike
changed the title
VSpike
previously approved these changes
Aug 4, 2021
benwh
previously approved these changes
Aug 4, 2021
| // app_kubernetes_io_instance | ||
| func linearLabelKey(labelKey string) string { | ||
| labelKey = strings.ReplaceAll(labelKey, "/", "_") | ||
| labelKey = strings.ReplaceAll(labelKey, ".", "_") |
There was a problem hiding this comment.
I wondered if we should be doing the same for dashes
https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set
But actually it seems like ES would be fine with these, so no issue there
jackatbancast
commented
Aug 4, 2021
This change replaces all occurences of `.` and `/` in label keys. Occasionally a kubernetes label will take the form of a url, e.g. `app.kubernetes.io/instance`. In this case we would output that key prefixed by our given parameter. This can cause issues with systems such as ElasticSearch where it will see the `.` as an object path separator and attempt to build the object from the labels. This may work but is likely unintended behaviour and can be surprising. This issue is compounded if you have a matching key to the first segment of the domain-prefixed key, e.g. `app` in our case. This would conflict with the object that is being created by `app.kubernetes.io` and potentially cause errors to occur. By reducing the label key to a form similar to snake case we can avoid this issue and provide dependant systems with a label form that doesn't conflict. Additionaly we can provide more consistent behaviour. --- This change additionally includes some changes to the console integration tests to increase the amount of time we wait for a short duration. I've not confirmed this yet, but it appears that the amount of time it takes to run tests in kubebuilder's envtest has increased, leading to some flaky tests. Increasing the short timeout appears to fix this issue, which can also be seen on the `master` branch.
jackatbancast
force-pushed
the
snake-case-console-label-keys
branch
from
8900ec0 to
16c6dac
Compare
theobarberbany
approved these changes
Aug 5, 2021
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.
This change replaces all occurences of
.and/in labelkeys. Occasionally a kubernetes label will take the form of a url,
e.g.
app.kubernetes.io/instance. In this case we would output thatkey prefixed by our given parameter.
This can cause issues with systems such as ElasticSearch where it will
see the
.as an object path separator and attempt to build theobject from the labels. This may work but is likely unintended
behaviour and can be surprising.
This issue is compounded if you have a matching key to the first
segment of the domain-prefixed key, e.g.
appin our case. This wouldconflict with the object that is being created by
app.kubernetes.ioand potentially cause errors to occur.
By reducing the label key to a form similar to snake case we can
avoid this issue and provide dependant systems with a label form that
doesn't conflict. Additionaly we can provide more consistent behaviour.