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

Use EPOCH timestamp as a file modification timestamp when adding libs docker layer #26735

Closed
wants to merge 9 commits into from
Closed

Use EPOCH timestamp as a file modification timestamp when adding libs docker layer #26735

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
cd26ee2
Use Instant.EPOCH when adding libsMainPath layers so if the content o…
fbotis Jul 14, 2022
e4138c1
adding feature flag
fbotis Jul 14, 2022
d677c7e
Set modification time for all the layers to EPOCH if useCurrentTimest…
fbotis Jul 15, 2022
90e8e7e
reverting the container creation time
fbotis Jul 15, 2022
88eb49d
reverting the container creation time
fbotis Jul 15, 2022
c751748
reverting the container creation time
fbotis Jul 15, 2022
acf968e
Updating javadoc on useCurrentTimestampFileModification jib config
fbotis Jul 15, 2022
eab7319
Use Instant.EPOCH when adding docker layers
fbotis Jul 14, 2022
34a5648
Merge branch 'main' of https://github.com/fbotis/quarkus
fbotis Jul 15, 2022
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
15 changes: 15 additions & 0 deletions ...age-jib/deployment/src/main/java/io/quarkus/container/image/jib/deployment/JibConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,4 +217,19 @@ public class JibConfig {
*/
@ConfigItem(defaultValue = "true")
public boolean useCurrentTimestamp;

/**
* Whether to set the modification time (last modified time) of the files put by Jib in the image to the actual
* build time. Otherwise, the modification time will be set to the Unix epoch (00:00:00, January 1st, 1970 in UTC).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should also explain what this does, basically what the effect of turning it off means for layering.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Appending something like the paragraph below?

If the modification time is constant (flag is set to false so Unix epoch is used) across two consecutive builds, the docker layer sha256 digest will be different only if the actual files added by Jib to the docker layer were changed. More exactly, having 2 consecutive builds will generate different docker layers only if the actual content of the files within the docker layer was changed.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏼

*
* If the modification time is constant (flag is set to false so Unix epoch is used) across two consecutive builds,
* the docker layer sha256 digest will be different only if the actual files added by Jib to the docker layer were
* changed. More exactly, having 2 consecutive builds will generate different docker layers only if the actual
* content of the files within the docker layer was changed.
*
* If the current timestamp is used the sha256 digest of the docker layer will always be different even if the
* content of the files didn't change.
*/
@ConfigItem(defaultValue = "true")
public boolean useCurrentTimestampFileModification;
}
21 changes: 11 additions & 10 deletions ...-jib/deployment/src/main/java/io/quarkus/container/image/jib/deployment/JibProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -445,14 +445,15 @@ private JibContainerBuilder createContainerBuilderFromFastJar(String baseJvmImag

try {
Instant now = Instant.now();
Instant modificationTime = jibConfig.useCurrentTimestampFileModification ? now : Instant.EPOCH;

JibContainerBuilder jibContainerBuilder = Jib
.from(toRegistryImage(ImageReference.parse(baseJvmImage), jibConfig.baseRegistryUsername,
jibConfig.baseRegistryPassword));
if (fastChangingLibPaths.isEmpty()) {
// just create a layer with the entire lib structure intact
addLayer(jibContainerBuilder, Collections.singletonList(componentsPath.resolve(JarResultBuildStep.LIB)),
workDirInContainer, "fast-jar-lib", isMutableJar, now);
workDirInContainer, "fast-jar-lib", isMutableJar, modificationTime);
} else {
// we need to manually create each layer
// the idea here is that the fast changing libraries are created in a later layer, thus when they do change,
Expand Down Expand Up @@ -486,15 +487,15 @@ private JibContainerBuilder createContainerBuilderFromFastJar(String baseJvmImag
.resolve(JarResultBuildStep.DEPLOYMENT_LIB);
addLayer(jibContainerBuilder, Collections.singletonList(deploymentPath),
workDirInContainer.resolve(JarResultBuildStep.LIB),
"fast-jar-deployment-libs", true, now);
"fast-jar-deployment-libs", true, modificationTime);
}

AbsoluteUnixPath libsMainPath = workDirInContainer.resolve(JarResultBuildStep.LIB)
.resolve(JarResultBuildStep.MAIN);
addLayer(jibContainerBuilder, nonFastChangingLibPaths, libsMainPath, "fast-jar-normal-libs",
isMutableJar, now);
isMutableJar, modificationTime);
addLayer(jibContainerBuilder, new ArrayList<>(fastChangingLibPaths), libsMainPath, "fast-jar-changing-libs",
isMutableJar, now);
isMutableJar, modificationTime);
}

if (appCDSResult.isPresent()) {
Expand All @@ -512,15 +513,15 @@ private JibContainerBuilder createContainerBuilderFromFastJar(String baseJvmImag
componentsPath.resolve(JarResultBuildStep.QUARKUS_RUN_JAR),
workDirInContainer.resolve(JarResultBuildStep.QUARKUS_RUN_JAR),
isMutableJar ? REMOTE_DEV_FILE_PERMISSIONS : DEFAULT_FILE_PERMISSIONS,
now,
modificationTime,
isMutableJar ? DEFAULT_BASE_IMAGE_USER : "")
.build());
}

addLayer(jibContainerBuilder, Collections.singletonList(componentsPath.resolve(JarResultBuildStep.APP)),
workDirInContainer, "fast-jar-quarkus-app", isMutableJar, now);
workDirInContainer, "fast-jar-quarkus-app", isMutableJar, modificationTime);
addLayer(jibContainerBuilder, Collections.singletonList(componentsPath.resolve(JarResultBuildStep.QUARKUS)),
workDirInContainer, "fast-jar-quarkus", isMutableJar, now);
workDirInContainer, "fast-jar-quarkus", isMutableJar, modificationTime);
if (JibConfig.DEFAULT_WORKING_DIR.equals(jibConfig.workingDirectory)) {
// this layer ensures that the working directory is writeable
// see https://github.com/GoogleContainerTools/jib/issues/1270
Expand All @@ -530,7 +531,7 @@ private JibContainerBuilder createContainerBuilderFromFastJar(String baseJvmImag
Files.createTempDirectory("jib"),
AbsoluteUnixPath.get(jibConfig.workingDirectory),
FilePermissions.DEFAULT_FOLDER_PERMISSIONS,
now, DEFAULT_BASE_IMAGE_USER))
modificationTime, DEFAULT_BASE_IMAGE_USER))
.build());
}
if (isMutableJar) {
Expand All @@ -541,13 +542,13 @@ private JibContainerBuilder createContainerBuilderFromFastJar(String baseJvmImag
Files.createTempDirectory("jib"),
workDirInContainer.resolve("dev"),
REMOTE_DEV_FOLDER_PERMISSIONS,
now, DEFAULT_BASE_IMAGE_USER))
modificationTime, DEFAULT_BASE_IMAGE_USER))
.addEntry(
new FileEntry(
componentsPath.resolve(JarResultBuildStep.QUARKUS_APP_DEPS),
workDirInContainer.resolve(JarResultBuildStep.QUARKUS_APP_DEPS),
REMOTE_DEV_FOLDER_PERMISSIONS,
now, DEFAULT_BASE_IMAGE_USER))
modificationTime, DEFAULT_BASE_IMAGE_USER))
.build());
}

Expand Down