Serialized Form (JKube Kit :: Config

Package org.eclipse.jkube.kit.config.image
- Class org.eclipse.jkube.kit.config.image.ImageConfiguration extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      Change the name which can be useful in long running runs e.g. for updating images when doing updates. Use with caution and only for those circumstances.
    - alias
```
String alias
```
    - build
```
BuildConfiguration build
```
    - watch
```
WatchImageConfiguration watch
```
    - external
```
Map<K,V> external
```
      Override externalConfiguration when defined via special property.
    - registry
```
String registry
```
- Class org.eclipse.jkube.kit.config.image.WatchImageConfiguration extends Object implements Serializable
  
  serialVersionUID:
  
  -8837447095092135706L
  - Serialized Fields
    - interval
```
Integer interval
```
      Interval in milliseconds to check/poll for changes
    - mode
```
WatchMode mode
```
    - postGoal
```
String postGoal
```
    - postExec
```
String postExec
```
Package org.eclipse.jkube.kit.config.image.build
- Class org.eclipse.jkube.kit.config.image.build.BuildConfiguration extends Object implements Serializable
  
  serialVersionUID:
  
  3904939784596208966L
  - Serialized Fields
    - from
```
String from
```
      The base image which should be used for this image.
      If not given this default to busybox:latest and is suitable for a pure data image.
      This field is applicable for all build strategies.
    - fromExt
```
Map<K,V> fromExt
```
      Extended definition for a base image. This field holds a map of defined in key:value format.
      The known keys are:
      
      name: Name of the base image
      
      A provided BuildConfiguration.from takes precedence over the name given here. This tag is useful for extensions of this plugin.
      This field is applicable for all build strategies.
    - ports
```
List<E> ports
```
      The exposed ports which is a list of <port> elements, one for each port to expose. Whitespace is trimmed from each element and empty elements are ignored.
      The format can be either pure numerical (8080) or with the protocol attached (8080/tcp).
      This field is applicable for all build strategies.
    - imagePullPolicy
```
String imagePullPolicy
```
      Specific pull policy for the base image. This overrides any global image pull policy.
      This field is applicable for all build strategies.
    - volumes
```
List<E> volumes
```
      List of <volume%gt; elements to create a container volume. Whitespace is trimmed from each element and empty elements are ignored.
      This field is applicable for all build strategies.
    - tags
```
List<E> tags
```
      List of additional tag elements with which an image is to be tagged after the build. Whitespace is trimmed from each element and empty elements are ignored.
      This field is applicable for all build strategies.
    - env
```
Map<K,V> env
```
      Environment variables.
      This field is applicable for all build strategies.
    - labels
```
Map<K,V> labels
```
      Labels.
      This field is applicable for all build strategies.
    - workdir
```
String workdir
```
      Directory to change to when starting the container.
      This field is applicable for all build strategies.
    - cmd
```
Arguments cmd
```
      A command to execute by default.
      This field is applicable for all build strategies.
    - user
```
String user
```
      User to which the image should switch to the end (corresponds to the USER Dockerfile directive).
      This field is applicable for all build strategies.
    - entryPoint
```
Arguments entryPoint
```
      An entrypoint allows you to configure a container that will run as an executable.
      This field is applicable for all build strategies.
    - assembly
```
AssemblyConfiguration assembly
```
      Specifies the assembly configuration.
      This field is applicable for all build strategies.
    - skip
```
Boolean skip
```
      If set to true disables building of the image.
      This field is applicable for all build strategies.
    - contextDir
```
String contextDir
```
      Path to a directory used for the build's context. You can specify the Dockerfile to use with dockerFile, which by default is the Dockerfile found in the contextDir. The Dockerfile can be also located outside the contextDir, if provided with an absolute file path.
      This field is applicable only for docker build strategy
    - dockerFile
```
String dockerFile
```
      Path to a Dockerfile which also triggers Dockerfile mode. The Docker build context directory is set to contextDir if given. If not the directory by default is the directory in which the Dockerfile is stored.
      This field is applicable only for docker build strategy
    - dockerArchive
```
String dockerArchive
```
      Path to a docker archive to load an image instead of building from scratch. If a dockerArchive is provided, no BuildConfiguration.dockerFile must be given.
      This field is applicable only for docker build strategy
    - filter
```
String filter
```
      Enable and set the delimiters for property replacements.
      By default properties in the format ${..} are replaced with Maven properties. When using a single char like @ then this is used as a delimiter (e.g @…@).
      This field is applicable only for docker build strategy
    - maintainer
```
String maintainer
```
      The author (MAINTAINER) field for the generated image
      This field is applicable only for docker build strategy
    - shell
```
Arguments shell
```
      Shell to be used for the BuildConfiguration.runCmds. It contains arg elements which are defining the executable and its params.
      This field is applicable only for docker build strategy
    - runCmds
```
List<E> runCmds
```
      Commands to be run during the build process.
      It contains <run> elements which are passed to the shell. Whitespace is trimmed from each element and empty elements are ignored.
      The run commands are inserted right after the assembly and after BuildConfiguration.workdir into the Dockerfile.
      This setting is not to be confused with the <run> section for this image which specifies the runtime behaviour when starting containers.
      This field is applicable only for docker build strategy
    - cleanup
```
String cleanup
```
      Cleanup dangling (untagged) images after each build (including any containers created from them)
      
      try: tries to remove the old image but doesn't fail the build if this is not possible
      
      remove: removes old image or fails if it doesn't
      
      none: No cleanup is requested
      
      This field is applicable only for docker build strategy
    - nocache
```
Boolean nocache
```
      Don't use Docker’s build cache.
      This field is applicable only for docker build strategy
    - optimise
```
Boolean optimise
```
      If set to true then it will compress all the BuildConfiguration.runCmds into a single RUN directive so that only one image layer is created.
      This field is applicable only for docker build strategy
    - args
```
Map<K,V> args
```
      Map specifying the value of Docker build args which should be used when building the image with an external Dockerfile which uses build arguments.
      The key-value syntax is the same as when defining Maven properties (or labels or env). This argument is ignored when no external Dockerfile is used.
      This field is applicable only for docker build strategy
    - healthCheck
```
HealthCheckConfiguration healthCheck
```
      Health check configuration.
      This field is applicable only for docker build strategy
    - compression
```
ArchiveCompression compression
```
      The compression mode how the build archive is transmitted to the docker daemon and how docker build archives are attached to this build as sources.
      This field is applicable only for docker build strategy
    - buildOptions
```
Map<K,V> buildOptions
```
      Map specifying the build options to provide to the docker daemon when building the image.
      These options map to the ones listed as query parameters in the Docker Remote API and are restricted to simple options (e.g.: memory, shmsize).
      
      See Also:
      
      Docker Engine API v1.40
      This field is applicable only for docker build strategy
    - createImageOptions
```
Map<K,V> createImageOptions
```
      Map specifying the create image options to provide to the docker daemon when pulling or importing an image.
      These options map to the ones listed as query parameters in the Docker Remote API and are restricted to simple options (e.g.: fromImage, fromSrc, platform).
      
      See Also:
      
      Docker Engine API v1.41
      This field is applicable only for docker build strategy
    - dockerFileFile
```
File dockerFileFile
```
      Path to Dockerfile to use, initialized lazily.
      This field is applicable only for docker build strategy
    - dockerArchiveFile
```
File dockerArchiveFile
```
      Path to archive file passed to docker daemon.
      This field is applicable only for docker build strategy
    - cacheFrom
```
List<E> cacheFrom
```
      Array of images used for build cache resolution.
      This field is applicable only for docker build strategy
- Class org.eclipse.jkube.kit.config.image.build.HealthCheckConfiguration extends Object implements Serializable
  
  serialVersionUID:
  
  3756852848945587001L
  - Serialized Fields
    - mode
```
HealthCheckMode mode
```
    - interval
```
String interval
```
    - timeout
```
String timeout
```
    - startPeriod
```
String startPeriod
```
    - retries
```
Integer retries
```
    - cmd
```
Arguments cmd
```
- Class org.eclipse.jkube.kit.config.image.build.RegistryAuthConfiguration extends Object implements Serializable
  - Serialized Fields
    - push
```
Map<K,V> push
```
    - pull
```
Map<K,V> pull
```
    - username
```
String username
```
    - password
```
String password
```
    - email
```
String email
```
    - authToken
```
String authToken
```

Serialized Form

Package org.eclipse.jkube.kit.config.image

Class org.eclipse.jkube.kit.config.image.ImageConfiguration extends Object implements Serializable

Serialized Fields

name

alias

build

watch

external

registry

Class org.eclipse.jkube.kit.config.image.WatchImageConfiguration extends Object implements Serializable

Serialized Fields

interval

mode

postGoal

postExec

Package org.eclipse.jkube.kit.config.image.build

Class org.eclipse.jkube.kit.config.image.build.BuildConfiguration extends Object implements Serializable

Serialized Fields

from

fromExt

ports

imagePullPolicy

volumes

tags

env

labels

workdir

cmd

user

entryPoint

assembly

skip

contextDir

dockerFile

dockerArchive

filter

maintainer

shell

runCmds

cleanup

nocache

optimise

args

healthCheck

compression

buildOptions

createImageOptions

dockerFileFile

dockerArchiveFile

cacheFrom

Class org.eclipse.jkube.kit.config.image.build.HealthCheckConfiguration extends Object implements Serializable

Serialized Fields

mode

interval

timeout

startPeriod

retries

cmd

Class org.eclipse.jkube.kit.config.image.build.RegistryAuthConfiguration extends Object implements Serializable

Serialized Fields

push

pull

username

password

email

authToken