feat(map.jinja): load configuration values from configurables sources #70
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
|
I updated my splityaml to puts I tested this formula with |
baby-gnu
force-pushed
the
feature/configurable-map.jinja
branch
2 times, most recently
from
ebf307b
to
b1cf8e1
Compare
Lookup the configuration for `map.jinja` from: 1. builtin default 1. `osarch` grain 2. `os_family` grain 3. `os` grain 4. `osfinger` grain 5. `lookup` table retrived by `config.get` 6. configuration retrived by `config.get` 7. `id` grain 2. `defaults.yaml`: optionally define a formula specific `map_jinja:sources` 3. global configuration lookup `map_jinja:sources` 4. formula specific `<tplroot>:map_jinja:sources` The hard coded default is backward compatible and add the minion id at the end of the list. If an entry does not match a `salt['config.get']` parameter, it's used as a literal file path (with `.yaml` added if it's missing). Each YAML file are formatted with the following top level keys: - `values`: contains the the parameter values - `strategy` (optional): define the merge strategy for the function `salt.slsutils.merge` (aggregate, list, overwrite, recurse, smart). The default is `smart`. - `merge_lists` (optional): boolean to merge lists or overwrite them It's possile to configure `config.get` when looking up the formula configuration. You need to define a subkey `strategy` with the following differences from YAML files: - `strategy` can only be one of `None`, `overwrite` and `recurse`. The default is `None`. - if you use `salt-ssh`, this merge strategy is skipped and and error log message is emitted. The parameters values are merged in the following order: 1. initialize default values from `defaults.yaml` 2. merge the values from each source defined by the ordered list `map_jinja:sources`
* libvirt/parameters/defaults.yaml: replace the top level key `libvirt` by 'values`.
baby-gnu
force-pushed
the
feature/configurable-map.jinja
branch
from
b1cf8e1
to
365f711
Compare
myii
approved these changes
Mar 24, 2020
There was a problem hiding this comment.
Fantastic work, @baby-gnu! The next generation of map.jinja has begun! All OK in the yaml_dump tests as well:
|
🎉 This PR is included in version 3.7.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
19 tasks
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.
PR progress checklist (to be filled in by reviewers)
What type of PR is this?
Primary type
[build]Changes related to the build system[chore]Changes to the build process or auxiliary tools and libraries such as documentation generation[ci]Changes to the continuous integration configuration[feat]A new feature[fix]A bug fix[perf]A code change that improves performance[refactor]A code change that neither fixes a bug nor adds a feature[revert]A change used to revert a previous commit[style]Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)Secondary type
[docs]Documentation changes[test]Adding missing or correcting existing testsDoes this PR introduce a
BREAKING CHANGE?No.
Related issues and/or pull requests
saltstack-formulas/template-formula#186
Describe the changes you're proposing
Load the formula parameters values from configurable
map.jinjasources.The configuration for
map.jinjacomes from:builtin default
osarchgrainos_familygrainosgrainosfingergrainlookuptable retrived byconfig.getconfig.getidgraindefaults.yaml: optionally define a formula specificmap_jinja:sourcesglobal configuration lookup
map_jinja:sourcesformula specific
<tplroot>:map_jinja:sourcesThe hard coded default is backward compatible and add the minion id at the end of the list.
If an entry does not match a
salt['config.get']parameter, it's used as a literal file path (with.yamladded if it's missing).Each YAML file is formatted with the following top level keys:
values: contains the the parameter valuesstrategy(optional): define the merge strategy for the functionsalt.slsutils.merge(aggregate, list, overwrite, recurse, smart). The default issmart.merge_lists(optional): boolean to merge lists or overwrite themIt's possile to configure
config.getwhen looking up the formula configuration. You need to define a subkeystrategywith the following differences from YAML files:strategycan be one ofNone, overwrite and recurse. The default isNone.if you use
salt-ssh, this merge strategy is skipped and and error log message is emitted.The parameters values are merged in the following order:
initialize default values from
defaults.yamlmerge the values from each source defined by the ordered list
map_jinja:sourcesPillar / config required to test the proposed changes
To test the skipping of the merge configuration of
config.getwhen usingsalt-ssh:Debug log showing how the proposed changes work
When you put a pillar
libvirt:strategytooverwrite, you havesalt-sshminionorsalt-callDocumentation checklist
README(e.g.Available states).pillar.example.Testing checklist
state_top).Additional context