Skip to content

Commit 9e059b8

Browse files
committed
review the product image docs
1 parent 7ad9cc0 commit 9e059b8

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

modules/guides/pages/custom-images.adoc

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,25 @@
44
:kind-load-image: https://kind.sigs.k8s.io/docs/user/quick-start/#loading-an-image-into-your-cluster
55
:description: Customize Stackable product images by modifying base images, deploying to a registry or Kubernetes cluster, and configuring your Stacklet to use them.
66

7-
The Stackable operator require a certain structure inside the product images, but modifications can be made.
8-
This is useful to for example load additional extensions or database drivers into an image.
7+
The Stackable operators require a certain structure inside the product images, but modifications can be made.
8+
This is useful for loading additional extensions or database drivers into an image or make any other required changes.
99

10-
To deploy a custom image, you will either have to manually load the image into the Kubernetes cluster or you have to deploy it into a custom registry.
10+
To deploy a custom image, you will either have to manually load the image into the Kubernetes cluster or deploy it into a custom registry.
1111

1212
== Steps
1313

14-
To use a customized image you have to:
14+
To use a customized image, you need to:
1515

1616
1. Create the customized image using a Stackable base image.
17-
2. Provide this image into the Kubernetes cluster.
17+
2. Provide this image to the Kubernetes cluster.
1818
3. Configure your Stacklet to use the custom image.
1919

2020
=== Create your customized image
2121

2222
The Stackable operators rely on the structure and contents of the product images, so any modifications need to be done using the Stackable images as base images.
2323

2424
You can find the Stackable Docker images in the {stackable-oci-registry}[Stackable OCI registry].
25-
Images follow a naming schema: `oci.stackable.tech/sdp/<product>:<product-version>-stackable<stackable-version>` where `<product>` are the products like `druid`, `trino` and `opa`, `<product-version>` are product versions like `28.0.1`, `414` or `0.61.0` and `<stackable-version>` is a Stackable platform version like `23.7` or `24.3.0`.
25+
Images follow a naming schema: `oci.stackable.tech/sdp/<product>:<product-version>-stackable<stackable-version>` where `<product>` includes products like `druid`, `trino`, and `opa`, `<product-version>` are product versions like `28.0.1` (i.e. Apache Druid 28.0.1), `414`, or `0.61.0`, and `<stackable-version>` is a Stackable platform version like `25.3.0` or `25.7.0`.
2626
The Stackable version can also be `0.0.0-dev` for nightly images.
2727
You can use this naming schema together with the xref:operators:supported_versions.adoc[] list to quickly find the base image you need.
2828

@@ -31,34 +31,36 @@ Use the `FROM` clause in your Dockerfile to reference the base image.
3131

3232
When tagging the image, there are no requirements by the operator, any registry and tag is possible.
3333
To avoid confusion, do not use the Stackable registry for your custom image, as you cannot push the image there.
34-
You can also keep the versions in the tag, and simply add a suffix to mark your changes.
34+
You can also keep the versions in the tag and simply add a suffix to mark your changes.
3535

3636
For example, for a custom image with a MySQL driver added, you might tag your image with `my.corp/stackable/hive:3.1.3-stackable24.3.0-mysql`.
3737

3838
=== Provide the image to the Kubernetes cluster
3939

4040
To deploy containers using this image, the Kubernetes cluster needs to be able to access the image.
4141

42-
You can either upload the image into a custom registry and pull it from there - refer to your registry on how to do this - or make the image available to the Kubernetes cluster directly.
43-
For example, in {kind}[`kind`] you can use the {kind-load-image}[`kind load docker-image`] command to load a local image into the Kind cluster.
42+
You can either upload the image into a custom registry and pull it from there refer to your registry documentation on how to do this or make the image available to the Kubernetes cluster directly.
43+
For example, in {kind}[`kind`], you can use the {kind-load-image}[`kind load docker-image`] command to load a local image into the Kind cluster.
4444

4545
=== Use your customized image in your Stacklet definition
4646

4747
To use the customized image in your Stacklet, adjust the xref:concepts:product-image-selection.adoc[] section in your Stacklet configuration.
4848
Use the `custom` field to specify your image:
4949

5050
[source,yaml]
51+
----
5152
spec:
5253
image:
5354
custom: my.corp/stackable/hive:3.1.3-stackable24.3.0-mysql
5455
productVersion: 3.1.3
56+
----
5557

56-
Note that you still need to specify the product version was used in the image for the operator to configure it correctly.
58+
Note that you still need to specify the product version used in the image for the operator to configure it correctly.
5759

58-
With this configuration the operator deploys your Stacklet using your custom image.
60+
With this configuration, the operator deploys your Stacklet using your custom image.
5961

6062
== Further reading and useful links
6163

62-
* Read about xref:concepts:product-image-selection.adoc[] to learn about other ways of specifying a product version or images, for example how to use a custom registry when mirroring Stackable images.
63-
* Have a look at the {stackable-oci-registry}[Stackable OCI registry] to find out which images are available to use as a base. Information on how to browse the registry
64-
can be found xref:contributor:project-overview.adoc#docker-images[here].
64+
* Read about xref:concepts:product-image-selection.adoc[] to learn about other ways of specifying a product version or images, for example, how to use a custom registry when mirroring Stackable images.
65+
* Have a look at the {stackable-oci-registry}[Stackable OCI registry] to find out which images are available to use as a base.
66+
Information on how to browse the registry can be found xref:contributor:project-overview.adoc#docker-images[here].

0 commit comments

Comments
 (0)