DEVELOP.md

PCF Dev Development

To develop PCF Dev you will need to have the following tools installed:

• Packer v0.9.0+
• Virtualbox 5.0+
• Go 1.6.1+
• jq 1.5+
• spiff 1.0.6+

Clone the PCF Dev source

git clone --recursive https://github.com/pivotal-cf/pcfdev.git

Building a PCF Dev Box

To build an OSS-only PCF Dev OVA, run:

./bin/build -only=virtualbox-iso # pass -debug for more output

Note: Support for VMware Fusion/Workstation has been discontinued. Support for AWS is temporarily suspended until a commercial version of PCF Dev becomes available from the AWS Marketplace.

Deploying a locally-built PCF Dev box

After the PCF Dev box has been built, you need to use the PCF Dev CLI to launch the OVA. This will disable various checks for system requirements such as system memory. More information on installation of the CLI can be found here.

cf dev start -o output/output-virtualbox-iso/oss-v0.ova

Customizing PCF Dev

Our build tool has the ability to build compiled releases or releases from source. By default, it will try to build releases that have been compiled by the PCF Dev team. If you have a non-compiled release that present on your workstation, you can configure the build to use it using the path: key. Simply edit the versions.json file at the root of this repo like "cf" : is done below:

{
  "releases": {
    "cf" : {
      "path": "/Users/pivotal/[path-to-release-folder]"
    },
    "diego" : {
      "version": "v0.1480.0",
      "sha1": "bfd87d6ef08458e19e2abc6fc6888ba9ac29fde6",
      "source_location": "https://github.com/cloudfoundry/diego-release",
      "compiled_release_url" : "https://s3.amazonaws.com/pcfdev/compiled-releases/diego-8d1450da393eae98d565b9e0e7154c742e75e513.tgz"
    },

If you would like to a different compiled release than is offered in the versions.json, simply make sure that the appropriate keys are modified.

Note: any necessary manifest changes can be done to the manifest.yml file at the root of this repo for a successful build.

Contributing

If you are interested in contributing to PCF Dev, please refer to CONTRIBUTING.

Copyright

See LICENSE for details. Copyright (c) 2015 Pivotal Software, Inc.