1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.hosted.dockerapi;
import java.io.File;
import java.net.InetAddress;
import java.util.List;
import java.util.Map;
import java.util.Optional;
/**
* API to simplify the com.github.dockerjava API for clients,
* and to avoid OSGi exporting those classes.
*/
public interface Docker {
/**
* Must be called before any other method. May be called more than once.
*/
void start();
interface CreateContainerCommand {
CreateContainerCommand withLabel(String name, String value);
CreateContainerCommand withEnvironment(String name, String value);
CreateContainerCommand withVolume(String path, String volumePath);
CreateContainerCommand withNetworkMode(String mode);
CreateContainerCommand withIpAddress(InetAddress address);
CreateContainerCommand withUlimit(String name, int softLimit, int hardLimit);
CreateContainerCommand withEntrypoint(String... entrypoint);
CreateContainerCommand withManagedBy(String manager);
CreateContainerCommand withAddCapability(String capabilityName);
CreateContainerCommand withDropCapability(String capabilityName);
void create();
}
CreateContainerCommand createContainerCommand(
DockerImage dockerImage,
ContainerResources containerResources,
ContainerName containerName,
String hostName);
interface ContainerStats {
Map<String, Object> getNetworks();
Map<String, Object> getCpuStats();
Map<String, Object> getMemoryStats();
Map<String, Object> getBlkioStats();
}
default boolean networkNATed() {
return false;
}
Optional<ContainerStats> getContainerStats(ContainerName containerName);
void startContainer(ContainerName containerName);
void stopContainer(ContainerName containerName);
void deleteContainer(ContainerName containerName);
void connectContainerToNetwork(ContainerName containerName, String networkName);
void copyArchiveToContainer(String sourcePath, ContainerName destinationContainer, String destinationPath);
List<Container> getAllContainersManagedBy(String manager);
List<ContainerName> listAllContainersManagedBy(String manager);
Optional<Container> getContainer(ContainerName containerName);
/**
* Checks if the image is currently being pulled or is already pulled, if not, starts an async
* pull of the image
*
* @param image Docker image to pull
* @return true iff image being pulled, false otherwise
*/
boolean pullImageAsyncIfNeeded(DockerImage image);
void deleteImage(DockerImage dockerImage);
void buildImage(File dockerfile, DockerImage dockerImage);
/**
* Deletes the local images that are currently not in use by any container and not recently used.
*/
void deleteUnusedDockerImages();
/**
* Execute a command in docker container as "yahoo". Will block until the command is finished.
*
* @param containerName The name of the container
* @param command The command with arguments to run.
*
* @return exitcodes, stdout and stderr in the ProcessResult
*/
ProcessResult executeInContainer(ContainerName containerName, String... command);
/**
* Execute a command in docker container as "root". Will block until the command is finished.
*
* @param containerName The name of the container
* @param command The command with arguments to run.
*
* @return exitcodes, stdout and stderr in the ProcessResult
*/
ProcessResult executeInContainerAsRoot(ContainerName containerName, String... command);
/**
* Execute a command in docker container as "root"
* The timeout will not kill the process spawned.
*
* @param containerName The name of the container
* @param timeoutSeconds Timeout for the process to finish in seconds or without timeout if empty
* @param command The command with arguments to run.
*
* @return exitcodes, stdout and stderr in the ProcessResult
*/
ProcessResult executeInContainerAsRoot(ContainerName containerName, Long timeoutSeconds, String... command);
String getGlobalIPv6Address(ContainerName name);
}
|
