Skip to content

Commit d53aa00

Browse files
fhennigfhennig
committed
more descriptions
1 parent 16cbe8f commit d53aa00

11 files changed

+13
-5
lines changed

‎modules/concepts/pages/multi-platform-support.adoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
= Multi-platform for SDP
2-
:description: This page describes multi-platform support for AMD64 and ARM64
32
:keywords: Multi-Architecture, infrastructure, docker, image, tags
43
:multi-platform-images: https://docs.docker.com/build/building/multi-platform/
4+
:description: Starting with Stackable 24.7, all images support AMD64 and ARM64 architectures, enabling mixed clusters with architecture-specific tags and automated selection.
55

66
WARNING: This status is still experimental, as we work to fine-tune the necessary workflows.
77

8-
== Description
9-
10-
Starting with Stackable release 24.7, all images are {multi-platform-images}[multi-platform images], supporting the AMD64 and ARM64 architectures.
8+
Starting with the Stackable Data Platform release 24.7, all images are {multi-platform-images}[multi-platform images], supporting the AMD64 and ARM64 architectures.
119
Each product image is built for each platform with an architecture-specific tag.
1210
For example, the Airflow images with tags `airflow:2.9.2-stackable24.7.0-amd64` and `airflow:2.9.2-stackable24.7.0-arm64` are bundled in the manifest list `airflow:2.9.2-stackable24.7.0` using an automated workflow.
1311
The appropriate image will then be transparently selected for the active platform/architecture.

‎modules/concepts/pages/opa.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
:opa: https://www.openpolicyagent.org
33
:rego: https://www.openpolicyagent.org/docs/latest/policy-language/
44
:opa-docs: https://www.openpolicyagent.org/docs/latest/#overview
5+
:description: Stackable Data Platform uses OpenPolicyAgent (OPA) for policy-based access control with Rego rules, ensuring efficient, local policy evaluation across nodes.
56

67
The Stackable Data Platform offers policy-based access control via the {opa}[OpenPolicyAgent] (OPA) operator.
78
Authorization policies are defined in the {rego}[Rego] language, divided into packages and supplied via ConfigMaps.

‎modules/concepts/pages/overrides.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
= Overrides
22
:k8s-openapi-deepmerge: https://arnavion.github.io/k8s-openapi/v0.22.x/k8s_openapi/trait.DeepMerge.html
3+
:description: Stackable operators support configuration overrides for Stacklets, including settings for config files, environment variables, and Pod specifications, with precedence rules.
34

45
The Stackable operators configure the xref:stacklet.adoc[Stacklets] they are operating with sensible defaults and required settings to enable connectivity and security.
56
Other important settings are usually exposed in the Stacklet resource definition for you to configure directly.

‎modules/concepts/pages/overview.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= Stackable Data Platform explained
2+
:description: The Stackable Data Platform leverages Kubernetes operators to manage products like ZooKeeper and HDFS, using custom resources for deployment and configuration.
23

34
The Stackable Data Platform (SDP) is built on Kubernetes.
45
Its core is a collection of Kubernetes Operators and CustomResourceDefinitions which are designed to work together.

‎modules/concepts/pages/product-image-selection.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
= Product image selection
22
:page-aliases: product_image_selection.adoc
3-
:description: This page describes the different ways of specifying a product image to use in your product deployment.
43
:keywords: Kubernetes, operator, docker, registry, custom image, tags
4+
:description: Learn how to specify product images for Stackable Data Platform deployments, including using default, custom, or mirrored registries.
55

66
To run any product on the Stackable Data Platform, you need to specify which version you want to run in the resource definition (i.e. a SparkApplication or DruidCluster).
77
The simplest way to do this is this:

‎modules/concepts/pages/resources.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= Resource management
2+
:description: Learn how to manage CPU, memory, and storage resources for Stackable Data Platform products, including setting requests, limits, and StorageClasses.
23

34
The Stackable Data Platform and its xref:operators:index.adoc[operators] deploy their products in https://kubernetes.io/docs/concepts/containers/[containers] within https://kubernetes.io/docs/concepts/workloads/pods/[Pods] using https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/[StatefulSets] or https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/[DaemonSets].
45
In order for the Kubernetes scheduler to select a suitable https://kubernetes.io/docs/concepts/architecture/nodes/[Node] for a Pod, https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource] requests and limits for CPU and memory can be specified.

‎modules/concepts/pages/s3.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= S3 resources
2+
:description: Explore how to configure S3 storage with Stackable using S3Connection and S3Bucket objects, including setup examples, credentials, and TLS configuration.
23

34
// -------------- Intro ----------------
45

‎modules/concepts/pages/service-discovery.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
= Service discovery ConfigMap
22
:page-aliases: service_discovery.adoc
3+
:description: Learn how Stackable's service discovery ConfigMap enables product connections, providing essential instance info for integration and external connections.
34

45
// Abstract
56
Stackable operators provide a _service discovery ConfigMap_ for each product instance that is deployed. **This ConfigMap has the same name as the product instance** and contains information about how to connect to the instance. The ConfigMap is used by other Operators to connect products together and can also be used by you, the user, to connect external software to Stackable-operated software.

‎modules/concepts/pages/service-exposition.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
= Service exposition
22
:k8s-service: https://kubernetes.io/docs/concepts/services-networking/service/
33
:k8s-service-types: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
4+
:description: Explore Stackable's service exposition options: ClusterIP for internal access, NodePort for unstable external access, and LoadBalancer for stable external access.
5+
46

57
Data products expose interfaces to the outside world.
68
These interfaces (whether UIs, or APIs) can be accessed by other products or by end users.

‎modules/concepts/pages/stacklet.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
= Stacklet
22
:page-aliases: roles-and-role-groups.adoc
3+
:description: A Stacklet is a managed product in Kubernetes, consisting of roles and role groups. Roles define components, while role groups allow fine-grained control over configurations.
34

45
A _Stacklet_ is a deployed product that is managed by a Stackable operator.
56
The running instance is made up of multiple pieces of software called _roles_ and can be further subdivided into _role groups_.

0 commit comments

Comments
 (0)