from __future__ import with_statement # needed for python 2.5
from fabric.api import *
+from fabric.contrib import files
+from fabric.context_managers import path
import os
+
+# ==========
+# = Config =
+# ==========
# Globals
env.project_name = 'wolnelektury'
+env.use_south = True
-
-# ===========
-# = Servers =
-# ===========
+# Servers
def staging():
"""Use staging server"""
- env.hosts = ['zuber@stigma.nowoczesnapolska.org.pl:2222']
- env.path = '/var/lektury'
-
+ env.hosts = ['stigma.nowoczesnapolska.org.pl:2222']
+ env.user = 'platforma'
+ env.path = '/var/services/wolnelektury'
+ env.python = '/usr/bin/python'
+ env.virtualenv = '/usr/bin/virtualenv'
+ env.pip = '/usr/bin/pip'
+
def production():
"""Use production server"""
- env.hosts = ['fundacja@wolnelektury:22123']
- env.path = '/opt/lektury'
-
+ env.hosts = ['wolnelektury.pl']
+ env.user = 'lektury'
+ env.path = '/srv/wolnelektury.pl'
+ env.python = '/usr/bin/python'
+ env.virtualenv = '/usr/bin/virtualenv'
+ env.pip = 've/bin/pip'
+ env.restart_webserver = restart_gunicorn_debian
# =========
# = Tasks =
# =========
def test():
"Run the test suite and bail out if it fails"
- require('project_dir', provided_by=[staging, production])
- result = local('cd %(path)s; python manage.py test' % env)
+ require('hosts', 'path', provided_by=[staging, production])
+ result = run('cd %(path)s/%(project_name)s; %(python)s manage.py test' % env)
+
+def setup():
+ """
+ Setup a fresh virtualenv as well as a few useful directories, then run
+ a full deployment. virtualenv and pip should be already installed.
+ """
+ require('hosts', 'path', provided_by=[staging, production])
+
+ run('mkdir -p %(path)s; cd %(path)s; %(virtualenv)s .;' % env, pty=True)
+ run('cd %(path)s; mkdir releases; mkdir shared; mkdir packages;' % env, pty=True)
+ run('cd %(path)s/releases; ln -s . current; ln -s . previous' % env, pty=True)
+ deploy()
def deploy():
"""
- Deploy the latest version of the site to the servers,
- install any required third party modules,
+ Deploy the latest version of the site to the servers,
+ install any required third party modules,
install the virtual host and then restart the webserver
"""
- require('hosts', provided_by=[staging, production])
- require('path')
-
+ require('hosts', 'path', provided_by=[staging, production])
+
import time
env.release = time.strftime('%Y-%m-%dT%H%M')
-
+
upload_tar_from_git()
+ upload_wsgi_script()
+ upload_vhost_sample()
+ upload_celery_conf()
install_requirements()
+ copy_localsettings()
symlink_current_release()
migrate()
+ collectstatic()
restart_webserver()
+ restart_celery()
def deploy_version(version):
"Specify a specific version to be made live"
- require('hosts', provided_by=[localhost,webserver])
- require('path')
+ require('hosts', 'path', provided_by=[localhost,webserver])
env.version = version
with cd(env.path):
run('rm releases/previous; mv releases/current releases/previous;', pty=True)
run('ln -s %(version)s releases/current' % env, pty=True)
restart_webserver()
+ restart_celery()
def rollback():
"""
run('mv releases/previous releases/current;', pty=True)
run('mv releases/_previous releases/previous;', pty=True)
restart_webserver()
-
-# def setup():
-# """
-# Setup a fresh virtualenv as well as a few useful directories, then run
-# a full deployment
-# """
-# require('hosts', provided_by=[staging, production])
-# require('path')
-# sudo('aptitude install -y python-setuptools')
-# sudo('easy_install pip')
-# sudo('pip install virtualenv')
-# sudo('aptitude install -y apache2-threaded')
-# sudo('aptitude install -y libapache2-mod-wsgi') # beware, outdated on hardy!
-# # we want to get rid of the default apache config
-# sudo('cd /etc/apache2/sites-available/; a2dissite default;', pty=True)
-# sudo('mkdir -p %(path)s; chown %(user)s:%(user)s %(path)s;' % env, pty=True)
-# run('ln -s %(path)s www;' % env, pty=True) # symlink web dir in home
-# with cd(env.path):
-# run('virtualenv .;' % env, pty=True)
-# run('mkdir logs; chmod a+w logs; mkdir releases; mkdir shared; mkdir packages;' % env, pty=True)
-# if env.use_photologue: run('mkdir photologue');
-# run('cd releases; ln -s . current; ln -s . previous;', pty=True)
-# deploy()
+ restart_celery()
# =====================================================================
# = Helpers. These are called by other functions rather than directly =
# =====================================================================
def upload_tar_from_git():
- "Create an archive from the current Git master branch and upload it"
+ "Create an archive from the current Git branch and upload it"
+ print '>>> upload tar from git'
require('release', provided_by=[deploy])
- local('git archive --format=tar master | gzip > %(release)s.tar.gz' % env)
+ local('git-archive-all.sh --format tar %(release)s.tar' % env)
+ local('gzip %(release)s.tar' % env)
run('mkdir -p %(path)s/releases/%(release)s' % env, pty=True)
run('mkdir -p %(path)s/packages' % env, pty=True)
put('%(release)s.tar.gz' % env, '%(path)s/packages/' % env)
run('cd %(path)s/releases/%(release)s && tar zxf ../../packages/%(release)s.tar.gz' % env, pty=True)
local('rm %(release)s.tar.gz' % env)
+def upload_vhost_sample():
+ "Create and upload Apache virtual host configuration sample"
+ print ">>> upload vhost sample"
+ files.upload_template('%(project_name)s.vhost.template' % env, '%(path)s/%(project_name)s.vhost.sample' % env, context=env)
+
+def upload_wsgi_script():
+ "Create and upload a wsgi script sample"
+ print ">>> upload wsgi script sample"
+ files.upload_template('%(project_name)s.wsgi.template' % env, '%(path)s/%(project_name)s.wsgi' % env, context=env)
+ run('chmod ug+x %(path)s/%(project_name)s.wsgi' % env)
+
+def upload_celery_conf():
+ "Create and upload a Celery conf for supervisord"
+ print ">>> upload celery supervisord conf"
+ files.upload_template('%(project_name)s-celery.conf.template' % env, '%(path)s/%(project_name)s-celery.conf' % env, context=env)
+ run('chmod ug+x %(path)s/%(project_name)s-celery.conf' % env)
+
def install_requirements():
"Install the required packages from the requirements file using pip"
+ print '>>> install requirements'
require('release', provided_by=[deploy])
- pip_options = file('pip-options.txt').read().strip()
- with cd('%(path)s/releases/%(release)s' % env):
- run('virtualenv --no-site-packages .')
- run('pip install -E . %s -r requirements.txt' % pip_options)
+ run('cd %(path)s; %(pip)s install -E ve -r %(path)s/releases/%(release)s/requirements.txt' % env, pty=True)
+
+def copy_localsettings():
+ "Copy localsettings.py from root directory to release directory (if this file exists)"
+ print ">>> copy localsettings"
+ require('release', provided_by=[deploy])
+ require('path', provided_by=[staging, production])
+
+ with settings(warn_only=True):
+ run('cp %(path)s/localsettings.py %(path)s/releases/%(release)s/%(project_name)s' % env)
def symlink_current_release():
"Symlink our current release"
+ print '>>> symlink current release'
require('release', provided_by=[deploy])
require('path', provided_by=[staging, production])
with cd(env.path):
- with settings(
- hide('warnings', 'running', 'stdout', 'stderr'),
- warn_only=True
- ):
- run('rm releases/previous; mv releases/current releases/previous;')
-
+ run('rm releases/previous; mv releases/current releases/previous')
run('ln -s %(release)s releases/current' % env)
def migrate():
"Update the database"
+ print '>>> migrate'
require('project_name', provided_by=[staging, production])
with cd('%(path)s/releases/current/%(project_name)s' % env):
- run('../bin/python manage.py syncdb --noinput' % env, pty=True)
- run('../bin/python manage.py migrate' % env, pty=True)
+ run('../../../ve/bin/python manage.py syncdb --noinput' % env, pty=True)
+ if env.use_south:
+ run('../../../ve/bin/python manage.py migrate' % env, pty=True)
+
+def collectstatic():
+ """Collect static files"""
+ print '>>> collectstatic'
+ require('project_name', provided_by=[staging, production])
+ with cd('%(path)s/releases/current/%(project_name)s' % env):
+ run('../../../ve/bin/python manage.py collectstatic --noinput' % env, pty=True)
+
+def restart_gunicorn_debian():
+ """Restarts gunicorn server using debian script."""
+ print '>>> restart gunicorn'
+ require('project_name', provided_by=[staging, production])
+ with path('/sbin'):
+ sudo('gunicorn-debian restart %(project_name)s' % env, shell=False)
def restart_webserver():
- "Restart the web server"
- run('touch %(path)s/releases/current/%(project_name)s/%(project_name)s.wsgi' % env)
-
-# def install_site():
-# "Add the virtualhost file to apache"
-# require('release', provided_by=[deploy, setup])
-# #sudo('cd %(path)s/releases/%(release)s; cp %(project_name)s%(virtualhost_path)s%(project_name)s /etc/apache2/sites-available/' % env)
-# sudo('cd %(path)s/releases/%(release)s; cp vhost.conf /etc/apache2/sites-available/%(project_name)s' % env)
-# sudo('cd /etc/apache2/sites-available/; a2ensite %(project_name)s' % env, pty=True)
+ """Restarts the web server."""
+ if hasattr(env, 'restart_webserver'):
+ env.restart_webserver()
+ else:
+ require('project_name', provided_by=[staging, production])
+ print '>>> restart webserver'
+ run('touch %(path)s/%(project_name)s.wsgi' % env)
+
+def restart_celery():
+ """Restarts the Celery task queue manager."""
+ print '>>> restart Celery'
+ require('project_name', provided_by=[staging, production])
+ sudo('supervisorctl restart celery.%(project_name)s:' % env, shell=False)