Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Replace the docker/podman binary by Jib to build the image #546

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Replace the docker/podman binary by Jib to build the image #546

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions plugin/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,18 @@
</build>

<dependencies>
<dependency>
<groupId>com.google.cloud.tools</groupId>
<artifactId>jib-core</artifactId>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-compress</artifactId>
</dependency>
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
</dependency>
<!-- Needed my maven-core -->
<dependency>
<groupId>javax.inject</groupId>
Expand Down
2 changes: 2 additions & 0 deletions plugin/src/main/java/org/wildfly/plugin/common/PropertyNames.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,8 @@ public interface PropertyNames {

String WILDFLY_FEATURE_PACK_LOCATION = "wildfly.feature-pack.location";

String WILDFLY_IMAGE_ARCHS = "wildfly.image.archs";

String WILDFLY_IMAGE_BINARY = "wildfly.image.binary";

String WILDFLY_LAYERS_CONFIGURATION_FILE_NAME = "wildfly.provisioning.layers.configuration.file.name";
Expand Down
217 changes: 93 additions & 124 deletions plugin/src/main/java/org/wildfly/plugin/provision/ApplicationImageMojo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,13 @@
*/
package org.wildfly.plugin.provision;

import static com.google.cloud.tools.jib.api.buildplan.FileEntriesLayer.DEFAULT_MODIFICATION_TIME_PROVIDER;
import static java.lang.String.format;
import static java.lang.String.join;

import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.time.Duration;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
Expand All @@ -33,13 +31,24 @@
import org.wildfly.plugin.common.PropertyNames;
import org.wildfly.plugin.core.Constants;

import com.google.cloud.tools.jib.api.Containerizer;
import com.google.cloud.tools.jib.api.DockerDaemonImage;
import com.google.cloud.tools.jib.api.ImageReference;
import com.google.cloud.tools.jib.api.Jib;
import com.google.cloud.tools.jib.api.JibContainerBuilder;
import com.google.cloud.tools.jib.api.RegistryImage;
import com.google.cloud.tools.jib.api.buildplan.AbsoluteUnixPath;
import com.google.cloud.tools.jib.api.buildplan.FileEntriesLayer;
import com.google.cloud.tools.jib.api.buildplan.FilePermissions;
import com.google.cloud.tools.jib.api.buildplan.FilePermissionsProvider;
import com.google.cloud.tools.jib.api.buildplan.OwnershipProvider;

/**
* Build (and push) an application image containing the provisioned server and the deployment.
* <p>
* The {@code image} goal extends the {@code package} goal, building and pushing the image occurs after the server
* is provisioned and the deployment deployed in it.
* <p>
* The {@code image} goal relies on a Docker binary to execute all image commands (build, login, push).
*
* <p>
* Note that if a WildFly Bootable JAR is packaged, it is ignored when building the image.
Expand All @@ -51,8 +60,6 @@
@SuppressWarnings({ "deprecated", "removal" })
public class ApplicationImageMojo extends PackageServerMojo {

public static final int DOCKER_CMD_CHECK_TIMEOUT = 3000;

/**
* Provides a reference to the settings file.
*/
Expand Down Expand Up @@ -84,10 +91,7 @@ public class ApplicationImageMojo extends PackageServerMojo {
* --&gt;
* &lt;push&gt;true&lt;/push&gt;
*
* &lt;!-- (optional) The binary used to perform image commands (build, login, push) (default is "docker") --&gt;
* &lt;docker-binary&gt;docker&lt;/docker-binary&gt;
*
* &lt;!-- (optional) the JDK version used by the application. Allowed values are "11" and "17". If unspecified, the "latest" tag is used to determine the JDK version used by WildFly runtime image --&gt;
* &lt;!-- (optional) the JDK version used by the application. Allowed values are "11", "17", and "21". If unspecified, the "latest" tag is used to determine the JDK version used by WildFly runtime image --&gt;
* &lt;jdk-version&gt;11&lt;/jdk-version&gt;
*
* &lt;!-- (optional) The group part of the name of the application image --&gt;
Expand Down Expand Up @@ -213,9 +217,23 @@ public class ApplicationImageMojo extends PackageServerMojo {
*
* @since 5.0.1
*/
@Deprecated(forRemoval = true, since = "5.0.2")
@Parameter(alias = "docker-binary", property = PropertyNames.WILDFLY_IMAGE_BINARY)
private String dockerBinary;

/**
* The list of architectures of the images (If not set, it defaults to {@code amd64,arm64}).
*
* Multiple architectures does not work with Docker or Podman.
* To build multiarch images, you must specify a registry and push the image ({@code registry} must be set and {@code push}
* must be true).
* Only `linux` operating system is supported.
*
* @since 5.0.1
*/
@Parameter(alias = "archs", property = PropertyNames.WILDFLY_IMAGE_ARCHS)
private String archs = "amd64,arm64";

/**
* Adds labels to the generated Dockerfile. Each label will be added as a new line with the prefix of {@code LABEL}.
* For example:
Expand Down Expand Up @@ -250,6 +268,11 @@ protected String getGoal() {
return "image";
}

private static final FilePermissionsProvider PERMISSIONS_PROVIDER = (sourcePath, destinationPath) -> FilePermissions
.fromOctalString("775");

private static final OwnershipProvider JBOSS_ROOT_OWNER = (sourcePath, destinationPath) -> "jboss:root";

@Override
public void execute() throws MojoExecutionException, MojoFailureException {
// when the application image is built, the deployment step is skipped.
Expand Down Expand Up @@ -288,80 +311,26 @@ public void execute() throws MojoExecutionException, MojoFailureException {
}

try {
// The Dockerfile is always generated when the image goal is run.
// This allows the user to then use the generated Dockerfile in other contexts than Maven.
String runtimeImage = this.image.getWildFlyRuntimeImage();
getLog().info(format("Generating Dockerfile %s from base image %s",
Paths.get(project.getBuild().getDirectory()).resolve("Dockerfile"),
runtimeImage));
generateDockerfile(runtimeImage, Paths.get(project.getBuild().getDirectory()), provisioningDir);

if (!image.build) {
return;
}
// Check if the binary was set via a property
if (image.dockerBinary == null) {
image.setDockerBinary(project.getProperties().getProperty(PropertyNames.WILDFLY_IMAGE_BINARY,
System.getProperty(PropertyNames.WILDFLY_IMAGE_BINARY)));
}

final String imageBinary = image.getDockerBinary();
if (imageBinary == null) {
throw new MojoExecutionException("Could not locate a binary to build the image with. Please check your " +
"installation and either set the path to the binary in your PATH environment variable or define the " +
"define the fully qualified path in your configuration, <docker-binary>/path/to/docker</docker-binary>. "
+
"The path can also be defined with the -Dwildfly.image.binary=/path/to/docker system property.");
}
if (!isImageBinaryAvailable(imageBinary)) {
throw new MojoExecutionException(
String.format("Unable to build application image with %1$s. Please check your %1$s installation",
imageBinary));
}

String runtimeImage = this.image.getWildFlyRuntimeImage();
String image = this.image.getApplicationImageName(project.getArtifactId());

boolean buildSuccess = buildApplicationImage(image);
Path serverDir = Paths.get(project.getBuild().getDirectory(), provisioningDir);
// FIXME we should continue to support images built with docker/podman
boolean buildSuccess = buildApplicationImageWithJib(image, runtimeImage, archs, serverDir, getDeploymentContent());
if (!buildSuccess) {
throw new MojoExecutionException(String.format("Unable to build application image %s", image));
}
getLog().info(String.format("Successfully built application image %s", image));

if (this.image.push) {
logToRegistry();

boolean pushSuccess = pushApplicationImage(image);
if (!pushSuccess) {
throw new MojoExecutionException(String.format("Unable to push application image %s", image));
}
getLog().info(String.format("Successfully pushed application image %s", image));
}
} catch (IOException e) {
throw new MojoExecutionException(e.getLocalizedMessage(), e);
}
}

private void logToRegistry() throws MojoExecutionException {
String registry = image.registry;
if (registry == null) {
getLog().info(String.format("Registry was not set. Using default for %s.", image.getDockerBinary()));
}
if (image.user != null && image.password != null) {
String[] dockerArgs = new String[] {
"login", registry,
"-u", image.user,
"-p", image.password
};
boolean loginSuccessful = ExecUtil.exec(getLog(), image.getDockerBinary(), dockerArgs);
if (!loginSuccessful) {
throw new MojoExecutionException(
String.format("Could not log to the container registry with the command: %s login %s -u %s -p *****",
image.getDockerBinary(), registry, image.user));
}
}
}

private boolean buildApplicationImage(String image) throws IOException {
private boolean buildApplicationImageWithDocker(String image) throws IOException {
getLog().info(format("Building application image %s using %s.", image, this.image.getDockerBinary()));
String[] dockerArgs = new String[] { "build", "-t", image, "." };

Expand All @@ -372,70 +341,70 @@ private boolean buildApplicationImage(String image) throws IOException {

}

private boolean pushApplicationImage(String image) {
getLog().info(format("Pushing application image %s using %s.", image, this.image.getDockerBinary()));

String[] dockerArgs = new String[] { "push", image };

getLog().info(format("Executing the following command to push application image: '%s %s'", this.image.getDockerBinary(),
join(" ", dockerArgs)));
return ExecUtil.exec(getLog(), Paths.get(project.getBuild().getDirectory()).toFile(), this.image.getDockerBinary(),
dockerArgs);
}

private void generateDockerfile(String runtimeImage, Path targetDir, String wildflyDirectory)
throws IOException, MojoExecutionException {
private boolean buildApplicationImageWithJib(String image, String runtimeImage, String archs, Path wildflyDirectory,
Path deployment)
throws IOException {

Path jbossHome = Path.of(wildflyDirectory);
// Docker requires the source file be relative to the context directory. From the documentation:
// The <src> path must be inside the context of the build; you cannot COPY ../something /something, because
// the first step of a docker build is to send the context directory (and subdirectories) to the docker daemon.
if (jbossHome.isAbsolute()) {
jbossHome = targetDir.relativize(jbossHome);
}
getLog().info(format("Building application image %s.", image));
try {
ImageReference imageRef = ImageReference.parse(image);
Containerizer containerizer;

String targetName = getDeploymentTargetName();
if (push) {
RegistryImage registryImage = RegistryImage.named(image);
if (user != null && password != null) {
registryImage.addCredential(user, password);
}
containerizer = Containerizer.to(registryImage);
} else {
DockerDaemonImage dockerDaemon = DockerDaemonImage.named(imageRef);
containerizer = Containerizer.to(dockerDaemon);
}

// Create the Dockerfile content
final StringBuilder dockerfileContent = new StringBuilder();
dockerfileContent.append("FROM ").append(runtimeImage).append('\n');
if (labels != null) {
labels.forEach(
(key, value) -> dockerfileContent.append("LABEL ").append(key).append("=\"")
.append(value.replace("\"", "\\\"")).append("\"\n"));
}
dockerfileContent.append("COPY --chown=jboss:root ").append(jbossHome).append(" $JBOSS_HOME\n")
.append("RUN chmod -R ug+rwX $JBOSS_HOME\n")
.append("COPY --chown=jboss:root ").append(getDeploymentContent().getFileName())
.append(" $JBOSS_HOME/standalone/deployments/").append(targetName);

final List<String> serverArgs = new ArrayList<>();
if (!layers.isEmpty() && !layersConfigurationFileName.equals(Constants.STANDALONE_XML)) {
serverArgs.add("-c=" + layersConfigurationFileName);
} else if (!serverConfig.equals(Constants.STANDALONE_XML)) {
serverArgs.add("-c=" + serverConfig);
}
FileEntriesLayer serverLayer = FileEntriesLayer.builder()
.setName("wildfly")
.addEntryRecursive(wildflyDirectory, AbsoluteUnixPath.get("/opt/server/"),
PERMISSIONS_PROVIDER,
DEFAULT_MODIFICATION_TIME_PROVIDER,
JBOSS_ROOT_OWNER)
.build();

FileEntriesLayer deploymentLayer = FileEntriesLayer.builder()
.setName("deployment")
.addEntryRecursive(deployment, AbsoluteUnixPath.get("/opt/server/standalone/deployments"),
PERMISSIONS_PROVIDER,
DEFAULT_MODIFICATION_TIME_PROVIDER,
JBOSS_ROOT_OWNER)
.build();

JibContainerBuilder builder = Jib.from(runtimeImage);

final List<String> serverArgs = new ArrayList<>();
if (!layers.isEmpty() && !layersConfigurationFileName.equals(Constants.STANDALONE_XML)) {
serverArgs.add("-c=" + layersConfigurationFileName);
} else if (!serverConfig.equals(Constants.STANDALONE_XML)) {
serverArgs.add("-c=" + serverConfig);
}

if (!serverArgs.isEmpty()) {
dockerfileContent.append('\n').append("ENV SERVER_ARGS=\"").append(String.join(",", serverArgs)).append('"');
}
if (!serverArgs.isEmpty()) {
builder.addEnvironmentVariable("SERVER_ARGS", String.join(",", serverArgs));
}

Files.writeString(targetDir.resolve("Dockerfile"), dockerfileContent, StandardCharsets.UTF_8);
}
builder.addFileEntriesLayer(serverLayer)
.addFileEntriesLayer(deploymentLayer)
.setLabels(labels);
if (archs != null) {
for (String arch : archs.split(",")) {
builder.addPlatform(arch.trim(), "linux");
}
}

private boolean isImageBinaryAvailable(String imageBinary) {
try {
if (!ExecUtil.execSilentWithTimeout(Duration.ofMillis(DOCKER_CMD_CHECK_TIMEOUT), imageBinary, "-v")) {
builder.containerize(containerizer);

getLog().warn(format("'%1$s -v' returned an error code. Make sure your %1$s binary is correct", imageBinary));
return false;
}
return true;
} catch (Exception e) {
getLog().warn(format("No %s binary found or general error: %s", imageBinary, e));
return false;
throw new IOException(e);
}

return true;
}

private String decrypt(final Server server) {
Expand Down
16 changes: 16 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@

<version.org.eclipse.sisu>0.3.5</version.org.eclipse.sisu>
<version.org.twdata.maven>2.3.1</version.org.twdata.maven>
<version.jib-core>0.27.1</version.jib-core>

<!-- other dependencies -->
<version.com.bernardomg.maven.skins>2.3.2</version.com.bernardomg.maven.skins>
Expand Down Expand Up @@ -235,6 +236,21 @@

<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.cloud.tools</groupId>
<artifactId>jib-core</artifactId>
<version>${version.jib-core}</version>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-compress</artifactId>
<version>1.26.0</version>
</dependency>
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.16.1</version>
</dependency>
<dependency>
<groupId>javax.inject</groupId>
<artifactId>javax.inject</artifactId>
Expand Down
9 changes: 1 addition & 8 deletions tests/standalone-tests/src/test/java/org/wildfly/plugin/provision/ImageTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
import static org.wildfly.plugin.tests.AbstractWildFlyMojoTest.getPomFile;

import java.io.ByteArrayOutputStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.time.Duration;
import java.util.List;
Expand Down Expand Up @@ -38,16 +37,10 @@ public void testBuildImage() throws Exception {
imageMojo.execute();
Path jbossHome = AbstractWildFlyMojoTest.getBaseDir().resolve("target").resolve("image-server");
assertTrue(jbossHome.toFile().exists());
Path dockerFile = AbstractWildFlyMojoTest.getBaseDir().resolve("target").resolve("Dockerfile");
assertTrue(dockerFile.toFile().exists());
List<String> dockerfileLines = Files.readAllLines(dockerFile);
assertLineContains(dockerfileLines, 1, "LABEL description=\"This text illustrates \\");
assertLineContains(dockerfileLines, 2, "that label-values can span multiple lines.\"");
assertLineContains(dockerfileLines, 3, "LABEL quoted.line=\"I have \\\"quoted myself\\\" here.\"");
assertLineContains(dockerfileLines, 4, "LABEL version=\"1.0\"");
final ByteArrayOutputStream stdout = new ByteArrayOutputStream();
assertTrue(ExecUtil.exec(stdout, binary, "inspect", "wildfly-maven-plugin/testing"));
assertEnvironmentUnset(stdout, "SERVER_ARGS=-c=");
// TODO assert labels are set on the stdout
} finally {

exec(binary, "rmi", "wildfly-maven-plugin/testing");
Expand Down