Skip to content
Switch branches/tags
This branch is 901 commits behind cloudfoundry-attic:master.
Fetch upstream

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time


This is a BOSH release for consul.


  1. Deploying
  2. Running Tests


In order to deploy consul-release you must follow the standard steps for deploying software with BOSH.

We assume you have already deployed and targeted a BOSH director. For more instructions on how to do that please see the BOSH documentation.

1. Uploading a stemcell

Find the "BOSH Lite Warden" stemcell you wish to use. provides a resource to find and download stemcells. Then run bosh upload release STEMCELL_URL_OR_PATH_TO_DOWNLOADED_STEMCELL.

2. Creating a release

From within the consul-release director run bosh create release --force to create a development release.

3. Uploading a release

Once you've created a development release run bosh upload release to upload your development release to the director.

4. Generating a deployment manifest

We provide a set of scripts and templates to generate a simple deployment manifest. You should use these as a starting point for creating your own manifest, but they should not be considered comprehensive or production-ready.

In order to automatically generate a manifest you must have installed spiff. Once installed, manifests can be generated using ./scripts/generate_consul_deployment_manifest [STUB LIST] with the provided stubs:

  1. director_uuid_stub

    The director_uuid_stub provides the uuid for the currently targeted BOSH director.

    director_uuid: DIRECTOR_UUID
  2. instance_count_stub

    The instance count stub provides the ability to overwrite the number of instances of consul to deploy. The minimal deployment of consul is shown below:

        instances: 1
        instances: 0

    NOTE: at no time should you deploy only 2 instances of consul.

  3. persistent_disk_stub

    The persistent disk stub allows you to override the size of the persistent disk used in each instance of the consul job. If you wish to use the default settings provide a stub with only an empty hash:

    persistent_disk_overrides: {}

    To override disk sizes the format is as follows

      consul_z1: 1234
      consul_z2: 1234	
  4. iaas_settings

    The IaaS settings stub contains IaaS-specific settings, including networks, cloud properties, and compilation properties. Please see the BOSH documentation for setting up networks and subnets on your IaaS of choice. We currently allow for three network configurations on your IaaS: consul1, consul2, and compilation. You must also specify the stemcell to deploy against as well as the version (or latest).

We provide default stubs for a BOSH-Lite deployment. Specifically:


  1. If you wish to override the name of the release and the deployment (default: consul) you can provide a release_name_stub with the following format:

      release_name: NAME
      deployment_name: NAME

Output the result of the above command to a file: ./scripts/generate_consul_deployment_manifest [STUB LIST] > OUTPUT_MANIFEST_PATH.

5. Deploy.

Run bosh -d OUTPUT_MANIFEST_PATH deploy.

Running Tests

We have written a test suite that exercises spinning up single/multiple consul server instances, scaling them, and perform rolling deploys. If you have already installed Go, you can run CONSATS_CONFIG=[config_file.json] ./scripts/test_default. ./scripts/test_default calls ./scripts/test, which installs all dependancies and appends the release directory to the gopath. ./scripts/test_default passes all test suites to ./scripts/test. If you wish to run a specific test suite you can call ./scripts/test directly like so: CONSATS_CONFIG=[config_file.json] ./scripts/test src/acceptance_tests/deploy/.

The CONSATS_CONFIG environment variable points to a configuration file which specifies the endpoint of the BOSH director and the path to your iaas_settings stub. An example config json for BOSH-lite would look like:

cat > integration_config.json << EOF
  "bosh_target": "",
  "iaas_settings_consul_stub_path": "./src/acceptance-tests/manifest-generation/bosh-lite-stubs/iaas-settings-consul.yml",
  "iaas_settings_turbulence_stub_path": "./src/acceptance-tests/manifest-generation/bosh-lite-stubs/iaas-settings-turbulence.yml",
  "turbulence_properties_stub_path": "./src/acceptance-tests/manifest-generation/bosh-lite-stubs/turbulence/property-overrides.yml",
  "cpi_release_url": "",
  "cpi_release_name": "bosh-warden-cpi",
  "bind_address": "",
  "turbulence_release_url": ""
export CONSATS_CONFIG=$PWD/integration_config.json

The full set of config parameters is explained below:

  • bosh_target (required) Public BOSH IP address that will be used to host test environment.
  • bind_address (required) IP that the local consul node will use to connect to the cluster. See note below for info about bosh-lite
  • iaas_settings_consul_stub_path (required) Stub containing iaas settings for the consul deployment.
  • iaas_settings_turbulence_stub_path (required for turbulence tests) Stub containing iaas setting for the turbulence deployment.
  • turbulence_properties_stub_path (required for turbulence tests) Stub containing property overrides for the turbulence deployment.
  • cpi_release_url (required for turbulence tests) CPI for the current BOSH director being used to deploy tests with.
  • cpi_release_name (required for turbulence tests) Name for the cpi_release_url parameter
  • bosh_operation_timeout (optional) Time to wait for BOSH commands to exit before erroring out. (default time is 5 min if not specified)
  • turbulence_operation_timeout (optional) Time to wait for Turbulence operations to succeed before erroring out. (default time is 5 min if not specified)

Note: When running against bosh-lite the IP specified for bind_address must be in the subnet. This is due how the consul agent and servers communicate and determine whether a source is trusted. This differs from most bosh-lite networking where the subnet is used.

Note: You must ensure that the stemcells specified in iaas_settings_consul and iaas_settings_turbulence_stub_path are already uploaded to the director at bosh_target.

Note: The ruby bundler gem is used to install the correct version of the bosh_cli, as well as to decrease the bosh startup time.


No description, website, or topics provided.



No packages published