Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion modules/concepts/nav.adoc
Original file line number Diff line number Diff line change
@@ -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]
Expand Down Expand Up @@ -29,4 +31,3 @@
** Maintenance
*** xref:maintenance/crds.adoc[CRD maintenance]
*** xref:maintenance/eos.adoc[End-of-Support check]
** xref:container-images.adoc[]
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
= Container images
:page-aliases: concepts:container-images.adoc
Comment thread
Techassi marked this conversation as resolved.
:ubi: https://catalog.redhat.com/software/base-images
:stackable-image-registry: https://oci.stackable.tech/
:stackable-sboms: https://sboms.stackable.tech/
:description: Overview of Stackables 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.
Comment thread
Techassi marked this conversation as resolved.

The core artifacts of the Stackable Data Platform are container images of Kubernetes operators and the products that these operators deploy.

Expand Down
120 changes: 120 additions & 0 deletions modules/concepts/pages/artifact-registries/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
= Artifact registries
:description: Overview of Stackable's artifact registries where container images and Helm Charts are published to.

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

[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/<PRODUCT>:<VERSION>-stackable<SDP_VERSION>
----
* Product operator container images can be pulled using:
+
[source,shell]
----
$ docker pull oci.stackable.tech/sdp/<PRODUCT>-operator:<SDP_VERSION>
----
* Product operator Helm Charts can be installed using:
+
[source,shell]
----
$ helm install <PRODUCT>-operator oci://oci.stackable.tech/sdp-charts/<PRODUCT>-operator \
--version <SDP_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`.
Comment thread
NickLarsenNZ marked this conversation as resolved.
See link:#pulling-quay-io[below].

[source,plain]
----
quay.io
|- stackable
|- airflow
|- airflow-operator
|- hbase
|- hbase-operator
|- ...
----

[#pulling-quay-io]
=== Pulling from quay.io

* Product container images can be pulled using:
+
[source,shell]
----
$ docker pull quay.io/stackable/<PRODUCT>:<VERSION>-stackable<SDP_VERSION>
----
* Product operator container images can be pulled using:
+
[source,shell]
----
$ docker pull quay.io/stackable/<PRODUCT>-operator:<SDP_VERSION>
----

// 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`.
Comment thread
NickLarsenNZ marked this conversation as resolved.

// [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/<PRODUCT>:<VERSION>-stackable<SDP_VERSION>
// ----
// * Product operator container images can be pulled using:
// +
// [source,shell]
// ----
// $ docker pull quay.io/stackable/sdp/<PRODUCT>-operator:<SDP_VERSION>
// ----
// * Product operator Helm Charts can be installed using:
// +
// [source,shell]
// ----
// $ helm install <PRODUCT>-operator oci://quay.io/stackable/sdp-charts/<PRODUCT>-operator \
// --version <SDP_VERSION> \
// --wait
// ----
Loading