Skip to content

Commit c19aa60

Browse files
authored
Remove floating tag references in custom image selection (#534)
* remove floating tag references * remove upgrade tips with floating tag
1 parent 272f354 commit c19aa60

File tree

1 file changed

+7
-38
lines changed

1 file changed

+7
-38
lines changed

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

Lines changed: 7 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -50,28 +50,23 @@ What this means is, that for example the Stackable Operator for Apache HBase wil
5050
|===
5151

5252

53-
However, since the last digit of the Stackable version is considered to be a patchlevel indicator, operators will be compatible with all images from the same release line.
53+
However, since the last digit of the Stackable version is considered to be a patch level indicator, operators will be compatible with all images from the same release line.
5454
So an operator of version _23.4.x_ will be compatible with all images of version _23.4.y_.
55-
This is intended to allow shorter update cycles for users, when new image versions are released that may contain security fixes - should the user so choose.
56-
55+
This is intended to allow shorter update cycles for users, when new image versions are released that may contain security fixes.
5756

5857
The following paragraphs explain the available settings and how they work.
5958

6059
At the bottom of this page in the <<_common_scenarios, common scenarios>> section some common update scenarios are explained as examples.
6160

6261
== Stackable provided images
6362

64-
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].
63+
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].
6564
If the Kubernetes cluster does not have internet access, a xref:_custom_docker_registry[] or xref:_custom_images[] can be used.
6665

6766
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.
6867
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.
6968

70-
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.
71-
There are two variants you can choose from:
72-
73-
1. Fixed version, e.g. `23.7.0`. This image will never change.
74-
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.
69+
Additionally, as images should be updated from time to time (e.g. new base image, security updates), a Stackable version can be provided. An image with the Stackable version `23.7.0` is fixed and will never change. Security updates within a release line will result in patch version bumps in the Stackable version to e.g. `23.7.1`.
7570

7671
If you don't specify the Stackable version, the operator will use its own version, e.g. `23.7.0`.
7772
When using a nightly operator or a `pr` version, it will use the nightly `0.0.0-dev` image.
@@ -137,7 +132,7 @@ When deriving images from official Stackable images this will mean updating the
137132
The recommended process here is:
138133

139134
** Tag clusters as "do not reconcile" (see xref:operations/cluster_operations.adoc[])
140-
** Update Stackable plattform
135+
** Update Stackable platform
141136
** Change custom images in cluster specifications
142137
** Remove "do not reconcile flag"
143138

@@ -156,34 +151,8 @@ spec:
156151
productVersion: 3.3.1
157152
----
158153

159-
### Quick updates of images
160-
Sometimes it can be useful to decouple operators upgrades from the image versions to allow using updated images as soons as Stackable releases them.
161-
This can significantly shorten turnaround times when reacting to security vulnerabilities for example.
162-
163-
For this scenario the Stackable version can be set to the release line, without including the patch level indicator.
164-
This will cause the operator to always use the most current image that it is compatible with when starting products.
165-
166-
[NOTE]
167-
====
168-
This behavior can result in _mixed_ clusters running on different image versions of the product.
169-
This should not create any issues, since the contained product binaries are exactly the same, but is worth knowing.
170-
171-
A rolling restart of the product would clean this mixed state up.
172-
====
173-
174-
#### Config
175-
[source,yaml]
176-
----
177-
spec:
178-
image:
179-
productVersion: 3.3.1
180-
stackableVersion: 23.4
181-
----
182-
183-
184-
185-
#### Custom images / pinned images
186-
When a setup requires the utmost stability and it is preferrable for things to break, rather than run with a different image version that for example has not been certified.
154+
### Custom images / pinned images
155+
When a setup requires the utmost stability, and it is preferable for things to break, rather than run with a different image version that for example has not been certified.
187156
Or when a user requires custom libraries / code in the images they run and build their own images derived from official Stackable images, this is the only possible way to do this.
188157

189158
Please see the warnings in <<customimages, custom images section>> above for how to upgrade in this scenario.

0 commit comments

Comments
 (0)