Skip to content

Latest commit

 

History

History
83 lines (58 loc) · 2.44 KB

README.md

File metadata and controls

83 lines (58 loc) · 2.44 KB
Raw

reactive-docker

A fully reactive client for the docker remote API.

  • fully async and non-blocking design
  • full typesafety
  • async streaming capabilities using enumerators (e.g. attaching to docker events stream)
  • supports latest docker remote API v1.14

pending features:

  • simplify API usage by providing additional convenience methods e.g. docker.run or docker.pull
  • publish sbt artifacts

Installation

As reactive-docker still is in a very early stage of development only SNAPSHOT artifacts will be published to Sonatype Snapshots repo. Add the following to your build.sbt:

  • resolvers += Resolver.sonatypeRepo("snapshots")
  • libraryDependencies += "org.almoehi" %% "reactive-docker" % "0.1-SNAPSHOT"

Sample Usage

import com.kolor.docker.api._
import com.kolor.docker.api.json.Formats._
import scala.concurrent.ExecutionContext.Implicits.global


implicit val docker = Docker("localhost")

val maybeImages = docker.images()
val maybeContainers = docker.containers()

for {
	images <- maybeImages
	containers <- maybeContainers
} yield {
	images.map(i => println(s"Image: $i"))
	containers.map(c => println(s"Container: $c"))
}

create a new container from busybox image and start it:

import com.kolor.docker.api._
//import com.kolor.docker.api.json.Formats._		// use this for API version < v1.12
import com.kolor.docker.api.json.FormatsV112._		// use this for API versions v1.12+
import scala.concurrent.duration.Duration
import scala.concurrent.Await
import play.api.libs.iteratee._
import scala.concurrent.ExecutionContext.Implicits.global


implicit val docker = Docker("localhost")
val timeout = Duration.create(30, SECONDS)

val cmd = Seq("/bin/sh", "-c", "while true; do echo hello world; sleep 1; done")
val containerName = "reactive-docker"
val imageTag = RepositoryTag.create("busybox", Some("latest"))
val cfg = ContainerConfig("busybox", cmd)


// create image, returns a list of docker messages when finished
val messages = Await.result(docker.imageCreate(imageTag), timeout)

messages.map(m => println(s"imageCreate: $m"))

// create container
val containerId = Await.result(docker.containerCreate("busybox", cfg, Some(containerName)), timeout)._1

// run container
Await.result(docker.containerStart(containerId), timeout)
println(s"container $containerId is running")

For more and up2date examples see DockerQuickSpec.scala and DockerApiSpec.scala in the test/ folder