autopilot

README

autopilot

cf plugin for hands-off, zero downtime application deploys

notice

This plugin is now archived and will not recieve any further changes. I haven't had time to properly maintain it for a long time and I'd rather archive it than have it limp on under false pretenses.

Thank you for your contributions over the past few years.

This plugin is still used in the Concourse cf-resource and will be merged into that if changes need to be made in the future.

installation

Download the latest version from the releases page and make it executable.

$ cf install-plugin path/to/downloaded/binary

usage

$ cf zero-downtime-push application-to-replace \
    -f path/to/new_manifest.yml \
    -p path/to/new/path

warning

Your application manifest must be up to date or the new application that is created will not resemble the application that it is replacing.

You can check your application doesn't have unexpected environment variables or services which are missing from the application manifest with Antifreeze.

method

Autopilot takes a different approach to other zero-downtime plugins. It doesn't perform any complex route re-mappings instead it leans on the manifest feature of the Cloud Foundry CLI. The method also has the advantage of treating a manifest as the source of truth and will converge the state of the system towards that. This makes the plugin ideal for continuous delivery environments.

1. The old application is renamed to <APP-NAME>-venerable. It keeps its old route mappings and this change is invisible to users.

2. The new application is pushed to <APP-NAME> (assuming that the name has not been changed in the manifest). It binds to the same routes as the old application (due to them being defined in the manifest) and traffic begins to be load-balanced between the two applications.

3. The old application is deleted along with its route mappings. All traffic now goes to the new application.