diff --git a/antora.yml b/antora.yml index ef3036437..2eb748416 100644 --- a/antora.yml +++ b/antora.yml @@ -1,5 +1,5 @@ name: home -version: "nightly" +version: "24.3" title: Stackable Documentation nav: - modules/ROOT/nav1.adoc @@ -13,7 +13,7 @@ nav: - modules/ROOT/nav3.adoc # this is for the extra bits at the end of the menu # The prerelease setting affects version sorting. # Set to 'true' for nightly and false otherwise. -prerelease: true +prerelease: false # The attributes below are specific to this component and version # https://docs.antora.org/antora/latest/component-attributes/#hard-set asciidoc: @@ -21,10 +21,14 @@ asciidoc: # Keep this version in line with the 'version' key above # The versions for the CRD docs are either 'nightly' or # a full major.minor.patch version like 23.7.1 - crd-docs-version: "nightly" + crd-docs-version: "24.3.0" + # Whether this version is already end of life. + # If true, a banner will be displayed informing the user. + end-of-life: true # use the attributes below to link to the CRD docs crd-docs-base-url: "https://crds.stackable.tech" - crd-docs: "{crd-docs-base-url}/{crd-docs-version}" - # this attribute is an annoying little hack to make the versioned - # link accessible to the UI template. + crd-docs: "{crd-docs-base-url}/{crd-docs-version}" + # to make attributes accessible to the UI template, they need to + # be prefixed with "page-" page-crd-docs: "{crd-docs}" + page-end-of-life: "{end-of-life}" diff --git a/modules/ROOT/pages/getting-started.adoc b/modules/ROOT/pages/getting-started.adoc index 61073e9d1..9df966dc9 100644 --- a/modules/ROOT/pages/getting-started.adoc +++ b/modules/ROOT/pages/getting-started.adoc @@ -30,11 +30,11 @@ Install the Stackable command line utility xref:management:stackablectl:index.ad The Stackable operators are components that translate the service definitions deployed via Kubernetes into deploy services on the worker nodes. These can be installed on any node that has access to the Kubernetes control plane. In this example we will install them on the controller node. -Stackable operators can be installed using `stackablectl`. Run the following commands to install ZooKeeper, Kafka and NiFi from the Stackable 23.11 release. +Stackable operators can be installed using `stackablectl`. Run the following commands to install ZooKeeper, Kafka and NiFi from the Stackable 24.3 release. [source,bash] ---- -stackablectl release install -i commons -i secret -i listener -i zookeeper -i kafka -i nifi 23.11 +stackablectl release install -i commons -i secret -i listener -i zookeeper -i kafka -i nifi 24.3 ---- .Using Helm instead @@ -53,12 +53,12 @@ Install the operators: [source,bash] ---- -helm install zookeeper-operator stackable-stable/zookeeper-operator --version=23.11.0 -helm install kafka-operator stackable-stable/kafka-operator --version=23.11.0 -helm install secret-operator stackable-stable/secret-operator --version=23.11.0 -helm install listener-operator stackable-stable/listener-operator --version=23.11.0 -helm install commons-operator stackable-stable/commons-operator --version=23.11.0 -helm install nifi-operator stackable-stable/nifi-operator --version=23.11.0 +helm install zookeeper-operator stackable-stable/zookeeper-operator --version=24.3.0 +helm install kafka-operator stackable-stable/kafka-operator --version=24.3.0 +helm install secret-operator stackable-stable/secret-operator --version=24.3.0 +helm install listener-operator stackable-stable/listener-operator --version=24.3.0 +helm install commons-operator stackable-stable/commons-operator --version=24.3.0 +helm install nifi-operator stackable-stable/nifi-operator --version=24.3.0 ---- ==== @@ -67,12 +67,12 @@ You can check which operators are installed using `stackablectl operator install [source,console] ---- OPERATOR VERSION NAMESPACE STATUS LAST UPDATED -commons 23.11.0 default deployed 2023-11-30 17:58:32.916032854 +0100 CET -kafka 23.11.0 default deployed 2023-11-30 17:58:55.036115353 +0100 CET -listener 23.11.0 default deployed 2023-11-30 17:59:18.136775259 +0100 CET -nifi 23.11.0 default deployed 2023-11-30 17:59:51.927081648 +0100 CET -secret 23.11.0 default deployed 2023-11-30 18:00:05.060241771 +0100 CET -zookeeper 23.11.0 default deployed 2023-11-30 18:00:08.425686918 +0100 CET +commons 24.3.0 default deployed 2024-03-30 17:58:32.916032854 +0100 CET +kafka 24.3.0 default deployed 2024-03-30 17:58:55.036115353 +0100 CET +listener 24.3.0 default deployed 2024-03-30 17:59:18.136775259 +0100 CET +nifi 24.3.0 default deployed 2024-03-30 17:59:51.927081648 +0100 CET +secret 24.3.0 default deployed 2024-03-30 18:00:05.060241771 +0100 CET +zookeeper 24.3.0 default deployed 2024-03-30 18:00:08.425686918 +0100 CET ---- == Deploying Stackable Services diff --git a/modules/ROOT/pages/release-notes.adoc b/modules/ROOT/pages/release-notes.adoc index 1483830f8..51804dfb0 100644 --- a/modules/ROOT/pages/release-notes.adoc +++ b/modules/ROOT/pages/release-notes.adoc @@ -147,6 +147,11 @@ The following are selected product features provided by new versions available i ** Also, starting from release 440, there is now row filtering and column masking in Open Policy Agent. * Apache ZooKeeper: Security and bug fixes. +Support for the ARM architecture:: +During the development of this release, we started introducing support for the arm64 architecture. +Currently support is experimental, and we only provide arm64 images for the previous release (23.11). +For more information on how to use the ARM images, refer to the xref:concepts:arm64-support.adoc[documentation]. + === Product versions ==== New versions @@ -218,10 +223,13 @@ These Kubernetes versions are no longer supported: === Supported OpenShift versions -This release supports the following OpenShift versions: +This release is available in the RedHat Certified Operator Catalog for the following OpenShift versions: * `4.15` * `4.14` +* `4.13` +* `4.12` +* `4.11` === Breaking changes diff --git a/modules/concepts/pages/arm64-support.adoc b/modules/concepts/pages/arm64-support.adoc index 831dfe32d..99bec5945 100644 --- a/modules/concepts/pages/arm64-support.adoc +++ b/modules/concepts/pages/arm64-support.adoc @@ -4,18 +4,25 @@ WARNING: This is an experimental feature of the Stackable Data Platform (SDP) and still under https://github.com/stackabletech/issues/issues/463[development]. +NOTE: 24.3.0 has been released as a multi-architecture release. We encountered certain limitations as Superset 3.1.0 hasn't been build yet and only Airflow 2.6.3 is currently available. + == Early access SDP release 23.11.0 has been ported to the ARM64 architecture. +With 24.3.0 we enabled multi-architecture. These images are stored within the `stackable-experimental` organization in our https://repo.stackable.tech/#browse/browse:docker:v2%2Fstackable-experimental[Docker repository]. === Available releases 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. +23.11.0 only brought `arm64` as early access feature, as of 24.3.0 we support multi-architecture ( mixed architectures on clusters ). + +Each product image is built using architecture-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. +24.7.0 will be released as part of the usual release process directly as multi-architecture release. + === 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: diff --git a/modules/concepts/pages/overrides.adoc b/modules/concepts/pages/overrides.adoc index b670a5b60..4336137d6 100644 --- a/modules/concepts/pages/overrides.adoc +++ b/modules/concepts/pages/overrides.adoc @@ -129,4 +129,4 @@ The `podOverrides` will be merged onto the following resources the operators dep They will *not* be applied to: -* Jobs, that are used to setup systems the product depends on e.g. create a database schema for Superset oder Airflow. +* Jobs, that are used to setup systems the product depends on e.g. create a database schema for Superset or Airflow. diff --git a/modules/concepts/pages/overview.adoc b/modules/concepts/pages/overview.adoc index 845ef984a..01067e679 100644 --- a/modules/concepts/pages/overview.adoc +++ b/modules/concepts/pages/overview.adoc @@ -47,7 +47,7 @@ Learn more about roles: xref:roles-and-role-groups.adoc[] [#deployment] == Deployment -All operators and products run as containers in a xref:home::kubernetes.adoc[Kubernetes cluster]. The operators are deployed with stackablectl (the Stackable CLI) or Helm. +All operators and products run as containers in a xref:ROOT:kubernetes.adoc[Kubernetes cluster]. The operators are deployed with stackablectl (the Stackable CLI) or Helm. image::deployment.drawio.svg[] @@ -66,4 +66,4 @@ image::common_objects.drawio.svg[] These objects can be reused by all operators that support this feature. The S3 bucket only needs to be described once, and then it can be referenced in all products that support reading and/or writing from/to S3. Learn more about S3 configuration: xref:s3.adoc[]. -Similarly for the OpenPolicyAgent (OPA). Configuring it looks the same across all products. Learn more: xref:opa.adoc[]. \ No newline at end of file +Similarly for the OpenPolicyAgent (OPA). Configuring it looks the same across all products. Learn more: xref:opa.adoc[]. diff --git a/modules/concepts/pages/stackable_resource_requests.adoc b/modules/concepts/pages/stackable_resource_requests.adoc index 7a1ba58bd..563c096a0 100644 --- a/modules/concepts/pages/stackable_resource_requests.adoc +++ b/modules/concepts/pages/stackable_resource_requests.adoc @@ -1,7 +1,7 @@ // This is meant to be inlined using the "include" directive in other pages. // WARNING: do not add headers here as they can break the structure of pages // that include this file. -Stackable operators handle resource requests in a sligtly different manner than Kubernetes. Resource requests are defined on role or group level. See xref:home:concepts:roles-and-role-groups.adoc[] for details on these concepts. On a role level this means that e.g. all workers will use the same resource requests and limits. This can be further specified on role group level (which takes priority to the role level) to apply different resources. +Stackable operators handle resource requests in a sligtly different manner than Kubernetes. Resource requests are defined on role or group level. See xref:concepts:roles-and-role-groups.adoc[] for details on these concepts. On a role level this means that e.g. all workers will use the same resource requests and limits. This can be further specified on role group level (which takes priority to the role level) to apply different resources. This is an example on how to specify CPU and memory resources using the Stackable https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/[Custom Resources]: