superset/docs
Xiao Hanyu 0a276ff75d Init docker for local development environment. (#4193)
This commit will try to dockerize superset in local development
environment.

The basic design is:
- Enable superset, redis and postgres service instead of using sqlite,
  just want to simulate production environment settings
- Use environment variables to config various app settings. It's easy to
  run and config superset to any environment if we use environment than
  traditional config files
- For local development environment, we just expose postgres and redis
  to local host machine thus you can connect local port via `psql` or
  `redis-cli`
- Wrap start up command in a standard `docker-entrypoint.sh`, and use
  `tail -f /dev/null` combined with manually `superset runserver -d` to
  make sure that code error didn't cause the container to fail.
- Use volumes to share code between host and container, thus you can use
  your favourite tools to modify code and your code will run in
  containerized environment
- Use volumes to persistent postgres and redis data, and also
  `node_modules` data.
  - If we don't cache `node_modules` in docker volume, then every time
    run docker build, the `node_modules` directory, will is about 500 MB
    large, will be sent to docker daemon, and make the build quite slow.
- Wrap initialization commands to a single script `docker-init.sh`

After this dockerize setup, any developers who want to contribute to
superset, just follow three easy steps:

```
git clone https://github.com/apache/incubator-superset/
cd incubator-superset
cp contrib/docker/{docker-build.sh,docker-compose.yml,docker-entrypoint.sh,docker-init.sh,Dockerfile} .
cp contrib/docker/superset_config.py superset/
bash -x docker-build.sh
docker-compose up -d
docker-compose exec superset bash
bash docker-init.sh
```
2018-06-09 21:26:41 -07:00
..
_static Adding a Gallery to the docs 2016-04-06 08:46:21 -07:00
_templates [WiP] rename project from Caravel to Superset (#1576) 2016-11-09 23:08:22 -08:00
Makefile [WiP] rename project from Caravel to Superset (#1576) 2016-11-09 23:08:22 -08:00
build.sh [WiP] rename project from Caravel to Superset (#1576) 2016-11-09 23:08:22 -08:00
conf.py [docs] many improvements to the documentation / cleanup (#4817) 2018-04-13 10:23:27 -07:00
druid.rst [docs] many improvements to the documentation / cleanup (#4817) 2018-04-13 10:23:27 -07:00
faq.rst [docs] many improvements to the documentation / cleanup (#4817) 2018-04-13 10:23:27 -07:00
gallery.rst [docs] many improvements to the documentation / cleanup (#4817) 2018-04-13 10:23:27 -07:00
images [docs] many improvements to the documentation / cleanup (#4817) 2018-04-13 10:23:27 -07:00
import_export_datasources.rst [docs] many improvements to the documentation / cleanup (#4817) 2018-04-13 10:23:27 -07:00
index.rst [docs] many improvements to the documentation / cleanup (#4817) 2018-04-13 10:23:27 -07:00
installation.rst Init docker for local development environment. (#4193) 2018-06-09 21:26:41 -07:00
misc.rst [docs] many improvements to the documentation / cleanup (#4817) 2018-04-13 10:23:27 -07:00
requirements.txt [travis/tox] Restructuring configuration (#4552) 2018-04-10 15:59:44 -07:00
security.rst [docs] many improvements to the documentation / cleanup (#4817) 2018-04-13 10:23:27 -07:00
sqllab.rst [docs] many improvements to the documentation / cleanup (#4817) 2018-04-13 10:23:27 -07:00
tutorial.rst [docs] many improvements to the documentation / cleanup (#4817) 2018-04-13 10:23:27 -07:00
videos.rst [docs] many improvements to the documentation / cleanup (#4817) 2018-04-13 10:23:27 -07:00
visualization.rst docs: fixup code blocks rendering (#4594) 2018-03-11 11:34:58 -07:00