`ocf` - Emulate Cloud Foundry's `cf` tool on OpenShift

This repository contains a command-line tool written in Go that emulates the Cloud Foundry cf tool but targeting OpenShift. The primary purpose of this tool is to ease migration of existing Cloud Foundry applications and workflows to OpenShift.

The tool is still in its infancy and there are probably plenty of bugs and untested corners. Speaking of tests, this could use some automated ones as well.

This builds on top of the Docker image at https://github.com/bbrowning/openshift-cloudfoundry that provides the necessary buildpacks to run Cloud Foundry applications on OpenShift. Any limitations that image has in emulating the Cloud Foundry environment will apply when using this tool.

Prerequisites

Download the latest release of this tool for your platform from https://github.com/bbrowning/ocf/releases and rename it to ocf. You'll also need recent OpenShift Origin client tools, which can be downloaded from https://github.com/openshift/origin/releases. Make sure the oc binary from that download gets in your $PATH.

Example usage with Cloud Foundry's Spring Music sample

Clone https://github.com/cloudfoundry-samples/spring-music somewhere locally and execute the following commands from inside its directory:

./gradlew assemble
ocf push

The ocf tool will read the application's manifest.yml file and deploy the application based on its contents. If everything goes as planned, the final output of the command will show the URL assigned to the application.

You'll notice these are identical commands to deploying it on Cloud Foundry, except you replace cf with ocf.

Want to switch from the default in-memory database to another, like MySQL?

oc new-app mysql --name=spring-mysql --env=MYSQL_USER=foo,MYSQL_PASSWORD=barbaz123,MYSQL_DATABASE=spring_music
ocf bind-service spring-music spring-mysql

The first command creates a new MySQL server and the second command emulates cf bind-service to bind that MySQL server to your application. The application should automatically redeploy after the second command and come back up (within a few minutes) connected to your MySQL database. You can confirm via the little 'i' button in the top right of the Spring Music green header bar.

Example usage with Cloud Foundry's Node.js sample

Clone https://github.com/cloudfoundry-samples/cf-sample-app-nodejs somewhere locally and execute the following command inside its directory:

ocf push

That's it!

Example usage with Cloud Foundry's Rails sample

Clone https://github.com/cloudfoundry-samples/rails_sample_app somewhere locally and execute the following command inside its directory:

oc new-app postgresql --name=rails-postgres --env=POSTGRESQL_USER=foo,POSTGRESQL_PASSWORD=barbaz123,POSTGRESQL_DATABASE=rails_sample
ocf push

The application's manifest.yml tells it to bind to the rails-postgres service. We use that to wire everything up and populate $VCAP_SERVICES inside the Rails app so that it can find our PostgreSQL instance. This means the cf-autoconfig gem used in this sample application works on OpenShift as well.

Testing

go test -v ./...

To also generate code coverage reports:

./script/coverage --html

Releasing

git tag -a v<version> -m "Release <version>"
git push --tags origin master

Travis will build and push the released binaries to GitHub. Edit the release notes in the GitHub UI.

bbrowning/ocf