top
(README.md)
# Blue/Green deployer plugin for CF

## Introduction

**cf-blue-green-deploy** is a plugin for the CF command line tool that
automates a few steps involved in zero-downtime deploys.

## Overview

The plugin takes care of the following steps packaged into one command:

* Pushes the current version of the app with a new name
* Optionally runs smoke tests against the newly pushed app to verify the deployment
  * If smoke tests fail, newly pushed app gets marked as failed and left around for investigation
  * If smoke tests pass, remaps routes from the currently live app to the newly deployed app
* Cleans up versions of the app no longer in use

## How to use

* Get the plugin from our repository
```
cf add-plugin-repo garage https://garage-cf-plugins.eu-gb.mybluemix.net/
cf install-plugin blue-green-deploy -r garage
```

* Deploy your app
```
cd your_app_root
cf blue-green-deploy app_name
```

* Deploy with optional smoke tests
```
cf blue-green-deploy app_name --smoke-test <path to test script>
```

The only argument passed to the smoke test script is the FQDN of the newly
pushed app. If the smoke test returns with a non-zero exit code the deploy
process will stop and fail, the current live app will not be affected.

If the test script exits with a zero exit code, the plugin will remap all
routes from the current live app to the new app. The plugin supports routes
under custom domains.

## How to build

```
script/build
```

This will download dependencies, run the tests, and build binaries in the
_artefacts_ folder.

Imports 7 package(s)

  1. github.com/cloudfoundry/cli/cf/configuration/config_helpers
  2. github.com/cloudfoundry/cli/cf/manifest
  3. github.com/cloudfoundry/cli/plugin
  4. github.com/cloudfoundry/cli/cf/models
  5. github.com/nicksnyder/go-i18n/i18n
  6. github.com/cloudfoundry/cli/cf/i18n
  7. github.com/cloudfoundry/cli/cf/configuration/core_config

Test imports 6 package(s)

  1. github.com/cloudfoundry/cli/generic
  2. github.com/onsi/gomega
  3. github.com/cloudfoundry/cli/plugin/fakes
  4. github.com/cloudfoundry-incubator/candiedyaml
  5. github.com/bluemixgaragelondon/cf-blue-green-deploy
  6. github.com/onsi/ginkgo