Support authentication to private docker registry
This commit adds the ability to configure Docker image registry authentication credentials in the Maven and Gradle plugins. The authentication credentials are passed to the Docker daemon with all daemon API calls, and the daemon forwards the credentials to the image registry when necessary. This makes it possible to use builder and run images stored in a private Docker registry. See gh-22972
This commit is contained in:
@@ -35,6 +35,7 @@ import org.springframework.boot.buildpack.platform.build.BuildRequest;
|
||||
import org.springframework.boot.buildpack.platform.build.Builder;
|
||||
import org.springframework.boot.buildpack.platform.build.Creator;
|
||||
import org.springframework.boot.buildpack.platform.build.PullPolicy;
|
||||
import org.springframework.boot.buildpack.platform.docker.configuration.DockerConfiguration;
|
||||
import org.springframework.boot.buildpack.platform.docker.transport.DockerEngineException;
|
||||
import org.springframework.boot.buildpack.platform.docker.type.ImageName;
|
||||
import org.springframework.boot.buildpack.platform.docker.type.ImageReference;
|
||||
@@ -72,6 +73,8 @@ public class BootBuildImage extends DefaultTask {
|
||||
|
||||
private PullPolicy pullPolicy;
|
||||
|
||||
private Docker docker;
|
||||
|
||||
public BootBuildImage() {
|
||||
this.jar = getProject().getObjects().fileProperty();
|
||||
this.targetJavaVersion = getProject().getObjects().property(JavaVersion.class);
|
||||
@@ -246,9 +249,31 @@ public class BootBuildImage extends DefaultTask {
|
||||
this.pullPolicy = pullPolicy;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the Docker configuration with the builder will be used.
|
||||
* @return docker configuration.
|
||||
*/
|
||||
@Input
|
||||
@Optional
|
||||
public Docker getDocker() {
|
||||
return this.docker;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the Docker configuration with the builder will be used.
|
||||
* @param docker docker configuration.
|
||||
*/
|
||||
@Option(option = "docker", description = "The Docker configuration to use")
|
||||
public void setDocker(Docker docker) {
|
||||
this.docker = docker;
|
||||
}
|
||||
|
||||
@TaskAction
|
||||
void buildImage() throws DockerEngineException, IOException {
|
||||
Builder builder = new Builder();
|
||||
DockerConfiguration dockerConfiguration = (this.docker != null) ? this.docker.getDockerConfiguration()
|
||||
: new DockerConfiguration();
|
||||
|
||||
Builder builder = new Builder(dockerConfiguration);
|
||||
BuildRequest request = createRequest();
|
||||
builder.build(request);
|
||||
}
|
||||
|
||||
@@ -0,0 +1,53 @@
|
||||
/*
|
||||
* Copyright 2012-2020 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.boot.gradle.tasks.bundling;
|
||||
|
||||
import org.springframework.boot.buildpack.platform.docker.configuration.DockerConfiguration;
|
||||
import org.springframework.boot.buildpack.platform.docker.configuration.DockerRegistryConfiguration;
|
||||
|
||||
/**
|
||||
* Docker configuration options.
|
||||
*
|
||||
* @author Wei Jiang
|
||||
* @since 2.4.0
|
||||
*/
|
||||
public class Docker {
|
||||
|
||||
/**
|
||||
* The docker registry configuration.
|
||||
*/
|
||||
private DockerRegistry registry;
|
||||
|
||||
public DockerRegistry getRegistry() {
|
||||
return this.registry;
|
||||
}
|
||||
|
||||
public void setRegistry(DockerRegistry registry) {
|
||||
this.registry = registry;
|
||||
}
|
||||
|
||||
public DockerConfiguration getDockerConfiguration() {
|
||||
DockerRegistryConfiguration dockerRegistryConfiguration = null;
|
||||
|
||||
if (this.registry != null) {
|
||||
dockerRegistryConfiguration = this.registry.getDockerRegistryConfiguration();
|
||||
}
|
||||
|
||||
return new DockerConfiguration(dockerRegistryConfiguration);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,98 @@
|
||||
/*
|
||||
* Copyright 2012-2020 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.boot.gradle.tasks.bundling;
|
||||
|
||||
import org.springframework.boot.buildpack.platform.docker.configuration.DockerRegistryConfiguration;
|
||||
|
||||
/**
|
||||
* Docker registry configuration options.
|
||||
*
|
||||
* @author Wei Jiang
|
||||
* @since 2.4.0
|
||||
*/
|
||||
public class DockerRegistry {
|
||||
|
||||
/**
|
||||
* Docker registry server address.
|
||||
*/
|
||||
private String url;
|
||||
|
||||
/**
|
||||
* Docker registry authentication username.
|
||||
*/
|
||||
private String username;
|
||||
|
||||
/**
|
||||
* Docker registry authentication password.
|
||||
*/
|
||||
private String password;
|
||||
|
||||
/**
|
||||
* Docker registry authentication email.
|
||||
*/
|
||||
private String email;
|
||||
|
||||
/**
|
||||
* Docker registry authentication identity token.
|
||||
*/
|
||||
private String token;
|
||||
|
||||
public String getUrl() {
|
||||
return this.url;
|
||||
}
|
||||
|
||||
public void setUrl(String url) {
|
||||
this.url = url;
|
||||
}
|
||||
|
||||
public String getUsername() {
|
||||
return this.username;
|
||||
}
|
||||
|
||||
public void setUsername(String username) {
|
||||
this.username = username;
|
||||
}
|
||||
|
||||
public String getPassword() {
|
||||
return this.password;
|
||||
}
|
||||
|
||||
public void setPassword(String password) {
|
||||
this.password = password;
|
||||
}
|
||||
|
||||
public String getEmail() {
|
||||
return this.email;
|
||||
}
|
||||
|
||||
public void setEmail(String email) {
|
||||
this.email = email;
|
||||
}
|
||||
|
||||
public String getToken() {
|
||||
return this.token;
|
||||
}
|
||||
|
||||
public void setToken(String token) {
|
||||
this.token = token;
|
||||
}
|
||||
|
||||
public DockerRegistryConfiguration getDockerRegistryConfiguration() {
|
||||
return new DockerRegistryConfiguration(this.url, this.username, this.password, this.email, this.token);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,47 @@
|
||||
/*
|
||||
* Copyright 2012-2020 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.boot.gradle.tasks.bundling;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import org.springframework.boot.buildpack.platform.docker.configuration.DockerRegistryConfiguration;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
/**
|
||||
* Tests for {@link DockerRegistry}.
|
||||
*
|
||||
* @author Wei Jiang
|
||||
*/
|
||||
public class DockerRegistryTests {
|
||||
|
||||
@Test
|
||||
void getDockerRegistryConfiguration() {
|
||||
DockerRegistry dockerRegistry = new DockerRegistry();
|
||||
dockerRegistry.setUsername("username");
|
||||
dockerRegistry.setPassword("password");
|
||||
dockerRegistry.setEmail("mock@spring.com");
|
||||
dockerRegistry.setUrl("http://mock.docker.registry");
|
||||
DockerRegistryConfiguration dockerRegistryConfiguration = dockerRegistry.getDockerRegistryConfiguration();
|
||||
assertThat(dockerRegistryConfiguration).isNotNull();
|
||||
assertThat(dockerRegistryConfiguration.getUsername()).isEqualTo(dockerRegistry.getUsername());
|
||||
assertThat(dockerRegistryConfiguration.getPassword()).isEqualTo(dockerRegistry.getPassword());
|
||||
assertThat(dockerRegistryConfiguration.getEmail()).isEqualTo(dockerRegistry.getEmail());
|
||||
assertThat(dockerRegistryConfiguration.getUrl()).isEqualTo(dockerRegistry.getUrl());
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user