Skip to content

Link to product image version concepts page from relevant ADRs #676

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

Merged
merged 2 commits into from
Nov 4, 2024
Merged

Link to product image version concepts page from relevant ADRs #676

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
15e33f3
Link to product image version concepts page from relevant ADRs
sbernauer Nov 4, 2024
b9554a1
newline
sbernauer Nov 4, 2024
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
2 changes: 1 addition & 1 deletion modules/concepts/pages/product-image-selection.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ spec:
# stackableVersion: 24.3.0 optional <.>
----
<.> The version of your product - consult the product operator documentation to find out about supported product versions.
<.> The version of the Stackable Data Platform. If you omit it, the operator will use it's own version together with the product version to select the product image.
<.> The version of the Stackable Data Platform. If you omit it, the operator will use it's own version together with the product version to select the product image. It is recommended to omit this field, so that you are always using the correct, compatible version of the product image.

This page explains the different ways of specifying product images and the components that are involved,
starting from the simple way of using the default images to explaining how to use custom or mirrored registries as well as custom images.
Expand Down
7 changes: 7 additions & 0 deletions modules/contributor/pages/adr/ADR018-product_image_versioning.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@ v0.1, 04.05.2022
** Natalie Klestrup-Röjiezon
* Date: 04.05.2022

[IMPORTANT]
====
Please note that this ADR was overruled in the meantime.
We decided to release operators and product images in lockstep, with the primary reason being the maintenance and distribution of compatibility matrices is complex both for us and customers.
The current state of image versioning is documented in xref:concepts:product-image-selection.adoc[this concept guide].
====

== Glossary

[cols="20%,80%"]
Expand Down
4 changes: 3 additions & 1 deletion modules/contributor/pages/adr/ADR023-product-image-selection.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ v0.1, 2022-08-31

Note: Parts of this ADR were expanded by xref:adr/ADR028-automatic-stackable-version.adoc[]

Note: The current state of image versioning is documented in xref:concepts:product-image-selection.adoc[this concept guide].

== Context and Problem Statement
Currently users have to specify the full image tag in the Products CRD, as described in xref:adr/ADR018-product_image_versioning.adoc[].

Expand Down Expand Up @@ -185,4 +187,4 @@ image:
productVersion: 1.4.1
----

This resolves to enum variant 3. The product version is mandatory so the operator knows what to do.
This resolves to enum variant 3. The product version is mandatory so the operator knows what to do.
2 changes: 2 additions & 0 deletions modules/contributor/pages/adr/ADR028-automatic-stackable-version.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Technical Story: https://github.com/stackabletech/issues/issues/404

Note: This ADR expands on parts of xref:adr/ADR023-product-image-selection.adoc[]

Note: The current state of image versioning is documented in xref:concepts:product-image-selection.adoc[this concept guide].

== Context and Problem Statement

// Describe the context and problem statement, e.g., in free form using two to three sentences. You may want to articulate the problem in form of a question.
Expand Down