Improved manifest extraction errors #827
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
Closes #817 This is something that comes up quite often in our internal environments When a data structure is not a Kubernetes manifest, the error makes it hard to find out why This adds a reason, and context for why the object we found isn't a Kubernetes object In the issue being closed, the error was: ``` >> tk show environments/default Error: got an error while extracting env `environments/default`: recursion did not resolve in a valid Kubernetes object. In path `.grafana.deployment` found key `apiVersion` of type `string` instead. ``` It is now: ``` >> tk show environments/default Error: got an error while extracting env `environments/default`: recursion ended on key "apiVersion" of type string which does not belong to a valid Kubernetes object instead, it an attribute of the following object: apiVersion: apps/v1 kind: 3000 metadata: name: grafana spec: selector: matchLabels: name: grafana template: metadata: labels: name: grafana spec: containers: - image: grafana/grafana name: grafana ports: - containerPort: 3000 name: ui this object is not a valid Kubernetes object because: attribute "kind" is not a string, it is a float64 ``` More verbose, but it actually helps the user find the error
|
iainlane
approved these changes
Mar 23, 2023
There was a problem hiding this comment.
looks better, nice one.
I definitely don't fully understand how validation works, but I left a comment about the message there, I feel it could be a bit clearer. Feel free to disregard if it doesn't make sense. & re-request if you make changes and want 👀 again.
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.
Closes #817
This is something that comes up quite often in our internal environments
When a data structure is not a Kubernetes manifest, the error makes it hard to find out why
This adds a reason, and context for why the object we found isn't a Kubernetes object
In the issue linked above, the error was:
It is now:
More verbose, but it actually helps the user find the error