Skip to main content

Dead simple LAMP-stack deployments for Python-powered web applications

Project description

https://badge.fury.io/py/underwear.png https://travis-ci.org/makaimc/underwear.png?branch=master https://pypip.in/d/underwear/badge.png

Underwear is a library for easily deploying any Python-powered web application to one or more Linux servers.

What Problem Does Underwear Solve?

Despite the advent of configuration management tools such as Puppet, Chef, Ansible, and Salt, it remains difficult to deploy a web application because you have to first learn one of those tools and then write scripts in the tool’s domain-specific language.

Underwear makes deploying to a traditional Linux server stack as easy as deploying to Heroku by providing a pre-packaged, easily configurable library. Deployments can be executed simply by installing Underwear with pip, specifying the IP addresses of the server(s) to deploy to, then running a couple of commands.

Quick Start

After these ten steps your app should be completely configured, secured, and deployed to remote servers.

These instructions will be simplied in future releases as the library is further developed.

  1. Install Underwear to your virtualenv:

    pip install underwear
    
  2. Add ‘underwear’ to INSTALLED_APPS in your Django project. Underwear currently only supports Django (Flask and Bottle will be added in the 0.5 release).

  3. Create a deploy directory under your Django project:

    mkdir deploy; cd deploy
    
  4. Download the Fabric file for uploading SSH keys, YAML configuration template, and hosts file to your project under the deploy/ directory:

    wget https://raw.github.com/makaimc/underwear/master/underwear/deploy/fabfile.py
    wget https://raw.github.com/makaimc/underwear/master/underwear/deploy/underwear.yml
    wget https://raw.github.com/makaimc/underwear/master/underwear/deploy/hosts
    
  5. Fill in blank variables fields in fabfile.py.

  6. Execute the Fabric script (the script will prompt you for the non-root password):

    fab bootstrap_ansible
    
  7. Fill in blank fields and modify desired settings in the underwear.yml file so that Underwear knows where to install your web application.

  8. Fill in the hosts file with your servers’ IP addresses. For example, the file may look like the following:

    [webservers]
    192.168.1.1
    
    [dbservers]
    192.168.1.2
    
  1. Deploy your application:

    python manage.py deploy
    
  2. Underwear will output each step in the deployment process to standard output as it happens.

  3. Access your application from the domain name you provided in the underwear.yml file.

License and Documentation

Underwear is free software under the MIT license.

Additional Underwear documentation can be found on Read the Docs.

Features

  • Automated deployments to a web & database server
  • Configurable via a simple YAML template

History

0.4.0 (2013-12-26)

  • Release now allows for 2 server web app deployments (one web server and one database server).
  • Fixes issues with Supervisor template and Django environment variables.
  • Includes templates required to tell the library where to deploy the application.

0.3.0 (2013-12-24)

  • First release on PyPI.

0.2.0 (2013-12-16)

  • Added initial working Ansible scripts for deployment.

0.1.0 (2013-12-16)

  • Initial codebase with Python package

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for underwear, version 0.4.2
Filename, size File type Python version Upload date Hashes
Filename, size underwear-0.4.2.tar.gz (21.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page