raulavila / pcfdev

PCF Dev is the simplest way to get a complete Cloud Foundry on a single machine

PCF Dev is currently in Closed Beta on the Pivotal Network. Our first Open Beta release should be available in the next couple of weeks.

PCF Dev

PCF Dev is a new distribution of Cloud Foundry designed to run on a developer’s laptop or workstation. PCF Dev gives application developers the full Cloud Foundry experience in a lightweight, easy to install package. PCF Dev is intended for application developers who wish to develop and debug their application locally on a full-featured Cloud Foundry. PCF Dev is also an excellent getting started environment for developers interested in learning and exploring Cloud Foundry.

More information about the project can be found on the FAQ.

Install

1. Download the latest pcfdev-<VERSION>.zip from the Pivotal Network. (Currently only available to select PCF customers)
2. Unzip the pcfdev-<VERSION>.zip.
3. Open a terminal or command prompt and navigate to the pcfdev-<VERSION> folder.
4. Run ./start-osx at a command prompt

• See Configuration for additional options

Check out the troubleshooting guide for more information.

Prerequisites

• Vagrant 1.8+
• CF CLI
• Internet connection required (for DNS)
• VirtualBox: 5.0+

Configuration

The following environment variables can be set during start-osx to customize the PCF Dev deployment:

1. PCFDEV_IP - sets the IP address to bring up the VM on

• defaults to 192.168.11.11 locally
• defaults to AWS-assigned public IP on AWS

1. PCFDEV_DOMAIN - sets an alternate alias for the system routes to be defined on

• defaults to local.pcfdev.io when deploying locally
• defaults to <PCFDEV_IP>.xip.io on AWS or when PCFDEV_IP is set

1. VM_CORES (local only) - number of CPU cores to allocate on the Guest VM

• defaults to host # of logical CPUs

1. VM_MEMORY (local only) - number of MB to allocate on the Guest VM

• defaults to 25% of host memory

Using the Cloud Foundry CLI

Follow the instructions provided at the end of start-osx to connect to PCF Dev:

==> default: PCF Dev is now running.
==> default: To begin using PCF Dev, please run:
==> default: 	cf api api.local.pcfdev.io --skip-ssl-validation
==> default: 	cf login
==> default: Email: admin
==> default: Password: admin

local.pcfdev.io above will show the domain configured for your PCF Dev instance.

To stage a simple app on PCF Dev, cd into the app directory and run cf push <APP_NAME>.

See cf documentation for information on deploying apps and attaching services.

Uninstall

To temporarily stop PCF Dev:

1. Open a terminal or command prompt and navigate to the pcfdev-<VERSION> folder.
2. Run ./stop-osx at a command prompt

• You can use the start-osx script to resume the stopped PCF Dev instance

To permanently destroy PCF Dev:

1. Open a terminal or command prompt and navigate to the pcfdev-<VERSION> folder.
2. Run ./destroy-osx at a command prompt

Contributing

If you are interested in contributing to PCF Dev, please refer to the contributing guidelines and development instructions.

Copyright

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

PCF Dev uses a version of Monit that can be found here, under the GPLv3 license.