Superset

A Compose stack

Superset is a Compose stack, a set of containers (6 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 6 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

• app runs apache/superset:6.1.0-dev, starts after db, broker
• worker runs apache/superset:6.1.0-dev, starts after db, broker
• beat runs apache/superset:6.1.0-dev, starts after db, broker
• init runs apache/superset:6.1.0-dev, starts after db
• broker runs valkey/valkey:8
• db runs postgres:16

Ports

A port is the door the app answers on. A mapping like 5000:5000 means it's reachable on port 5000 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

• 5000:5000
• 6379:6379

Volumes

A volume is where Superset keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

• /app/superset_home kept in the superset_home volume Docker manages
• /var/lib/postgresql/data kept in the dbdata volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Superset takes 16 of them, all with defaults you can leave alone or tweak:

• SUPERSET_SECRET_KEY, pulled from your own environment
• SUPERSET_CONFIG_PATH, defaults to /tmp/superset_config.py
• SUPERSET_CONFIG_CONTENT, defaults to import os SECRET_KEY = os.environ["SUPERSET_SECRET_KEY"] SQLALCHEMY_DATABASE_URI = ( f"postgresql+psycopg2://{os.environ['DB_USER']}:{os.environ['DB_PASSWORD']}" f"@{os.environ['DB_HOST']}:{os.environ['DB_PORT']}/{os.environ['DB_NAME']}" ) _REDIS = f"redis://:{os.environ['REDIS_AUTH']}@{os.environ.get('REDIS_HOST', 'broker')}:6379" class CeleryConfig: broker_url = _REDIS + "/0" result_backend = _REDIS + "/1" imports = ("superset.sql_lab", "superset.tasks.scheduler") worker_prefetch_multiplier = 1 task_acks_late = False CELERY_CONFIG = CeleryConfig CACHE_CONFIG = { "CACHE_TYPE": "RedisCache", "CACHE_DEFAULT_TIMEOUT": 300, "CACHE_KEY_PREFIX": "superset_", "CACHE_REDIS_URL": _REDIS + "/2", } DATA_CACHE_CONFIG = {**CACHE_CONFIG, "CACHE_KEY_PREFIX": "superset_data_"} FILTER_STATE_CACHE_CONFIG = {**CACHE_CONFIG, "CACHE_KEY_PREFIX": "superset_filter_"} EXPLORE_FORM_DATA_CACHE_CONFIG = {**CACHE_CONFIG, "CACHE_KEY_PREFIX": "superset_explore_"}
• DB_HOST, defaults to db
• DB_PORT, defaults to 5432
• DB_NAME, defaults to superset
• DB_USER, defaults to superset
• DB_PASSWORD, defaults to superset-local-only
• REDIS_HOST, defaults to broker
• REDIS_AUTH, pulled from your own environment
• SUPERSET_PORT, defaults to 5000
• ADMIN_PASSWORD, pulled from your own environment
• SUPERSET_LOAD_EXAMPLES, defaults to no
• POSTGRES_USER, defaults to superset
• POSTGRES_PASSWORD, defaults to superset-local-only
• POSTGRES_DB, defaults to superset

Restart policy

The restart policy here is unless-stopped, so Docker restarts Superset after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like app) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Superset up. Add the template list to Portainer once, then deploying Superset is a click rather than a wall of config.