Apache
/
jclouds
mirror of https://github.com/apache/jclouds.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
jclouds/apis/docker/README.md

56 lines
2.2 KiB
Markdown
Raw Normal View History

[JCLOUDS-500] Initial commit for docker
2014-01-28 04:42:43 -05:00
# Docker as a local cloud provider
jclouds-docker is a local cloud provider modelled on [docker](http://www.docker.io). 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:
- install the latest Docker release (please visit https://docs.docker.com/installation/)
support for docker 1.3.2 - update value objects (Container, Config) - add new value object (Resource, StatusCode) - add more options for ContainerApi - add support for pause/unpause, restart, kill, copy and attach APIs + Mock and Live tests - add *ParseTest - refactor MockTests - removed *Options.NONE - cleanup low-value javadoc - more coverage in LiveTests - removed useless DockerProperties - add comments for TLS issue - use Date where needed - fix listImages - add package-private constructor to value classes - remove KillOptions, RestartOptions, StopOptions in favour of @QueryParam - use PEM instead of PKCS12 format - update docker/pom.xml to use sshj dependencies - explicit usage of OkHttp driver - simplify DockerApiMetadata - add bouncycastle driver explicitly
2014-11-24 11:34:22 -05:00
add docker NetworkAPI - bump api version to 1.21 - use `alpine/3.2` image for liveTests - use `kwart/alpine-ext:3.2-ssh` image as ssh-able image - assert request bodies created correctly in NetworkApiMockTest
2015-11-10 10:49:59 -05:00
If you are using `docker-machine` then it can also manage certificates and help you setup `DOCKER_CERT_PATH` and `DOCKER_HOST` environment variables.
support for docker 1.3.2 - update value objects (Container, Config) - add new value object (Resource, StatusCode) - add more options for ContainerApi - add support for pause/unpause, restart, kill, copy and attach APIs + Mock and Live tests - add *ParseTest - refactor MockTests - removed *Options.NONE - cleanup low-value javadoc - more coverage in LiveTests - removed useless DockerProperties - add comments for TLS issue - use Date where needed - fix listImages - add package-private constructor to value classes - remove KillOptions, RestartOptions, StopOptions in favour of @QueryParam - use PEM instead of PKCS12 format - update docker/pom.xml to use sshj dependencies - explicit usage of OkHttp driver - simplify DockerApiMetadata - add bouncycastle driver explicitly
2014-11-24 11:34:22 -05:00
[docker] upgrade to docker 1.7 and refactor TLS support
2015-07-13 16:26:26 -04:00
Assuming these environment variables are setup correctly there are no further setups steps are required.
support for docker 1.3.2 - update value objects (Container, Config) - add new value object (Resource, StatusCode) - add more options for ContainerApi - add support for pause/unpause, restart, kill, copy and attach APIs + Mock and Live tests - add *ParseTest - refactor MockTests - removed *Options.NONE - cleanup low-value javadoc - more coverage in LiveTests - removed useless DockerProperties - add comments for TLS issue - use Date where needed - fix listImages - add package-private constructor to value classes - remove KillOptions, RestartOptions, StopOptions in favour of @QueryParam - use PEM instead of PKCS12 format - update docker/pom.xml to use sshj dependencies - explicit usage of OkHttp driver - simplify DockerApiMetadata - add bouncycastle driver explicitly
2014-11-24 11:34:22 -05:00
[docker] upgrade to docker 1.7 and refactor TLS support
2015-07-13 16:26:26 -04:00
Live tests then can now be run: `mvn -Plive integration-test`
[JCLOUDS-500] Initial commit for docker
2014-01-28 04:42:43 -05:00
#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](https://issues.apache.org/jira/browse/JCLOUDS)
- 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
support for docker 1.3.2 - update value objects (Container, Config) - add new value object (Resource, StatusCode) - add more options for ContainerApi - add support for pause/unpause, restart, kill, copy and attach APIs + Mock and Live tests - add *ParseTest - refactor MockTests - removed *Options.NONE - cleanup low-value javadoc - more coverage in LiveTests - removed useless DockerProperties - add comments for TLS issue - use Date where needed - fix listImages - add package-private constructor to value classes - remove KillOptions, RestartOptions, StopOptions in favour of @QueryParam - use PEM instead of PKCS12 format - update docker/pom.xml to use sshj dependencies - explicit usage of OkHttp driver - simplify DockerApiMetadata - add bouncycastle driver explicitly
2014-11-24 11:34:22 -05:00
add docker NetworkAPI - bump api version to 1.21 - use `alpine/3.2` image for liveTests - use `kwart/alpine-ext:3.2-ssh` image as ssh-able image - assert request bodies created correctly in NetworkApiMockTest
2015-11-10 10:49:59 -05:00
$ docker rm -f `docker ps -a`
support for docker 1.3.2 - update value objects (Container, Config) - add new value object (Resource, StatusCode) - add more options for ContainerApi - add support for pause/unpause, restart, kill, copy and attach APIs + Mock and Live tests - add *ParseTest - refactor MockTests - removed *Options.NONE - cleanup low-value javadoc - more coverage in LiveTests - removed useless DockerProperties - add comments for TLS issue - use Date where needed - fix listImages - add package-private constructor to value classes - remove KillOptions, RestartOptions, StopOptions in favour of @QueryParam - use PEM instead of PKCS12 format - update docker/pom.xml to use sshj dependencies - explicit usage of OkHttp driver - simplify DockerApiMetadata - add bouncycastle driver explicitly
2014-11-24 11:34:22 -05:00
[JCLOUDS-500] Initial commit for docker
2014-01-28 04:42:43 -05:00
2. remove all the images
support for docker 1.3.2 - update value objects (Container, Config) - add new value object (Resource, StatusCode) - add more options for ContainerApi - add support for pause/unpause, restart, kill, copy and attach APIs + Mock and Live tests - add *ParseTest - refactor MockTests - removed *Options.NONE - cleanup low-value javadoc - more coverage in LiveTests - removed useless DockerProperties - add comments for TLS issue - use Date where needed - fix listImages - add package-private constructor to value classes - remove KillOptions, RestartOptions, StopOptions in favour of @QueryParam - use PEM instead of PKCS12 format - update docker/pom.xml to use sshj dependencies - explicit usage of OkHttp driver - simplify DockerApiMetadata - add bouncycastle driver explicitly
2014-11-24 11:34:22 -05:00
$ docker rmi -f `docker images -q`