Fork me on GitHub
Built by Maven

buildx:containerfile

Full name:

org.honton.chas:buildx-maven-plugin:0.0.10:containerfile

Description:

Create a Containerfile.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: prepare-package.

Required Parameters

Name Type Since Description
<context> String - Directory containing source content for build
Default value is: ${project.build.directory}/context.
User property is: buildx.context.
<from> String - Base image for subsequent instructions
User property is: buildx.from.

Optional Parameters

Name Type Since Description
<cli> String - image build command line interface
Default value is: docker.
User property is: buildx.cli.
<cmd> ShellOrExecConfig - Default command / parameters for the executing container
<containerFile> String - Build instruction file, relative to context
User property is: buildx.containerFile.
<entrypoint> ShellOrExecConfig - Command that the container executes
<env> Map<String,String> - Map of environment variables that are set when container runs
<expose> List<String> - List of ports that the container will expose
<labels> Map<String,String> - Label to be applied to image
<layers> List<LayerConfig> - File layers to copy from the context into the image file system
<skip> boolean - Skip upgrade
Default value is: false.
User property is: buildx.skip.
<user> String - The User[:Group] that runs inside the container. May be uid or name.
User property is: buildx.user.
<volumes> List<String> - List of locations in the image filesystem where external mounts are expected
<workdir> String - Working directory for the container's process
User property is: buildx.workdir.

Parameter Details

<cli>

image build command line interface
  • Type: String
  • Required: No
  • User Property: buildx.cli
  • Default: docker

<cmd>

Default command / parameters for the executing container

<containerFile>

Build instruction file, relative to context
  • Type: String
  • Required: No
  • User Property: buildx.containerFile

<context>

Directory containing source content for build
  • Type: String
  • Required: Yes
  • User Property: buildx.context
  • Default: ${project.build.directory}/context

<entrypoint>

Command that the container executes

<env>

Map of environment variables that are set when container runs
  • Type: Map<String, String>
  • Required: No

<expose>

List of ports that the container will expose
  • Type: List<String>
  • Required: No

<from>

Base image for subsequent instructions
  • Type: String
  • Required: Yes
  • User Property: buildx.from

<labels>

Label to be applied to image
  • Type: Map<String, String>
  • Required: No

<layers>

File layers to copy from the context into the image file system
  • Type: List<org.honton.chas.buildx.maven.plugin.config.LayerConfig>
  • Required: No

<skip>

Skip upgrade
  • Type: boolean
  • Required: No
  • User Property: buildx.skip
  • Default: false

<user>

The User[:Group] that runs inside the container. May be uid or name.
  • Type: String
  • Required: No
  • User Property: buildx.user

<volumes>

List of locations in the image filesystem where external mounts are expected
  • Type: List<String>
  • Required: No

<workdir>

Working directory for the container's process
  • Type: String
  • Required: No
  • User Property: buildx.workdir