Require CloudInit .spec.contents to be valid YAML (backport #34) #35
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
![mergify[bot]](https://avatars.githubusercontent.com/in/10562?s=60&v=4){kind=small}
The Elemental cloud-init executor will fail in disastrous ways instead of just discarding the document if the document's contents are not YAML. However, it does ignore instructions that it doesn't understand if the document is valid YAML. So, require that the CloudInit resource's .spec.contents are valid YAML. Ideally we could use the yip package to parse and perform semantic analysis on the document as a richer form of validation here, but that package does not expose a way of reading those diagnostics. In client code, it only logs what the errors are (in fact, the function signature doesn't return an error.) Some future work upstream in that package could be beneficial here to create an API such that the yip package can return errors to its caller instead of simply logging them. Signed-off-by: Connor Kuehl <[email protected]> (cherry picked from commit 786b1b2)
ibrokethecloud
approved these changes
Feb 11, 2024
markhillgit
approved these changes
Feb 11, 2024
tserong
approved these changes
Feb 12, 2024
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 is an automatic backport of pull request #34 done by Mergify.
Mergify commands and options
More conditions and actions can be found in the documentation.
You can also trigger Mergify actions by commenting on this pull request:
@Mergifyio refreshwill re-evaluate the rules@Mergifyio rebasewill rebase this PR on its base branch@Mergifyio updatewill merge the base branch into this PR@Mergifyio backport <destination>will backport this PR on<destination>branchAdditionally, on Mergify dashboard you can:
Finally, you can contact us on https://mergify.com