Debian Installation¶

By default, AutoPlanner is only packaged as a standard Python project, downloadable from Pypi. However, you can create pure Debian packages with DjangoFloor.

The source code provides one Bash scripts, deb-debian-8_ubuntu-14.10-150.10.sh.

This script is designed to run on basic installation and are split in five steps:

update system and install missing packages,

create a virtualenv and install all dependencies,

package all dependencies,

package AutoPlanner,

install all packages and AutoPlanner, prepare a simple configuration to test.

If everything is ok, you can copy all the .deb packages to your private mirror or to the destination server. By default, AutoPlanner is installed with Apache 2.4 and systemd. You can switch to Nginx or supervisor by tweaking the right stdeb-XXX.cfg file.

Configuration¶

Default configuration file is /etc/autoplanner/settings.ini. If you need more complex settings, you can override default values (given in djangofloor.defaults and autoplanner.defaults) by creating a file named /etc/autoplanner/settings.py. After any change in the database configuration or any upgrade, you must migrate the database to create the required tables.

sudo -u autoplanner autoplanner-manage migrate

After installation and configuration, do not forget to create a superuser:

sudo -u autoplanner autoplanner-manage createsuperuser

Launch the service¶

The service can be stopped or started via the service command. By default, AutoPlanner is not started.

sudo service autoplanner-gunicorn start
sudo service autoplanner-celery start

If you want AutoPlanner to be started at startup, you have to enable it in systemd:

systemctl enable autoplanner-gunicorn.service
systemctl enable autoplanner-celery.service

Backup¶

A complete AutoPlanner installation is made a different kinds of files:

the code of your application and its dependencies (you should not have to backup them),

static files (as they are provided by the code, you can lost them),

configuration files (you can easily recreate it, or you must backup it),

database content (you must backup it),

user-created files (you must also backup them).

Many backup strategies exist, and you must choose one that fits your needs. We can only propose general-purpose strategies.

We use logrotate to backup the database, with a new file each day.

sudo mkdir -p /var/backups/autoplanner
sudo chown -r autoplanner: /var/backups/autoplanner
sudo -u autoplanner -i
cat << EOF > /etc/autoplanner/backup_db.conf
/var/backups/autoplanner/backup_db.sql.gz {
  daily
  rotate 20
  nocompress
  missingok
  create 640 autoplanner autoplanner
  postrotate
  myproject-manage dumpdb | gzip > /var/backups/autoplanner/backup_db.sql.gz
  endscript
}
EOF
touch /var/backups/autoplanner/backup_db.sql.gz
crontab -e
MAILTO=admin@autoplanner.example.org
0 1 * * * /usr/local/bin/autoplanner-manage clearsessions
0 2 * * * logrotate -f /etc/autoplanner/backup_db.conf

Backup of the user-created files can be done with rsync, with a full backup each month: If you have a lot of files to backup, beware of the available disk place!

sudo mkdir -p /var/backups/autoplanner/media
sudo chown -r autoplanner: /var/backups/autoplanner
cat << EOF > /etc/autoplanner/backup_media.conf
/var/backups/autoplanner/backup_media.tar.gz {
  monthly
  rotate 6
  nocompress
  missingok
  create 640 autoplanner autoplanner
  postrotate
  tar -C /var/backups/autoplanner/media/ -czf /var/backups/autoplanner/backup_media.tar.gz .
  endscript
}
EOF
touch /var/backups/autoplanner/backup_media.tar.gz
crontab -e
MAILTO=admin@autoplanner.example.org
0 3 * * * rsync -arltDE /var/autoplanner/data/media/ /var/backups/autoplanner/media/
0 5 0 * * logrotate -f /etc/autoplanner/backup_media.conf

Restoring a backup¶

cat /var/backups/autoplanner/backup_db.sql.gz | gunzip | /usr/local/bin/autoplanner-manage dbshell
tar -C /var/autoplanner/data/media/ -xf /var/backups/autoplanner/backup_media.tar.gz

Monitoring¶

Nagios or Shinken¶

You can use Nagios checks to monitor several points:

connection to the application server (gunicorn or uwsgi):

connection to the database servers (PostgreSQL and Redis),

connection to the reverse-proxy server (apache or nginx),

the validity of the SSL certificate (can be combined with the previous check),

creation date of the last backup (database and files),

living processes for gunicorn, celery, redis, postgresql, apache,

standard checks for RAM, disk, swap…

Here is a sample NRPE configuration file:

cat << EOF | sudo tee /etc/nagios/nrpe.d/autoplanner.cfg
command[autoplanner_wsgi]=/usr/lib/nagios/plugins/check_http -H 127.0.0.1 -p 9000
command[autoplanner_redis]=/usr/lib/nagios/plugins/check_tcp -H localhost -p 6379
command[autoplanner_database]=/usr/lib/nagios/plugins/check_tcp -H localhost -p 5432
command[autoplanner_reverse_proxy]=/usr/lib/nagios/plugins/check_http -H autoplanner.example.org -p 80 -e 401
command[autoplanner_backup_db]=/usr/lib/nagios/plugins/check_file_age -w 172800 -c 432000 /var/backups/autoplanner/backup_db.sql.gz
command[autoplanner_backup_media]=/usr/lib/nagios/plugins/check_file_age -w 3024000 -c 6048000 /var/backups/autoplanner/backup_media.sql.gz
command[autoplanner_gunicorn]=/usr/lib/nagios/plugins/check_procs -C python -a '/usr/local/bin/autoplanner-gunicorn'
command[autoplanner_celery]=/usr/lib/nagios/plugins/check_procs -C python -a '/usr/local/bin/autoplanner-celery worker'
EOF

Sentry¶

For using Sentry to log errors, you must add raven.contrib.django.raven_compat to the installed apps.

[global]
extra_apps = raven.contrib.django.raven_compat
[sentry]
dsn_url = https://[key]:[secret]@app.getsentry.com/[project]

Of course, the Sentry client (Raven) must be separately installed, before testing the installation:

sudo -u autoplanner -i
autoplanner-manage raven test