Fix #12413: Docker: auto pull image + private registry support

Author: LEDfan

pom.xml

@@ -240,14 +240,29 @@
 		</dependency>
 		<!-- Jersey, a dependency of docker-client with wonky version constraints -->
 		<dependency>
-			<groupId>org.glassfish.jersey.inject</groupId>
-			<artifactId>jersey-hk2</artifactId>
-			<version>2.26</version>
+			<groupId>org.glassfish.jersey.core</groupId>
+			<artifactId>jersey-client</artifactId>
+			<version>2.22</version>
 		</dependency>
 		<dependency>
-			<groupId>org.glassfish.jersey.bundles.repackaged</groupId>
-			<artifactId>jersey-guava</artifactId>
-			<version>2.26-b03</version>
+			<groupId>org.glassfish.jersey.core</groupId>
+			<artifactId>jersey-common</artifactId>
+			<version>2.22</version>
+		</dependency>
+		<dependency>
+			<groupId>org.glassfish.jersey.connectors</groupId>
+			<artifactId>jersey-apache-connector</artifactId>
+			<version>2.22</version>
+		</dependency>
+		<dependency>
+			<groupId>org.glassfish.jersey.media</groupId>
+			<artifactId>jersey-media-json-jackson</artifactId>
+			<version>2.22</version>
+		</dependency>
+		<dependency>
+			<groupId>org.glassfish.hk2</groupId>
+			<artifactId>hk2-api</artifactId>
+			<version>2.4.0-b31</version>
 		</dependency>
 
 		<!-- MonetDB, for gathering usage stats (optional) -->

src/main/java/eu/openanalytics/containerproxy/backend/docker/DockerEngineBackend.java

@@ -22,13 +22,18 @@
 
 import com.spotify.docker.client.DockerClient.ListContainersParam;
 import com.spotify.docker.client.DockerClient.RemoveContainerParam;
+import com.spotify.docker.client.ProgressHandler;
+import com.spotify.docker.client.exceptions.DockerException;
+import com.spotify.docker.client.exceptions.NotFoundException;
 import com.spotify.docker.client.messages.Container.PortMapping;
 import com.spotify.docker.client.messages.ContainerConfig;
 import com.spotify.docker.client.messages.ContainerCreation;
 import com.spotify.docker.client.messages.ContainerInfo;
 import com.spotify.docker.client.messages.HostConfig;
 import com.spotify.docker.client.messages.HostConfig.Builder;
 import com.spotify.docker.client.messages.PortBinding;
+import com.spotify.docker.client.messages.ProgressMessage;
+import com.spotify.docker.client.messages.RegistryAuth;
 import eu.openanalytics.containerproxy.model.runtime.Container;
 import eu.openanalytics.containerproxy.model.runtime.ExistingContainerInfo;
 import eu.openanalytics.containerproxy.model.runtime.Proxy;
@@ -37,6 +42,8 @@
 import eu.openanalytics.containerproxy.model.runtime.runtimevalues.RuntimeValueKey;
 import eu.openanalytics.containerproxy.model.runtime.runtimevalues.UserIdKey;
 import eu.openanalytics.containerproxy.model.spec.ContainerSpec;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.net.URI;
 import java.net.URL;
@@ -49,10 +56,27 @@
 
 public class DockerEngineBackend extends AbstractDockerBackend {
 
+	private static final String PROPERTY_IMG_PULL_POLICY = "image-pull-policy";
+
+	private ImagePullPolicy imagePullPolicy;
+	private final Logger logger = LoggerFactory.getLogger(getClass());
+
+	@Override
+	public void initialize() {
+		super.initialize();
+		imagePullPolicy = environment.getProperty(getPropertyPrefix() + PROPERTY_IMG_PULL_POLICY, ImagePullPolicy.class, ImagePullPolicy.IfNotPresent);
+	}
+
 	@Override
 	protected Container startContainer(ContainerSpec spec, Proxy proxy) throws Exception {
 		Builder hostConfigBuilder = HostConfig.builder();
-		
+
+		if (imagePullPolicy == ImagePullPolicy.Always
+			|| (imagePullPolicy == ImagePullPolicy.IfNotPresent && !isImagePresent(spec))) {
+			logger.info("Pulling image {}", spec.getImage());
+			pullImage(spec);
+		}
+
 		Map<String, List<PortBinding>> portBindings = new HashMap<>();
 		if (isUseInternalNetwork()) {
 			// In internal networking mode, we can access container ports directly, no need to bind on host.
@@ -203,6 +227,36 @@ public List<ExistingContainerInfo> scanExistingContainers() throws Exception {
 
 		return containers;
 	}
-	
+
+	private boolean isImagePresent(ContainerSpec spec) throws DockerException, InterruptedException {
+		try {
+			dockerClient.inspectImage(spec.getImage());
+			return true;
+		} catch (NotFoundException ex) {
+			return false;
+		}
+	}
+
+	private void pullImage(ContainerSpec spec) throws DockerException, InterruptedException {
+		if (spec.getDockerSwarmRegistryDomain() != null
+				&& spec.getDockerSwarmRegistryUsername() != null
+				&& spec.getDockerSwarmRegistryPassword() != null) {
+
+			RegistryAuth registryAuth = RegistryAuth.builder()
+					.serverAddress(spec.getDockerSwarmRegistryDomain())
+					.username(spec.getDockerSwarmRegistryUsername())
+					.password(spec.getDockerSwarmRegistryPassword())
+					.build();
+			dockerClient.pull(spec.getImage(), registryAuth, message -> {});
+		} else {
+			dockerClient.pull(spec.getImage(), message -> {});
+		}
+	}
+
+	public enum ImagePullPolicy {
+		Never,
+		Always,
+		IfNotPresent
+	}
 
 }

src/test/java/eu/openanalytics/containerproxy/test/proxy/TestIntegrationOnSwarm.java

@@ -1,3 +1,23 @@
+/**
+ * ContainerProxy
+ *
+ * Copyright (C) 2016-2021 Open Analytics
+ *
+ * ===========================================================================
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the Apache License as published by
+ * The Apache Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * Apache License for more details.
+ *
+ * You should have received a copy of the Apache License
+ * along with this program.  If not, see <http://www.apache.org/licenses/>
+ */
 package eu.openanalytics.containerproxy.test.proxy;
 
 import com.spotify.docker.client.DefaultDockerClient;