The plugin can create an https://github.com/opencontainers/image-spec[OCI image] from executable jars using https://buildpacks.io[Cloud Native Buildpacks].
Images can be built using the `bootBuildImage` task and a local Docker installation.
The task is automatically created when the `java` plugin is applied and is an instance of {boot-build-image-javadoc}[`BootBuildImage`].
[[build-image-customization]]
=== Image Customizations
The plugin invokes a {buildpacks-reference}/concepts/components/builder/[builder] to orchestrate the generation of an image.
The builder includes multiple {buildpacks-reference}/concepts/components/buildpack[buildpacks] that can inspect the application to influence the generated image.
By default, the plugin chooses a builder image.
The name of the generated image is deduced from project properties.
Task properties can be used to configure how the builder should operate on the project.
The following table summarizes the available properties and their default values:
|===
| Property | Description | Default value
| `builder`
| Name of the Builder image to use.
| `cloudfoundry/cnb:0.0.43-bionic`
| `imageName`
| {spring-boot-api}/buildpack/platform/docker/type/ImageReference.html#of-java.lang.String-[Image name] for the generated image.
The example above assumes that the builder defines a `BP_JAVA_VERSION` property (typically used to customize the JDK version the image should use).
[[build-image-example-custom-image-name]]
==== Custom Image Name
By default, the image name is inferred from the `artifactId` and the `version` of the project, something like `docker.io/library/${project.artifactId}:${project.version}`.
You can take control over the name by setting task properties, as shown in the following example:
The plugin can create https://github.com/opencontainers/image-spec[OCI images] using a https://buildpacks.io/[buildpack].
The plugin can create an https://github.com/opencontainers/image-spec[OCI image] using https://buildpacks.io/[Cloud Native Buildpacks].
Images can be built using the `build-image` goal and a local Docker installation.
Images can be built using the `build-image` goal and a local Docker installation.
The easiest way to get started is to to invoke `mvn spring-boot:build-image` on a project.
The easiest way to get started is to to invoke `mvn spring-boot:build-image` on a project.
@ -14,7 +14,7 @@ It is possible to automate the creation of an image whenever the `package` phase
<plugin>
<plugin>
<groupId>org.springframework.boot</groupId>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<artifactId>spring-boot-maven-plugin</artifactId>
<version>{version}</version>
<version>{gradle-project-version}</version>
<executions>
<executions>
<execution>
<execution>
<goals>
<goals>
@ -32,7 +32,11 @@ When the `build-image` repackages the application, it applies the same settings
[[build-image-customization]]
[[build-image-customization]]
=== Image Customizations
=== Image Customizations
By default, the image is built using the `cloudfoundry/cnb:0.0.43-bionic` builder and its name is deduced from the `artifactId` of the project.
The plugin invokes a {buildpacks-reference}/concepts/components/builder/[builder] to orchestrate the generation of an image.
The builder includes multiple {buildpacks-reference}/concepts/components/buildpack[buildpacks] that can inspect the application to influence the generated image.
By default, the plugin chooses a builder image.
The name of the generated image is deduced from project properties.
The `image` parameter allows to configure how the builder should operate on the project.
The `image` parameter allows to configure how the builder should operate on the project.
The following table summarizes the available properties and their default values:
The following table summarizes the available properties and their default values:
@ -40,15 +44,15 @@ The following table summarizes the available properties and their default values
| Property | Description | Default value
| Property | Description | Default value
| `builder`
| `builder`
| {buildpacks-reference}/concepts/components/builder/[Builder image] name to use.
| Environment properties that should be passed to the builder.
| Environment variables that should be passed to the builder.
|
|
| `cleanCache`
| `cleanCache`
@ -56,7 +60,7 @@ The following table summarizes the available properties and their default values
| `false`
| `false`
| `verboseLogging`
| `verboseLogging`
| Whether verbose logging is required.
| Enables verbose logging of builder operations.
| `false`
| `false`
|===
|===
@ -81,7 +85,7 @@ If you need to customize the builder used to create the image, configure yours a
<plugin>
<plugin>
<groupId>org.springframework.boot</groupId>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<artifactId>spring-boot-maven-plugin</artifactId>
<version>{version}</version>
<version>{gradle-project-version}</version>
<configuration>
<configuration>
<image>
<image>
<builder>mine/java-cnb-builder</builder>
<builder>mine/java-cnb-builder</builder>
@ -93,7 +97,7 @@ If you need to customize the builder used to create the image, configure yours a
</project>
</project>
----
----
This configuration will use the `latest` version of the `mine/java-cnb-builder` builder.
This configuration will use a builder image with the name `mine/java-cnb-builder` and the tag `latest`.
If the builder exposes configuration options, those can be set using the `env` attributes, as shown in the following example:
If the builder exposes configuration options, those can be set using the `env` attributes, as shown in the following example:
@ -105,7 +109,7 @@ If the builder exposes configuration options, those can be set using the `env` a
<plugin>
<plugin>
<groupId>org.springframework.boot</groupId>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<artifactId>spring-boot-maven-plugin</artifactId>
<version>{version}</version>
<version>{gradle-project-version}</version>
<configuration>
<configuration>
<image>
<image>
<builder>mine/java-cnb-builder</builder>
<builder>mine/java-cnb-builder</builder>
@ -126,7 +130,7 @@ The example above assumes that `mine/java-cnb-builder` defines a `BP_JAVA_VERSIO
[[build-image-example-custom-image-name]]
[[build-image-example-custom-image-name]]
==== Custom Image Name
==== Custom Image Name
By default, the image name is inferred from the `artifactId` and the `version` of the project, something like `docker.io/library/${project.artifactId}:{project.version}`.
By default, the image name is inferred from the `artifactId` and the `version` of the project, something like `docker.io/library/${project.artifactId}:${project.version}`.
You can take control over the name, as shown in the following example:
You can take control over the name, as shown in the following example:
[source,xml,indent=0,subs="verbatim,attributes"]
[source,xml,indent=0,subs="verbatim,attributes"]
@ -137,7 +141,7 @@ You can take control over the name, as shown in the following example:
Scott Frederick
5 years ago