Fabric - a tool for writing deployment scripts
Deploying a new version of server-side software is not trivial. Here are a few things that I need to do while deploying a new version of App Translator (written in Go) from my Mac dev computer to a production server:
- compile the source .go files to an executable, on the server
- which means I have to copy the source files from my dev machine to a server
- ideally run tests to make sure I didn’t introduce regressions
- shut-down the currently running version
- start the new version
Doing this by hand every time would be slow and tedious. Iteration speed matters.
The solution is automation, but that’s tricky since it involves operations both on the local machine (like prepare the source for upload) and remote server (like compiling the sources on the server).
Luckily, I’m not the first person to encounter this problem which is why Fabric exists.
Fabric is both a tool written in Python and a library of Python code for writing automatic deployment scripts.
On my Mac I’ve installed Fabric with
sudo easy_install pip; sudo pip install fabric
The basics of Fabric are:
write the deploy script called
each function in
fabfile.pycan be thought of as an action
to execute a given action in
As an example, I only have one action named
deploy so to deploy a new version, I run
Remote execution is via ssh
The code is deployed to Unix-based servers via ssh, so for convenience you can set up password-less (public key based) login for the account you use for deployment.
The code running locally runs under your account.
You need to specify which account on the server to use.
You can run an action against a single server or multiple servers at once.
Fabric can run arbitrary code both locally and on the server, so the possibilities are, literally, limitless.
My App Translator deploy script is an example of a fairly complex script.
What you can learn from it:
how to specify server and user account for deployment (
- how to create a zip file locally, upload it to the server and unzip it there
- how to compile sources both locally (no point uploading if the code doesn’t compile) and on the server (to build the final executable)
- how to run tests both locally and remotely
- how to safely deploy a new version while preserving a way to easily revert to previous version in case of problems
- how to do the the first-time setup (in case of deploying to a new server)
I’ve used Fabric in 3 of my projects and it does what it supposed to do well.
If I was writing new project from scratch, I would automate essentially everything related to setting up a new instance (it doesn’t make sense to do it for existing projects since they’re already set up).