Skip to content

Commit 16cbe8f

Browse files
committed
first batch of descriptions
1 parent 173f247 commit 16cbe8f

File tree

10 files changed

+10
-0
lines changed

10 files changed

+10
-0
lines changed

modules/concepts/pages/authentication.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
= Authentication
22
:keycloak: https://www.keycloak.org/
3+
:description: Overview of Stackable’s user authentication methods and configuration for LDAP, OIDC, TLS, and Static providers.
34

45
The Stackable Platform uses the AuthenticationClass as a central mechanism to handle user authentication across supported products.
56
The authentication mechanism needs to be configured only in the AuthenticationClass which is then referenced in the xref:stacklet.adoc[Stacklet] definition.

modules/concepts/pages/container-images.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
:ubi: https://catalog.redhat.com/software/base-images
33
:stackable-image-registry: https://repo.stackable.tech/#browse/browse
44
: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.
56

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

modules/concepts/pages/index.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= Concepts
2+
:description: Explore Stackable Data Platform concepts like Stacklets, configuration mechanisms, resources, connectivity, security, and observability.
23

34
== Overview
45

modules/concepts/pages/labels.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
= Labels
22
:common-labels: https://kubernetes.io/docs/concepts/overview/working-with-objects/common-labels/
3+
:description: Understand resource labeling by Stackable operators and tools like stackablectl and Helm for better management and organization.
34

45
Labels are key/value pairs in the metadata of Kubernetes objects that add identifying information to the object.
56
They do not have direct semantic implications but can be used to organize and manage resources.

modules/concepts/pages/logging.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
:vector-agg-install: https://vector.dev/docs/setup/installation/package-managers/helm/#aggregator
99
:vector-source-vector: https://vector.dev/docs/reference/configuration/sources/vector/
1010
:vector-topology-centralized: https://vector.dev/docs/setup/deployment/topologies/#centralized
11+
:description: Learn Stackable's logging setup: human-readable and aggregated logs with Vector, consistent configuration across Stacklets, and custom overrides.
1112

1213
Logging is important for observability of the platform.
1314
Stackable provides human-readable plaintext logs for each running container, as well as aggregated and persisted logs with identical structure across the whole platform.

modules/concepts/pages/operations/cluster_operations.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
= Cluster operations
22
:page-aliases: ../cluster_operations.adoc
3+
:description: Manage Stackable clusters with operations like pausing reconciliation, stopping Pods, and manual/automatic restarts. Learn how to update and restart services effectively.
34

45
Stackable operators offer different cluster operations to control the reconciliation process.
56
This is useful when updating operators, debugging or testing of new settings:

modules/concepts/pages/operations/graceful_shutdown.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= Graceful shutdown
2+
:description: Graceful shutdown ensures a controlled, clean shutdown of service instances, allowing time for normal shutdown activities.
23

34
Graceful shutdown refers to the managed, controlled shutdown of service instances in the manner intended by the software authors.
45
Typically, an instance will receive a signal indicating the intent for the server to shut down, and it will initiate a controlled shutdown.

modules/concepts/pages/operations/index.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= Operations
2+
:description: Guidance for maintaining Stackable Data Platform installations. Covers service availability, maintenance actions, and performance optimization.
23

34
This section of the documentation is intended for the operations teams that maintain a Stackable Data Platform installation.
45
It provides you with the necessary details to operate it in a production environment.

modules/concepts/pages/operations/pod_disruptions.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
= Allowed Pod disruptions
22
:k8s-pdb: https://kubernetes.io/docs/tasks/run-application/configure-pdb/
3+
:description: Configure PodDisruptionBudgets (PDBs) to minimize planned downtime for Stackable products. Default values are based on fault tolerance and can be customized.
34

45
Any downtime of our products is generally considered to be bad.
56
Although downtime can't be prevented 100% of the time - especially if the product does not support High Availability - we can try to do our best to reduce it to an absolute minimum.

modules/concepts/pages/operations/pod_placement.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
= Pod placement
22
:page-aliases: ../pod_placement.adoc
3+
:description: Configure pod affinity, anti-affinity, and node affinity for Stackable Data Platform operators using YAML definitions.
34

45
Several operators of the Stackable Data Platform permit the configuration of pod affinity as described in the Kubernetes https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/[documentation].
56
If no affinity is defined in the product's custom resource, the operators apply reasonable defaults that make use of the `preferred_during_scheduling_ignored_during_execution` property.

0 commit comments

Comments
 (0)