Skip to content

Commit eb2d2a7

Browse files
authored
Link to product image version concepts page from relevant ADRs (#676)
* Link to product image version concepts page from relevant ADRs * newline
1 parent c393f5c commit eb2d2a7

File tree

4 files changed

+13
-2
lines changed

4 files changed

+13
-2
lines changed

modules/concepts/pages/product-image-selection.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ spec:
1414
# stackableVersion: 24.3.0 optional <.>
1515
----
1616
<.> The version of your product - consult the product operator documentation to find out about supported product versions.
17-
<.> 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.
17+
<.> 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.
1818

1919
This page explains the different ways of specifying product images and the components that are involved,
2020
starting from the simple way of using the default images to explaining how to use custom or mirrored registries as well as custom images.

modules/contributor/pages/adr/ADR018-product_image_versioning.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ v0.1, 04.05.2022
1414
** Natalie Klestrup-Röjiezon
1515
* Date: 04.05.2022
1616
17+
[IMPORTANT]
18+
====
19+
Please note that this ADR was overruled in the meantime.
20+
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.
21+
The current state of image versioning is documented in xref:concepts:product-image-selection.adoc[this concept guide].
22+
====
23+
1724
== Glossary
1825

1926
[cols="20%,80%"]

modules/contributor/pages/adr/ADR023-product-image-selection.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ v0.1, 2022-08-31
1313
1414
Note: Parts of this ADR were expanded by xref:adr/ADR028-automatic-stackable-version.adoc[]
1515

16+
Note: The current state of image versioning is documented in xref:concepts:product-image-selection.adoc[this concept guide].
17+
1618
== Context and Problem Statement
1719
Currently users have to specify the full image tag in the Products CRD, as described in xref:adr/ADR018-product_image_versioning.adoc[].
1820

@@ -185,4 +187,4 @@ image:
185187
productVersion: 1.4.1
186188
----
187189

188-
This resolves to enum variant 3. The product version is mandatory so the operator knows what to do.
190+
This resolves to enum variant 3. The product version is mandatory so the operator knows what to do.

modules/contributor/pages/adr/ADR028-automatic-stackable-version.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Technical Story: https://github.com/stackabletech/issues/issues/404
1414

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

17+
Note: The current state of image versioning is documented in xref:concepts:product-image-selection.adoc[this concept guide].
18+
1719
== Context and Problem Statement
1820

1921
// 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.

0 commit comments

Comments
 (0)