Skip to content

nunb/micropcf

 
 

Repository files navigation

microPCF (Pivotal Cloud Foundry)

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 ]

Deploy microPCF with Vagrant

A colocated deployment of microPCF can be launched locally with Vagrant. You will need:

Spin up a virtual environment

Download the Vagrantfile into a new local folder, and open a prompt to that folder:

# download https://github.com/pivotal-cf/micropcf/releases/download/<VERSION>/Vagrantfile-<VERSION>.base
# mv Vagrantfile-<VERSION>.base Vagrantfile
vagrant up --provider virtualbox

By default, the cluster can be targeted at cf api api.local.micropcf.io --skip-ssl-validation.

Unless you're attempting to develop microPCF itself, please download the Vagrantfile from Github Releases or Nightly Builds. There's no need to clone the repository in order to use microPCF.

Supported environment variables

These variables must be set during vagrant up.

  1. MICROPCF_IP - sets the IP address to bring up the VM on
  2. MICROPCF_DOMAIN - sets an alternate alias for the system routes to be defined on
  • defaults to local.micropcf.io, then $MICROPCF_IP.xip.io
  1. VM_CORES - number of CPU cores to allocate on the Guest VM (defaults to host # of logical CPUs)
  2. VM_MEMORY - number of MB to allocate on the Guest VM (defaults to 25% of host memory)
Install cf - CF CLI

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.

Troubleshooting

  1. Ubuntu 14.04 LTS does not install a compatible version of Vagrant by default. A compatible version can be found on the Vagrant Downloads page.
  2. Use an Administrator shell to deploy using VMware Workstation on Windows.

Contributing

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

Copyright

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

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Shell 76.2%
  • Ruby 23.8%