Permalink
Find file
619 lines (535 sloc) 36.3 KB

ChangeLog

  • 0.20.0 (2017-02-17)
    • Removed build-nofork and source-nofork in favor for a more direct solution which prevents forking of the lifecycle. Please refer the documentation, chapter "Assembly" for more information about this.

The experimental goals build-nofork and source-nofork have been removed again. Please use build and source directly when binding to execution phases.

  • 0.19.1 (2017-02-09)

    • Fix handling of run commands from properties (#684)
    • Fix empty <link> causing NullPointerException (#693)
  • 0.19.0 (2017-01-03)

    • Better log message when waiting for URL (#640)
    • Extended authentication for AWS ECR (#663)
    • Add two new goals: "volume-create" and "volume-remove" for volume handling independent of images.
    • Support for loading from an tar archive (option <build><dockerArchive>) (#645)
    • Support when both dockerFileDir and dockerFile are set and dockerFile is a relative path (#624)
    • Fix concurrency issue when writing into log files (#652)
    • Support any Docker build options (#666)
  • 0.18.1 (2016-11-17)

    • Renamed basedir and exportBasedir in an <assembly> configuration to targetDir and exportTargetDir since this better reflects the purpose, i.e. the target in the Docker image to which the assembly is copied. The old name is still recognized but deprecated.
    • Fix issue with log statements which use a single argument form
    • Fix bug in HTTP wait configuration when using an external property handler (#613)
    • Fix NPE for "docker:log" when the container to log has already been stopped (#612)
    • Allow a protocol (tcp/udp) for the specification of a port (#610)

The following variables in the assembly configuration has been renamed for consistencies sake:

  • basedir --> targetDir
  • exportBasedir --> exportTargetDir

The old variable names are still accepted but will be removed for release 1.0

  • 0.17.2 (2016-11-3)

    • Fix issues with an empty Docker config file
  • 0.17.1 (2016-10-28)

    • Add initial Docker compose support (#384)
    • Made docker:run running in the foreground
    • Add lifecycle fork to package for docker:build and docker:source for ease of use. Introduced docker:build-nofork and docker:source-nofork
    • Removed lifecycle forks for all other Mojos (#567) (#599)
    • Add new option tarLongFileMode for the assembly configuration to avoid warning for too long files (#591)
    • Add new option tmpfs for <run> to add mount pathes for temorary file systems (#455)
    • Changed docker.image to docker.filter and <image> to <filter>.

For 0.17 the lifecycle handling of the plugins has changed slightly. All forks to the initialize phase have been removed since they collide with certain setups. Instead a fork to the package phase has been introduced for docker:build and docker:source to make it easier for them to be consumed on the commandline (because otherwise at least package has to be added as goal so that the assembly could be constructed from the artifacts built). If you have these goals bound to an <execution> please use build-nofork and source-nofork instead, otherwise the package phase will be called twice.

Also the treatment of the Maven property docker.image has changed. This was supposed to be used as a filter which caused a lot of confusion if people accidentally put their Docker image names into this property. Now the property has no special meaning anymore, and you can use docker.filter now for filtering out a specific images to build. For the same reason the top-level configuration element <image> has been renamed to <filter>.

  • 0.16.9 (2016-10-23)

    • Removed (undocumented) property docker.image.name which could be used to be inserted as a %a specifier part in an image name.
    • Fixed exposing of all property and port mappings (#583)
    • Fix concurrency issue on log wait (#596)
    • Add Dockerfile HEALTHCHECK support (#594)
    • Fix writing empty property files (#592)
  • 0.16.8 (2016-10-14)

    • Allow multiple network links per <link> element (#558)
    • Fix startup of dependent containers when using links with specific container ids (#586)
  • 0.16.7 (2016-10-07)

    • Even better logging
  • 0.16.6 (2016-10-07)

    • Fix concurrency issues when doing a watch on logs (#574)
    • Break push with dedicated registry if temporary image tag already exists (#575)
    • Reduce log output for the non color case when pulling images (#568)
    • Add possibility to change colors in log messages
    • Don't print a progressbar when in batch mode (mvn -B) (#564)
    • Add exposedProperty key to change the alias part of the exposed container properties (#557)
  • 0.16.5 (2016-09-27)

    • Refactored Docker connection parameter detection
    • Added a for extended definition of base images (#572)
  • 0.16.4 (2016-09-26)

    • Fix issue with DOCKER_HOST coming from Docker Machine
    • Don't pull a 'scratch' base image (#565)
    • Fix handling when looking up non-existing containers (#566)
  • 0.16.3 (2016-09-22)

    • Add 'allowAllHosts' to ping wait checker (#559)
    • Allow 'stopAllContainers' also as Maven properties (#536)
    • Use alias for stopping containers when naming strategy "alias" is used (#536)
    • New option 'startParallel' for docker:start to speedup execution (#531)
    • Tuned detection of docker host connection parameters to be more extensible
  • 0.16.2 (2016-09-15)

    • Fixed naming of 'buildArgs' for docker:build (was args formerly)
    • Experimental Support for 'Docker for Windows' (#523)
    • Remove versions from custom lifecycle deps (#539)
    • Fix extra new line in logoutput (#538)
  • 0.15.16 (2016-08-03)

    • Run 'stopContainer' in a Future to short circuit extra waiting (#518)
    • Don't pass docker.buildArg values that are empty (#529)
    • Add new implicit generated properties docker.container.<alias>.net.<name>.ip when custom networks are used (#533)
  • 0.15.14 (2016-07-29)

    • Pattern match fix for multiline log output. Related to (#259)
  • 0.15.13 (2016-07-29)

    • Add for running containers in special security contexts (#524)
    • Add support for multiples network aliases (#466)
  • 0.15.12 (2016-07-25)

    • API and documentation updates
  • 0.15.11 (2016-07-20)

    • Invoke the initialize phase before docker goals (#315)
    • Allow images to only be pulled once per build (useful for reactor projects) (#504)
    • Allow retry of pushing a docker image in case of a 500 error (#508)
    • Add "ulimits" to run-configuration (#484)
  • 0.15.10 (2016-07-19)

    • Don't do redirect when waiting on an HTTP port (#499)
    • Removed the container fetch limit of 100 and optimized getting containers by name and image (#513)
  • 0.15.9 (2016-06-28)

    • Fixed issue when target directory does not exist yet (#497)
  • 0.15.8 (2016-06-27)

    • Removed image configuration caching (#495)
    • Fix for tcp wait when used with Docker for Mac (#430)
    • Add warning when assembly is empty when watching a Docker image (#490)
    • Add docker.skip.build, docker.skip.run, docker.skip.push properties and renamed docker.skipTags to docker.skip.tag (#483)
    • Reverted jansi back to version 1.11 because of this issue
    • Add new assembly config options permissions for fine tuning permissions in the docker.tar (#477). Deprecated ignorePermissions in favor of a <permissions>ignore</permissions>
    • Add auto creation of custom networks if the option autoCreateCustomNetwork is set (#482)
    • Support for docker machine added (#481)
  • 0.15.7 (2016-06-09)

    • Add support for '.maven-dockerinclude' for including certain files in plain Dockerfile build (#471)
    • Add support for placeholders in image names.
    • Expose container id as Maven property docker.container.<alias>.id (#412)
    • Fix broken link in documentation (#468)
  • 0.15.4 (2016-06-03)

    • Update dependencies: Apache HttpClient 4.5.2, JMockit 1.23, ...
    • Fix read-only bindings (#462)
    • Add 'shmSize' as option to the build config (#463)
    • Fixed issue with memory and `
  • 0.15.3 (2016-05-27)

    • Add duration information when pulling, building and pushing images (#313)
    • Fixed logging to always use format strings (#457)
    • Allow extended image names (#459)
  • 0.15.2 (2016-05-19)

    • More robust response stream parsing (#436)
    • Add docker.dockerFileDir and docker.dockerFile to the properties configuration provider. (#438)
    • Fix splitting of bind volumes for Windows pathes (#443)
    • Add new build config option user for switching the user at the end of the Dockerfile. docker.user can be used for the properties configuration provider (#441)
    • Include dot dirs when creating the build tar (#446)
    • Fix property handler with wait config but empty tcp wait connection (#451)
  • 0.15.1 (2016-05-03)

    • Fix push / pull progress bar (#91)
    • Allow empty environment variable (#434)
    • Async log request get now their own HTTP client (#344) (#259)
  • 0.15.0 (2016-04-27)

    • Be more conservative when no "warnings" are returned on create (#407)
    • Fix parsing of timestamps with numeric timezone (#410)
    • Validate image names to fit Docker conventions (#423) (#419)
    • Add support for builds args in external Dockerfiles (#334)
    • Move dockerFileDir to topLevel <build> and introduced dockerFile directive build>assembly>dockerFileDir is now deprecated and will be removed.
    • Add new packaging "docker" (build + run), "docker-build" (build only) and "docker-tar" (creating source) (#433)
    • Add docker:run as an alias to docker:start
    • Expose certain container properties also as Maven properties. By default the format is docker.container.<alias>.ip for the internal IP address of container with alias <alias>. (#198)
  • 0.14.2

    • Introduce a mode try for <cleanup> so that an image gets removed if not being still used. This is the default now, which should be close enough to true (except that it won't fail the build when the image couldn't be removed) (#401)
  • 0.14.1

    • First (test) release performed with a fabric8 CD pipeline. No new features.
  • 0.14.0

    • Add support for Docker network and host, bridge and container network modes (#335)
    • Add support for older Maven versions, minimum required version is now 3.0.5 (#290)
    • Update to maven-assembly-plugin 2.6 which fixes issue with line endings on windows (#127)
    • Disabled color output on Windows because ANSI emulation can't be enabled in Maven's sl4j logger which caches system out/err
    • Moved to to fabric8io as GitHub organization which implies also changes in the maven coordinates (Maven group-id is now io.fabric8)
    • Fix wait section in samples (#385)
    • Add logging configuration to property handler
    • Add support for a logging driver (#379)

With version 0.14.0 this plugin moved to the fabric8 community in order to provide even better services. This include a change in the Maven coordinates. I.e. the Maven group id is now io.fabric8 (formerly: "org.jolokia"). Please adapt your pom files accordingly.

  • 0.13.9

    • Check also registry stored with an https prefix (#367)
    • Don't stop containers not started by the project during parallel reactor builds (#372)
  • 0.13.8

    • Add option nocache to build configuration (#348)
    • Add system property docker.nocache to disable build caching globally (#349)
    • Add support for '.maven-dockerignore' for excluding certain files in plain Dockerfile build (#362)
    • If naming strategy is "alias" stop only the container with the given alias with docker:stop (#359)
    • Fix that containers without d-m-p label where still stopped
    • Add support for OpenShift login (use -DuseOpenShiftAuth for enabling this) (#350)
    • Add support for dedicated pull and push registry configuration respectively (#351)
  • 0.13.7

    • Fix default for "cleanup" in build configuration to true (as documented) (#338)
    • Fix dynamic host property update in port mapping (#323)
    • New goal 'docker:source' for attaching a Docker tar archive to the Maven project with an classifier "docker-" (#311)
    • Be more careful with chowning the user when is used in an assembly (#336)
    • Move VOLUME to the end of the Dockerfile to allow initialization via RUN commands (#341)
    • Allow multiple configurations with different Docker hosts again (#320)
    • docker:start blocks now only when system property docker.follow is given (#249)
    • docker:stop only stops containers started by this plugin by default (#87)
    • Lookup ~/.docker/config.json for registry credentials as fallback (#147)
  • 0.13.6

    • Don't use user from image when pulling base images (#147)
    • Add a new assembly descriptor reference hawt-app for using assemblies created by hawt-app
  • 0.13.5

    • Improvements for docker:watch (#288)
    • Add parameter kill to <watch> configuration for waiting before sending SIGKILL when stopping containers (#293)
    • Add file for <log> to store the logout put in a file. Use docker.logStdout to show logs nevertheless to stdout (#287)
    • Support watchMode == copy for copying changed assembly files into a running container (#268)
    • Add a target/classpath file to the assembly as classpath for artifact-with-dependencies predefined assembly descriptor (#283)
    • Disable Apache HTTP Client retry in WaitUtil (#297)
  • 0.13.4

    • Support explicit exec arguments for start.cmd and start.entrypoint. (#253)
    • Fix processing of split chunked JSON responses (#259)
    • Fix for default registry handling. Again and again. (#261)
    • Allow runCmds to be compressed into a single command with the build config option optimise. (#263)
    • Proper error message when default timeout is hit while waiting (#274)
    • Add proper error message when docker host URL is malformed (#277)
    • If no wait condition is given in wait continue immediately (#276)
    • Add logic to specify exec commands during postStart and preStop (#272)
    • Fixed docker:watch bug when watching on plain files
  • 0.13.3

    • Allow dangling images to be cleaned up after build (#20)
    • Adapt order of WORKDIR and RUN when building images (#222)
    • Allow 'build' and/or 'run' configuration to be skipped (#207)
    • Refactored to use 'inspect' instead of 'list' for checking the existence of an image (#230)
    • Refactored ApacheHttpClientDelegate to avoid leaking connections (#232)
    • Allow empty build or assembly elements (#214) (#236)
    • Add new configuration parameter 'maxConnections' to allow to specify the number of parallel connections to the Docker Host. Default: 100 (#254)
    • Allow multiple containers of the same image to be linked (#182)
    • HTTP method and status code can be specified when waiting on an HTTP URL (#258)
    • Introduced global portPropertyFile setting (#90)
    • Allow the container's host ip to be bound to a maven property and exported
  • 0.13.2

    • "run" directives can be added to the Dockerfile (#191)
    • Support user information in wait URL (#211)
    • Stop started container in case of an error during startup (#217)
    • Allow linking to external containers (#195)
    • Allow volume mounting from external containers (#73)
  • 0.13.1

    • Allow autoPull to be forced on docker:build and docker:start (#96)
    • Respect username when looking up credentials for a Docker registry (#174)
    • Add "force=1" to push for Fedora/CentOs images allowing to push to docker hub

Note that the default registry has been changed to docker.io as docker hub doesn't use registry.hub.docker.com as the default registry and refused to authenticate against this registry. For backward compatibility reasons registry.hub.docker.com, index.docker.io and docker.io can be used as a server id in ~/.m2/settings.xml for the default credentials for pushing without registry to Docker hub.

  • 0.13.0
    • Add docker:watch (#187)
    • Allow extraHosts IPs to be resolved at runtime (#196)
    • Add workDir as configuration option to <build> (#204)
    • Fix problem with log output and wait (#200)
    • Don't verify SSL server certificates if DOCKER_TLS_VERIFY is not set (#192)
    • For bind path on Windows machines (#188)
    • No 'from' required when using a Dockerfile (#201)
    • Support for LABEL for build and run.

Note that since version 0.13.0 this plugin requires Docker API version v1.17 or later in order to support labels.

The watch feature has changed: Instead of using paramters like docker.watch or docker.watch.interval for docker:start a dedicated docker:watch has been introduced. Also the <run><watch>...</watch></run> configuration has been moved one level up so that <watch> and <run> are on the same level. Please refer to the manual for an in depth explanation of the much enhanced watch functionality.

  • 0.12.0
    • Allow CMD and ENTRYPOINT with shell and exec arguments (#130) (#149)
    • Unix Socket support (#179)
    • Add a new parameter 'skipTags' for avoiding configured tagging of images (#145)
    • Break build if log check or URL check runs into a timeout (#173)

Please note that for consistencies sake <command> has been renamed to <cmd> which contains inner elements to match better the equivalent Dockerfile argument. The update should be trivial and easy to spot since a build will croak immediately.

The old format

<build>
  <command>java -jar /server.jar</command>
</build>

becomes now

<build>
  <cmd>
    <exec>
      <arg>java</arg>
      <arg>-jar</arg>
      <arg>/server.jar</arg>
    </exec>
  </cmd>
</build>

or

<build>
  <cmd>
    <shell>java -jar /server.jar</shell>
  </cmd>
</build>

depending on whether you prefer the exec or shell form.

  • 0.11.5

    • Fix problem with http:// URLs when a CERT path is set
    • Fix warnings when parsing a pull response
    • Add a new parameter 'docker.follow' which makes a docker:start blocking until the CTRL-C is pressed (#176)
    • Add a user parameter to the assembly configuration so that the added files are created for this user
    • Fix problem when creating intermediate archive for collecting assembly files introduced with #139. The container can be now set with "mode" in the assembly configuration with the possible values dir, tar, tgz and zip (#171)
    • Workaround Docker problem when using an implicit registry index.docker.io when no registry is explicitly given.
    • Fixed references to docker hub in documentation (#169)
    • Fixed registry authentication lookup (#146)
  • 0.11.4

    • Fixed documentation for available properties
    • Changed property docker.assembly.exportBase to docker.assembly.exportBaseDir (#164)
    • Changed default behaviour of exportBaseDir (true if no base image used with from, false otherwise)
    • Fix log messages getting cut off in the build (#163)
    • Allow system properties to overwrite dynamic port mapping (#161)
    • Fix for empty authentication when pushing to registries (#102)
    • Added watch mode for images with -Ddocker.watch (#141)
    • Added support for inline assemblies (#157, #158)
    • Add support for variable substitution is environment declarations (#137)
    • Use Tar archive as intermediate container when creating image (#139)
    • Better error handling for Docker errors wrapped in JSON response only (#167)
  • 0.11.3

    • Add support for removeVolumes in docker:stop configuration (#120)
    • Add support for setting a custom maintainer in images (#117)
    • Allow containers to be named using <namingStrategy>alias</namingStrategy> when started (#48)
    • Add new global property 'docker.verbose' for switching verbose image build output (#36)
    • Add support for environment variables specified in a property file (#128)
    • Documentation improvements (#107, #121)
    • Allow to use a dockerFileDir without any assembly
  • 0.11.2

    • Fix maven parse error when specifying restart policy (#99)
    • Allow host names to be used in port bindings (#101)
    • Add support for tagging at build and push time (#104)
    • Use correct output dir during multi-project builds (#97)
    • descriptor and descriptorRef in the assembly configuration are now optional (#66)
    • Fix NPE when filtering enabled during assembly creation (#82)
    • Allow ${project.build.finalName} to be overridden when using a pre-packaged assembly descriptor for artifacts (#111)
  • 0.11.1

    • Add support for binding UDP ports (#83)
    • "Entrypoint" supports now arguments (#84)
    • Fix basedir for multi module projects (#89)
    • Pull base images before building when "autoPull" is switched on (#76, #77, #88)
    • Fix for stopping containers without tag (#86)
  • 0.11.0

    • Add support for binding/exporting containers during startup (#55)
    • Provide better control of the build assembly configuration. In addition, the plugin will now search for assembly descriptors in src/main/docker. This default can be overridden via the global configuration option sourceDirectory.
    • An external Dockerfile can now be specified to build an image.
    • When "creating" containers they get now all host configuration instead of during "start". This is the default behaviour since v1.15 while the older variant where the host configuration is fed into the "start" call is deprecated and will go away.
    • Allow selecting the API version with the configuration "apiVersion". Default and minimum API version is now "v1.15"
    • A registry can be specified as system property docker.registry or environment variable DOCKER_REGISTRY (#26)
    • Add new wait parameter shutdown which allows to specify the amount of time to wait between stopping a container and removing it (#54)

Please note, that the syntax for binding volumes from another container has changed slightly in 0.10.6. See "Volume binding" for details but in short:

<run>
  <volumes>
    <from>data</from>
    <from>fabric8/demo</from>
  </volumes>
....
</run>

becomes

<run>
  <volumes>
    <from>
      <image>data</image>
      <image>fabric8/demo</image>
    </from>
  </volumes>
....
</run>

The syntax for specifying the build assembly configuration has also changed. See "Build Assembly" for details but in short:

<build>
  ...
  <exportDir>/export</exportDir>
  <assemblyDescriptor>src/main/docker/assembly.xml</assemblyDescriptor>
</build>

becomes

<build>
  ...
  <assembly>
    <basedir>/export</basedir>
    <descriptor>assembly.xml</descriptor>
  </assembly>
</build>
  • 0.10.5

    • Add hooks for external configurations
    • Add property based configuration for images (#42)
    • Add new goal docker:logs for showing logs of configured containers (#49)
    • Support for showing logs during docker:start (#8)
    • Use COPY instead of ADD when putting a Maven assembly into the container (#53)
    • If exportDir is / then do not actually export (since it doesn't make much sense) (see #62)
  • 0.10.4

    • Restructured and updated documentation
    • Fixed push issue when using a private registry (#40)
    • Add support for binding to an arbitrary host IP (#39)
  • 0.10.3

    • Added "remove" goal for cleaning up images
    • Allow "stop" also as standalone goal for stopping all managed builds
  • 0.10.2

    • Support for SSL Authentication with Docker 1.3. Plugin will respect DOCKER_CERT_PATH with fallback to ~/.docker/. The plugin configuration certPath can be used, too and has the highest priority.
    • Getting rid of UniRest, using Apache HttpComponents exclusively for contacting the Docker host.
    • Support for linking of containers (see the configuration in the shootout-docker-maven POM) Images can be specified in any order, the plugin takes care of the right startup order when running containers.
    • Support for waiting on a container's log output before continuing

0.9.x Series

Original configuration syntax (as described in the old README)

  • 0.9.12

    • Fixed push issue when using a private registry (#40)
  • 0.9.11

    • Support for SSL Authentication with Docker 1.3. Plugin will respect DOCKER_CERT_PATH with fallback to ~/.docker/. The plugin configuration certPath can be used, too and has the highest priority.