Ръководство за Docker за Java

1. Общ преглед

В тази статия ще разгледаме друг утвърден специфичен за платформата API - Java API Client за Docker .

В цялата статия ние разбираме начина за свързване с работещ демон на Docker и какъв тип важна функционалност API предлага на разработчиците на Java.

2. Зависимост на Maven

Първо, трябва да добавим основната зависимост в нашия файл pom.xml :

 com.github.docker-java docker-java 3.0.14 

По време на писането на статията последната версия на API е 3.0.14 . Всяка версия може да бъде видяна или от страницата за издание на GitHub, или от хранилището на Maven.

3. Използване на Docker Client

DockerClient е мястото, където можем да установим връзка между двигател / демон на Docker и нашето приложение.

По подразбиране демонът на Docker може да бъде достъпен само във файла unix: ///var/run/docker.sock . Можем да комуникираме локално с механизма на Docker, който слуша в Unix сокета, освен ако не е конфигурирано друго .

Тук се прилагаме за класа DockerClientBuilder, за да създадем връзка, като приемем настройките по подразбиране:

DockerClient dockerClient = DockerClientBuilder.getInstance().build();

По същия начин можем да отворим връзка в две стъпки:

DefaultDockerClientConfig.Builder config = DefaultDockerClientConfig.createDefaultConfigBuilder(); DockerClient dockerClient = DockerClientBuilder .getInstance(config) .build();

Тъй като двигателите могат да разчитат на други характеристики, клиентът също може да се конфигурира с различни условия.

Например, конструкторът приема URL адрес на сървър, т.е.можем да актуализираме стойността на връзката, ако двигателят е наличен на порт 2375 :

DockerClient dockerClient = DockerClientBuilder.getInstance("tcp://docker.baeldung.com:2375").build();

Имайте предвид, че трябва да добавим низа на свързване с unix: // или tcp: // в зависимост от типа на връзката.

Ако отидем още една стъпка по-нататък, можем да получим по-усъвършенствана конфигурация, използвайки клас DefaultDockerClientConfig :

DefaultDockerClientConfig config = DefaultDockerClientConfig.createDefaultConfigBuilder() .withRegistryEmail("[email protected]") .withRegistryPassword("baeldung") .withRegistryUsername("baeldung") .withDockerCertPath("/home/baeldung/.docker/certs") .withDockerConfig("/home/baeldung/.docker/") .withDockerTlsVerify("1") .withDockerHost("tcp://docker.baeldung.com:2376").build(); DockerClient dockerClient = DockerClientBuilder.getInstance(config).build();

По същия начин можем да извършим същия подход, като използваме Properties :

Properties properties = new Properties(); properties.setProperty("registry.email", "[email protected]"); properties.setProperty("registry.password", "baeldung"); properties.setProperty("registry.username", "baaldung"); properties.setProperty("DOCKER_CERT_PATH", "/home/baeldung/.docker/certs"); properties.setProperty("DOCKER_CONFIG", "/home/baeldung/.docker/"); properties.setProperty("DOCKER_TLS_VERIFY", "1"); properties.setProperty("DOCKER_HOST", "tcp://docker.baeldung.com:2376"); DefaultDockerClientConfig config = DefaultDockerClientConfig.createDefaultConfigBuilder() .withProperties(properties).build(); DockerClient dockerClient = DockerClientBuilder.getInstance(config).build();

Друг избор, освен ако не конфигурираме настройките на двигателя в изходния код, е да зададем съответни променливи на средата, така че да можем да разгледаме само екземпляра по подразбиране на DockerClient в проекта:

export DOCKER_CERT_PATH=/home/baeldung/.docker/certs export DOCKER_CONFIG=/home/baeldung/.docker/ export DOCKER_TLS_VERIFY=1 export DOCKER_HOST=tcp://docker.baeldung.com:2376

4. Управление на контейнери

API ни позволява разнообразен избор относно управлението на контейнери. Нека разгледаме всеки един от тях.

4.1. Списък с контейнери

Сега, когато имаме установена връзка, можем да изброим всички работещи контейнери, разположени на хоста на Docker:

List containers = dockerClient.listContainersCmd().exec();

При условие, че показването на работещите контейнери не обжалва необходимостта, можем да използваме предлаганите опции за заявка на контейнери.

В този случай показваме контейнери със статус „излязъл“:

List containers = dockerClient.listContainersCmd() .withShowSize(true) .withShowAll(true) .withStatusFilter("exited").exec()

Това е еквивалент на:

$ docker ps -a -s -f status=exited # or $ docker container ls -a -s -f status=exited

4.2. Създайте контейнер

Създаването на контейнер се обслужва с метода createContainerCmd . Можем да декларираме по-сложна декларация, като използваме наличните методи, започвайки с префикса „ с“ .

Да приемем, че имаме команда за създаване на докер, дефинираща зависим от хоста контейнер MongoDB, който слуша вътрешно на порт 27017:

$ docker create --name mongo \ --hostname=baeldung \ -e MONGO_LATEST_VERSION=3.6 \ -p 9999:27017 \ -v /Users/baeldung/mongo/data/db:/data/db \ mongo:3.6 --bind_ip_all

Ние можем да стартираме същия контейнер заедно с неговите конфигурации програмно:

CreateContainerResponse container = dockerClient.createContainerCmd("mongo:3.6") .withCmd("--bind_ip_all") .withName("mongo") .withHostName("baeldung") .withEnv("MONGO_LATEST_VERSION=3.6") .withPortBindings(PortBinding.parse("9999:27017")) .withBinds(Bind.parse("/Users/baeldung/mongo/data/db:/data/db")).exec();

4.3. Стартиране, спиране и убиване на контейнер

След като създадем контейнера, можем да го стартираме, спрем и убием съответно по име или идентификатор:

dockerClient.startContainerCmd(container.getId()).exec(); dockerClient.stopContainerCmd(container.getId()).exec(); dockerClient.killContainerCmd(container.getId()).exec();

4.4. Огледайте контейнер

Методът inspectContainerCmd приема аргумент String , който указва името или идентификатора на контейнер. Използвайки този метод, можем директно да наблюдаваме метаданните на контейнер:

InspectContainerResponse container = dockerClient.inspectContainerCmd(container.getId()).exec();

4.5. Снимка на контейнер

Подобно на командата за ангажиране на docker , ние можем да създадем ново изображение, използвайки метода commitCmd .

В нашия пример сценарият е , че преди това стартирахме контейнер alpine: 3.6, чийто идентификатор е „3464bb547f88“ и инсталирахме git отгоре му.

Сега искаме да създадем нова снимка на изображението от контейнера:

String snapshotId = dockerClient.commitCmd("3464bb547f88") .withAuthor("Baeldung <[email protected]>") .withEnv("SNAPSHOT_YEAR=2018") .withMessage("add git support") .withCmd("git", "version") .withRepository("alpine") .withTag("3.6.git").exec();

Тъй като новото ни изображение в комплект с git остава на хоста, можем да го търсим на хоста на Docker:

$ docker image ls alpine --format "table {{.Repository}} {{.Tag}}" REPOSITORY TAG alpine 3.6.git

5. Управление на изображения

Има няколко приложими команди, които сме получили за управление на операции с изображения.

5.1. Списък на изображенията

За да изброим всички налични изображения, включително висящи изображения на хоста на Docker, трябва да приложим към метода listImagesCmd :

List images = dockerClient.listImagesCmd().exec();

Ако имаме две изображения на нашия Docker Host, трябва да получим обектите Image от тях по време на изпълнение . Изображенията, които търсим са:

$ docker image ls --format "table {{.Repository}} {{.Tag}}" REPOSITORY TAG alpine 3.6 mongo 3.6

До това, за да видим междинните изображения, трябва да го поискаме изрично:

List images = dockerClient.listImagesCmd() .withShowAll(true).exec();

Ако случаят е само показване на висящи изображения, трябва да се има предвид методът withDanglingFilter :

List images = dockerClient.listImagesCmd() .withDanglingFilter(true).exec();

5.2. Build an Image

Let's focus on the way of building an image using the API. The buildImageCmd method builds Docker images from a Dockerfile. In our project, we already have one Dockerfile which gives an Alpine image with git installed:

FROM alpine:3.6 RUN apk --update add git openssh && \ rm -rf /var/lib/apt/lists/* && \ rm /var/cache/apk/* ENTRYPOINT ["git"] CMD ["--help"]

The new image will be built without using cache and before starting the building process, in any case, Docker engine will attempt to pull the newer version of alpine:3.6. If everything goes well, we should eventually see the image with the given name,alpine:git:

String imageId = dockerClient.buildImageCmd() .withDockerfile(new File("path/to/Dockerfile")) .withPull(true) .withNoCache(true) .withTag("alpine:git") .exec(new BuildImageResultCallback()) .awaitImageId();

5.3. Inspect an Image

We can inspect the low-level information about an image thanks to the inspectImageCmd method:

InspectImageResponse image = dockerClient.inspectImageCmd("161714540c41").exec();

5.4. Tag an Image

Adding a tag to our image is quite simple using the dockertag command, so the API is no exception. We can carry out the same intention with the tagImageCmd method as well. To tag a Docker image with id 161714540c41 into the baeldung/alpine repository with git:

String imageId = "161714540c41"; String repository = "baeldung/alpine"; String tag = "git"; dockerClient.tagImageCmd(imageId, repository, tag).exec();

We would list the newly created image, and there it is:

$ docker image ls --format "table {{.Repository}} {{.Tag}}" REPOSITORY TAG baeldung/alpine git

5.5. Push an Image

Before sending out an image to a registry service, the docker client must be configured to cooperate with the service because working with registries need to be authenticated in advance.

Since we assume that the client was configured with Docker Hub, we can push the baeldung/alpine image to the baeldung DockerHub account:

dockerClient.pushImageCmd("baeldung/alpine") .withTag("git") .exec(new PushImageResultCallback()) .awaitCompletion(90, TimeUnit.SECONDS);

We must abide by the duration of the process. In the example, we are waiting 90 seconds.

5.6. Pull an Image

To download images from registry services, we make use of the pullImageCmd method. In addition, if the image being pulled from a private registry, the client must know our credential otherwise the process ends up with a failure. Same as the pulling an image, we specify a callback along with a fixed period to pull an image:

dockerClient.pullImageCmd("baeldung/alpine") .withTag("git") .exec(new PullImageResultCallback()) .awaitCompletion(30, TimeUnit.SECONDS);

To check out whether the mentioned image exists on the Docker host after pulling it:

$ docker images baeldung/alpine --format "table {{.Repository}} {{.Tag}}" REPOSITORY TAG baeldung/alpine git

5.7. Remove an Image

Another simple function among the rest is the removeImageCmd method. We can remove an image with its short or long ID:

dockerClient.removeImageCmd("beaccc8687ae").exec();

5.8. Search in Registry

To search an image from Docker Hub, the client comes with the searchImagesCmd method taking a String value which indicates a term. Here, we explore images related to a name containing ‘Java' in Docker Hub:

List items = dockerClient.searchImagesCmd("Java").exec();

The output returns first 25 related images in a list of SearchItem objects.

6. Volume Management

If Java projects need to interact with Docker for volumes, we should also take into account this section. Briefly, we look at the fundamental techniques of volumes provided by the Docker Java API.

6.1. List Volumes

All of the available volumes including named and unnamed are listed with:

ListVolumesResponse volumesResponse = dockerClient.listVolumesCmd().exec(); List volumes = volumesResponse.getVolumes();

6.2. Inspect a Volume

The inspectVolumeCmd method is the form to show the detailed information of a volume. We inspect the volume by specifying its short id:

InspectVolumeResponse volume = dockerClient.inspectVolumeCmd("0220b87330af5").exec();

6.3. Create a Volume

The API serves two different options to create a volume. The non-arg createVolumeCmd method creates a volume where the name is given by Docker:

CreateVolumeResponse unnamedVolume = dockerClient.createVolumeCmd().exec();

Rather than using the default behavior, the helper method called withName lets us set a name to a volume:

CreateVolumeResponse namedVolume = dockerClient.createVolumeCmd().withName("myNamedVolume").exec();

6.4. Remove a Volume

We can intuitively delete a volume from the Docker host using the removeVolumeCmd method. What is important to note that we cannot delete a volume if it is in use from a container. We remove the volume, myNamedVolume, from the volume list:

dockerClient.removeVolumeCmd("myNamedVolume").exec();

7. Network Management

Our last section is about managing network tasks with the API.

7.1. List Networks

We can display the list of network units with one of the conventional API methods starting with list:

List networks = dockerClient.listNetworksCmd().exec();

7.2. Create a Network

The equivalent of the docker network create command is conducted with the createNetworkCmd method. If we have a thirty party or a custom network driver, the withDriver method can accept them besides the built-in drivers. In our case, let's create a bridge network whose name is baeldung:

CreateNetworkResponse networkResponse = dockerClient.createNetworkCmd() .withName("baeldung") .withDriver("bridge").exec();

Furthermore, creating a network unit with the default settings doesn't solve the problem, we can apply for other helper methods to construct an advanced network. Thus, to override the default subnetwork with a custom value:

CreateNetworkResponse networkResponse = dockerClient.createNetworkCmd() .withName("baeldung") .withIpam(new Ipam() .withConfig(new Config() .withSubnet("172.36.0.0/16") .withIpRange("172.36.5.0/24"))) .withDriver("bridge").exec();

The same command we can run with the docker command is:

$ docker network create \ --subnet=172.36.0.0/16 \ --ip-range=172.36.5.0/24 \ baeldung

7.3. Inspect a Network

Displaying the low-level details of a network is also covered in the API:

Network network = dockerClient.inspectNetworkCmd().withNetworkId("baeldung").exec();

7.4. Remove a Network

We can safely remove a network unit with its name or id using the removeNetworkCmd method:

dockerClient.removeNetworkCmd("baeldung").exec();

8. Conclusion

In this extensive tutorial, we explored the various diverse functionality of the Java Docker API Client, along with several implementation approaches for deployment and management scenarios.

Всички примери, илюстрирани в тази статия, могат да бъдат намерени в GitHub.