Experimental support for layered images #719
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
oracle-contributor-agreement
bot
added
the
OCA Verified
This commit introduces a Gradle DSL to support layered images creation.
As of now, this is mainly aimed towards a single use case which is incremental builds.
The test project demonstrates how to use the DSL to create a base layer which includes
the JDK "java.base" module as well as all external dependencies used by the project.
The DSL builds on top of the binaries concept, by allowing them to declare either
that they produce a layer, or that they use one or more layers. The DSL contains
methods to make it easier to declare use or creation, as well as supports an easy
way to declare that a layer should use only external dependencies. For example,
this is how you would create a base layer and consume it from the main binary:
```
graalvmNative {
binaries {
libdependencies {
createLayer {
modules = ["java.base"]
jars.from(externalDependenciesOf(configurations.runtimeClasspath))
}
}
main {
useLayer("libdependencies")
}
}
}
```
Note that there is a _binary_ named `libdependencies`, and as soon
as the `createLayer` is called, it will offer additional options which are
specific to layers (for example declaring the list of packages or modules).
The DSL to create a layer contains the `packages` option, which could be
used with automatic extraction of package names, which is why there is
code to extract packages from jars, however, this code is currently
unused for a reason: these packages can contain dependencies to "optional"
modules, which cannot be figured out at build time. Typically, logback
will support additional modules and load them dynamically, and if the
package is included in the list and that the supporting dependencies
are not on classpath, then the layer creation would fail. Therefore,
the only reliable option right now is to use the `jars` property to
set the list of jars which should belong to the layer.
Windows uses the argFile by default, which highlighted a bug: the arg file was written in the output directory, which was cleaned before running the task (cleaning is necessary or we'd have stale files and up-to-date checking would be broken). The arg file is now written in the temp directory instead.
melix
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit introduces a Gradle DSL to support layered images creation. As of now, this is mainly aimed towards a single use case which is incremental builds. The test project demonstrates how to use the DSL to create a base layer which includes the JDK "java.base" module as well as all external dependencies used by the project.
The DSL builds on top of the binaries concept, by allowing them to declare either that they produce a layer, or that they use one or more layers. The DSL contains methods to make it easier to declare use or creation, as well as supports an easy way to declare that a layer should use only external dependencies. For example, this is how you would create a base layer and consume it from the main binary:
Note that there is a binary named
libdependencies, and as soon as thecreateLayeris called, it will offer additional options which are specific to layers (for example declaring the list of packages or modules).The DSL to create a layer contains the
packagesoption, which could be used with automatic extraction of package names, which is why there is code to extract packages from jars, however, this code is currently unused for a reason: these packages can contain dependencies to "optional" modules, which cannot be figured out at build time. Typically, logback will support additional modules and load them dynamically, and if the package is included in the list and that the supporting dependencies are not on classpath, then the layer creation would fail. Therefore, the only reliable option right now is to use thejarsproperty to set the list of jars which should belong to the layer.