mirror of
https://github.com/getredash/redash.git
synced 2025-12-25 01:03:20 -05:00
New bootstrap script
This commit is contained in:
Arik Fraimovich
@@ -1,195 +1,110 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# This script setups Redash along with supervisor, nginx, PostgreSQL and Redis. It was written to be used on
|
||||
# Ubuntu 16.04. Technically it can work with other Ubuntu versions, but you might get non compatible versions
|
||||
# of PostgreSQL, Redis and maybe some other dependencies.
|
||||
#
|
||||
# This script is not idempotent and if it stops in the middle, you can't just run it again. You should either
|
||||
# understand what parts of it to exclude or just start over on a new VM (assuming you're using a VM).
|
||||
|
||||
set -eu
|
||||
|
||||
REDASH_BASE_PATH=/opt/redash
|
||||
|
||||
# Default branch/version to master if not specified in REDASH_BRANCH env var
|
||||
REDASH_BRANCH="${REDASH_BRANCH:-master}"
|
||||
|
||||
# Install latest version if not specified in REDASH_VERSION env var
|
||||
REDASH_VERSION=${REDASH_VERSION-0.12.0.b2449}
|
||||
LATEST_URL="https://github.com/getredash/redash/releases/download/v${REDASH_VERSION}/redash.${REDASH_VERSION}.tar.gz"
|
||||
REDASH_BRANCH="${REDASH_BRANCH:-master}" # Default branch/version to master if not specified in REDASH_BRANCH env var
|
||||
REDASH_VERSION=${REDASH_VERSION-1.0.1.b2833} # Install latest version if not specified in REDASH_VERSION env var
|
||||
LATEST_URL="https://s3.amazonaws.com/redash-releases/redash.${REDASH_VERSION}.tar.gz"
|
||||
VERSION_DIR="/opt/redash/redash.${REDASH_VERSION}"
|
||||
REDASH_TARBALL=/tmp/redash.tar.gz
|
||||
FILES_BASE_URL=https://raw.githubusercontent.com/getredash/redash/${REDASH_BRANCH}/setup/ubuntu/files
|
||||
|
||||
FILES_BASE_URL=https://raw.githubusercontent.com/getredash/redash/${REDASH_BRANCH}/setup/ubuntu/files/
|
||||
|
||||
# Verify running as root:
|
||||
if [ "$(id -u)" != "0" ]; then
|
||||
if [ $# -ne 0 ]; then
|
||||
echo "Failed running with sudo. Exiting." 1>&2
|
||||
exit 1
|
||||
verify_root() {
|
||||
# Verify running as root:
|
||||
if [ "$(id -u)" != "0" ]; then
|
||||
if [ $# -ne 0 ]; then
|
||||
echo "Failed running with sudo. Exiting." 1>&2
|
||||
exit 1
|
||||
fi
|
||||
echo "This script must be run as root. Trying to run with sudo."
|
||||
sudo bash "$0" --with-sudo
|
||||
exit 0
|
||||
fi
|
||||
echo "This script must be run as root. Trying to run with sudo."
|
||||
sudo bash "$0" --with-sudo
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Base packages
|
||||
apt-get -y update
|
||||
DEBIAN_FRONTEND=noninteractive apt-get -y -o Dpkg::Options::="--force-confdef" -o Dpkg::Options::="--force-confold" dist-upgrade
|
||||
apt-get install -y python-pip python-dev nginx curl build-essential pwgen
|
||||
# BigQuery dependencies:
|
||||
apt-get install -y libffi-dev libssl-dev
|
||||
# MySQL dependencies:
|
||||
apt-get install -y libmysqlclient-dev
|
||||
# Microsoft SQL Server dependencies:
|
||||
apt-get install -y freetds-dev
|
||||
# Hive dependencies:
|
||||
apt-get install -y libsasl2-dev
|
||||
#Saml dependency
|
||||
apt-get install -y xmlsec1
|
||||
|
||||
# Upgrade pip if host is Ubuntu 16.04
|
||||
if [[ $(lsb_release -d) = *Ubuntu* ]] && [[ $(lsb_release -rs) = *16.04* ]]; then
|
||||
pip install --upgrade pip
|
||||
fi
|
||||
pip install -U setuptools==23.1.0
|
||||
|
||||
# redash user
|
||||
# TODO: check user doesn't exist yet?
|
||||
adduser --system --no-create-home --disabled-login --gecos "" redash
|
||||
|
||||
# PostgreSQL
|
||||
pg_available=0
|
||||
psql --version || pg_available=$?
|
||||
if [ $pg_available -ne 0 ]; then
|
||||
wget $FILES_BASE_URL"postgres_apt.sh" -O /tmp/postgres_apt.sh
|
||||
bash /tmp/postgres_apt.sh
|
||||
apt-get update
|
||||
apt-get -y install postgresql-9.3 postgresql-server-dev-9.3
|
||||
fi
|
||||
|
||||
add_service() {
|
||||
service_name=$1
|
||||
service_command="/etc/init.d/$service_name"
|
||||
|
||||
echo "Adding service: $service_name (/etc/init.d/$service_name)."
|
||||
chmod +x "$service_command"
|
||||
|
||||
if command -v chkconfig >/dev/null 2>&1; then
|
||||
# we're chkconfig, so lets add to chkconfig and put in runlevel 345
|
||||
chkconfig --add "$service_name" && echo "Successfully added to chkconfig!"
|
||||
chkconfig --level 345 "$service_name" on && echo "Successfully added to runlevels 345!"
|
||||
elif command -v update-rc.d >/dev/null 2>&1; then
|
||||
#if we're not a chkconfig box assume we're able to use update-rc.d
|
||||
update-rc.d "$service_name" defaults && echo "Success!"
|
||||
else
|
||||
echo "No supported init tool found."
|
||||
fi
|
||||
|
||||
$service_command start
|
||||
}
|
||||
|
||||
# Redis
|
||||
redis_available=0
|
||||
redis-cli --version || redis_available=$?
|
||||
if [ $redis_available -ne 0 ]; then
|
||||
wget http://download.redis.io/releases/redis-2.8.17.tar.gz
|
||||
tar xzf redis-2.8.17.tar.gz
|
||||
rm redis-2.8.17.tar.gz
|
||||
(cd redis-2.8.17
|
||||
make
|
||||
make install
|
||||
create_redash_user() {
|
||||
adduser --system --no-create-home --disabled-login --gecos "" redash
|
||||
}
|
||||
|
||||
# Setup process init & configuration
|
||||
install_system_packages() {
|
||||
apt-get -y update
|
||||
# Base packages
|
||||
apt install -y python-pip python-dev nginx curl build-essential pwgen
|
||||
# Data sources dependencies:
|
||||
apt install -y libffi-dev libssl-dev libmysqlclient-dev libpq-dev freetds-dev libsasl2-dev
|
||||
# SAML dependency
|
||||
apt install -y xmlsec1
|
||||
# Storage servers
|
||||
apt install postgresql redis-server
|
||||
apt install supervisor
|
||||
}
|
||||
|
||||
REDIS_PORT=6379
|
||||
REDIS_CONFIG_FILE="/etc/redis/$REDIS_PORT.conf"
|
||||
REDIS_LOG_FILE="/var/log/redis_$REDIS_PORT.log"
|
||||
REDIS_DATA_DIR="/var/lib/redis/$REDIS_PORT"
|
||||
create_directories() {
|
||||
mkdir /opt/redash
|
||||
chown redash /opt/redash
|
||||
|
||||
# Default config file
|
||||
if [ ! -f "/opt/redash/.env" ]; then
|
||||
sudo -u redash wget "$FILES_BASE_URL/env" -O /opt/redash/.env
|
||||
fi
|
||||
|
||||
mkdir -p "$(dirname "$REDIS_CONFIG_FILE")" || die "Could not create redis config directory"
|
||||
mkdir -p "$(dirname "$REDIS_LOG_FILE")" || die "Could not create redis log dir"
|
||||
mkdir -p "$REDIS_DATA_DIR" || die "Could not create redis data directory"
|
||||
COOKIE_SECRET=$(pwgen -1s 32)
|
||||
echo "export REDASH_COOKIE_SECRET=$COOKIE_SECRET" > /opt/redash/.env
|
||||
}
|
||||
|
||||
wget -O /etc/init.d/redis_6379 $FILES_BASE_URL"redis_init"
|
||||
wget -O $REDIS_CONFIG_FILE $FILES_BASE_URL"redis.conf"
|
||||
|
||||
add_service "redis_$REDIS_PORT"
|
||||
)
|
||||
rm -rf redis-2.8.17
|
||||
fi
|
||||
|
||||
# Directories
|
||||
if [ ! -d "$REDASH_BASE_PATH" ]; then
|
||||
sudo mkdir /opt/redash
|
||||
sudo chown redash /opt/redash
|
||||
sudo -u redash mkdir /opt/redash/logs
|
||||
fi
|
||||
|
||||
# Default config file
|
||||
if [ ! -f "/opt/redash/.env" ]; then
|
||||
sudo -u redash wget $FILES_BASE_URL"env" -O /opt/redash/.env
|
||||
echo 'export REDASH_STATIC_ASSETS_PATH="../rd_ui/dist/"' >> /opt/redash/.env
|
||||
fi
|
||||
|
||||
if [ ! -d "$VERSION_DIR" ]; then
|
||||
extract_redash_sources() {
|
||||
sudo -u redash wget "$LATEST_URL" -O "$REDASH_TARBALL"
|
||||
sudo -u redash mkdir "$VERSION_DIR"
|
||||
sudo -u redash tar -C "$VERSION_DIR" -xvf "$REDASH_TARBALL"
|
||||
ln -nfs "$VERSION_DIR" /opt/redash/current
|
||||
ln -nfs /opt/redash/.env /opt/redash/current/.env
|
||||
}
|
||||
|
||||
cd /opt/redash/current
|
||||
|
||||
install_python_packages() {
|
||||
pip install --upgrade pip
|
||||
# pip install -U setuptools==23.1.0
|
||||
# TODO: venv?
|
||||
pip install -r requirements.txt
|
||||
fi
|
||||
# setproctitle is used by Celery for "pretty" process titles
|
||||
pip install setproctitle
|
||||
pip install -r /opt/redash/current/requirements.txt
|
||||
pip install -r /opt/redash/current/requirements_all_ds.txt
|
||||
}
|
||||
|
||||
# Create database / tables
|
||||
pg_user_exists=0
|
||||
sudo -u postgres psql postgres -tAc "SELECT 1 FROM pg_roles WHERE rolname='redash'" | grep -q 1 || pg_user_exists=$?
|
||||
if [ $pg_user_exists -ne 0 ]; then
|
||||
echo "Creating redash postgres user & database."
|
||||
create_database() {
|
||||
# Create user and database
|
||||
sudo -u postgres createuser redash --no-superuser --no-createdb --no-createrole
|
||||
sudo -u postgres createdb redash --owner=redash
|
||||
|
||||
cd /opt/redash/current
|
||||
sudo -u redash bin/run ./manage.py database create_tables
|
||||
fi
|
||||
}
|
||||
|
||||
# Create default admin user
|
||||
cd /opt/redash/current
|
||||
# TODO: make sure user created only once
|
||||
# TODO: generate temp password and print to screen
|
||||
sudo -u redash bin/run ./manage.py users create --admin --password admin "Admin" "admin"
|
||||
setup_supervisor() {
|
||||
wget -O /etc/supervisor/conf.d/redash.conf "$FILES_BASE_URL/supervisord.conf"
|
||||
service supervisor restart
|
||||
}
|
||||
|
||||
# Create Redash read only pg user & setup data source
|
||||
pg_user_exists=0
|
||||
sudo -u postgres psql postgres -tAc "SELECT 1 FROM pg_roles WHERE rolname='redash_reader'" | grep -q 1 || pg_user_exists=$?
|
||||
if [ $pg_user_exists -ne 0 ]; then
|
||||
echo "Creating redash reader postgres user."
|
||||
REDASH_READER_PASSWORD=$(pwgen -1)
|
||||
sudo -u postgres psql -c "CREATE ROLE redash_reader WITH PASSWORD '$REDASH_READER_PASSWORD' NOCREATEROLE NOCREATEDB NOSUPERUSER LOGIN"
|
||||
sudo -u redash psql -c "grant select(id,name,type) ON data_sources to redash_reader;" redash
|
||||
sudo -u redash psql -c "grant select(id,name) ON users to redash_reader;" redash
|
||||
sudo -u redash psql -c "grant select on alerts, alert_subscriptions, groups, events, queries, dashboards, widgets, visualizations, query_results to redash_reader;" redash
|
||||
setup_nginx() {
|
||||
rm /etc/nginx/sites-enabled/default
|
||||
wget -O /etc/nginx/sites-available/redash "$FILES_BASE_URL/nginx_redash_site"
|
||||
ln -nfs /etc/nginx/sites-available/redash /etc/nginx/sites-enabled/redash
|
||||
service nginx restart
|
||||
}
|
||||
|
||||
cd /opt/redash/current
|
||||
sudo -u redash bin/run ./manage.py ds new "Redash Metadata" --type "pg" --options "{\"user\": \"redash_reader\", \"password\": \"$REDASH_READER_PASSWORD\", \"host\": \"localhost\", \"dbname\": \"redash\"}"
|
||||
fi
|
||||
|
||||
# Pip requirements for all data source types
|
||||
cd /opt/redash/current
|
||||
pip install -r requirements_all_ds.txt
|
||||
|
||||
# Setup supervisord + sysv init startup script
|
||||
sudo -u redash mkdir -p /opt/redash/supervisord
|
||||
pip install supervisor==3.1.2 # TODO: move to requirements.txt
|
||||
|
||||
# Get supervisord startup script
|
||||
sudo -u redash wget -O /opt/redash/supervisord/supervisord.conf $FILES_BASE_URL"supervisord.conf"
|
||||
|
||||
wget -O /etc/init.d/redash_supervisord $FILES_BASE_URL"redash_supervisord_init"
|
||||
add_service "redash_supervisord"
|
||||
|
||||
# Nginx setup
|
||||
rm /etc/nginx/sites-enabled/default
|
||||
wget -O /etc/nginx/sites-available/redash $FILES_BASE_URL"nginx_redash_site"
|
||||
ln -nfs /etc/nginx/sites-available/redash /etc/nginx/sites-enabled/redash
|
||||
service nginx restart
|
||||
|
||||
# Hotfix: missing query snippets table:
|
||||
cd /opt/redash/current
|
||||
sudo -u redash bin/run python -c "from redash import models; models.QuerySnippet.create_table()"
|
||||
verify_root
|
||||
install_system_packages
|
||||
create_redash_user
|
||||
create_directories
|
||||
extract_redash_sources
|
||||
install_python_packages
|
||||
create_database
|
||||
setup_supervisor
|
||||
setup_nginx
|
||||
@@ -1,4 +1,3 @@
|
||||
export REDASH_LOG_LEVEL="INFO"
|
||||
export REDASH_REDIS_URL=redis://localhost:6379/0
|
||||
export REDASH_DATABASE_URL="postgresql://redash"
|
||||
export REDASH_COOKIE_SECRET=veryverysecret
|
||||
|
||||
@@ -1,24 +1,14 @@
|
||||
[supervisord]
|
||||
nodaemon=false
|
||||
logfile=/opt/redash/logs/supervisord.log
|
||||
pidfile=/opt/redash/supervisord/supervisord.pid
|
||||
directory=/opt/redash/current
|
||||
|
||||
[inet_http_server]
|
||||
port = 127.0.0.1:9001
|
||||
|
||||
[rpcinterface:supervisor]
|
||||
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
|
||||
|
||||
[program:redash_server]
|
||||
command=/opt/redash/current/bin/run gunicorn -b 127.0.0.1:5000 --name redash -w 4 --max-requests 1000 redash.wsgi:app
|
||||
directory=/opt/redash/current
|
||||
process_name=redash_server
|
||||
user=redash
|
||||
numprocs=1
|
||||
priority=999
|
||||
autostart=true
|
||||
autorestart=true
|
||||
stdout_logfile=/opt/redash/logs/api.log
|
||||
stderr_logfile=/opt/redash/logs/api_error.log
|
||||
|
||||
# There are two queue types here: one for ad-hoc queries, and one for the refresh of scheduled queries
|
||||
# (note that "scheduled_queries" appears only in the queue list of "redash_celery_scheduled").
|
||||
@@ -26,20 +16,18 @@ stderr_logfile=/opt/redash/logs/api_error.log
|
||||
|
||||
[program:redash_celery]
|
||||
command=/opt/redash/current/bin/run celery worker --app=redash.worker --beat -c2 -Qqueries,celery --maxtasksperchild=10 -Ofair
|
||||
directory=/opt/redash/current
|
||||
process_name=redash_celery
|
||||
user=redash
|
||||
numprocs=1
|
||||
priority=999
|
||||
autostart=true
|
||||
autorestart=true
|
||||
stdout_logfile=/opt/redash/logs/celery.log
|
||||
stderr_logfile=/opt/redash/logs/celery_error.log
|
||||
|
||||
[program:redash_celery_scheduled]
|
||||
command=/opt/redash/current/bin/run celery worker --app=redash.worker -c2 -Qscheduled_queries --maxtasksperchild=10 -Ofair
|
||||
directory=/opt/redash/current
|
||||
process_name=redash_celery_scheduled
|
||||
user=redash
|
||||
numprocs=1
|
||||
priority=999
|
||||
autostart=true
|
||||
autorestart=true
|
||||
stdout_logfile=/opt/redash/logs/celery.log
|
||||
stderr_logfile=/opt/redash/logs/celery_error.log
|
||||
|
||||
Reference in New Issue
Block a user