Important
Regular upstream releases deliver security updates. Keep your Superset instance up to date to receive the latest patches.
Disclaimer
OSS Library requires internet connectivity and is not supported in air-gapped environments. Attempting to use it in an air-gapped environment may result in errors or unexpected behavior.
Apache Superset is an open-source business intelligence web application that provides data visualization, dashboard creation, and SQL-based data exploration for databases.
Warning
Superset doesn't support Red Hat OpenShift (RHOS).
Key features
- No-code interface for building charts.
- Web-based SQL Editor for querying.
- Semantic layer for defining custom dimensions and metrics.
- Support for SQL databases and data engines.
- A range of visualization types, including bar charts and geospatial visualizations.
- A configurable caching layer to reduce database load.
- Configurable security roles and authentication options.
- An API for programmatic customization.
- Cloud-native architecture.
Apache Superset components
- Core application — Includes a Python (Flask) backend, an API layer, and a React frontend. When a user loads a chart or dashboard, Superset queries the configured data warehouse and renders the result as a visualization.
- Metadata database — Stores chart definitions, dashboard configurations, user information, and logs. PostgreSQL and MySQL support production use. Avoid SQLite for production. Some installation methods use it by default.
- Caching layer (optional) — Reduces data warehouse load by storing query results, and acts as a message broker for the worker process. Redis is the most common choice.
- Worker and beat (optional) — Handles asynchronous task execution and scheduling, typically via Celery.
Enable the caching layer and worker to access these features:
- Alerts and reports
- Caching
- Async queries
- Dashboard thumbnails
Supported data sources
Superset can query data from any SQL-based datastore or data engine (Presto, Trino, Athena, and more) that has a Python DB-API driver and a SQLAlchemy dialect.
Requirements
Technical requirements
- (Required) Database: Superset requires an external database to store chart definitions, dashboard configurations, user information, and logs. You must create this database before deploying Superset.
- PostgreSQL v13+ is recommended for production. Have the host, port, database name, username, and password ready before installation. You can obtain these from the Connect tab of your cluster in the HM console.
- Superset also supports MySQL v8.x+.
- Resources: Worker pods default to 1Gi Memory and 250m CPU.
Deploying Superset
- Navigate to Asset Library, then select Apps in the HM console.
- Select Apache Superset and select Deploy.
- Under Identity, enter a name for your deployment and select the target project.
- Under Parameters, fill in the required fields. See Parameters for field descriptions.
- Select Deploy to install Superset.
Parameters
| Parameter | Description | Required |
|---|---|---|
PostgreSQL Host | Hostname or IP address of your PostgreSQL server. Examples: postgres.database.svc.cluster.local, prod-postgres.example.com, 10.0.1.50. | Yes |
Database name | Name of the PostgreSQL database. | Yes |
Database username | PostgreSQL user for the Superset application. | Yes |
Database password | PostgreSQL password for the database connection. | Yes |
PostgreSQL Port | Port number for the PostgreSQL connection. Default: 5432. | No |
replicaCount | Number of Superset replicas. Default: 1. | No |
CPU limit (node) | Maximum CPU for the Superset node. Default: 1000m. | No |
Memory limit (node) | Maximum memory for the Superset node. Default: 2Gi. | No |
CPU limit (worker) | Maximum CPU for the Superset worker. Default: 1000m. | No |
Memory limit (worker) | Maximum memory for the Superset worker. Default: 2Gi. | No |
CPU request (worker) | Requested CPU for the Superset worker. Default: 500m. | No |
Memory request (worker) | Requested memory for the Superset worker. Default: 1Gi. | No |
Post-deployment configuration
Once Superset is deployed, complete these steps to finish your setup:
- Navigate to your Project and select the Apps tab, or navigate to Estate > Apps to check the deployment status. When the status shows Ready, launch the app to continue.
- Open Superset from the HM console.
- Navigate to Settings > Database Connection to add your data sources for analysis.
Support resources
As Superset OSS is community-supported, use these resources for technical guidance and updates:
- Superset community — peer-to-peer support from the community.
- Superset documentation — self-service deployment and feature guides, as well as additional information on Superset installation and configuration.
- Superset GitHub repository — source code, issue tracker, and release notes.