Inject metadata into HCL templates #737
Open
+252
−52
Conversation
This file contains hidden or 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
allisonlarson
force-pushed
the
f-add-metadata-to-hcl
branch
from
618f76a to
08a01c3
Compare
tgross
previously approved these changes
Sep 15, 2025
There was a problem hiding this comment.
Great work on this @allisonlarson! One minor question: what about the old code that was setting the meta attributes? That's redundant now so can we remove it?
Comment on lines
+47
to
+49
| // the values with any existing meta block or attribute. If the parsing fails, | ||
| // or the HCL is invalid, the original job is returned unmodified so that the | ||
| // errors can be caught later during job parsing. |
There was a problem hiding this comment.
I like that we're giving up here so that we avoid having to reimplement all the logic the parser already has. 👍
|
@tgross Correct, it should be redundant! I had left it as-is in the case of a fallback, but it makes more sense to remove it completely. |
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.
Description
Currently, nomad-pack injects metadata about the pack into the json definition of the job and not the HCL. When a pack job is managed outside of nomad-pack, like in the UI, the job loses its reference to the pack and is unable to be managed with nomad-pack until the job is completely removed.
This change takes the rendered HCL and injects the metadata into the job/meta block, instead of just the json. It will merge with the defined meta attribute or block if it exists. In the case that it cannot successfully parse the HCL, the original job will be returned. If the job is has multiple meta attributes/blocks defined, it will merge with one and return the other untouched. This is invalid, but will be caught in the next step of the process, which is parsing the templates in nomad. The approach is to inject these values with as little change to the underlying job as possible, and allow any existing invalid HCL to still be passed through and caught in nomad during the parsing step.
Reminders
CHANGELOG.mdentryChanges to Security Controls
Are there any changes to security controls (access controls, encryption, logging) in this pull request? If so, explain.