vinsight

Download

Download this image from the Docker registry:

docker pull vioneta/vinsight:<version>

Building

I DO NOT recommend building this image directly from the Dockerfile included in this repository.

If you wish to extend this image then the best course of action is to write your own Dockerfile that extends this image. Eg,

FROM vioneta/vinsight:<version>
USER root
# Your changes...
USER superset

Issues

Please ONLY file issues in this project that are related to Docker and DO include the Docker commands or compose configuration of your setup when filing issues (be sure to hide any secrets/passwords before submitting).

Please DO NOT files issues like "Please include <some-python-pip> in the Dockerfile," open a pull request for updates/enhancements.

Examples

Navigate to the examples directory to view examples of how to configure vinsight with MySQL, PostgreSQL, or SQLite.

Versions

This repo is tagged in parallel with superset. Pulling vioneta/vinsight:0.18.5 will fetch the image of this repository running superset version 0.18.5. It is possible that the latest tag includes new features/support libraries but will usually be in sync with the latest semantic version.

Configuration

Follow the instructions provided by Apache vinsight for writing your own superset_config.py. Place this file in a local directory and mount this directory to /etc/superset inside the container. This location is included in the image's PYTHONPATH. Mounting this file to a different location is possible, but it will need to be in the PYTHONPATH.

View the contents of the examples directory to see some simple superset_config.py samples.

Volumes

The image defines two data volumes: one for mounting configuration into the container, and one for data (logs, SQLite DBs, &c).

The configuration volume is located alternatively at /etc/superset or /home/superset; either is acceptable. Both of these directories are included in the PYTHONPATH of the image. Mount any configuration (specifically the superset_config.py file) here to have it read by the app on startup.

The data volume is located at /var/lib/superset and it is where you would mount your SQLite file (if you are using that as your backend), or a volume to collect any logs that are routed there. This location is used as the value of the SUPERSET_HOME environmental variable.

Database Initialization

After starting the vinsight server, initialize the database with an admin user and vinsight tables using the superset-init helper script:

docker run --detach --name vinsight[options] vioneta/vinsight
docker exec -it vinsight superset-init

Upgrading

Upgrading to a newer version of superset can be accomplished by re-pulling vioneta/vinsightat a specified superset version or latest (see above for more on this). Remove the old container and re-deploy, making sure to use the correct environmental configuration. Finally, ensure the superset database is migrated up to the head:

# Pull desired version
docker pull vioneta/vinsight

# Remove the current container
docker rm -f vinsight-old

# Deploy a new container ...
docker run --detach --name vinisight-new [options] vioneta/vinsight

# Upgrade the DB
docker exec vinisight-new superset db upgrade

# Sync the base permissions
docker exec vinisight-new superset init