Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update SDD 0033 - Commodore Component Instance Versioning #184

Merged
merged 1 commit into from
Jan 31, 2025
Merged

Update SDD 0033 - Commodore Component Instance Versioning #184

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/modules/SDDs/pages/0033-commodore-component-instance-versioning.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
:sdd_owner: Aldebaran
:sdd_reviewers: Simon Gerber
:sdd_date: 2025-01-08
:sdd_status: accepted
:sdd_status: implemented
include::partial$meta-info-table.adoc[]

[NOTE]
Expand All @@ -30,7 +30,7 @@ Commodore will leverage the existing configuration options in `.parameters.compo
Instance versions can be specified in `.parameters.components.<instance-name>` and override the value specified in `.parameters.components.<component-name>`.
Even if all instances provide their own version, a version for the base component (`.parameters.components.<component-name>`) must still be specified.

Component authors must explicitly declare that their component supports multi-versioning by setting component parameter `_metadata.multi_versioning=true`.
Component authors must explicitly declare that their component supports multi-versioning by setting component parameter `_metadata.multi_version=true`.
In a valid catalog, all used versions of the same component must advertise this support.

Components with multi-versioning support must ensure they create no file conflicts when downloading dependencies.
Expand All @@ -42,6 +42,8 @@ If a component is to support multi-versioning, Jsonnet dependencies should there

Similarly, if the component includes a Jsonnet library that is made available to other components, the version for the library is taken from the main (non-instantiated) version of the component.

Finally, if a component reads another component's default values, it will always see the default values of the main (non-instantiated) version of the component.

=== Implementation Details/Notes/Constraints

We can clone the repository of the base component and create a separate worktree for each instance to check out the correct version.
Expand Down