From 1320943512490bce1ae3f24439a470129394b395 Mon Sep 17 00:00:00 2001 From: Techassi Date: Mon, 20 Apr 2026 14:09:11 +0200 Subject: [PATCH 1/2] docs: Add artifact registries page --- modules/concepts/nav.adoc | 3 +- .../container-images.adoc | 3 +- .../pages/artifact-registries/index.adoc | 118 ++++++++++++++++++ 3 files changed, 122 insertions(+), 2 deletions(-) rename modules/concepts/pages/{ => artifact-registries}/container-images.adoc (95%) create mode 100644 modules/concepts/pages/artifact-registries/index.adoc diff --git a/modules/concepts/nav.adoc b/modules/concepts/nav.adoc index b420d8ba0..e63fa7af3 100644 --- a/modules/concepts/nav.adoc +++ b/modules/concepts/nav.adoc @@ -1,6 +1,8 @@ * xref:concepts:index.adoc[] ** xref:overview.adoc[Platform overview] ** xref:stacklet.adoc[] +** xref:artifact-registries/index.adoc[] +*** xref:artifact-registries/container-images.adoc[] ** Common configuration mechanisms *** xref:product_image_selection.adoc[] *** xref:overrides.adoc[Advanced: overrides] @@ -29,4 +31,3 @@ ** Maintenance *** xref:maintenance/crds.adoc[CRD maintenance] *** xref:maintenance/eos.adoc[End-of-Support check] -** xref:container-images.adoc[] diff --git a/modules/concepts/pages/container-images.adoc b/modules/concepts/pages/artifact-registries/container-images.adoc similarity index 95% rename from modules/concepts/pages/container-images.adoc rename to modules/concepts/pages/artifact-registries/container-images.adoc index 2520367dc..4e30f045c 100644 --- a/modules/concepts/pages/container-images.adoc +++ b/modules/concepts/pages/artifact-registries/container-images.adoc @@ -1,8 +1,9 @@ = Container images +:page-aliases: concepts:container-images.adoc :ubi: https://catalog.redhat.com/software/base-images :stackable-image-registry: https://oci.stackable.tech/ :stackable-sboms: https://sboms.stackable.tech/ -:description: Overview of Stackable’s container images, including structure, multi-platform support, and why upstream images are not used. +:description: Overview of Stackable's container images, including structure, multi-platform support, and why upstream images are not used. The core artifacts of the Stackable Data Platform are container images of Kubernetes operators and the products that these operators deploy. diff --git a/modules/concepts/pages/artifact-registries/index.adoc b/modules/concepts/pages/artifact-registries/index.adoc new file mode 100644 index 000000000..07c6dba3e --- /dev/null +++ b/modules/concepts/pages/artifact-registries/index.adoc @@ -0,0 +1,118 @@ += Artifact registries +:description: Overview of Stackable's artifact registries where container images and Helm Charts are published to. + +Currently, the SDP operator and product container images, as well as the Helm Charts are published on two registries: `oci.stackable.tech` and `quay.io`. +This page details in which structure these artifacts are stored and can be retrieved. + +== oci.stackable.tech + +[source,plain] +---- +oci.stackable.tech +|- sdp +| |- airflow +| |- airflow-operator +| |- hbase +| |- hbase-operator +| |- ... +|- sdp-charts + |- airflow-operator + |- hbase-operator + |- ... +---- + +=== Pulling from oci.stackable.tech + +* Product container images can be pulled using: ++ +[source,shell] +---- +$ docker pull oci.stackable.tech/sdp/:-stackable +---- +* Product operator container images can be pulled using: ++ +[source,shell] +---- +$ docker pull oci.stackable.tech/sdp/-operator: +---- +* Product operator Helm Charts can be installed using: ++ +[source,shell] +---- +$ helm install -operator oci://oci.stackable.tech/sdp-charts/-operator \ + --version \ + --wait +---- + +== quay.io + +Currently, only the operator and product container images are published to quay.io by mirroring them from our Harbor instance on `oci.stackable.tech`. + +[source,plain] +---- +quay.io +|- stackable + |- airflow + |- airflow-operator + |- hbase + |- hbase-operator + |- ... +---- + +=== Pulling from quay.io + +* Product container images can be pulled using: ++ +[source,shell] +---- +$ docker pull quay.io/stackable/:-stackable +---- +* Product operator container images can be pulled using: ++ +[source,shell] +---- +$ docker pull quay.io/stackable/-operator: +---- + +// NOTE: This is how it will be going forward. +// On quay.io, everything is stored under the central `stackable` organization. +// The rest of the structure is identical compared to `oci.stackable.tech`. + +// [source,plain] +// ---- +// quay.io +// |- stackable +// |- sdp +// | |- airflow +// | |- airflow-operator +// | |- hbase +// | |- hbase-operator +// | |- ... +// |- sdp-charts +// |- airflow-operator +// |- hbase-operator +// |- ... +// ---- + +// === Pulling from quay.io + +// * Product container images can be pulled using: +// + +// [source,shell] +// ---- +// $ docker pull quay.io/stackable/sdp/:-stackable +// ---- +// * Product operator container images can be pulled using: +// + +// [source,shell] +// ---- +// $ docker pull quay.io/stackable/sdp/-operator: +// ---- +// * Product operator Helm Charts can be installed using: +// + +// [source,shell] +// ---- +// $ helm install -operator oci://quay.io/stackable/sdp-charts/-operator \ +// --version \ +// --wait +// ---- From 271c0d18925a75c19221dc9f3f571be7fc752dcb Mon Sep 17 00:00:00 2001 From: Techassi Date: Mon, 20 Apr 2026 15:28:38 +0200 Subject: [PATCH 2/2] docs: Adjust a few sentences according to feedback --- modules/concepts/pages/artifact-registries/index.adoc | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/modules/concepts/pages/artifact-registries/index.adoc b/modules/concepts/pages/artifact-registries/index.adoc index 07c6dba3e..6d72b48cc 100644 --- a/modules/concepts/pages/artifact-registries/index.adoc +++ b/modules/concepts/pages/artifact-registries/index.adoc @@ -1,8 +1,8 @@ = Artifact registries :description: Overview of Stackable's artifact registries where container images and Helm Charts are published to. -Currently, the SDP operator and product container images, as well as the Helm Charts are published on two registries: `oci.stackable.tech` and `quay.io`. -This page details in which structure these artifacts are stored and can be retrieved. +The SDP operator and product container images, as well as the Helm Charts are published on two registries: `oci.stackable.tech` and `quay.io`. +This page details in which structure these artifacts are stored and how they can be retrieved. == oci.stackable.tech @@ -47,6 +47,7 @@ $ helm install -operator oci://oci.stackable.tech/sdp-charts/- == quay.io Currently, only the operator and product container images are published to quay.io by mirroring them from our Harbor instance on `oci.stackable.tech`. +See link:#pulling-quay-io[below]. [source,plain] ---- @@ -59,6 +60,7 @@ quay.io |- ... ---- +[#pulling-quay-io] === Pulling from quay.io * Product container images can be pulled using: