From 7c30792eceec7d7a6aa9f9a23761cfbb4495bb74 Mon Sep 17 00:00:00 2001 From: Andrew Kenworthy Date: Mon, 17 Apr 2023 11:35:26 +0200 Subject: [PATCH 01/10] release 23.4.0 --- CHANGELOG.md | 2 ++ Cargo.lock | 4 ++-- deploy/helm/superset-operator/Chart.yaml | 4 ++-- docs/antora.yml | 3 ++- .../examples/getting_started/getting_started.sh | 16 ++++++++-------- .../superset/pages/usage-guide/security.adoc | 4 ++-- docs/templating_vars.yaml | 10 +++++----- rust/crd/Cargo.toml | 2 +- rust/operator-binary/Cargo.toml | 2 +- tests/test-definition.yaml | 8 ++++---- 10 files changed, 29 insertions(+), 26 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1e822d14..d248f34a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,8 @@ ## [Unreleased] +## [23.4.0] - 2023-04-17 + ### Added - Log aggregation added ([#326]). diff --git a/Cargo.lock b/Cargo.lock index d51cef25..106063e3 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1817,7 +1817,7 @@ dependencies = [ [[package]] name = "stackable-superset-crd" -version = "0.0.0-dev" +version = "23.4.0" dependencies = [ "serde", "serde_json", @@ -1830,7 +1830,7 @@ dependencies = [ [[package]] name = "stackable-superset-operator" -version = "0.0.0-dev" +version = "23.4.0" dependencies = [ "anyhow", "built", diff --git a/deploy/helm/superset-operator/Chart.yaml b/deploy/helm/superset-operator/Chart.yaml index a1fe9bd7..be457d62 100644 --- a/deploy/helm/superset-operator/Chart.yaml +++ b/deploy/helm/superset-operator/Chart.yaml @@ -1,8 +1,8 @@ --- apiVersion: v2 name: superset-operator -version: "0.0.0-dev" -appVersion: "0.0.0-dev" +version: "23.4.0" +appVersion: "23.4.0" description: The Stackable Operator for Apache Superset home: https://github.com/stackabletech/superset-operator maintainers: diff --git a/docs/antora.yml b/docs/antora.yml index d522680b..bb7edf79 100644 --- a/docs/antora.yml +++ b/docs/antora.yml @@ -1,3 +1,4 @@ --- name: home -version: "nightly" +version: "23.4" +prerelease: false diff --git a/docs/modules/superset/examples/getting_started/getting_started.sh b/docs/modules/superset/examples/getting_started/getting_started.sh index 60bb32f4..8c08d755 100755 --- a/docs/modules/superset/examples/getting_started/getting_started.sh +++ b/docs/modules/superset/examples/getting_started/getting_started.sh @@ -18,26 +18,26 @@ cd "$(dirname "$0")" case "$1" in "helm") -echo "Adding 'stackable-dev' Helm Chart repository" +echo "Adding 'stackable-stable' Helm Chart repository" # tag::helm-add-repo[] -helm repo add stackable-dev https://repo.stackable.tech/repository/helm-dev/ +helm repo add stackable-stable https://repo.stackable.tech/repository/helm-stable/ # end::helm-add-repo[] echo "Updating Helm repo" helm repo update echo "Installing Operators with Helm" # tag::helm-install-operators[] -helm install --wait commons-operator stackable-dev/commons-operator --version 0.0.0-dev -helm install --wait secret-operator stackable-dev/secret-operator --version 0.0.0-dev -helm install --wait superset-operator stackable-dev/superset-operator --version 0.0.0-dev +helm install --wait commons-operator stackable-stable/commons-operator --version 23.4.0 +helm install --wait secret-operator stackable-stable/secret-operator --version 23.4.0 +helm install --wait superset-operator stackable-stable/superset-operator --version 23.4.0 # end::helm-install-operators[] ;; "stackablectl") echo "installing Operators with stackablectl" # tag::stackablectl-install-operators[] stackablectl operator install \ - commons=0.0.0-dev \ - secret=0.0.0-dev \ - superset=0.0.0-dev + commons=23.4.0 \ + secret=23.4.0 \ + superset=23.4.0 # end::stackablectl-install-operators[] ;; *) diff --git a/docs/modules/superset/pages/usage-guide/security.adoc b/docs/modules/superset/pages/usage-guide/security.adoc index 41401de3..bf2132fd 100644 --- a/docs/modules/superset/pages/usage-guide/security.adoc +++ b/docs/modules/superset/pages/usage-guide/security.adoc @@ -8,7 +8,7 @@ The default setting is to manually set up users via the Webinterface. === LDAP -Superset supports xref:nightly@home:concepts:authentication.adoc[authentication] of users against an LDAP server. This requires setting up an xref:nightly@home:concepts:authentication.adoc#authenticationclass[AuthenticationClass] for the LDAP server. +Superset supports xref:home:concepts:authentication.adoc[authentication] of users against an LDAP server. This requires setting up an xref:home:concepts:authentication.adoc#authenticationclass[AuthenticationClass] for the LDAP server. The AuthenticationClass is then referenced in the SupersetCluster resource as follows: [source,yaml] @@ -32,7 +32,7 @@ spec: Users that log in with LDAP are assigned to a default https://superset.apache.org/docs/security/#roles[Role] which is specified with the `userRegistrationRole` property. -You can follow the xref:nightly@home:tutorials:authentication_with_openldap.adoc[] tutorial to learn how to set up an AuthenticationClass for an LDAP server, as well as consulting the xref:nightly@home:reference:authenticationclass.adoc[] reference. +You can follow the xref:home:tutorials:authentication_with_openldap.adoc[] tutorial to learn how to set up an AuthenticationClass for an LDAP server, as well as consulting the xref:home:reference:authenticationclass.adoc[] reference. == [[authorization]]Authorization Superset has a concept called `Roles` which allows you to grant user permissions based on roles. diff --git a/docs/templating_vars.yaml b/docs/templating_vars.yaml index 9a4ef928..3749015b 100644 --- a/docs/templating_vars.yaml +++ b/docs/templating_vars.yaml @@ -1,8 +1,8 @@ --- helm: - repo_name: stackable-dev - repo_url: https://repo.stackable.tech/repository/helm-dev/ + repo_name: stackable-stable + repo_url: https://repo.stackable.tech/repository/helm-stable/ versions: - commons: 0.0.0-dev - secret: 0.0.0-dev - superset: 0.0.0-dev + commons: 23.4.0 + secret: 23.4.0 + superset: 23.4.0 diff --git a/rust/crd/Cargo.toml b/rust/crd/Cargo.toml index 6632a36c..2d61b4b5 100644 --- a/rust/crd/Cargo.toml +++ b/rust/crd/Cargo.toml @@ -5,7 +5,7 @@ edition = "2021" license = "OSL-3.0" name = "stackable-superset-crd" repository = "https://github.com/stackabletech/superset-operator" -version = "0.0.0-dev" +version = "23.4.0" publish = false [dependencies] diff --git a/rust/operator-binary/Cargo.toml b/rust/operator-binary/Cargo.toml index fff707e3..2a68bd2f 100644 --- a/rust/operator-binary/Cargo.toml +++ b/rust/operator-binary/Cargo.toml @@ -3,7 +3,7 @@ name = "stackable-superset-operator" authors = ["Stackable GmbH "] description = "Stackable Operator for Apache Superset" license = "OSL-3.0" -version = "0.0.0-dev" +version = "23.4.0" edition = "2021" repository = "https://github.com/stackabletech/superset-operator" publish = false diff --git a/tests/test-definition.yaml b/tests/test-definition.yaml index 50d4cc95..d5816462 100644 --- a/tests/test-definition.yaml +++ b/tests/test-definition.yaml @@ -2,12 +2,12 @@ dimensions: - name: superset values: - - 1.3.2-stackable23.4.0-rc2 - - 1.4.1-stackable23.4.0-rc2 - - 1.5.1-stackable23.4.0-rc2 + - 1.3.2-stackable23.4.0 + - 1.4.1-stackable23.4.0 + - 1.5.1-stackable23.4.0 - name: superset-latest values: - - 1.5.1-stackable23.4.0-rc2 + - 1.5.1-stackable23.4.0 - name: ldap-authentication values: - no-tls From 993700b9b79426bf019898e728d4018f67b0d048 Mon Sep 17 00:00:00 2001 From: Felix Hennig Date: Mon, 17 Apr 2023 14:25:10 +0200 Subject: [PATCH 02/10] fixed incorrect version --- docs/modules/superset/examples/getting_started/superset.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/superset/examples/getting_started/superset.yaml b/docs/modules/superset/examples/getting_started/superset.yaml index f0d40686..5148975b 100644 --- a/docs/modules/superset/examples/getting_started/superset.yaml +++ b/docs/modules/superset/examples/getting_started/superset.yaml @@ -6,7 +6,7 @@ metadata: spec: image: productVersion: 1.5.1 - stackableVersion: 23.4.0-rc2 + stackableVersion: 23.4.0 credentialsSecret: simple-superset-credentials loadExamplesOnInit: true nodes: From d7130d185319d95f4984f06a27c75bb76725fb48 Mon Sep 17 00:00:00 2001 From: Felix Hennig Date: Mon, 17 Apr 2023 15:28:46 +0200 Subject: [PATCH 03/10] added listenerclass --- docs/modules/superset/examples/getting_started/superset.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/modules/superset/examples/getting_started/superset.yaml b/docs/modules/superset/examples/getting_started/superset.yaml index 5148975b..006ba65d 100644 --- a/docs/modules/superset/examples/getting_started/superset.yaml +++ b/docs/modules/superset/examples/getting_started/superset.yaml @@ -7,6 +7,8 @@ spec: image: productVersion: 1.5.1 stackableVersion: 23.4.0 + clusterConfig: + listenerClass: external-unstable credentialsSecret: simple-superset-credentials loadExamplesOnInit: true nodes: From c652fbf889c583c3b3abffb2be2fb651114e7431 Mon Sep 17 00:00:00 2001 From: Malte Sander Date: Mon, 15 May 2023 14:31:43 +0200 Subject: [PATCH 04/10] Add missing crd defaults (#367) (#368) cherry picked from commit 014f081349823f40a8da1ae5dd075d4a18907495 --- CHANGELOG.md | 8 ++++++++ deploy/helm/superset-operator/crds/crds.yaml | 3 +-- rust/crd/src/lib.rs | 1 + 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d248f34a..326d5b5a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,14 @@ ## [Unreleased] +## [23.4.1] - 2023-05-17 + +### Added + +- Missing CRD defaults for `status.conditions` field ([#367]). + +[#367]: https://github.com/stackabletech/superset-operator/pull/367 + ## [23.4.0] - 2023-04-17 ### Added diff --git a/deploy/helm/superset-operator/crds/crds.yaml b/deploy/helm/superset-operator/crds/crds.yaml index c3a9e112..35c3ef9b 100644 --- a/deploy/helm/superset-operator/crds/crds.yaml +++ b/deploy/helm/superset-operator/crds/crds.yaml @@ -1515,6 +1515,7 @@ spec: nullable: true properties: conditions: + default: [] items: properties: lastTransitionTime: @@ -1556,8 +1557,6 @@ spec: - type type: object type: array - required: - - conditions type: object required: - spec diff --git a/rust/crd/src/lib.rs b/rust/crd/src/lib.rs index 7d7c2ce9..fafc1289 100644 --- a/rust/crd/src/lib.rs +++ b/rust/crd/src/lib.rs @@ -430,6 +430,7 @@ impl Configuration for SupersetConfigFragment { #[derive(Clone, Debug, Default, Deserialize, Eq, JsonSchema, PartialEq, Serialize)] #[serde(rename_all = "camelCase")] pub struct SupersetClusterStatus { + #[serde(default)] pub conditions: Vec, } From 306d94a87356f0f77fd261c1f51a2b7838e6c3fc Mon Sep 17 00:00:00 2001 From: Andrew Kenworthy Date: Tue, 16 May 2023 11:27:12 +0200 Subject: [PATCH 05/10] release 23.4.1 --- Cargo.lock | 4 ++-- deploy/helm/superset-operator/Chart.yaml | 4 ++-- rust/crd/Cargo.toml | 2 +- rust/operator-binary/Cargo.toml | 2 +- tests/test-definition.yaml | 8 ++++---- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 106063e3..da362e01 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1817,7 +1817,7 @@ dependencies = [ [[package]] name = "stackable-superset-crd" -version = "23.4.0" +version = "23.4.1" dependencies = [ "serde", "serde_json", @@ -1830,7 +1830,7 @@ dependencies = [ [[package]] name = "stackable-superset-operator" -version = "23.4.0" +version = "23.4.1" dependencies = [ "anyhow", "built", diff --git a/deploy/helm/superset-operator/Chart.yaml b/deploy/helm/superset-operator/Chart.yaml index be457d62..38eb3c1f 100644 --- a/deploy/helm/superset-operator/Chart.yaml +++ b/deploy/helm/superset-operator/Chart.yaml @@ -1,8 +1,8 @@ --- apiVersion: v2 name: superset-operator -version: "23.4.0" -appVersion: "23.4.0" +version: "23.4.1" +appVersion: "23.4.1" description: The Stackable Operator for Apache Superset home: https://github.com/stackabletech/superset-operator maintainers: diff --git a/rust/crd/Cargo.toml b/rust/crd/Cargo.toml index 2d61b4b5..d1edb1c8 100644 --- a/rust/crd/Cargo.toml +++ b/rust/crd/Cargo.toml @@ -5,7 +5,7 @@ edition = "2021" license = "OSL-3.0" name = "stackable-superset-crd" repository = "https://github.com/stackabletech/superset-operator" -version = "23.4.0" +version = "23.4.1" publish = false [dependencies] diff --git a/rust/operator-binary/Cargo.toml b/rust/operator-binary/Cargo.toml index 2a68bd2f..a76d1a12 100644 --- a/rust/operator-binary/Cargo.toml +++ b/rust/operator-binary/Cargo.toml @@ -3,7 +3,7 @@ name = "stackable-superset-operator" authors = ["Stackable GmbH "] description = "Stackable Operator for Apache Superset" license = "OSL-3.0" -version = "23.4.0" +version = "23.4.1" edition = "2021" repository = "https://github.com/stackabletech/superset-operator" publish = false diff --git a/tests/test-definition.yaml b/tests/test-definition.yaml index d5816462..c8bd8a31 100644 --- a/tests/test-definition.yaml +++ b/tests/test-definition.yaml @@ -2,12 +2,12 @@ dimensions: - name: superset values: - - 1.3.2-stackable23.4.0 - - 1.4.1-stackable23.4.0 - - 1.5.1-stackable23.4.0 + - 1.3.2-stackable23.4.1 + - 1.4.1-stackable23.4.1 + - 1.5.1-stackable23.4.1 - name: superset-latest values: - - 1.5.1-stackable23.4.0 + - 1.5.1-stackable23.4.1 - name: ldap-authentication values: - no-tls From a9a84f9ee80aceaf496664faf5b3d3e81761d8da Mon Sep 17 00:00:00 2001 From: Andrew Kenworthy Date: Tue, 16 May 2023 13:07:16 +0200 Subject: [PATCH 06/10] pin and lock udeps --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 4f6b88f4..23561a30 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -42,7 +42,7 @@ jobs: - uses: Swatinem/rust-cache@359a70e43a0bb8a13953b04a90f76428b4959bb6 # v2.2.0 with: key: udeps - - run: cargo install cargo-udeps + - run: cargo install --locked cargo-udeps@0.1.35 - run: cargo udeps # This job evaluates the github environment to determine why this action is running and selects the appropriate From 495e2c801e187769a7d53acd43e89486eefeb4fb Mon Sep 17 00:00:00 2001 From: Techassi Date: Thu, 21 Sep 2023 12:29:35 +0200 Subject: [PATCH 07/10] Initial commit (#406) --- .../pages/getting_started/installation.adoc | 20 ++++--- docs/modules/superset/pages/index.adoc | 57 ++++++++++++++----- 2 files changed, 55 insertions(+), 22 deletions(-) diff --git a/docs/modules/superset/pages/getting_started/installation.adoc b/docs/modules/superset/pages/getting_started/installation.adoc index 267934db..c67ea7b4 100644 --- a/docs/modules/superset/pages/getting_started/installation.adoc +++ b/docs/modules/superset/pages/getting_started/installation.adoc @@ -1,21 +1,21 @@ = Installation -On this page you will install the Stackable Superset Operator as well as the commons and secret Operator which are required by all Stackable Operators. +On this page you will install the Stackable Superset Operator as well as the commons and secret Operator which are +required by all Stackable Operators. == Stackable Operators There are 2 ways to run Stackable Operators -1. Using xref:stackablectl::index.adoc[] - -2. Using Helm +. Using xref:management:stackablectl:index.adoc[] +. Using Helm === stackablectl -stackablectl is the command line tool to interact with Stackable operators and our recommended way to install Operators. -Follow the xref:stackablectl::installation.adoc[installation steps] for your platform. +`stackablectl` is the command line tool to interact with Stackable operators and our recommended way to install +Operators. Follow the xref:management:stackablectl:installation.adoc[installation steps] for your platform. -After you have installed stackablectl run the following command to install all Operators necessary for Superset: +After you have installed `stackablectl`, run the following command to install all Operators necessary for Superset: [source,bash] ---- @@ -30,7 +30,8 @@ The tool will show [INFO ] Installing superset operator ---- -TIP: Consult the xref:stackablectl::quickstart.adoc[] to learn more about how to use stackablectl. For example, you can use the `-k` flag to create a Kubernetes cluster with link:https://kind.sigs.k8s.io/[kind]. +TIP: Consult the xref:management:stackablectl:quickstart.adoc[] to learn more about how to use `stackablectl`. For +example, you can use the `--cluster kind` flag to create a Kubernetes cluster with link:https://kind.sigs.k8s.io/[kind]. === Helm @@ -46,7 +47,8 @@ Then install the Stackable Operators: include::example$getting_started/getting_started.sh[tag=helm-install-operators] ---- -Helm will deploy the Operators in a Kubernetes Deployment and apply the CRDs for the Superset service (as well as the CRDs for the required operators). You are now ready to deploy Superset in Kubernetes. +Helm will deploy the Operators in a Kubernetes Deployment and apply the CRDs for the Superset service (as well as the +CRDs for the required operators). You are now ready to deploy Superset in Kubernetes. == What's next diff --git a/docs/modules/superset/pages/index.adoc b/docs/modules/superset/pages/index.adoc index 4afd40a8..ea38572a 100644 --- a/docs/modules/superset/pages/index.adoc +++ b/docs/modules/superset/pages/index.adoc @@ -2,23 +2,40 @@ :description: The Stackable Operator for Apache Superset is a Kubernetes operator that can manage Apache Superset clusters. Learn about its features, resources, dependencies and demos, and see the list of supported Superset versions. :keywords: Stackable Operator, Apache Superset, Kubernetes, operator, data science, data exploration, SQL, engineer, big data, CRD, StatefulSet, ConfigMap, Service, Druid, Trino, S3, demo, version -The Stackable Operator for Apache Superset is an operator that can deploy and manage https://superset.apache.org/[Apache Superset] clusters on Kubernetes. Superset is a data exploration and visualization tool that connects to data sources via SQL. Store your data in Apache Druid or Trino, and manage your Druid and Trino instances with the Stackable Operators for xref:druid:index.adoc[Apache Druid] or xref:trino:index.adoc[Trino]. This operator helps you manage your Superset instances on Kubernetes efficiently. +The Stackable Operator for Apache Superset is an operator that can deploy and manage https://superset.apache.org/[Apache +Superset] clusters on Kubernetes. Superset is a data exploration and visualization tool that connects to data sources +via SQL. Store your data in Apache Druid or Trino, and manage your Druid and Trino instances with the Stackable +Operators for xref:druid:index.adoc[Apache Druid] or xref:trino:index.adoc[Trino]. This operator helps you manage your +Superset instances on Kubernetes efficiently. == Getting started -Get started using Superset with Stackable Operator by following the xref:getting_started/index.adoc[]. It guides you through installing the Operator alongside a PostgreSQL database, connecting to your Superset instance and analyzing some preloaded example data. +Get started using Superset with Stackable Operator by following the xref:getting_started/index.adoc[]. It guides you +through installing the Operator alongside a PostgreSQL database, connecting to your Superset instance and analyzing some +preloaded example data. == Resources -The Operator manages three https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/[custom resources]: The _SupersetCluster_, _SupersetDB_ and _DruidConnection_. It creates a number of different Kubernetes resources based on the custom resources. +The Operator manages three https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/[custom +resources]: The _SupersetCluster_, _SupersetDB_ and _DruidConnection_. It creates a number of different Kubernetes +resources based on the custom resources. === Custom resources -The SupersetCluster is the main resource for the configuration of the Superset instance. The resource defines only one xref:concepts:roles-and-role-groups.adoc[role], the `node`. The various configuration options are explained in the xref:usage-guide/index.adoc[]. It helps you tune your cluster to your needs by configuring xref:usage-guide/storage-resource-configuration.adoc[resource usage], xref:usage-guide/security.adoc[security], xref:usage-guide/logging.adoc[logging] and more. +The SupersetCluster is the main resource for the configuration of the Superset instance. The resource defines only one +xref:concepts:roles-and-role-groups.adoc[role], the `node`. The various configuration options are explained in the +xref:usage-guide/index.adoc[]. It helps you tune your cluster to your needs by configuring +xref:usage-guide/storage-resource-configuration.adoc[resource usage], xref:usage-guide/security.adoc[security], +xref:usage-guide/logging.adoc[logging] and more. -When a SupersetCluster is first deployed, a SupersetDB resource is created. The SupersetDB resource is a wrapper resource for the SQL database that is used by Superset for its metadata. The resource contains some configuration but also keeps track of whether the database has been initialized or not. It is not deleted automatically if a SupersetCluster is deleted, and so can be reused. +When a SupersetCluster is first deployed, a SupersetDB resource is created. The SupersetDB resource is a wrapper +resource for the SQL database that is used by Superset for its metadata. The resource contains some configuration but +also keeps track of whether the database has been initialized or not. It is not deleted automatically if a +SupersetCluster is deleted, and so can be reused. -DruidConnection resources link a Superset and Druid instance. It lets you define this connection in the familiar way of deploying a resource (instead of configuring the connection via the Superset UI or API). The operator configures the connection between Druid and the Superset instance. +DruidConnection resources link a Superset and Druid instance. It lets you define this connection in the familiar way of +deploying a resource (instead of configuring the connection via the Superset UI or API). The operator configures the +connection between Druid and the Superset instance. === Kubernetes resources @@ -26,11 +43,16 @@ Based on the custom resources you define, the Operator creates ConfigMaps, State image::superset_overview.drawio.svg[A diagram depicting the Kubernetes resources created by the operator] -The diagram above depicts all the Kubernetes resources created by the operator, and how they relate to each other. The Jobs created for the SupersetDB and DruidConnnection resources are not shown. +The diagram above depicts all the Kubernetes resources created by the operator, and how they relate to each other. The +Jobs created for the SupersetDB and DruidConnnection resources are not shown. -For every xref:concepts:roles-and-role-groups.adoc#_role_groups[role group] you define, the Operator creates a StatefulSet with the amount of replicas defined in the RoleGroup. Every Pod in the StatefulSet has two containers: the main container running Superset and a sidecar container gathering metrics for xref:operators:monitoring.adoc[]. The Operator creates a Service for the `node` role as well as a single service per role group. +For every xref:concepts:roles-and-role-groups.adoc#_role_groups[role group] you define, the Operator creates a +StatefulSet with the amount of replicas defined in the RoleGroup. Every Pod in the StatefulSet has two containers: the +main container running Superset and a sidecar container gathering metrics for xref:operators:monitoring.adoc[]. The +Operator creates a Service for the `node` role as well as a single service per role group. -ConfigMaps are created, one per RoleGroup and also one for the SupersetDB. Both ConfigMaps contains two files: `log_config.py` and `superset_config.py` which contain logging and general Superset configuration respectively. +ConfigMaps are created, one per RoleGroup and also one for the SupersetDB. Both ConfigMaps contains two files: +`log_config.py` and `superset_config.py` which contain logging and general Superset configuration respectively. == Dependencies @@ -38,19 +60,28 @@ Superset requires an SQL database in which to store its metadata, dashboards and == Connecting to data sources -Superset does not store its own data, instead it connects to other products where data is stored. On the Stackable Platform the two commonly used choices are xref:druid:index.adoc[Apache Druid] and xref:trino:index.adoc[Trino]. For Druid there is a way to xref:usage-guide/connecting-druid.adoc[connect a Druid instance declaratively] with a custom resource. For Trino this is on the roadmap. Have a look at the demos linked <> for examples of using Superset with Druid or Trino. +Superset does not store its own data, instead it connects to other products where data is stored. On the Stackable +Platform the two commonly used choices are xref:druid:index.adoc[Apache Druid] and xref:trino:index.adoc[Trino]. For +Druid there is a way to xref:usage-guide/connecting-druid.adoc[connect a Druid instance declaratively] with a custom +resource. For Trino this is on the roadmap. Have a look at the demos linked <> for examples of using +Superset with Druid or Trino. == [[demos]]Demos -Many of the Stackable xref:stackablectl::demos/index.adoc[demos] use Superset in the stack for data visualization and explaration. The demos come in two main variants. +Many of the Stackable xref:demos:index.adoc[demos] use Superset in the stack for data visualization and explaration. The +demos come in two main variants. === With Druid -The xref:stackablectl::demos/nifi-kafka-druid-earthquake-data.adoc[] and xref:stackablectl::demos/nifi-kafka-druid-water-level-data.adoc[] demos show Superset connected to xref:druid:index.adoc[Druid], exploring earthquake and water level data respectively. +The xref:demos:nifi-kafka-druid-earthquake-data.adoc[] and xref:demos:nifi-kafka-druid-water-level-data.adoc[] demos +show Superset connected to xref:druid:index.adoc[Druid], exploring earthquake and water level data respectively. === With Trino -The xref:stackablectl::demos/spark-k8s-anomaly-detection-taxi-data.adoc[], xref:stackablectl::demos/trino-taxi-data.adoc[], xref:stackablectl::demos/trino-iceberg.adoc[] and xref:stackablectl::demos/data-lakehouse-iceberg-trino-spark.adoc[] demos all use a xref:trino:index.adoc[Trino] instance on top of S3 storage that hold data to analyze. Superset is connected to Trino to analyze a variety of different datasets. +The xref:demos:spark-k8s-anomaly-detection-taxi-data.adoc[], xref:demos:trino-taxi-data.adoc[], +xref:demos:trino-iceberg.adoc[] and xref:demos:data-lakehouse-iceberg-trino-spark.adoc[] demos all use a +xref:trino:index.adoc[Trino] instance on top of S3 storage that hold data to analyze. Superset is connected to Trino to +analyze a variety of different datasets. == Supported Versions From 14ca1fc670248d0cf18c2974ead064f1fa334270 Mon Sep 17 00:00:00 2001 From: Felix Hennig Date: Mon, 25 Mar 2024 12:18:09 +0100 Subject: [PATCH 08/10] fix(docs): incorrect xref fixed --- docs/modules/superset/pages/usage-guide/security.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/superset/pages/usage-guide/security.adoc b/docs/modules/superset/pages/usage-guide/security.adoc index bf2132fd..26172d7c 100644 --- a/docs/modules/superset/pages/usage-guide/security.adoc +++ b/docs/modules/superset/pages/usage-guide/security.adoc @@ -32,7 +32,7 @@ spec: Users that log in with LDAP are assigned to a default https://superset.apache.org/docs/security/#roles[Role] which is specified with the `userRegistrationRole` property. -You can follow the xref:home:tutorials:authentication_with_openldap.adoc[] tutorial to learn how to set up an AuthenticationClass for an LDAP server, as well as consulting the xref:home:reference:authenticationclass.adoc[] reference. +You can follow the xref:home:tutorials:authentication_with_openldap.adoc[] tutorial to learn how to set up an AuthenticationClass for an LDAP server, as well as consulting the xref:reference:authenticationclass.adoc[] reference. == [[authorization]]Authorization Superset has a concept called `Roles` which allows you to grant user permissions based on roles. From 9fad0801a55add479f258908282e678533f56230 Mon Sep 17 00:00:00 2001 From: Nick <10092581+NickLarsenNZ@users.noreply.github.com> Date: Fri, 2 Aug 2024 01:11:54 +1200 Subject: [PATCH 09/10] docs: remove home module from refs (stackabletech/documentation#637) (#521) --- docs/modules/superset/pages/usage-guide/logging.adoc | 2 +- docs/modules/superset/pages/usage-guide/monitoring.adoc | 2 +- docs/modules/superset/pages/usage-guide/security.adoc | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/modules/superset/pages/usage-guide/logging.adoc b/docs/modules/superset/pages/usage-guide/logging.adoc index 2626d003..64f4fdcd 100644 --- a/docs/modules/superset/pages/usage-guide/logging.adoc +++ b/docs/modules/superset/pages/usage-guide/logging.adoc @@ -17,4 +17,4 @@ spec: ---- Further information on how to configure logging, can be found in -xref:home:concepts:logging.adoc[]. +xref:concepts:logging.adoc[]. diff --git a/docs/modules/superset/pages/usage-guide/monitoring.adoc b/docs/modules/superset/pages/usage-guide/monitoring.adoc index 9366a983..dae4805c 100644 --- a/docs/modules/superset/pages/usage-guide/monitoring.adoc +++ b/docs/modules/superset/pages/usage-guide/monitoring.adoc @@ -1,4 +1,4 @@ = Monitoring The managed Superset instances are automatically configured to export Prometheus metrics. See -xref:home:operators:monitoring.adoc[] for more details. \ No newline at end of file +xref:operators:monitoring.adoc[] for more details. \ No newline at end of file diff --git a/docs/modules/superset/pages/usage-guide/security.adoc b/docs/modules/superset/pages/usage-guide/security.adoc index 26172d7c..d865869d 100644 --- a/docs/modules/superset/pages/usage-guide/security.adoc +++ b/docs/modules/superset/pages/usage-guide/security.adoc @@ -8,7 +8,7 @@ The default setting is to manually set up users via the Webinterface. === LDAP -Superset supports xref:home:concepts:authentication.adoc[authentication] of users against an LDAP server. This requires setting up an xref:home:concepts:authentication.adoc#authenticationclass[AuthenticationClass] for the LDAP server. +Superset supports xref:concepts:authentication.adoc[authentication] of users against an LDAP server. This requires setting up an xref:concepts:authentication.adoc#authenticationclass[AuthenticationClass] for the LDAP server. The AuthenticationClass is then referenced in the SupersetCluster resource as follows: [source,yaml] @@ -32,7 +32,7 @@ spec: Users that log in with LDAP are assigned to a default https://superset.apache.org/docs/security/#roles[Role] which is specified with the `userRegistrationRole` property. -You can follow the xref:home:tutorials:authentication_with_openldap.adoc[] tutorial to learn how to set up an AuthenticationClass for an LDAP server, as well as consulting the xref:reference:authenticationclass.adoc[] reference. +You can follow the xref:tutorials:authentication_with_openldap.adoc[] tutorial to learn how to set up an AuthenticationClass for an LDAP server, as well as consulting the xref:reference:authenticationclass.adoc[] reference. == [[authorization]]Authorization Superset has a concept called `Roles` which allows you to grant user permissions based on roles. From 6b17127f54b45bea745f03e56463a8adbc44d576 Mon Sep 17 00:00:00 2001 From: xeniape Date: Mon, 22 Jun 2026 11:01:27 +0200 Subject: [PATCH 10/10] chore: fix broken link --- docs/modules/superset/pages/usage-guide/connecting-druid.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/superset/pages/usage-guide/connecting-druid.adoc b/docs/modules/superset/pages/usage-guide/connecting-druid.adoc index 3fc660c8..5039515d 100644 --- a/docs/modules/superset/pages/usage-guide/connecting-druid.adoc +++ b/docs/modules/superset/pages/usage-guide/connecting-druid.adoc @@ -1,6 +1,6 @@ = Connecting Apache Druid clusters -The operator can automatically connect Superset to Apache Druid clusters managed by the https://docs.stackable.tech/druid/index.html[Stackable Druid Cluster]. +The operator can automatically connect Superset to Apache Druid clusters managed by the xref:druid:index.adoc[Stackable Druid Cluster]. To do so, create a _DruidConnection_ resource: