cf-deployment

About

cf-deployment is a collection of tools to facilitate deploying Cloud Foundry with BOSH.

Tools

Prepare Deployments

Usage:
./tools/prepare_deployments <aws> PATH_TO_CONFIG_FILE

Arguments:

• aws: The infrastructure for which to generate the manifests. Currently only aws is supported.
• PATH_TO_CONFIG_FILE: Path to the config file.

Description:
Generates a Cloud Foundry deployment manifest called cf.yml placed in either a specified or default directory (see references to deployments-dir below). The config file you pass to ./tools/prepare_deployments must be a JSON file specifying some or all of the following properties:

• cf: (string, optional)
  • a path to a directory of cf-release; when using a path to a directory, make sure all submodules, including recursive submodules, have been initialized
  • the string "integration-latest"
• etcd: (string, optional)
  • a path to a directory of etcd-release
  • a path to a release tarball
  • the string "director-latest"
  • the string "integration-latest"
• consul: (string, optional)
  • a path to a directory of consul-release
  • a path to a release tarball
  • the string "director-latest"
  • the string "integration-latest"
• stemcell: (string, optional)
  • a path to a stemcell tarball
  • the string "director-latest"
  • the string "integration-latest"
• stubs: (array of strings, required)
  • a non-empty list of paths to stub files
• deployments-dir: (string, optional)
  • a path to a directory where manifests will be written

For example:

{
  "cf": "/Users/pivotal/workspace/cf-release",
  "etcd": "integration-latest",
  "consul": "/Users/pivotal/Downloads/consul-release-v23.tgz",
  "stemcell": "/Users/pivotal/Downloads/light-bosh-stemcell-3058-aws-xen-hvm-ubuntu-trusty-go_agent.tgz",
  "stubs": ["/Users/pivotal/workspace/deployment1/properties-stub.yml", "/Users/pivotal/workspace/deployment1/instances-stub.yml"],
  "deployments-dir": "/Users/pivotal/workspace/deployment1/artifacts"
}

NOTE: The manifest templates each IaaS require certain properties to be set in a stub provided by the user. To see instructions for the current recommendations on how to create this stub for the various IaaSes, check out the following links:

• AWS
• vSphere (not currently supported by this tool)
• vCloud (not currently supported by this tool)
• OpenStack (not currently supported by this tool)
• BOSH-Lite (not currently supported by this tool)

Defaults:
For each property (other than stubs) that is not specified in the config file, the following default values exist:

• cf: defaults to "integration-latest"
• etcd: defaults to "integration-latest"
• consul: defaults to "integration-latest"
• stemcell: defaults to "integration-latest"
• deployments-dir: defaults to ./outputs/manifests

Explanation of director-latest and integration-latest

When the special version string integration-latest is specified for a release or stemcell, this tool will read blessed_versions.json and fill in the proper values in the deployment manifest for that release or stemcell. The exception to this is cf in which case it will clone the cf-release repo into a temporary directory, check out the git commit SHA specified for cf-release in blessed_versions.json, and specify create as the version in the generated deployment manifest. Note that the create version keyword is a work-in-progress feature, expected to be officially supported in BOSH by early November 2015. See this branch of work.

When the special version string director-latest is specified the script will set the version of the release or stemcell in the generated deployment manifest to latest. The exception to this is cf which does not support director-latest.