Support different versions per instance of a component #559
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
simu
changed the title
Recent pylint (or Python+pylint) versions can deal with `Optional[str]` and similar type annotations without requiring the pylint annotation `# pylint: disable=unsubscriptable-object`.
Implemented:
* Create separate worktrees for each component alias
* Create class symlinks for each component alias
* Create each alias target with only the defaults and component class
for the alias worktree
* Works only for components which use `${_base_directory}` in their
config (kapitan.compile and kapitan.dependencies mainly)
TODO:
* Actually allow users to specify version for each alias separately
* Cleanup changes
* Add tests
* Update docs
simu
force-pushed
the
feat/per-alias-versions
branch
from
cd837a7 to
7322392
Compare
We add support for specifying instance versions in `parameters.components`. Commodore falls back to the version/url/path specified for the component when the keys are not provided for component aliases. Note that the actual dependency handling doesn't yet support overriding URL/path for aliases.
simu
force-pushed
the
feat/per-alias-versions
branch
from
7322392 to
591f081
Compare
HappyTetrahedron
force-pushed
the
feat/per-alias-versions
branch
3 times, most recently
from
dded3cf to
0e6e4cd
Compare
- Fix compile tests by falling back to old component path if no dependencies object is present - Fix git tree tests by allowing dependency repos with no Author information on components - Fix using the correct path for rendering aliased targets
HappyTetrahedron
force-pushed
the
feat/per-alias-versions
branch
from
0e6e4cd to
a588aea
Compare
simu
commented
Jan 28, 2025
Comment on lines
210
to
+214
| for c in sorted(components): | ||
| if inv.defaults_file(c).is_file(): | ||
| classes.append(f"defaults.{c}") | ||
| defaults_file = inv.defaults_file(c) | ||
| if c == component and target != component: | ||
| # Special case alias defaults symlink | ||
| defaults_file = inv.defaults_file(target) |
There was a problem hiding this comment.
We've not really thought about this in the design doc, but this snippet makes the implicit decision to only provide the class/defaults.yml of the unaliased instance of other components to each component instance.
This is probably fine for the same reasons as it's fine to only provide the unaliased component library, since I can't really imagine a sensible usecase where a component would want to read configuration from multiple instances of another component.
HappyTetrahedron
force-pushed
the
feat/per-alias-versions
branch
from
ae47615 to
fc7e23a
Compare
HappyTetrahedron
force-pushed
the
feat/per-alias-versions
branch
from
8c4ee76 to
d9bc703
Compare
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 PR changes Commodore to
parameters.components.<instance-name>Note that per-instance versions only work correctly only for components which use
${_base_directory}in their config when specifying Jsonnet files or Helm chart/YAML locations inkapitan.compileandkapitan.dependencies. Note, that components should use${_base_directory}anyway, and new components created from the template use${_base_directory}out of the box.TODO:
Resolves #563
Checklist
bug,enhancement,documentation,change,breaking,dependencyas they show up in the changelog