Skip to content
master
Switch branches/tags
Go to file
Code
This branch is 7 commits ahead of hatofmonkeys:master.

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

#Cloud Focker

Cloud Focker is the convergence of Cloud Foundry and Docker (portmanteau - Cloud F + ocker) aiming to bring the Cloud Foundry experience to a developer's machine.

##Tutorial

This is a brief tutorial to ease you through your first focking experience.

###Set up your Docker environment

Select either option 1 or option 2, then move to Test your Docker environment.

####Option 1 : Easy - Mac/Windows/Linux - using Vagrant

vagrant up --provider virtualbox
vagrant ssh

All later commands are entered as the vagrant user's shell in the vagrant VM.

####Option 2 : Advanced users - Linux only - using a local Docker daemon

$ go get github.com/cloudcredo/cloudfocker/fock

The user for 'fock' commands must have permissions to access the Docker daemon.

###Test your Docker environment

$ fock docker

You should see output similar to this:

Checking Docker version
Client API version: 1.13
Go version (client): go1.3
Server version: 1.1.2
Server API version: 1.13
Go version (server): go1.2.1
Git commit (server): d84a070

###Fock your local machine

Download the base Cloud Foundry container image.

$ fock this

###Add a buildpack

$ fock add-buildpack https://github.com/cloudfoundry/java-buildpack

###Deploy your application

Change PWD to the sample Java application.

$ cd /vagrant/sample-apps/java/

Start the application.

$ fock up

Starting the CloudFocker container...
Running Buildpacks...
-----> Java Buildpack Version: 120c640
*--Buildpack output omitted--*
Started the CloudFocker container.
Deleting the CloudFocker container...
cloudfocker-staging
Deleted container.
Starting the CloudFocker container...
5b69950f351d2c843fe2ffd531edd87c09f19a368241ae37a6d2e025000dd6c8
Started the CloudFocker container.
Connect to your running application at http://localhost:8080/

You should now be able to browse the output on the vagrant machine.

$ curl localhost:8080

You should also be able to browse the output on your host machine.

The focking site.

Please note the unsubtle CloudCredo advertising.

###Shut the application down

$ fock off

##Buildpacks

A great list of Cloud Foundry buildpacks is available on the Cloud Foundry community wiki.

List buildpacks

$ fock buildpacks

cf-buildpack-php
go-buildpack
java-buildpack
nodejs-buildpack
python-buildpack
ruby-buildpack

Add a buildpack

$ fock add-buildpack https://github.com/cloudfoundry/php-buildpack

Remove a buildpack

$ fock delete-buildpack php-buildpack

Sample applications to use with the buildpacks are in sample-apps.

##External Services

Services can be connected to your application by adding a vcap_services.json file to the root directory of your application. This is demonstrated in the ruby-with-services sample application.

#####Note - the following steps are only appropriate to users of the Vagrant image (tutorial option 1 above).

Change PWD to the sample ruby-with-services sample application.

$ cd /vagrant/sample-apps/ruby-with-services

If necessary, install a Ruby buildpack.

$ fock add-buildpack https://github.com/cloudfoundry/cf-buildpack-ruby

Start the application.

$ fock up

Set a value for a key.

http://localhost:8080/set/hello/to/world

Get the value.

http://localhost:8080/get/hello

##Potential Uses

####For application development

Cloud Focker gives a fast-feedback, production-like Cloud Foundry environment on a developer's machine. Make a change, fock up, rinse, repeat. When you're finished, just fock off.

####For buildpack development

Cloud Focker gives a fast-feedback environment for iterating on buildpacks. Buildpacks are stored in $CLOUDFOCKER_HOME(default ~/.cloudfocker)/buildpacks and can be edited directly.

####For continuous integration

Deploying Cloud Focker to your CI server means you can quickly get feedback about your Cloud Foundry applications.

####For deploying applications to non-Cloud-Foundry environments

If you aren't fortunate enough to work in an organisation with access to a proper PaaS such as Cloud Foundry - you can still use Cloud Foundry's buildpacks, via Cloud Focker, to build applications. You will need to host the containers in an IaaS+ offering, such as Kubernetes or Shipyard. IaaS+ systems leave the responsibility with the user to fock themselves.

##Developing Cloud Focker

There is a public tracker for this project here.

##FAQ

#####Why have you built Cloud Focker?

Cloud Foundry, at a high level, has two responsibilities for applications: staging - so they are ready to be run, and then - running them. Decker brought Cloud Foundry's running experience to container developers. Cloud Focker brings the Cloud Foundry staging experience to application developers. By separating these responsibilities we can discuss the right way to build containers, and the right way to run them.

As a Cloud Foundry Community Advisory Board member - anything I can do to illustrate the great experience Cloud Foundry brings to developers is worthwhile. I think everybody benefits from fast-feedback and small batch sizes. Get code into a production-like environment as soon as possible. Let's iterate faster.

#####How is Cloud Focker different to Slugbuilder, Building, Buildstep, etc?

Cloud Focker uses the Cloud Foundry components as far as possible to provide a production-like Cloud Foundry environment to developers.

#####How is this different to Decker?

Decker is about running containers in a remote Cloud Foundry. Cloud Focker is about running Cloud Foundry applications in local containers.

#####How is this different to BOSH-Lite?

BOSH-Lite is a fantastic development environment for BOSH developers. Cloud Focker is for application developers.

#####How is this different to Micro Cloud Foundry?

MCF has been defunct since Cloud Foundry v1, and even back then it ate a considerable amount of resources. Cloud Focker runs on any machine capable of running Docker, only consuming the resources necessary to stage and run the application.

#####Just how 'production-like' is this?

Cloud Focker attempts to use the same components as Cloud Foundry's 'Diego'.

The base filesystem is exactly the same as a Cloud Foundry container.

Environment variables are currently handled in a different manner to CF. File locations and user mapping are also slightly different, which may cause subtle issues. Cloud Focker is under development to bridge this gap.

#####How do I enter the running container to 'poke around' in the shell?

We will be automating this process, for now use nsenter.

#####Why can't I use my boot2docker setup on win/mac, not vagrant?

Feel free to try Cloud Focker with boot2docker, and good luck with the volume mounts.

#####Can I use a non-default base container image?

By default the Cloud Foundry lucid64 image is used. You can choose to download a different base container image using the $FOCKER_ROOTFS_URL environment variable.

#####Why can't I use the Python CF buildpack?

The pip installer does some interesting things with users that our docker usage doesn't like. There is a ticket to fix this in the backlog.

#####What about 'Error response from daemon: Conflict, The name cloudfocker-runtime is already assigned to 7a519360a3d3. You have to delete (or rename) that container to be able to assign cloudfocker-runtime to a container again.'?

This is what happens when good Cloud Fockers turn bad. Simply run:

$ docker rm cloudfocker-runtime

We will automate this when we have a better understanding of all the scenrios in which it occurs.

#####Did you only create this project so you could have fun making endless double entendres in the README?

No. I enjoyed the portmanteau too.

##A message from our sponsors.

If you've read this far you've demonstrated a remarkable level of tenacity. CloudCredo are recruiting, and would like to hear from you.

About

Cloud Foundry + Docker = Cloud Focker

Resources

License

Releases

No releases published

Packages

No packages published