jclouds/apis/docker
Andrew Donald Kennedy 42d0576aa9 Add openStdin option to Docker template options and set all port bindings explicitly 2016-04-26 10:33:17 +02:00
..
src Add openStdin option to Docker template options and set all port bindings explicitly 2016-04-26 10:33:17 +02:00
README.md add docker NetworkAPI 2015-11-13 16:47:01 +01:00
pom.xml [JCLOUDS-1084] Docker live tests fixed and made more robust 2016-02-22 17:16:40 +01:00

README.md

Docker as a local cloud provider

jclouds-docker is a local cloud provider modelled on docker. Similar to other jclouds supported providers, it supports the same portable abstractions offered by jclouds.

##Setup

Please follow these steps to configure your workstation for jclouds-docker:

If you are using docker-machine then it can also manage certificates and help you setup DOCKER_CERT_PATH and DOCKER_HOST environment variables.

Assuming these environment variables are setup correctly there are no further setups steps are required.

Live tests then can now be run: mvn -Plive integration-test

#How it works

                                           ---------------   -------------
                                          |   Image(s)    | |   Node(s)   |
                                          ---------------   -------------
 ---------    docker remote api           ----------------------------------------
| jclouds | ---------------------------> |              DOCKER_HOST              |
 ---------                               ----------------------------------------

##Components

  • jclouds - acts as a java client to access to docker features
  • DOCKER_HOST - hosts Docker API, NB: jclouds-docker assumes that the latest Docker is installed
  • Image - it is a docker image that can be started.
  • Node - is a docker container

Assumptions

  • jclouds-docker assumes that the images specified using the template are ssh'able.

#Notes:

  • jclouds-docker is still at alpha stage please report any issues you find at jclouds issues
  • jclouds-docker has been tested on Mac OSX, it might work on Linux iff vbox is running and set up correctly. However, it has never been tried on Windows.

#Troubleshooting As jclouds docker support is quite new, issues may occasionally arise. Please follow these steps to get things going again:

  1. Remove all containers

    $ docker rm -f docker ps -a

  2. remove all the images

    $ docker rmi -f docker images -q