You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/modules/superset/pages/index.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
= Stackable Operator for Apache Superset
2
-
: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.
2
+
:description: Stackable Operator for Apache Superset manages Superset clusters on Kubernetes for data exploration, SQL connections, and visualization.
3
3
:keywords: Stackable operator, Apache Superset, Kubernetes, operator, data science, data exploration
Copy file name to clipboardExpand all lines: docs/modules/superset/pages/usage-guide/configuration-environment-overrides.adoc
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,14 +4,12 @@ The cluster definition also supports overriding configuration properties and env
4
4
either per role or per role group, where the more specific override (role group) has precedence over
5
5
the less specific one (role).
6
6
7
-
IMPORTANT: Overriding certain properties which are set by the operator (such as the `STATS_LOGGER`)
8
-
can interfere with the operator and can lead to problems.
7
+
IMPORTANT: Overriding certain properties which are set by the operator (such as the `STATS_LOGGER`) can interfere with the operator and can lead to problems.
9
8
10
9
== Configuration Properties
11
10
12
-
For a role or role group, at the same level of `config`, you can specify `configOverrides` for the
13
-
`superset_config.py`. For example, if you want to set the CSV export encoding and the preferred
14
-
databases adapt the `nodes` section of the cluster resource as follows:
11
+
For a role or role group, at the same level of `config`, you can specify `configOverrides` for the `superset_config.py`.
12
+
For example, if you want to set the CSV export encoding and the preferred databases adapt the `nodes` section of the cluster resource as follows:
15
13
16
14
[source,yaml]
17
15
----
@@ -53,8 +51,9 @@ nodes:
53
51
config: {}
54
52
----
55
53
56
-
All override property values must be strings. They are treated as Python expressions. So care must
57
-
be taken to produce a valid configuration.
54
+
All override property values must be strings.
55
+
They are treated as Python expressions.
56
+
So care must be taken to produce a valid configuration.
58
57
59
58
For a full list of configuration options we refer to the
60
59
https://github.com/apache/superset/blob/master/superset/config.py[main config file for Superset].
@@ -88,7 +87,8 @@ nodes:
88
87
89
88
== Environment Variables
90
89
91
-
In a similar fashion, environment variables can be (over)written. For example per role group:
90
+
In a similar fashion, environment variables can be (over)written.
The operator can automatically connect Superset clusters that it manages to Apache Druid clusters managed by the xref:druid:index.adoc[Stackable operator for Apache Druid].
6
8
@@ -27,9 +29,9 @@ spec:
27
29
28
30
The `namespace` part is optional in both cases; if it is omitted it will default to the namespace of the DruidConnection.
29
31
30
-
Once Superset startup is complete and the database is initialized, the Superset operator will create a https://kubernetes.io/docs/concepts/workloads/controllers/job/[Job] that will connect to the Superset cluster to run an import command to add the Druid cluster as a datasource.
32
+
Once Superset startup is complete and the database is initialized, the Superset operator will create a {k8s-job}[Job] that will connect to the Superset cluster to run an import command to add the Druid cluster as a datasource.
31
33
32
-
IMPORTANT: The Job is connecting to the Superset Pods. If you are restricting network traffic in your Kubernetes cluster, make sure to configure a https://kubernetes.io/docs/concepts/services-networking/network-policies/[NetworkPolicy] that allows the Job to connect to Superset.
34
+
IMPORTANT: The Job is connecting to the Superset Pods. If you are restricting network traffic in your Kubernetes cluster, make sure to configure a {k8s-network-policies}[NetworkPolicy] that allows the Job to connect to Superset.
33
35
34
36
Once the Job is completed you can see the Druid cluster as a database in the user interface under Data > Databases:
Copy file name to clipboardExpand all lines: docs/modules/superset/pages/usage-guide/listenerclass.adoc
+5-2Lines changed: 5 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,11 @@
1
1
= Service exposition with ListenerClasses
2
+
:description: Superset service exposition with ListenerClass: configure access via internal, external-unstable, or external-stable services.
2
3
3
-
Apache Superset offers a web UI and an API. The Operator deploys a service called `<name>-external` (where `<name>` is the name of the SupersetCluster) through which Superset can be reached.
4
+
Apache Superset offers a web UI and an API.
5
+
The Operator deploys a service called `<name>-external` (where `<name>` is the name of the SupersetCluster) through which Superset can be reached.
4
6
5
-
This service can have three different types: `cluster-internal`, `external-unstable` and `external-stable`. Read more about the types in the xref:concepts:service-exposition.adoc[service exposition] documentation at platform level.
7
+
This service can have three different types: `cluster-internal`, `external-unstable` and `external-stable`.
8
+
Read more about the types in the xref:concepts:service-exposition.adoc[service exposition] documentation at platform level.
Copy file name to clipboardExpand all lines: docs/modules/superset/pages/usage-guide/logging.adoc
+3-4Lines changed: 3 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
= Log aggregation
2
+
:description: The logs can be forwarded to a Vector log aggregator by providing a discovery ConfigMap for the aggregator and by enabling the log agent.
2
3
3
-
The logs can be forwarded to a Vector log aggregator by providing a discovery
4
-
ConfigMap for the aggregator and by enabling the log agent:
4
+
The logs can be forwarded to a Vector log aggregator by providing a discovery ConfigMap for the aggregator and by enabling the log agent:
5
5
6
6
[source,yaml]
7
7
----
@@ -14,5 +14,4 @@ spec:
14
14
enableVectorAgent: true
15
15
----
16
16
17
-
Further information on how to configure logging, can be found in
18
-
xref:concepts:logging.adoc[].
17
+
Further information on how to configure logging, can be found in xref:concepts:logging.adoc[].
Copy file name to clipboardExpand all lines: docs/modules/superset/pages/usage-guide/security.adoc
+10-6Lines changed: 10 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,8 @@
1
1
= Security
2
+
:description: Superset security: configure authentication via database, LDAP, or OpenID Connect with roles-based authorization for user access control.
<1> The reference to an AuthenticationClass called `ldap`
41
45
<2> The default role to which all users are assigned
42
46
43
-
Users that log in with LDAP are assigned to a default https://superset.apache.org/docs/security/#roles[Role^{external-link-icon}^] which is specified with the `userRegistrationRole` property.
47
+
Users that log in with LDAP are assigned to a default {superset-roles}[Role^{external-link-icon}^] which is specified with the `userRegistrationRole` property.
44
48
45
49
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:concepts:authentication.adoc#_ldap[AuthenticationClass concepts page].
46
50
@@ -50,7 +54,7 @@ An OpenID Connect provider can be used for authentication.
50
54
Unfortunately, there is no generic support for OpenID Connect built into Superset.
51
55
This means that only specific OpenID Connect providers can be configured.
52
56
53
-
IMPORTANT: Superset deployments on the Stackable Data Platform only support https://www.keycloak.org/[Keycloak^{external-link-icon}^].
57
+
IMPORTANT: Superset deployments on the Stackable Data Platform only support {keycloak}[Keycloak^{external-link-icon}^].
54
58
55
59
[source,yaml]
56
60
----
@@ -73,7 +77,7 @@ spec:
73
77
<2> The reference to the Secret containing the Superset client credentials
74
78
<3> The default role to which all users are assigned
75
79
76
-
Users that log in with OpenID Connect are assigned to a default https://superset.apache.org/docs/security/#roles[Role^{external-link-icon}^] which is specified with the `userRegistrationRole` property.
80
+
Users that log in with OpenID Connect are assigned to a default {superset-roles}[Role^{external-link-icon}^] which is specified with the `userRegistrationRole` property.
77
81
78
82
The Secret containing the Superset client credentials:
79
83
@@ -120,15 +124,15 @@ Further information for specifying an AuthenticationClass for an OIDC provider c
120
124
== [[authorization]]Authorization
121
125
122
126
Superset has a concept called `Roles` which allows you to grant user permissions based on roles.
123
-
Have a look at the https://superset.apache.org/docs/security[Superset documentation on Security^{external-link-icon}^].
127
+
Have a look at the {superset-security}[Superset documentation on Security^{external-link-icon}^].
124
128
125
129
=== Superset database
126
130
127
131
You can view all the available roles in the web interface of Superset and can also assign users to these roles.
128
132
129
133
=== LDAP
130
134
131
-
Superset supports assigning https://superset.apache.org/docs/security/#roles[Roles^{external-link-icon}^] to users based on their LDAP group membership, though this is not yet supported by the Stackable operator.
135
+
Superset supports assigning {superset-roles}[Roles^{external-link-icon}^] to users based on their LDAP group membership, though this is not yet supported by the Stackable operator.
132
136
All the users logging in via LDAP get assigned to the same role which you can configure via the attribute `authentication[*].userRegistrationRole` on the `SupersetCluster` object:
133
137
134
138
[source,yaml]
@@ -149,7 +153,7 @@ spec:
149
153
=== OpenID Connect
150
154
151
155
The mechanism for assigning roles to users described in the LDAP section also applies to OpenID Connect.
152
-
Superset supports assigning https://superset.apache.org/docs/security/#roles[Roles^{external-link-icon}^] to users based on their OpenID Connect scopes, though this is not yet supported by the Stackable operator.
156
+
Superset supports assigning {superset-roles}[Roles^{external-link-icon}^] to users based on their OpenID Connect scopes, though this is not yet supported by the Stackable operator.
153
157
All the users logging in via OpenID Connect get assigned to the same role which you can configure via the attribute `authentication[*].userRegistrationRole` on the `SupersetCluster` object:
0 commit comments