Skip to content

Commit 7ad9cc0

Browse files
committed
review the product image docs
1 parent 6c25f3c commit 7ad9cc0

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
:keywords: Kubernetes, operator, docker, registry, custom image, tags
44
:description: Learn how to specify product images for Stackable Data Platform deployments, including using default, custom, or mirrored registries.
55

6-
To run any product on the Stackable Data Platform, you need to specify which version you want to run in the resource definition (e.g., a `SparkApplication` or `DruidCluster`).
6+
To run any product on the Stackable Data Platform, you need to specify the desired version in the resource definition (e.g., a `SparkApplication` or `DruidCluster`).
77
The simplest way to do this is as follows:
88

99
[source,yaml]
@@ -16,7 +16,7 @@ spec:
1616
<.> The version of your product.
1717
Consult the product operator documentation to find out about supported product versions.
1818
<.> The version of the Stackable Data Platform.
19-
If you omit it, the operator will use its own version together with the product version to select the product image.
19+
If omitted, the operator will use its own version along with the product version to select the product image.
2020
It is recommended to omit this field to ensure you are always using the correct, compatible version of the product image.
2121

2222
== Product and Stackable version explained
@@ -58,7 +58,7 @@ However, since the last digit of the Stackable version is considered a patch lev
5858
So, an operator of version _25.7.x_ will be compatible with all images of version _25.7.y_ release line.
5959
This allows for shorter update cycles for users when new image versions are released that may contain security fixes.
6060

61-
The following paragraphs explain the available settings and how they work.
61+
The following sections explain the available settings and how they work.
6262
At the bottom of this page, in the <<_common_scenarios, common scenarios>> section, some common update scenarios are explained as examples.
6363

6464
== Stackable provided images
@@ -133,11 +133,11 @@ Only when the correct product version is given to the operator will the product
133133

134134
Using custom images has a few limitations that users should be aware of:
135135

136-
* The images will _have_ to have the same structures that Stackable operators expect.
136+
* The images must have the same structures that Stackable operators expect.
137137
This should usually be ensured by specifying a Stackable image in the `FROM` clause of the Dockerfile (all the available images can be found in our https://oci.stackable.tech/api/v2.0/projects/sdp[Stackable OCI registry] - the schema is typically: `oci.stackable.tech/sdp/<product>:<product-version>-stackable<stackable-version>`.
138138
Information on how to browse the registry can be found in the xref:contributor:project-overview.adoc#docker-images[Docker images section of the project overview]).
139139

140-
* Images will have to be upgraded for every new Stackable release to follow structural changes that Stackable may have made to their images.
140+
* Images will need to be upgraded for every new Stackable release to follow structural changes that Stackable may have made to their images.
141141
When deriving images from official Stackable images, this will mean updating the version of the image in the `FROM` clause to the correct Stackable release.
142142

143143
* It is not possible to update the Stackable Platform to a new version without changing the deployed cluster definitions when using custom images.

0 commit comments

Comments
 (0)