[docs] Add documentation for nomad-pack template functions #494
Conversation
angrycub
added
theme/docs
stage/accepted
type/enhancement
theme/template/function
| ##### Example | ||
|
|
||
| ``` | ||
| [[ $cs := ( customSpew | withDisableCapacities true ) ]][[ $cs.Sdump . ]] |
There was a problem hiding this comment.
should be a toStringList example
| ##### Example | ||
|
|
||
| ``` | ||
|
|
||
| ``` | ||
|
|
||
| ##### Output | ||
|
|
||
| ``` | ||
| ``` |
There was a problem hiding this comment.
empty example/output for nomadRegions
|
|
||
| #### `fileContents` <a id="fileContents"></a> | ||
|
|
||
| Imports the contents of a file on the local file system into the template at runtime. |
There was a problem hiding this comment.
Can it be clarified that the files are relative to the directory where nomad-pack is invoked? I'm pretty sure they aren't relative to the job as that isn't working for me (which is frustrating, because thats where I'd expect them to be).
There was a problem hiding this comment.
The fileContents function is part of the job meta-templating and is run while building the job spec itself. Should you want to import files while processing the jobspec , you should consider the HCL2 file function, which would work more like you expect; but requires that the file to include always travel with the job spec.
|
I think this is also missing the functions defined [here]https://github.com/hashicorp/nomad-pack/blob/3c0178a561b360906c591718edb25ae25ae9d964/internal/pkg/variable/parser/template_context.go#L159( for variable retrieval. |
| ##### Example | ||
|
|
||
| ``` | ||
| [[ $cs := ( customSpew | withMaxDepth true ) ]][[ $cs.Sdump . ]] |
There was a problem hiding this comment.
Max Depth should be an integer
[[ $cs := ( customSpew | withMaxDepth 5) ]][[ $cs.Sdump . ]]
| ##### Example | ||
|
|
||
| ``` | ||
| [[ $cs := ( customSpew | withDisableMethods true ) ]][[ $cs.Sdump . ]] |
There was a problem hiding this comment.
withDisableMethods sets s.DisableMethods to true. So only "true" is not allowed (want 1 got 2). So it should be:
[[ $cs := ( customSpew | withDisableMethods ) ]][[ $cs.Sdump . ]]
There was a problem hiding this comment.
Same with all the following, which use "true" as parameter
|
Could this get merged and then improved at a later date? |
This PR starts chipping away at the Pack documentation tech debt by documenting the template helper functions that Pack provides to the template context.