MicroPCF is an open source project for running a local version of Pivotal Cloud Foundry. It supports the CF CLI and runs using Vagrant on VirtualBox, VMware Fusion for Mac, VMware Workstation for Windows, and Amazon Web Services.
[ Website | Latest Release | Nightly Builds ]
A colocated deployment of microPCF can be launched locally with Vagrant. You will need:
- A microPCF Vagrantfile from the latest release or nightly builds
- Vagrant 1.7+ installed
NOTE: Ubuntu 14.04 LTS does not install a compatible version of Vagrant by default. You can upgrade the version that you get out of the box by downloading the
.deb
file from Vagrant.
Download the Vagrantfile into a new local folder, and open a prompt to that folder:
vagrant up --provider virtualbox
This spins up a virtual environment that is accessible at local.micropcf.io
Use an Administrator shell to deploy using VMware Workstation on Windows.
MICROPCF_IP
- sets the IP address to bring up the VM onMICROPCF_DOMAIN
- sets an alternate alias for the system routes to be defined on
- defaults to
local.micropcf.io
, then$MICROPCF_IP.xip.io
VM_CORES
- number of CPU cores to allocate on the Guest VM (defaults to host # of logical CPUs)VM_MEMORY
- number of MB to allocate on the Guest VM (defaults to 25% of host memory)
More information is available on the Cloud Foundry CLI README or the Cloud Foundry CLI Releases page. Please install the appropriate binary for your architecture.
NOTE: These instructions are for people contributing code to microPCF. If you only want to deploy microPCF, see above. These instructions cover Vagrant/Virtualbox development. A similar process can be followed for Vagrant/VMWare and Vagrant/AWS development. More documentation is forthcoming.
To develop microPCF you will need to have the following tools installed:
- Packer
- Vagrant
- Virtualbox
- Direnv (optional)
git clone --recursive https://github.com/pivotal-cf/micropcf.git
Setup your shell for building microPCF:
cd micropcf
direnv allow # or: source .envrc
If you change any Diego components, you'll need to build a local Vagrant box with your changes. If you don't plan to change any Diego components, you can update the box_version
property in the Vagrantfile
to point to a pre-built microPCF box on Atlas and skip this step.
./images/base/build -only=virtualbox-iso
vagrant box add --force micropcf-virtualbox-v0.box --name micropcf/base
# in micropcf/vagrant
vagrant up --provider=virtualbox
If you are interested in contributing to microPCF, please refer to CONTRIBUTING.
See LICENSE for details. Copyright (c) 2015 Pivotal Software, Inc.