/pcfdev

This is the depricated version of PCF Dev - please visit the current Github repository https://github.com/cloudfoundry-incubator/cfdev for the latest updates

Primary LanguageGoApache License 2.0Apache-2.0

Update on PCF Dev

This is the deprecated version of PCF Dev - please visit the current Github repository https://github.com/cloudfoundry-incubator/cfdev for the latest updates

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.

Open Source

This repository contains source code that allows developers to build an open source version of PCF Dev that only contains the Elastic Runtime and the CF MySQL Broker. The binary distribution of PCF Dev that is available on the Pivotal Network contains other PCF components (such as the Redis, RabbitMQ and Spring Cloud Services marketplace services as well as Apps Manager) that are not available in this repository.

However, we encourage you to leave any feedback or issues you may encounter regarding the full, binary distribution of PCF Dev in this repository's Github issues.

Install

  1. Download the latest pcfdev-VERSION-PLATFORM.zip from the Pivotal Network.
  2. Unzip the zip file and navigate to its containing folder using PowerShell or a Unix terminal.
  3. Run the extracted binary.
  4. Run cf dev start.

Check out the documentation for more information. Running cf dev help will display an overview of PCF Dev VM management commands.

Prerequisites

Using the Cloud Foundry CLI Plugin

Follow the instructions provided at the end of cf dev start to connect to PCF Dev:

Downloading VM...
Progress: |====================>| 100%
VM downloaded
Importing VM...
Starting VM...
Provisioning VM...
Waiting for services to start...
40 out of 40 running
 _______  _______  _______    ______   _______  __   __
|       ||       ||       |  |      | |       ||  | |  |
|    _  ||       ||    ___|  |  _    ||    ___||  |_|  |
|   |_| ||       ||   |___   | | |   ||   |___ |       |
|    ___||      _||    ___|  | |_|   ||    ___||       |
|   |    |     |_ |   |      |       ||   |___  |     |
|___|    |_______||___|      |______| |_______|  |___|
is now running.
To begin using PCF Dev, please run:
    cf login -a https://api.local.pcfdev.io --skip-ssl-validation
Admin user => Email: admin / Password: admin
Regular user => Email: user / Password: pass

The local.pcfdev.io domain may differ slightly 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.

Using a customized PCF Dev OVA

Specify the path to the custom built OVA with the -o flag to the cf dev start command.

$ cf dev start -o /path/to/custom/ova
Importing VM...
Starting VM...
Provisioning VM..
...

To build a custom PCF Dev OVA, please see our DEVELOP Documentation.

Uninstall

To temporarily stop PCF Dev run cf dev stop.

To destroy your PCF Dev VM run cf dev destroy.

To uninstall the PCF Dev cf CLI plugin run cf uninstall-plugin pcfdev

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.