Push button to deploy.
One of the cool things about working at Hyves
is the regular hackathons. The Hyves hackathons are two days where employees can work on projects entirely of their own devising. Typically this results in small teams forming around an idea and trying to produce a working prototype in two days. These events are fun, and a lot can be learned and achieved in the time.
At the last hackathon, our team (Alexander
) decided to produce a piece of hardware rather than software. The concept started off simply; we wanted a big, red, fifties-looking button we could use to deploy the entire Hyves system. It grew from there.
With a little brainstorming prior to the hackathon, we came up with a more complete concept. The vision was now to produce a Deployatron. This would have the following features:
- Integrate with our existing, Jenkins based, build and deploy process
- Able to do the two major deploy workflows (deploying the staging and live versions of the site)
- Look retro-cool
So we got hold of an Arduino
, bought the best looking components we could find and set to work.
The first thing we did was get together and do a bit of design. We started off with some system design. We decided that we needed four things: integration with Jenkins, a piece of software running on the Deploymeister's*
computer to act as a middle-man, some software on the Arduino and the actual hardware. We decided to keep the Arduino firmware as minimal as possible, and focus the intelligence in the middle layer.
We had several tasks to complete, so we defined some minimal APIs between them and set to work. Matias soon had the Jenkins integration under control using the excellent jenkinsapi
library. Alexander set to work on the middleware using Python and Twisted to create an event driven system to talk to the Arduino's serial port. Chris started plugging LEDs into the Arduino and remembering how to solder. By the end of day one we had a working prototype set up, talking via the middleware to the Jenkins server and responding with its flashing LEDs.
The next day we got onto polishing the system. Matias and Rodrigo started work on the case, drilling, cutting and the like, Alexander started putting the finishing touches to the Arduino firmware and Chris started the soldering. With help from various people (William, Sofie) by 4:30pm we had a 90% working system with the following features:
- Ability to switch between two work-flows
- Flashing red/green LEDs to indicate build and deploy process
- Button to build the branch
- Button that lights up red when it's possible to deploy (when there was a good, recent, build)
- Two key switches to “arm” the deployatron
All this in a nice looking box, with event-driven middleware communicating between it and Jenkins.
The Deployatron has been used by the Deploymeister to build and deploy the site. There are a few bugs to work out, but its generally functioning fine. In addition, there are a bunch of possible things we might want to do with this in the future:
- Integrate some other features of the build process – rollback, for instance
- Make the Deployatron network based, so the software doesn't need to be installed on the Deploymeister's computer
- Put the middleware directly into a Jenkins plugin, possibly with the ability to just specify which pins which switches and which LEDs are on and what processes they should respond to/start
- Add indicators for other things – state of the unit tests, for instance
The Deploymeister is the developer responsible for building and deploying the site in a given week. This role is shared by all developers in a rotating system.