Skip to content
Open
Show file tree
Hide file tree
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
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= First steps
:description: First steps with Apache Superset, covering a first instance with a metadata database and credentials, its web interface and the example dashboards.

Once you have followed the steps in xref:getting_started/installation.adoc[] for the Operator and its dependencies, you will now go through the steps to set up and connect to a Superset instance.

Expand Down
1 change: 1 addition & 0 deletions docs/modules/superset/pages/getting_started/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Getting started
:description: Getting started with Apache Superset on Kubernetes, covering the Stackable operator and its dependencies, a first instance and sample data.

This guide helps you get started with Superset using the Stackable Operator.
It covers the installation of the Operator and its dependencies, setting up your first Superset instance, connecting to it, and exploring sample data.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Installation
:description: Installation of the Stackable operator for Apache Superset and the commons, secret and listener operators it depends on, with stackablectl or Helm.

On this page you will install the Stackable Superset Operator as well as the commons, secret and listener operators which are required by all Stackable Operators.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Command Line Parameters
:description: Command-line parameters the Stackable operator for Apache Superset accepts, with their default values and usage examples.

This operator accepts the following command line parameters:

Expand Down
1 change: 1 addition & 0 deletions docs/modules/superset/pages/reference/crds.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
= CRD Reference
:description: CRD reference for the Stackable operator for Apache Superset on the Stackable Hub, covering every field, default and API version.

Find all CRD reference for the Stackable Operator for Apache Superset at: {crd-ref}{crd-ref-release}&operator=superset-operator.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Environment variables
:description: Environment variables the Stackable operator for Apache Superset accepts, with their default values and what each one controls.

This operator accepts the following environment variables:

Expand Down
1 change: 1 addition & 0 deletions docs/modules/superset/pages/reference/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Reference
:description: Reference for the Stackable operator for Apache Superset, covering CRD fields, command-line parameters and environment variables.

Consult the reference documentation section to find exhaustive information on:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Configuration & Environment Overrides
:description: Overrides for Apache Superset, covering configuration properties, environment variables and Pod specs per role or role group.

The cluster definition also supports overriding configuration properties and environment variables,
either per role or per role group, where the more specific override (role group) has precedence over
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Cluster Operation
:description: Cluster operations for Apache Superset, covering how to pause reconciliation of a cluster or stop it entirely through its custom resource.

Superset installations can be configured with different cluster operations like pausing reconciliation or stopping the
cluster. See xref:concepts:operations/cluster_operations.adoc[cluster operations] for more details.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Graceful shutdown
:description: Graceful shutdown of Apache Superset nodes, covering the configurable shutdown timeout and how the Superset process stops.

You can configure the graceful shutdown as described in xref:concepts:operations/graceful_shutdown.adoc[].

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Operations
:description: Operating Apache Superset with the Stackable operator, covering graceful shutdown, Pod disruptions, Pod placement and cluster operations.

This section of the documentation is intended for the operations teams that maintain a Stackable Data Platform installation.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Allowed Pod disruptions
:description: The PodDisruptionBudget the Stackable operator writes for Apache Superset nodes, and how to disable it.

You can configure the permitted Pod disruptions for Superset nodes as described in xref:concepts:operations/pod_disruptions.adoc[].

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Pod Placement
:description: Pod placement for Apache Superset, covering the default affinities and placement next to OPA when role mapping from OPA is configured.

You can configure the Pod placement of the Superset pods as described in xref:concepts:operations/pod_placement.adoc[].

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

== Resource Requests

include::concepts:stackable_resource_requests.adoc[]
include::concepts:partial$stackable_resource_requests.adoc[]

A minimal HA setup consisting of 2 Superset instances has the following
https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource requirements]:
Expand Down
Loading