Skip to content

Commit

Permalink
more descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
fhennig committed Sep 10, 2024
1 parent effadcc commit fde1c91
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 4 deletions.
2 changes: 1 addition & 1 deletion modules/reference/pages/duration.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
= Duration format
:page-aliases: concepts:duration.adoc

:rust-duration-max: https://doc.rust-lang.org/std/time/struct.Duration.html#associatedconstant.MAX
:go-std-time: https://cs.opensource.google/go/go/+/refs/tags/go1.21.2:src/time/format.go;l=1589
:k8s-cr: https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/
:go: https://go.dev/
:description: nderstand the human-readable duration format used by Stackable operators, based on Go's time.ParseDuration, with units like days, hours, minutes, and seconds.

All Stackable operators use a human-readable duration format. It very closely resembles the format used by the {go}[Go] programming language - which Kubernetes uses internally.
Every duration field of a {k8s-cr}[CustomResource], for example, the xref:trino:usage-guide/operations/graceful-shutdown.adoc[`spec.workers.roleConfig.gracefulShutdownTimeout`] field, supports this format.
Expand Down
3 changes: 2 additions & 1 deletion modules/reference/pages/glossary.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
= Glossary
:li: pass:[<i class="fa-solid fa-link fa-sm" style="margin-left: 5px; vertical-align: baseline;"></i>]
:description: Glossary of Stackable terms, including "Role," "Role Group," and "Stacklet," with definitions and links to detailed explanations.

// refined styling for the glossary
++++
Expand Down Expand Up @@ -54,4 +55,4 @@ Learn more about xref:concepts:stacklet.adoc#role-groups[role groups].
A Stacklet is defined by a custom resource like AirflowCluster or DruidCluster.
The term refers to the defining resource and all the resources that belong to it, which are created by the operator, such as StatefulSets, Services, Secrets and ConfigMaps.
All objects together are the Stacklet.
====
====
7 changes: 5 additions & 2 deletions modules/tutorials/pages/authentication_with_openldap.adoc
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
= Authentication with OpenLDAP
:kind: https://kind.sigs.k8s.io/
:k9s: https://k9scli.io/
:description: Learn how to set up LDAP authentication for Stackable's Superset and Trino products, including installing OpenLDAP and configuring authentication classes.

The Stackable platform supports user authentication with LDAP in multiple products. This page guides you through setting
up the configuration necessary to use an existing LDAP installation with Stackable supported products. You can learn
more about authentication in the Stackable Platform on the xref:concepts:authentication.adoc[concepts page].

Prerequisites:

* a k8s cluster available, or https://kind.sigs.k8s.io/[kind] installed
* a k8s cluster available, or {kind}[kind] installed
* xref:management:stackablectl:index.adoc[] installed
* basic knowledge of how to create resources in Kubernetes (i.e. `kubectl apply -f <filename>.yaml`) and inspect them
(`kubectl get` or a tool like https://k9scli.io/[k9s])
(`kubectl get` or a tool like {k9s}[k9s])
== Setup

Expand Down
1 change: 1 addition & 0 deletions modules/tutorials/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Tutorials
:description: Explore Stackable Data Platform tutorials for feature setup, product operators, and getting started guides for Airflow, Druid, HBase, and more.

Tutorials help you learn about a specific aspect of the Stackable Data Platform in a hands-on way.

Expand Down

0 comments on commit fde1c91

Please sign in to comment.