The Reporting setup guide assists in configuring the reporting plugin, relying on specific dependencies and configurations.
The reporting plugin, available as a Docker image, requires the following dependencies:
Configuring the reporting plugin involves several steps:
Update the reporting-image
URL in the spark-app.yml
file.
Configure the correct database ENV variables in the spark-app.yml
file (check them in the above examples with/without webhook).
Deploy the application:
For deployments without a webhook, manage secrets and environmental variables for security:
NOTE: Passwords are currently set as plain strings, which is not secure practice in a production environment.
When using the webhook, employ environmental variables with secrets for a balanced security approach:
In Kubernetes-based Spark deployments managed by the Spark Operator, you can define the sparkApplication configuration to customize the behavior, resources, and environment for both the driver and executor components of Spark jobs. The driver section allows fine-tuning of parameters specifically pertinent to the driver part of the Spark application.
Below are the configurable values within the chart values.yml file (with webhook):
Detailed Superset Configuration Guide:
Refer to Superset Documentation for in-depth information:
After installation, perform the following essential configurations:
For document-related data storage, configure these environment variables:
SPRING_DATASOURCE_URL
SPRING_DATASOURCE_USERNAME
SPRING_DATASOURCE_PASSWORD
Ensure accurate details to prevent startup errors. The Liquibase script manages schema and migrations.
The following values should be set with the corresponding Redis-related values:
SPRING_REDIS_HOST
SPRING_REDIS_PORT
To implement alternative user authentication:
AUTH_TYPE
in your superset.yml
configuration file:
AUTH_TYPE: AUTH_OID
openid-connect
realm:
OIDC_OPENID_REALM: 'flowx'
With this configuration, the login page changes to a prompt where the user can select the desired OpenID provider.
Firstly, you will want to make sure that flask stops using flask-openid
and starts using flask-oidc
instead.
To do so, you will need to create your own security manager that configures flask-oidc
as its authentication provider.
To enable OpenID in Superset, you would previously have had to set the authentication type to AUTH_OID
.
The security manager still executes all the behavior of the super class, but overrides the OID attribute with the OpenIDConnect
object.
Further, it replaces the default OpenID authentication view with a custom one:
On authentication, the user is redirected back to Superset.
Finally, we need to add some parameters to the superset .yml file:
The Reporting setup guide assists in configuring the reporting plugin, relying on specific dependencies and configurations.
The reporting plugin, available as a Docker image, requires the following dependencies:
Configuring the reporting plugin involves several steps:
Update the reporting-image
URL in the spark-app.yml
file.
Configure the correct database ENV variables in the spark-app.yml
file (check them in the above examples with/without webhook).
Deploy the application:
For deployments without a webhook, manage secrets and environmental variables for security:
NOTE: Passwords are currently set as plain strings, which is not secure practice in a production environment.
When using the webhook, employ environmental variables with secrets for a balanced security approach:
In Kubernetes-based Spark deployments managed by the Spark Operator, you can define the sparkApplication configuration to customize the behavior, resources, and environment for both the driver and executor components of Spark jobs. The driver section allows fine-tuning of parameters specifically pertinent to the driver part of the Spark application.
Below are the configurable values within the chart values.yml file (with webhook):
Detailed Superset Configuration Guide:
Refer to Superset Documentation for in-depth information:
After installation, perform the following essential configurations:
For document-related data storage, configure these environment variables:
SPRING_DATASOURCE_URL
SPRING_DATASOURCE_USERNAME
SPRING_DATASOURCE_PASSWORD
Ensure accurate details to prevent startup errors. The Liquibase script manages schema and migrations.
The following values should be set with the corresponding Redis-related values:
SPRING_REDIS_HOST
SPRING_REDIS_PORT
To implement alternative user authentication:
AUTH_TYPE
in your superset.yml
configuration file:
AUTH_TYPE: AUTH_OID
openid-connect
realm:
OIDC_OPENID_REALM: 'flowx'
With this configuration, the login page changes to a prompt where the user can select the desired OpenID provider.
Firstly, you will want to make sure that flask stops using flask-openid
and starts using flask-oidc
instead.
To do so, you will need to create your own security manager that configures flask-oidc
as its authentication provider.
To enable OpenID in Superset, you would previously have had to set the authentication type to AUTH_OID
.
The security manager still executes all the behavior of the super class, but overrides the OID attribute with the OpenIDConnect
object.
Further, it replaces the default OpenID authentication view with a custom one:
On authentication, the user is redirected back to Superset.
Finally, we need to add some parameters to the superset .yml file: