Superset docker does not work well with WSL2

[gbronner]

I attempted to set up a superset development environment to add a new data source. Turned out that I could not figure out how to get this to work despite working very hard on it

1. I set up a new WSL2 Ubuntu 24 VM on my computer
2. I followed the instructions here https://superset.apache.org/docs/installation/docker-compose/ to check out superset and run docker compose up

A non-exhaustive list of issues I encountered:

Issues with Docker

The newest versions of superset docker-compose.yml are incompatible with any version of docker in the ubuntu repositories.

This necessitates removing docker, docker-ce, docker-compose-plugin, and anything else docker related, adding the docker repository to the package sources, and installing the latest version of docker.

Docker, by default uses the same IP address space as WSL. So you have to go find and edit /etc/docker/daemon.json and add
"bip": "192.168.200.1/24" and restart docker or reboot your wsl or both.

If you don't do this, building the superset-node container will fail.

Issues with configuration

It isn't at all clear from the instructions where to edit superset_config.py I think you finally need to do it in superset/docker/pythonpath_dev/superset_config.py

Otherwise you will get all sorts of nasty warnings about SECRET_KEYS

Likewise, you need to copy superset-websocket/config.example.json to config.json and edit it or the superset-websocket container will die.

Overall criticism:

• This process is unlikely to work because it isn't pinned to a known working version.
• This process has a bunch of unnecessary containers. A simple version that omits redis, postgres, websockets, nginx and runs most things in the same container would be a far better way to go about using this.

[dosubot[bot]]

Hey @gbronner! I'm here to help you with any bugs, questions, or contributions. Let's tackle this issue together!

I found a similar closed issue regarding Superset installation build failures using Docker on MS-Windows, which might provide some insights into your situation. The issue was resolved by creating a Docker volume for the node_modules directory ^[1].

To address the specific issues you've encountered:

1. Docker Version Compatibility: It's necessary to use the latest Docker version from the Docker repository rather than the Ubuntu repositories, as the latter may not be compatible with the latest docker-compose.yml configurations.

2. IP Address Conflicts: You correctly identified the need to modify the /etc/docker/daemon.json file to change the bip setting, which resolves IP address conflicts between Docker and WSL2.

3. Configuration Files:

   • For superset_config.py, you should indeed edit the file located at superset/docker/pythonpath_dev/superset_config.py to avoid warnings about SECRET_KEYS.
   • For the websocket configuration, copying superset-websocket/config.example.json to config.json and making necessary edits is essential to prevent the websocket container from failing.

4. Simplifying the Setup: While the current setup includes multiple containers for different services, a minimal development environment can be achieved by focusing on the essential containers: Superset Flask web server, Postgres, and Redis ^[2]. This approach can help streamline the setup process.

These steps should help you overcome the issues with setting up Superset on WSL2.

To continue talking to Dosu, mention @dosu.