You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by GitBox <gi...@apache.org> on 2018/06/10 04:26:43 UTC
[GitHub] mistercrunch closed pull request #4193: Init docker for local
development environment.
mistercrunch closed pull request #4193: Init docker for local development environment.
URL: https://github.com/apache/incubator-superset/pull/4193
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/.gitignore b/.gitignore
index df3cb8bd3c..11929a9b7e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -41,3 +41,10 @@ superset/assets/version_info.json
*.iml
venv
@eaDir/
+
+# docker
+/Dockerfile
+/docker-build.sh
+/docker-compose.yml
+/docker-entrypoint.sh
+/docker-init.sh
diff --git a/contrib/docker/Dockerfile b/contrib/docker/Dockerfile
new file mode 100644
index 0000000000..3d474864f7
--- /dev/null
+++ b/contrib/docker/Dockerfile
@@ -0,0 +1,60 @@
+FROM python:3.6
+
+MAINTAINER Xiao Hanyu <ha...@shopeemobile.com>
+
+# Add a normal user
+RUN useradd --user-group --create-home --shell /bin/bash work
+
+# Configure environment
+ENV LANG=C.UTF-8 \
+ LC_ALL=C.UTF-8 \
+ HOME=/home/work
+
+RUN apt-get update -y
+
+# Install some dependencies
+# http://airbnb.io/superset/installation.html#os-dependencies
+RUN apt-get update -y && apt-get install -y build-essential libssl-dev \
+ libffi-dev python3-dev libsasl2-dev libldap2-dev
+
+RUN apt-get install -y vim less postgresql-client redis-tools
+
+# Install nodejs for custom build
+# https://github.com/apache/incubator-superset/blob/master/docs/installation.rst#making-your-own-build
+# https://nodejs.org/en/download/package-manager/
+RUN curl -sL https://deb.nodesource.com/setup_8.x | bash -
+RUN apt-get install -y nodejs
+RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add -; \
+ echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list; \
+ apt-get update; \
+ apt-get install -y yarn
+
+RUN mkdir $HOME/incubator-superset
+
+WORKDIR $HOME/incubator-superset
+
+COPY ./ ./
+
+RUN pip install --upgrade setuptools pip
+RUN pip install -e . && pip install -r requirements-dev.txt
+
+ENV PATH=/home/work/incubator-superset/superset/bin:$PATH \
+ PYTHONPATH=./superset/:$PYTHONPATH
+
+COPY docker-entrypoint.sh /usr/local/bin/
+RUN chmod +x /usr/local/bin/docker-entrypoint.sh
+RUN ln -s usr/local/bin/docker-entrypoint.sh /entrypoint.sh # backwards compat
+
+COPY ./superset ./superset
+RUN chown -R work:work $HOME
+
+USER work
+
+RUN cd superset/assets && yarn
+RUN cd superset/assets && npm run build
+
+HEALTHCHECK CMD ["curl", "-f", "http://localhost:8088/health"]
+
+ENTRYPOINT ["docker-entrypoint.sh"]
+
+EXPOSE 8088
diff --git a/contrib/docker/docker-build.sh b/contrib/docker/docker-build.sh
new file mode 100644
index 0000000000..55f73274d6
--- /dev/null
+++ b/contrib/docker/docker-build.sh
@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+set -ex
+
+docker build -t apache/incubator-superset -f Dockerfile .
diff --git a/contrib/docker/docker-compose.yml b/contrib/docker/docker-compose.yml
new file mode 100644
index 0000000000..9085793c10
--- /dev/null
+++ b/contrib/docker/docker-compose.yml
@@ -0,0 +1,48 @@
+version: '3'
+services:
+ redis:
+ image: redis:3.2
+ restart: always
+ ports:
+ - 6379:6379
+ volumes:
+ - redis:/data
+ postgres:
+ image: postgres:10
+ restart: always
+ environment:
+ POSTGRES_DB: superset
+ POSTGRES_PASSWORD: superset
+ POSTGRES_USER: superset
+ ports:
+ - 5432:5432
+ volumes:
+ - postgres:/var/lib/postgresql/data
+ superset:
+ image: apache/incubator-superset
+ restart: always
+ environment:
+ POSTGRES_DB: superset
+ POSTGRES_USER: superset
+ POSTGRES_PASSWORD: superset
+ POSTGRES_HOST: postgres
+ POSTGRES_PORT: 5432
+ REDIS_HOST: redis
+ REDIS_PORT: 6379
+ SUPERSET_ENV: local
+ ports:
+ - 8088:8088
+ command: "tail -f /dev/null"
+ depends_on:
+ - postgres
+ - redis
+ volumes:
+ - .:/home/work/incubator-superset
+ - superset-node-modules:/home/work/incubator-superset/superset/assets/node_modules
+volumes:
+ postgres:
+ external: false
+ redis:
+ external: false
+ superset-node-modules:
+ external: false
diff --git a/contrib/docker/docker-entrypoint.sh b/contrib/docker/docker-entrypoint.sh
new file mode 100644
index 0000000000..c6629c7b70
--- /dev/null
+++ b/contrib/docker/docker-entrypoint.sh
@@ -0,0 +1,12 @@
+#!/bin/bash
+set -ex
+
+if [ "$#" -ne 0 ]; then
+ exec "$@"
+elif [ "$SUPERSET_ENV" = "local" ]; then
+ superset runserver -d
+elif [ "$SUPERSET_ENV" = "production" ]; then
+ superset runserver -a 0.0.0.0 -w $((2 * $(getconf _NPROCESSORS_ONLN) + 1))
+else
+ superset --help
+fi
diff --git a/contrib/docker/docker-init.sh b/contrib/docker/docker-init.sh
new file mode 100644
index 0000000000..940ad4fa34
--- /dev/null
+++ b/contrib/docker/docker-init.sh
@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+
+set -ex
+
+# Create an admin user (you will be prompted to set username, first and last name before setting a password)
+fabmanager create-admin --app superset
+
+# Initialize the database
+superset db upgrade
+
+# Load some data to play with
+superset load_examples
+
+# Create default roles and permissions
+superset init
+
+# Need to run `npm run build` when enter contains for first time
+cd superset/assets && npm run build && cd ../../
+
+# Start superset worker for SQL Lab
+superset worker &
+
+# To start a development web server, use the -d switch
+superset runserver -d
diff --git a/contrib/docker/superset_config.py b/contrib/docker/superset_config.py
new file mode 100644
index 0000000000..52536d6b6c
--- /dev/null
+++ b/contrib/docker/superset_config.py
@@ -0,0 +1,48 @@
+# -*- coding: utf-8 -*-
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+from __future__ import unicode_literals
+
+import os
+
+
+def get_env_variable(var_name, default=None):
+ """Get the environment variable or raise exception."""
+ try:
+ return os.environ[var_name]
+ except KeyError:
+ if default is not None:
+ return default
+ else:
+ error_msg = 'The environment variable {} was missing, abort...'\
+ .format(var_name)
+ raise EnvironmentError(error_msg)
+
+
+POSTGRES_USER = get_env_variable('POSTGRES_USER')
+POSTGRES_PASSWORD = get_env_variable('POSTGRES_PASSWORD')
+POSTGRES_HOST = get_env_variable('POSTGRES_HOST')
+POSTGRES_PORT = get_env_variable('POSTGRES_PORT')
+POSTGRES_DB = get_env_variable('POSTGRES_DB')
+
+# The SQLAlchemy connection string.
+SQLALCHEMY_DATABASE_URI = 'postgresql://%s:%s@%s:%s/%s' % (POSTGRES_USER,
+ POSTGRES_PASSWORD,
+ POSTGRES_HOST,
+ POSTGRES_PORT,
+ POSTGRES_DB)
+
+REDIS_HOST = get_env_variable('REDIS_HOST')
+REDIS_PORT = get_env_variable('REDIS_PORT')
+
+
+class CeleryConfig(object):
+ BROKER_URL = 'redis://%s:%s/0' % (REDIS_HOST, REDIS_PORT)
+ CELERY_IMPORTS = ('superset.sql_lab', )
+ CELERY_RESULT_BACKEND = 'redis://%s:%s/1' % (REDIS_HOST, REDIS_PORT)
+ CELERY_ANNOTATIONS = {'tasks.add': {'rate_limit': '10/s'}}
+ CELERY_TASK_PROTOCOL = 1
+
+
+CELERY_CONFIG = CeleryConfig
diff --git a/docs/installation.rst b/docs/installation.rst
index 28efb462ae..4666f8295a 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -35,6 +35,27 @@ The Superset web server and the Superset Celery workers (optional)
are stateless, so you can scale out by running on as many servers
as needed.
+Start with Docker
+-----------------
+
+If you know docker, then you're lucky, we have shortcut road for you to
+initialize development environment: ::
+
+ 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
+
+After several minutes for sueprset initialization to finish, you can open a
+a browser and view `http://localhost:8088` to start your journey.
+
+Or if you're curious and want to install superset from bottom up, then go
+ahead.
+
OS dependencies
---------------
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org