Apache Superset Production Docker Setup

This directory contains a production-ready Docker Compose setup for Apache Superset with separated containers for better scalability, security, and maintenance.

Branding by and for coasti.org.

📋 Prerequisites

• Docker and Docker Compose installed
• At least 4GB RAM available
• Optional: For Mapbox integration (to get backgrounds other than OpenStreetMap when plotting GeoJson):
  • register on mapbox (https://www.mapbox.com/)
  • navigate to Admin > Tokens and create a new token
  • set MAPBOX_API_KEY in ./config/.env after the product is deployed

🚀 Getting Started

Using the coasti installer

coasti product add git@github.com:coasti-org/superset_docker.git

Using copier

copier copy git@github.com:coasti-org/superset_docker.git /abs/path/to/superset_docker --trust

Manually

git clone git@github.com:coasti-org/superset_docker.git
cd superset_docker

# copy (and then edit) config files
cp ./config/.env.jina ./config/.env
cp ./config/superset_config_sample.py ./config/superset_config.py
cp ./docker/docker-compose-sample.yml ./docker/docker-compose.yml

docker compose --env-file ./config/.env -f ./docker/docker-compose.yml up

🔧 Deployment and Docker Cheat-Sheet

The commands below assume that you made a copy of ./docker/docker-compose-sample.yml to ./docker/docker-compose.yml.

# pull the images
docker compose -f ./docker/docker-compose.yml pull

# start superset (and its required containers)
docker compose -f ./docker/docker-compose.yml --env-file ./config/.env up superset-app

# instead of providing the .env to every compose command, you can source it
set -a; source ./config/.env; set +a

# start all containers and send to background
docker compose -f ./docker/docker-compose.yml up -d

# connect to a running container to explore what is happening
docker exec -it superset-app bash

# view logs for a specific container
docker logs -f superset-app

# restart a container
docker restart superset-app

# stop all containers of the stack
docker compose -f ./docker/docker-compose.yml down

# stop and remove docker volumes
docker compose -f ./docker/docker-compose.yml down -v  # WARNING: This deletes all data

🆙 Updating

coasti product update superset_docker

copier update -a /abs/path/to/superset_docker/config/install_answers.yml

Note on Version numbers:

Our Versioning adheres to semver. Since we essentially just wrap superset, we include their version as metatag, so it is remains easy to spot which version of superset is included.

E.g. 0.1.2+superset.6.0.0 means superset version 6.0.0, while our wrapping codes are at 0.1.2. This follows PEP440 (Regex Check), which is a bit more restrictive than plain semver, but is required to support updates via copier.

📚 Further Reading

• docs/project_overview.md
• docs/configuration.md
• docs/troubleshooting.md
• docs/manual_setup.md (without copier)
• docs/migration.md (from an existing superset instance)