Skip to content

Commit 014c07c

Browse files
TechassiTechassi
authored
docs: Add artifact registries page (#837)
* docs: Add artifact registries page * docs: Adjust a few sentences according to feedback
1 parent a62d4fb commit 014c07c

3 files changed

Lines changed: 124 additions & 2 deletions

File tree

‎modules/concepts/nav.adoc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
* xref:concepts:index.adoc[]
22
** xref:overview.adoc[Platform overview]
33
** xref:stacklet.adoc[]
4+
** xref:artifact-registries/index.adoc[]
5+
*** xref:artifact-registries/container-images.adoc[]
46
** Common configuration mechanisms
57
*** xref:product_image_selection.adoc[]
68
*** xref:overrides.adoc[Advanced: overrides]
@@ -29,4 +31,3 @@
2931
** Maintenance
3032
*** xref:maintenance/crds.adoc[CRD maintenance]
3133
*** xref:maintenance/eos.adoc[End-of-Support check]
32-
** xref:container-images.adoc[]

modules/concepts/pages/container-images.adoc renamed to modules/concepts/pages/artifact-registries/container-images.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
= Container images
2+
:page-aliases: concepts:container-images.adoc
23
:ubi: https://catalog.redhat.com/software/base-images
34
:stackable-image-registry: https://oci.stackable.tech/
45
:stackable-sboms: https://sboms.stackable.tech/
5-
:description: Overview of Stackable’s container images, including structure, multi-platform support, and why upstream images are not used.
6+
:description: Overview of Stackable's container images, including structure, multi-platform support, and why upstream images are not used.
67

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

‎modules/concepts/pages/artifact-registries/index.adoc‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
= Artifact registries
2+
:description: Overview of Stackable's artifact registries where container images and Helm Charts are published to.
3+
4+
The SDP operator and product container images, as well as the Helm Charts are published on two registries: `oci.stackable.tech` and `quay.io`.
5+
This page details in which structure these artifacts are stored and how they can be retrieved.
6+
7+
== oci.stackable.tech
8+
9+
[source,plain]
10+
----
11+
oci.stackable.tech
12+
|- sdp
13+
| |- airflow
14+
| |- airflow-operator
15+
| |- hbase
16+
| |- hbase-operator
17+
| |- ...
18+
|- sdp-charts
19+
|- airflow-operator
20+
|- hbase-operator
21+
|- ...
22+
----
23+
24+
=== Pulling from oci.stackable.tech
25+
26+
* Product container images can be pulled using:
27+
+
28+
[source,shell]
29+
----
30+
$ docker pull oci.stackable.tech/sdp/<PRODUCT>:<VERSION>-stackable<SDP_VERSION>
31+
----
32+
* Product operator container images can be pulled using:
33+
+
34+
[source,shell]
35+
----
36+
$ docker pull oci.stackable.tech/sdp/<PRODUCT>-operator:<SDP_VERSION>
37+
----
38+
* Product operator Helm Charts can be installed using:
39+
+
40+
[source,shell]
41+
----
42+
$ helm install <PRODUCT>-operator oci://oci.stackable.tech/sdp-charts/<PRODUCT>-operator \
43+
--version <SDP_VERSION> \
44+
--wait
45+
----
46+
47+
== quay.io
48+
49+
Currently, only the operator and product container images are published to quay.io by mirroring them from our Harbor instance on `oci.stackable.tech`.
50+
See link:#pulling-quay-io[below].
51+
52+
[source,plain]
53+
----
54+
quay.io
55+
|- stackable
56+
|- airflow
57+
|- airflow-operator
58+
|- hbase
59+
|- hbase-operator
60+
|- ...
61+
----
62+
63+
[#pulling-quay-io]
64+
=== Pulling from quay.io
65+
66+
* Product container images can be pulled using:
67+
+
68+
[source,shell]
69+
----
70+
$ docker pull quay.io/stackable/<PRODUCT>:<VERSION>-stackable<SDP_VERSION>
71+
----
72+
* Product operator container images can be pulled using:
73+
+
74+
[source,shell]
75+
----
76+
$ docker pull quay.io/stackable/<PRODUCT>-operator:<SDP_VERSION>
77+
----
78+
79+
// NOTE: This is how it will be going forward.
80+
// On quay.io, everything is stored under the central `stackable` organization.
81+
// The rest of the structure is identical compared to `oci.stackable.tech`.
82+
83+
// [source,plain]
84+
// ----
85+
// quay.io
86+
// |- stackable
87+
// |- sdp
88+
// | |- airflow
89+
// | |- airflow-operator
90+
// | |- hbase
91+
// | |- hbase-operator
92+
// | |- ...
93+
// |- sdp-charts
94+
// |- airflow-operator
95+
// |- hbase-operator
96+
// |- ...
97+
// ----
98+
99+
// === Pulling from quay.io
100+
101+
// * Product container images can be pulled using:
102+
// +
103+
// [source,shell]
104+
// ----
105+
// $ docker pull quay.io/stackable/sdp/<PRODUCT>:<VERSION>-stackable<SDP_VERSION>
106+
// ----
107+
// * Product operator container images can be pulled using:
108+
// +
109+
// [source,shell]
110+
// ----
111+
// $ docker pull quay.io/stackable/sdp/<PRODUCT>-operator:<SDP_VERSION>
112+
// ----
113+
// * Product operator Helm Charts can be installed using:
114+
// +
115+
// [source,shell]
116+
// ----
117+
// $ helm install <PRODUCT>-operator oci://quay.io/stackable/sdp-charts/<PRODUCT>-operator \
118+
// --version <SDP_VERSION> \
119+
// --wait
120+
// ----

0 commit comments

Comments
 (0)