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
```
    - run
```
RunImageConfiguration run
```
    - 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.LogConfiguration extends Object implements Serializable
  
  serialVersionUID:
  
  6896468158396394236L
  - Serialized Fields
    - enabled
```
boolean enabled
```
    - prefix
```
String prefix
```
    - date
```
String date
```
    - color
```
String color
```
    - file
```
String file
```
    - driver
```
LogConfiguration.LogDriver driver
```
- Class org.eclipse.jkube.kit.config.image.LogConfiguration.LogDriver extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
    - opts
```
Map<K,V> opts
```
- Class org.eclipse.jkube.kit.config.image.NetworkConfig extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
    - mode
```
NetworkConfig.Mode mode
```
    - aliases
```
List<E> aliases
```
- Class org.eclipse.jkube.kit.config.image.RestartPolicy extends Object implements Serializable
  
  serialVersionUID:
  
  7192766280075022364L
  - Serialized Fields
    - name
```
String name
```
    - retry
```
int retry
```
- Class org.eclipse.jkube.kit.config.image.RunImageConfiguration extends Object implements Serializable
  
  serialVersionUID:
  
  439009097742935171L
  - Serialized Fields
    - env
```
Map<K,V> env
```
      Environment variables to set when starting the container. key: variable name, value: env value.
    - labels
```
Map<K,V> labels
```
    - envPropertyFile
```
String envPropertyFile
```
      Path to a property file holding environment variables.
    - cmd
```
Arguments cmd
```
      Command to execute in container.
    - domainname
```
String domainname
```
      Container domain name.
    - dependsOn
```
List<E> dependsOn
```
    - entrypoint
```
Arguments entrypoint
```
      Container entry point.
    - hostname
```
String hostname
```
      Container hostname.
    - user
```
String user
```
      Container user.
    - workingDir
```
String workingDir
```
      Working directory.
    - shmSize
```
Long shmSize
```
      Size of /dev/shm in bytes.
    - memory
```
Long memory
```
      Memory in bytes.
    - memorySwap
```
Long memorySwap
```
      Total memory (swap + ram) in bytes, -1 to disable.
    - portPropertyFile
```
String portPropertyFile
```
      Path to a file where the dynamically mapped properties are written to.
    - net
```
String net
```
      For simple network setups. For complex stuff use "network".
    - network
```
NetworkConfig network
```
    - dns
```
List<E> dns
```
    - dnsSearch
```
List<E> dnsSearch
```
    - capAdd
```
List<E> capAdd
```
    - capDrop
```
List<E> capDrop
```
    - securityOpts
```
List<E> securityOpts
```
    - privileged
```
Boolean privileged
```
    - extraHosts
```
List<E> extraHosts
```
    - cpuShares
```
Long cpuShares
```
    - cpus
```
Long cpus
```
    - cpuSet
```
String cpuSet
```
    - ports
```
List<E> ports
```
      Port mapping. Can contain symbolic names in which case dynamic ports are used.
    - containerNamePattern
```
String containerNamePattern
```
      A pattern to define the naming of the container where:
      
      %a for the "alias" mode
      
      %n for the image name
      
      %t for a timestamp
      
      %i for an increasing index of container names
    - exposedPropertyKey
```
String exposedPropertyKey
```
      Property key part used to expose the container ip when running.
    - volumes
```
RunVolumeConfiguration volumes
```
      Mount volumes from the given image's started containers.
    - links
```
List<E> links
```
      Links to other container started.
    - wait
```
WaitConfiguration wait
```
      Configuration for how to wait during startup of the container.
    - tmpfs
```
List<E> tmpfs
```
      Mountpath for tmps.
    - log
```
LogConfiguration log
```
    - restartPolicy
```
RestartPolicy restartPolicy
```
    - ulimits
```
List<E> ulimits
```
    - skip
```
Boolean skip
```
    - imagePullPolicy
```
String imagePullPolicy
```
      Policy for pulling the image to start
    - readOnly
```
Boolean readOnly
```
      Mount the container's root filesystem as read only.
    - autoRemove
```
Boolean autoRemove
```
      Automatically remove the container when it exists.
- Class org.eclipse.jkube.kit.config.image.RunVolumeConfiguration extends Object implements Serializable
  - Serialized Fields
    - from
```
List<E> from
```
      List of images names from where volumes are mounted
    - bind
```
List<E> bind
```
      List of bind parameters for binding/mounting host directories into the container
- Class org.eclipse.jkube.kit.config.image.UlimitConfig extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
    - hard
```
Integer hard
```
    - soft
```
Integer soft
```
- Class org.eclipse.jkube.kit.config.image.WaitConfiguration extends Object implements Serializable
  - Serialized Fields
    - time
```
Integer time
```
    - http
```
WaitConfiguration.HttpConfiguration http
```
    - exec
```
WaitConfiguration.ExecConfiguration exec
```
    - tcp
```
WaitConfiguration.TcpConfiguration tcp
```
    - healthy
```
Boolean healthy
```
    - log
```
String log
```
    - shutdown
```
Integer shutdown
```
    - kill
```
Integer kill
```
    - exit
```
Integer exit
```
- Class org.eclipse.jkube.kit.config.image.WaitConfiguration.ExecConfiguration extends Object implements Serializable
  - Serialized Fields
    - postStart
```
String postStart
```
    - preStop
```
String preStop
```
    - breakOnError
```
boolean breakOnError
```
- Class org.eclipse.jkube.kit.config.image.WaitConfiguration.HttpConfiguration extends Object implements Serializable
  
  serialVersionUID:
  
  -4093004978420554981L
  - Serialized Fields
    - url
```
String url
```
    - method
```
String method
```
    - status
```
String status
```
    - allowAllHosts
```
boolean allowAllHosts
```
- Class org.eclipse.jkube.kit.config.image.WaitConfiguration.TcpConfiguration extends Object implements Serializable
  
  serialVersionUID:
  
  4809023624478231971L
  - Serialized Fields
    - mode
```
WaitConfiguration.TcpConfigMode mode
```
    - host
```
String host
```
    - ports
```
List<E> ports
```
- Class org.eclipse.jkube.kit.config.image.WatchImageConfiguration extends Object implements Serializable
  
  serialVersionUID:
  
  -8837447095092135706L
  - Serialized Fields
    - interval
```
Integer interval
```
    - 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.Arguments extends Object implements Serializable
  
  serialVersionUID:
  
  -7896288279513401758L
  - Serialized Fields
    - shell
```
String shell
```
    - exec
```
List<E> exec
```
    - execInlined
```
List<E> execInlined
```
      Used to distinguish between shorter version
      <cmd> <arg>echo</arg> <arg>Hello, world!</arg> </cmd>
      from the full one
      <cmd> <exec> <arg>echo</arg> <arg>Hello, world!</arg> </exec> </cmd>
      and throw a validation error if both specified.
- Class org.eclipse.jkube.kit.config.image.build.BuildConfiguration extends Object implements Serializable
  
  serialVersionUID:
  
  3904939784596208966L
  - Serialized Fields
    - 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 of the contextDir, if provided with an absolute file path.
    - 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.
    - 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.
    - 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 @…@).
    - 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.
    - 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.
    - maintainer
```
String maintainer
```
      The author (MAINTAINER) field for the generated image
    - 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).
    - shell
```
Arguments shell
```
      Shell to be used for the BuildConfiguration.runCmds. It contains arg elements which are defining the executable and its params.
    - imagePullPolicy
```
String imagePullPolicy
```
      Specific pull policy for the base image. This overrides any global image pull policy.
    - 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.
    - 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
    - nocache
```
Boolean nocache
```
      Don't use Docker’s build cache.
    - 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.
    - 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.
    - 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.
    - env
```
Map<K,V> env
```
      Environment variables.
    - labels
```
Map<K,V> labels
```
      Labels.
    - 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.
    - entryPoint
```
Arguments entryPoint
```
      An entrypoint allows you to configure a container that will run as an executable.
    - workdir
```
String workdir
```
      Directory to change to when starting the container.
    - cmd
```
Arguments cmd
```
      A command to execute by default.
    - user
```
String user
```
      User to which the Dockerfile should switch to the end (corresponds to the USER Dockerfile directive).
    - healthCheck
```
HealthCheckConfiguration healthCheck
```
      Health check configuration.
    - assembly
```
AssemblyConfiguration assembly
```
      Specifies the assembly configuration.
    - skip
```
Boolean skip
```
      If set to true disables building of the image.
    - 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.
    - 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
    - dockerFileFile
```
File dockerFileFile
```
      Path to Dockerfile to use, initialized lazily.
    - dockerArchiveFile
```
File dockerArchiveFile
```
    - cacheFrom
```
List<E> cacheFrom
```
- 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

run

build

watch

external

registry

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

Serialized Fields

enabled

prefix

date

color

file

driver

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

Serialized Fields

name

opts

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

Serialized Fields

name

mode

aliases

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

Serialized Fields

name

retry

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

Serialized Fields

env

labels

envPropertyFile

cmd

domainname

dependsOn

entrypoint

hostname

user

workingDir

shmSize

memory

memorySwap

portPropertyFile

net

network

dns

dnsSearch

capAdd

capDrop

securityOpts

privileged

extraHosts

cpuShares

cpus

cpuSet

ports

containerNamePattern

exposedPropertyKey

volumes

links

wait

tmpfs

log

restartPolicy

ulimits

skip

imagePullPolicy

readOnly

autoRemove

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

Serialized Fields

from

bind

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

Serialized Fields