diff --git a/modules/concepts/pages/product-image-selection.adoc b/modules/concepts/pages/product-image-selection.adoc index efcc62e40..31b532418 100644 --- a/modules/concepts/pages/product-image-selection.adoc +++ b/modules/concepts/pages/product-image-selection.adoc @@ -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. diff --git a/modules/contributor/pages/adr/ADR018-product_image_versioning.adoc b/modules/contributor/pages/adr/ADR018-product_image_versioning.adoc index 9e11d1f04..28a535405 100644 --- a/modules/contributor/pages/adr/ADR018-product_image_versioning.adoc +++ b/modules/contributor/pages/adr/ADR018-product_image_versioning.adoc @@ -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%"] diff --git a/modules/contributor/pages/adr/ADR023-product-image-selection.adoc b/modules/contributor/pages/adr/ADR023-product-image-selection.adoc index 90bdff002..16f139f3f 100644 --- a/modules/contributor/pages/adr/ADR023-product-image-selection.adoc +++ b/modules/contributor/pages/adr/ADR023-product-image-selection.adoc @@ -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[]. @@ -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. \ No newline at end of file +This resolves to enum variant 3. The product version is mandatory so the operator knows what to do. diff --git a/modules/contributor/pages/adr/ADR028-automatic-stackable-version.adoc b/modules/contributor/pages/adr/ADR028-automatic-stackable-version.adoc index 4fb5a659c..721797f17 100644 --- a/modules/contributor/pages/adr/ADR028-automatic-stackable-version.adoc +++ b/modules/contributor/pages/adr/ADR028-automatic-stackable-version.adoc @@ -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.