Skip to content

Commit 7112a45

Browse files
sbernaueradwk67
andauthored
Document automatic stackable version (#433)
* Document automatic stackable version * Update modules/concepts/pages/product_image_selection.adoc Co-authored-by: Andrew Kenworthy <andrew.kenworthy@stackable.de> --------- Co-authored-by: Andrew Kenworthy <andrew.kenworthy@stackable.de>
1 parent dd7c947 commit 7112a45

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

modules/concepts/pages/product_image_selection.adoc

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,28 @@ There are multiple ways to specify the image used:
1414
If your Kubernetes cluster has internet access, the easiest way is to use the publicly available Images from the https://docker.stackable.tech/[Image registry hosted by Stackable].
1515
If the Kubernetes cluster does not have internet access, a xref:_custom_docker_registry[] or xref:_custom_images[] can be used.
1616

17-
Currently, you need to specify two versions:
17+
Currently, you need to specify the product version. This can be found on the xref:operators:supported_versions.adoc[list of supported product versions] or on the website of the product itself.
18+
This requirement might be relaxed in the future, as every platform release will ship wth a recommended product versions, which will be used by default.
19+
20+
Additionally you can specify the Stackable version: As we need to make changes to the Images from time to time (e.g. security updates), we also have to version them using the Stackable version. An image gets released for every version of the SDP.
21+
There are two variants you can choose from:
22+
23+
1. Fixed version, e.g. `23.7.0`. This image will never change.
24+
2. Release line, e.g. `23.7`. This will be a floating tag pointing to the latest patch release of the SDP release line. It will contain the latest security patches, but will also change over time.
25+
26+
If you don't specify the Stackable version, the operator will use its own version, e.g. `23.7.0`.
27+
When using a nightly operator or a `pr` version, it will use the nightly `0.0.0-dev` image.
1828

19-
1. **Product version:** The version of the product, as it e.g. can be found on the xref:operators:supported_versions.adoc[list of supported product versions] or on the website of the product itself.
20-
2. **Stackable version:** As we need to make changes to the Images from time to time (e.g. security updates), we also have to version them using the Stackable version.
2129
All the available images (with their product and stackable version) can be found in our https://repo.stackable.tech/#browse/browse:docker:v2%2Fstackable[docker repository].
2230

23-
The versions need to be specified on Stackable products as follows:
31+
The versions need to be specified as follows:
2432

2533
[source,yaml]
2634
----
2735
spec:
2836
image:
2937
productVersion: 3.3.1
30-
stackableVersion: 0.1.0
38+
# stackableVersion: 23.7.0 # optional, or e.g. 23.7
3139
----
3240

3341
== Custom docker registry
@@ -42,11 +50,11 @@ Afterwards you can use the following snippet to configure your custom docker rep
4250
spec:
4351
image:
4452
productVersion: 3.3.1
45-
stackableVersion: 0.1.0
53+
stackableVersion: 23.7.0
4654
repo: my.corp/myteam/stackable
4755
----
4856

49-
This will change the image from the default Stackable repository `docker.stackable.tech/stackable/kafka:3.3.1-stackable0.1.0` to `my.corp/myteam/stackable/kafka:3.3.1-stackable0.1.0`.
57+
This will change the image from the default Stackable repository `docker.stackable.tech/stackable/kafka:3.3.1-stackable23.7.0` to `my.corp/myteam/stackable/kafka:3.3.1-stackable23.7.0`.
5058

5159
== Custom images
5260

0 commit comments

Comments
 (0)