Skip to content
Merged
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
48 changes: 27 additions & 21 deletions modules/concepts/pages/arm64-support.adoc
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
= Multi-Architecture for SDP (Experimental)
:description: This page describes how to access ARM64 based SDP early
:description: This page describes how to access ARM64-based SDP early
:keywords: Multi-Architecture, infrastructure, docker, image, tags, early-access

WARNING: This is an experimental feature of the Stackable Data Platform and still under https://github.com/stackabletech/issues/issues/463[development].
WARNING: This is an experimental feature of the Stackable Data Platform (SDP) and still under https://github.com/stackabletech/issues/issues/463[development].

== Early-Access
== Early access

SDP release 23.11.0 has been ported to the ARM64 architecture. These images are stored within the `stackable-experimental` organization in our https://repo.stackable.tech/#browse/browse:docker:v2%2Fstackable-experimental[Nexus].
SDP release 23.11.0 has been ported to the ARM64 architecture.
Comment thread
lfrancke marked this conversation as resolved.
These images are stored within the `stackable-experimental` organization in our https://repo.stackable.tech/#browse/browse:docker:v2%2Fstackable-experimental[Docker repository].

As they are not available by default so you need to first switch to the `stackable-experimental` organization before pulling them for use with the data platform.
=== Available releases

=== Actual Releases
The only release currently available for ARM64 is the early access version mentioned above.

The only release currently available for ARM64 is the early-access version mentioned above.
Each product image is built using ARM-specific tags to keep them distinct from development/nightly images.
In the future they may be bundled as a manifest list using an automated workflow.

Each product is built using ARM-specific tags to keep them distinct from development/nightly images. In future they may be bundled as a manifest list using an automated workflow.

=== Early-Access with Helm
=== Operators

According to our https://docs.stackable.tech/home/stable/airflow/getting_started/installation#_helm[installation guide] you can install ARM64 operators e.g. for the commons operator as follows:

Expand All @@ -25,15 +25,12 @@ According to our https://docs.stackable.tech/home/stable/airflow/getting_started
helm install commons-operator stackable-stable/commons-operator --namespace stackable-operators --create-namespace --version=23.11.0 --set image.repository=docker.stackable.tech/stackable-experimental/commons-operator
----

WARNING: Listener operator 23.11.0 not available for bare metal arm64 machines

By declaring `--set image.repository=docker.stackable.tech/stackable-experimental/commons-operator` you will overwrite the image selected by default with one located in the organization `stackable-experimental`. The other operators can be installed in the same way.

WARNING: You have to install every operator you need for a given demo individually with helm using `--skip-release` with stackablectl. Otherwise, it will try to install x86 operators and pull ARM64 product images afterwards.

=== Early-Access to our products
=== Products

The https://docs.stackable.tech/home/stable/concepts/product_image_selection[Product image selection] mechanism allows the user to choose a specific product image and/or a different repository which may be relevant for e.g. air-gapped environments or when using a mirrored repository. To choose an ARM64 image specify the image in the `custom` field as follows:
The https://docs.stackable.tech/home/stable/concepts/product_image_selection[Product image selection] mechanism allows the user to choose a specific product image and/or a different repository, which may be relevant for e.g. air-gapped environments or when using a mirrored repository.
To choose an ARM64 image specify the image in the `custom` field as follows:

[source,yaml]
----
Expand All @@ -45,9 +42,15 @@ spec:

NOTE: Only 23.11.0 is working at this moment.

=== Prepared Demos
=== Prepared demos

It is possible to run SDP demos on ARM64 architecture, but due to the changes that are necessary we have provided a separate branch to make this easier. Please follow the instructions below to run a demo on ARM.
WARNING: Usually stackablectl would install all required operators for a demo automatically.
But stackablectl is not yet aware of multiple architectures so it would install the x86 operators.
Therefore, if you want to install a demo, you need to always use the `--skip-release` flag for stackablectl.
See the example in this section.

It is possible to run SDP demos on ARM64 architecture, but due to the changes that are necessary we have provided a separate branch to make this easier.
Please follow the instructions below to run a demo on ARM.

You will need access to a Kubernetes Cluster and to have the stackablectl https://docs.stackable.tech/home/stable/quickstart[command-line tool] installed.

Expand All @@ -57,18 +60,21 @@ You will need access to a Kubernetes Cluster and to have the stackablectl https:
git clone git@github.com:stackabletech/demos.git
----

==== 2. Checkout ARM64 demo branch ( release 23.11.0 )
==== 2. Checkout ARM64 demo branch (release 23.11.0)
[source,bash]
----
cd demos && git pull && git checkout spike/demos-on-arm
----
==== 3. Install stackable operators ( release 23.11.0 )
NOTE: This executes a script where all operators (except listener operator) with version 23.11.0 are installed. You can omit this step and only install operators you want by copying the corresponding `helm` command.

==== 3. Install stackable operators (release 23.11.0)
Comment thread
lfrancke marked this conversation as resolved.
NOTE: This executes a script where all operators with version 23.11.0 are installed.
You can omit this step and only install operators you want by copying the corresponding `helm` command.

[source,bash]
----
./arm.sh
----

==== 4. Install your demo with stackablectl (e.g. nifi-kafka-druid-earthquake-data)
[source,bash]
----
Expand Down