[ { "path": ".circleci/config.yml", "content": "version: 2\n\njobs:\n # Build Website\n doc:\n working_directory: ~/fabric8io/dmp-docs\n docker:\n - image: circleci/node:9-browsers\n steps:\n - checkout\n - run:\n - git config --global user.email \"circleci@fabric8.io\"\n - git config --global user.name \"CircleCI\"\n - run: ./doc/ci-docs.sh\n\n # Run unit tests\n build:\n working_directory: ~/fabric8io/docker-maven-plugin\n docker:\n - image: circleci/openjdk:11\n steps:\n - checkout\n - restore_cache:\n key: dmp-{{ checksum \"pom.xml\" }}\n - run: mvn install -Pjacoco\n - run: bash <(curl -s https://codecov.io/bash)\n - save_cache:\n key: dmp-{{ checksum \"pom.xml\" }}\n paths:\n - ~/.m2\n\n # Run integration tests\n e2e-tests:\n working_directory: ~/fabric8io/docker-maven-plugin\n machine: true\n steps:\n - checkout\n - restore_cache:\n key: dmp-{{ checksum \"pom.xml\" }}\n - run:\n command: |\n mvn clean install -DskipTests\n PROJECT_VERSION=$(mvn -q -Dexec.executable=echo -Dexec.args='${project.version}' --non-recursive exec:exec)\n cd it/\n find . -type f -exec sed -i 's/0.29-SNAPSHOT/'\"$PROJECT_VERSION\"'/g' {} +\n mvn clean install\n - save_cache:\n key: dmp-{{ checksum \"pom.xml\" }}\n paths:\n - ~/.m2\n\n sonar-pr:\n working_directory: ~/fabric8io/dmp-sonar-pr\n docker:\n - image: circleci/openjdk:11\n steps:\n - checkout\n - restore_cache:\n key: dmp-sonar-pr-{{ checksum \"pom.xml\" }}\n - run: |\n if [ -n \"${CIRCLE_PR_NUMBER}\" ]; then\n mvn clean -Pjacoco org.jacoco:jacoco-maven-plugin:prepare-agent package sonar:sonar \\\n -Dsonar.pullrequest.base=master \\\n -Dsonar.pullrequest.branch=${CIRCLE_BRANCH} \\\n -Dsonar.pullrequest.key=${CIRCLE_PR_NUMBER} \\\n -Dsonar.pullrequest.provider=GitHub \\\n -Dsonar.pullrequest.github.repository=fabric8io/docker-maven-plugin \\\n -Dsonar.github.oauth=${GITHUB_COMMENT_TOKEN} \\\n -Dsonar.host.url=https://sonarcloud.io \\\n -Dsonar.organization=default \\\n -Dsonar.login=${SONARQUBE_TOKEN}\n else\n echo \"No Sonar PR analysis as this is not a pull request\"\n fi\n\n - save_cache:\n key: dmp-sonar-pr-{{ checksum \"pom.xml\" }}\n paths:\n - ~/.m2\n\n sonar:\n working_directory: ~/fabric8io/dmp-sonar\n docker:\n - image: circleci/openjdk:11\n steps:\n - checkout\n - restore_cache:\n key: dmp-sonar-{{ checksum \"pom.xml\" }}\n - run: |\n mvn clean -Pjacoco org.jacoco:jacoco-maven-plugin:prepare-agent package sonar:sonar \\\n -Dsonar.host.url=https://sonarcloud.io \\\n -Dsonar.organization=default \\\n -Dsonar.login=${SONARQUBE_TOKEN}\n - save_cache:\n key: dmp-sonar-{{ checksum \"pom.xml\" }}\n paths:\n - ~/.m2\n\nworkflows:\n version: 2\n all:\n jobs:\n - doc:\n filters:\n branches:\n only: dmp.fabric8.io\n - build\n - e2e-tests\n - sonar-pr\n - sonar:\n filters:\n branches:\n only: master\n" }, { "path": ".codecov.yml", "content": "coverage:\n range: \"45...90\"\n precision: 2\n round: down\n status:\n project:\n default:\n threshold: \"2%\"\ncomment:\n layout: \"header, diff, tree, sunburst\"\n require_changes: true\n\n" }, { "path": ".github/ISSUE_TEMPLATE.md", "content": "\n\n### Description\n\n### Info\n\n* d-m-p version :\n* Maven version (`mvn -v`) :\n```\n\n```\n* Docker version :\n* If it's a bug, how to reproduce :\n* If it's a feature request, what is your use case :\n* Sample project : *[GitHub Clone URL]*\n" }, { "path": ".gitignore", "content": ".idea/\n.DS_Store\ntarget/\n*.iml\n.classpath\n.project\n.settings\n.*.md.html\ntemp" }, { "path": ".mvn/jvm.config", "content": "-Xmx2048m -Djava.awt.headless=true -XX:+UseG1GC -XX:+UseStringDeduplication\n" }, { "path": ".mvn/maven.config", "content": "-Dmaven.artifact.threads=8\n" }, { "path": ".mvn/wrapper/maven-wrapper.properties", "content": "distributionUrl=https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.5.4/apache-maven-3.5.4-bin.zip\n" }, { "path": "CONTRIBUTING.md", "content": "## Contributing \n\nYou want to contribute ? Awesome ! We **♥︎♥︎ LOVE ♥︎♥︎** contributions ;-)\n\nHere some things to check out when doing a PR:\n\n* Please sign-off your commits as described below.\n* If adding a new feature please [update the documentation](https://github.com/fabric8io/docker-maven-plugin/blob/master/src/main/asciidoc/), too.\n* Don't forget the unit tests.\n* If adding a new configuration option, don't forget to add this to the [PropertyHandler](https://github.com/fabric8io/docker-maven-plugin/blob/master/src/main/java/io/fabric8/maven/docker/config/handler/property/PropertyConfigHandler.java), too.\n\nHowever, if you can't do some of the points above, please still consider contributing. Simply ask us on `#fabric8` at Freenode or via an GitHub [issue](https://github.com/fabric8io/docker-maven-plugin/issues). We are not dogmatic.\n\n### Signing off your commits\n\nPull requests are highly appreciated and most of them get applied. However, you\nmust sign-off your code so that you certify that your contributions is compatible with the\nlicense of this project (which is the [Apache Public License 2](../LICENSE)). The sign-off also certifies\nthat you wrote it or otherwise have the right to\npass it on as an open-source patch under the APL 2. The rules are simple: if you\ncan certify the below (from\n[developercertificate.org](http://developercertificate.org/)):\n\n```\nDeveloper Certificate of Origin\nVersion 1.1\n\nCopyright (C) 2004, 2006 The Linux Foundation and its contributors.\n660 York Street, Suite 102,\nSan Francisco, CA 94110 USA\n\nEveryone is permitted to copy and distribute verbatim copies of this\nlicense document, but changing it is not allowed.\n\nDeveloper's Certificate of Origin 1.1\n\nBy making a contribution to this project, I certify that:\n\n(a) The contribution was created in whole or in part by me and I\n have the right to submit it under the open source license\n indicated in the file; or\n\n(b) The contribution is based upon previous work that, to the best\n of my knowledge, is covered under an appropriate open source\n license and I have the right under that license to submit that\n work with modifications, whether created in whole or in part\n by me, under the same open source license (unless I am\n permitted to submit under a different license), as indicated\n in the file; or\n\n(c) The contribution was provided directly to me by some other\n person who certified (a), (b) or (c) and I have not modified\n it.\n\n(d) I understand and agree that this project and the contribution\n are public and that a record of the contribution (including all\n personal information I submit with it, including my sign-off) is\n maintained indefinitely and may be redistributed consistent with\n this project or the open source license(s) involved.\n```\n\nthen you just add a line to every git commit message:\n\n Signed-off-by: Joe Smith \n\nwith your real name (first and last name)\n\nIf you set your `user.name` and `user.email` git configs, you can sign your\ncommit automatically with `git commit -s`. If you forgot this you can\nuse `git commit -s --amend` to add this in retrospective for the last commit.\nIf you need to sign-off multiple commits within a branch, you need to do an interactive\nrebase with `git rebase -i`. A nice shortcut for signing off every commit in a branch can\nbe provided with this [alias](http://stackoverflow.com/questions/25570947/how-to-use-git-interactive-rebase-for-signing-off-a-series-of-commits)\nwhich you can put into your `~/.gitconfig`:\n\n````\n[alias]\n # Usage: git signoff-rebase [base-commit]\n signoff-rebase = \"!EDITOR='sed -i -re s/^pick/e/' sh -c 'git rebase -i $1 && while test -f .git/rebase-merge/interactive; do git commit --amend --signoff --no-edit && git rebase --continue; done' -\"\n # Ideally we would use GIT_SEQUENCE_EDITOR in the above instead of EDITOR but that's not supported for git < 1.7.8.\n````\n\nWhen sending pull request we prefer that to be a single commit. So please squash your commits\nwith an interactive rebase before sending the pull request. This is nicely explained [here](https://github.com/edx/edx-platform/wiki/How-to-Rebase-a-Pull-Request).\n\nSaid all this, don't hesitate to ask when there are any problems or you have an issue with this process.\n" }, { "path": "Jenkinsfile", "content": "#!/usr/bin/groovy\n@Library('github.com/fabric8io/fabric8-pipeline-library@master')\ndef dummy\nmavenNode {\n dockerNode {\n checkout scm\n sh \"git remote set-url origin git@github.com:fabric8io/docker-maven-plugin.git\"\n\n def pipeline = load 'release.groovy'\n\n stage 'Stage'\n def stagedProject = pipeline.stage()\n\n stage 'Promote'\n pipeline.release(stagedProject)\n\n }\n}\n" }, { "path": "LICENSE", "content": "Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"{}\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright {yyyy} {name of copyright owner}\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License." }, { "path": "README.md", "content": "# docker-maven-plugin\n\n[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.fabric8/docker-maven-plugin/badge.svg?style=flat)](https://maven-badges.herokuapp.com/maven-central/io.fabric8/docker-maven-plugin/)\n[![Circle CI](https://circleci.com/gh/fabric8io/docker-maven-plugin/tree/master.svg?style=shield)](https://circleci.com/gh/fabric8io/docker-maven-plugin/tree/master)\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=io.fabric8%3Adocker-maven-plugin&metric=coverage)](https://sonarcloud.io/dashboard?id=io.fabric8%3Adocker-maven-plugin)\n[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=io.fabric8%3Adocker-maven-plugin&metric=sqale_index)](https://sonarcloud.io/dashboard?id=io.fabric8%3Adocker-maven-plugin)\n\nThis is a Maven plugin for building Docker images and managing containers for integration tests.\nIt works with Maven 3.0.5 and Docker 1.6.0 or later.\n\n#### Goals\n\n| Goal | Description | Default Lifecycle Phase |\n| ----------------------------------------------------------------------------------------------- | ------------------------------------------------ | ----------------------- |\n| [`docker:start`](https://fabric8io.github.io/docker-maven-plugin/#docker:start) | Create and start containers | pre-integration-test |\n| [`docker:stop`](https://fabric8io.github.io/docker-maven-plugin/#docker:stop) | Stop and destroy containers | post-integration-test |\n| [`docker:build`](https://fabric8io.github.io/docker-maven-plugin/#docker:build) | Build images | install |\n| [`docker:watch`](https://fabric8io.github.io/docker-maven-plugin/#docker:watch) | Watch for doing rebuilds and restarts | |\n| [`docker:push`](https://fabric8io.github.io/docker-maven-plugin/#docker:push) | Push images to a registry | deploy |\n| [`docker:remove`](https://fabric8io.github.io/docker-maven-plugin/#docker:remove) | Remove images from local docker host | post-integration-test |\n| [`docker:logs`](https://fabric8io.github.io/docker-maven-plugin/#docker:logs) | Show container logs | |\n| [`docker:source`](https://fabric8io.github.io/docker-maven-plugin/#docker:source) | Attach docker build archive to Maven project | package |\n| [`docker:save`](https://fabric8io.github.io/docker-maven-plugin/#docker:save) | Save image to a file | |\n| [`docker:volume-create`](https://fabric8io.github.io/docker-maven-plugin/#docker:volume-create) | Create a volume to share data between containers | pre-integration-test |\n| [`docker:volume-remove`](https://fabric8io.github.io/docker-maven-plugin/#docker:volume-remove) | Remove a created volume | post-integration-test |\n\n#### Documentation\n\n* The **[User Manual](https://fabric8io.github.io/docker-maven-plugin)** [[PDF](https://fabric8io.github.io/docker-maven-plugin/docker-maven-plugin.pdf)] has a detailed reference for all and everything.\n* The [Introduction](doc/intro.md) is a high level\n overview of this plugin's features and provides an usage example.\n provided goals and possible configuration parameters.\n* [Examples](doc/examples.md) are below `samples/` and contain example\n setups which you can use as blueprints for your own projects.\n* [ChangeLog](doc/changelog.md) has the release history of this plugin.\n* [Contributing](CONTRIBUTING.md) explains how you can contribute to this project. Pull requests are highly appreciated!\n\n\n#### Docker API Support\n\n* Docker 1.6 (**v1.18**) is the minimal required version\n* Docker 1.8.1 (**v1.20**) is required for `docker:watch`\n* Docker 1.9 (**v1.21**) is required for using custom networks and build args.\n" }, { "path": "doc/changelog.md", "content": "# ChangeLog\n\n* **0.34.0** (2020-09-13)\n - Support `ARG` in `FROM` ([#859](https://github.com/fabric8io/docker-maven-plugin/issues/859))\n - Handle authentication tokens returned from credential helpers ([#1348](https://github.com/fabric8io/docker-maven-plugin/issues/1348))\n - Migrate from joda-time to java.time ([#1025](https://github.com/fabric8io/docker-maven-plugin/issues/1025))\n The handling of Y changes when the week straddle the New year ([Stack Overflow](https://stackoverflow.com/questions/26431882/difference-between-year-of-era-and-week-based-year))\n - Fix JSON error when parsin tafs ([#1354](https://github.com/fabric8io/docker-maven-plugin/issues/1354))\n - Add `skipPush` option to build image configuration ([#1243](https://github.com/fabric8io/docker-maven-plugin/issues/1243))\n - docker.container..ip property is no longer set ([#1242](https://github.com/fabric8io/docker-maven-plugin/issues/1242))\n - Support `squash` in build options to squash newly built layers into a single layer ([#785](https://github.com/fabric8io/docker-maven-plugin/issues/785)) \n - Support for JIB mode([#1277](https://github.com/fabric8io/docker-maven-plugin/pull/1277))\n\n* **0.33.0** (2020-01-21)\n - Update to jnr-unixsocket 0.25 to solve concurrency issues ([#552](https://github.com/fabric8io/docker-maven-plugin/issues/552))\n - Udate ECR AuthorizationToken URL to new endpoint ([#1317](https://github.com/fabric8io/docker-maven-plugin/issues/1317))\n - Allow including `com.amazonaws:aws-java-sdk-core` as plugin dependency to pick up various forms of AWS credentials with which to authenticate at AWS ECR ([#1311](https://github.com/fabric8io/docker-maven-plugin/issues/1311))\n\n* **0.32.0** (2020-01-08)\n - Support building dockerFile without pushing it to docker server ([#1197](https://github.com/fabric8io/docker-maven-plugin/issues/1197))\n - Update to jnr-unixsocket 0.23\n - Add null check for null instance in config.json for email ([#1262](https://github.com/fabric8io/docker-maven-plugin/issues/1262))\n - Allow merging of image configurations using `` ([#1259](https://github.com/fabric8io/docker-maven-plugin/issues/1259))\n - Update to joda-time 2.10.4 ([#706](https://github.com/fabric8io/docker-maven-plugin/issues/706))\n - Add docker:build support for 'network' option ([#1030](https://github.com/fabric8io/docker-maven-plugin/issues/1030))\n - Avoiding chown to reduce the image size ([#544](https://github.com/fabric8io/docker-maven-plugin/issues/544))\n (_Note: Assembly user format `user:user:user` with the third user option has been marked deprecated\n and will not be available in future versions of plugin_)\n - Failure referencing a previous staged image in FROM clause ([#1264](https://github.com/fabric8io/docker-maven-plugin/issues/1264))\n - Treat bridged and default network mode the same ([#1234](https://github.com/fabric8io/docker-maven-plugin/issues/1234))\n - Fix NPE when cacheFrom is missing from config ([#1274](https://github.com/fabric8io/docker-maven-plugin/issues/1274))\n - Fix healthy option regression introduced in 0.25.0 ([#1279](https://github.com/fabric8io/docker-maven-plugin/issues/1279))\n - Allow killing and removing all spawned containers ([#1182](https://github.com/fabric8io/docker-maven-plugin/issues/1182))\n - Deprecated \"authToken\" for ECR authentication in favor of \"auth\" ([#1286](https://github.com/fabric8io/docker-maven-plugin/issues/1286))\n - Allow overriding of existing image in creation of temporary one with same tag before push ([#838](https://github.com/fabric8io/docker-maven-plugin/issues/838))\n - Pick up AWS credentials from ENV variables ([#1310](https://github.com/fabric8io/docker-maven-plugin/issues/1310))\n - Fix accidentally disabled logging under certain conditions ([#1291](https://github.com/fabric8io/docker-maven-plugin/issues/1291))\n - When stopping containers, try harder to remove containers, even if one fails ([#1251](https://github.com/fabric8io/docker-maven-plugin/issues/1251))\n - Added integration tests ([#1209](https://github.com/fabric8io/docker-maven-plugin/issues/1209))\n\n* **0.31.0** (2019-08-10)\n - Fix test cases on Windows ([#1220](https://github.com/fabric8io/docker-maven-plugin/issues/1220))\n - ECR credentials from IAM Task role for ECS Fargate deployment ([#1233](https://github.com/fabric8io/docker-maven-plugin/issues/1233))\n - Fix bug in properties names extracted from docker config json file ([#1237](https://github.com/fabric8io/docker-maven-plugin/issues/1237))\n - Fix that portPropertyFile is not written anymore ([#1112](https://github.com/fabric8io/docker-maven-plugin/issues/1112))\n - Use identity token if found in Docker config.json ([#1249](https://github.com/fabric8io/docker-maven-plugin/issues/1249))\n - Allow also starting with an environment variable in `targetDir` of an aseembly config instead of insisting on only absolute path-names ([#1244](https://github.com/fabric8io/docker-maven-plugin/issues/1244))\n - Support for pattern matching in `docker:stop` and `docker:remove` ([#1215](https://github.com/fabric8io/docker-maven-plugin/issues/1215))\n - Increase interoperability with docker-java by accepting `registry.username` and `registry.password`, too ([#1245](https://github.com/fabric8io/docker-maven-plugin/issues/1245))\n\n* **0.30.0** (2019-04-21)\n - Restore ANSI color to Maven logging if disabled during plugin execution and enable color for Windows with Maven 3.5.0 or later. Color logging is enabled by default, but disabled if the Maven CLI disables color (e.g. in batch mode) ([#1108](https://github.com/fabric8io/docker-maven-plugin/issues/1108))\n - Fix NPE if docker:save is called with -Dfile=file-name-only.tar ([#1203](https://github.com/fabric8io/docker-maven-plugin/issues/1203))\n - Fix NPE in BuildImageConfiguration ([#1200](https://github.com/fabric8io/docker-maven-plugin/issues/1200))\n - Improve GZIP compression performance for docker:save ([#1205](https://github.com/fabric8io/docker-maven-plugin/issues/1205))\n - Allow docker:save to attach image archive as a project artifact ([#1210](https://github.com/fabric8io/docker-maven-plugin/pull/1210))\n - Use pattern to detect image name in archive loaded during build and tag with image name from the project configuration ([#1207](https://github.com/fabric8io/docker-maven-plugin/issues/1207))\n - Add 'cacheFrom' option to specify images to use as cache sources ([#1132](https://github.com/fabric8io/docker-maven-plugin/issues/1132))\n\nRenamed \"nocache\" to \"noCache\" for consistencies reason. \"nocache\" is still supported but deprecated and will be removed in a future version. Same is true for the global system property \"docker.nocache\" which is renamed to \"docker.noCache\" \n\n* **0.29.0** (2019-04-08)\n - Avoid failing docker:save when no images with build configuration are present ([#1185](https://github.com/fabric8io/docker-maven-plugin/issues/1185))\n - Reintroduce minimal API-VERSION parameter in order to support docker versions below apiVersion 1.25\n - docs: Correct default image naming\n - Proxy settings are being ignored ([#1148](https://github.com/fabric8io/docker-maven-plugin/issues/1148))\n - close api version http connection ([#1152](https://github.com/fabric8io/docker-maven-plugin/issues/1152))\n - Log more information when verbose=true ([#917](https://github.com/fabric8io/docker-maven-plugin/issues/917))\n - Obtain container ip address from custom network for tcp/http wait\n - Fix http (SSL) ping with 'allowAllHosts' flag enabled\n - Update to jnr-unixsocket 0.22\n - Enhance @sha256 digest for tags in FROM (image_name:image_tag@sha256) ([#541](https://github.com/fabric8io/docker-maven-plugin/issues/541))\n - Support docker SHELL setting for runCmds ([#1157](https://github.com/fabric8io/docker-maven-plugin/issues/1157))\n - Added 'autoRemove' option for running containers ([#1179](https://github.com/fabric8io/docker-maven-plugin/issues/1179))\n - Added support for AWS EC2 instance roles when pushing to AWS ECR ([#1186](https://github.com/fabric8io/docker-maven-plugin/issues/1186))\n - Introduce `contextDir` configuration option which would be used to specify docker build context ([#1189](https://github.com/fabric8io/docker-maven-plugin/issues/1189))\n - Add support for auto-pulling multiple base image for multi stage builds ([#1057](https://github.com/fabric8io/docker-maven-plugin/issues/1057))\n - Fix usage of credential helper that do not support 'version' command ([#1159](https://github.com/fabric8io/docker-maven-plugin/issues/1159))\n\nPlease note that `dockerFileDir` is now deprecated in favor of `contextDir` which also allows absolute paths to Dockerfile with \n`dockerFile` and it will be removed in 1.0.0. It's still supported in this release but users are suggested to migrate to \n`contextDir` instead.\n \n* **0.28.0** (2018-12-13)\n - Update to JMockit 1.43\n - Compiles with Java 11\n - Update to jnr-unixsocket version to 0.21 ([#1089](https://github.com/fabric8io/docker-maven-plugin/issues/1089))\n - Add 'readOnly' option for docker:run cto mount container's root fs read-only ([#1125](https://github.com/fabric8io/docker-maven-plugin/issues/1125))\n - Provide container properties to the wait configuration execution ([#1111](https://github.com/fabric8io/docker-maven-plugin/issues/1111))\n - Allow @sha256 digest for tags in FROM ([#541](https://github.com/fabric8io/docker-maven-plugin/issues/541))\n\n* **0.27.2** (2018-10-05)\n - Fix NPE regression related to volumes (again) ([#1091](https://github.com/fabric8io/docker-maven-plugin/issues/1091))\n - Fix NPE when stopping containers with autoCreateCustomNetworks ([#1097](https://github.com/fabric8io/docker-maven-plugin/issues/1097))\n - Smarter API version handling ([#1060](https://github.com/fabric8io/docker-maven-plugin/issues/1060))\n - Fix regression when calling the credential helper for authentication, leading to an exception because of the usage of an already shutdown executor service ([#1098](https://github.com/fabric8io/docker-maven-plugin/issues/1098))\n - Add support for CPU configurations with compose ([#1102](https://github.com/fabric8io/docker-maven-plugin/issues/1102))\n\n* **0.27.1** (2018-09-28)\n - Fix NPE when no volume configuration is present ([#1091](https://github.com/fabric8io/docker-maven-plugin/issues/1091))\n - Allow credentialhelper look up the registry without scheme prefix ([#1068](https://github.com/fabric8io/docker-maven-plugin/issues/1068))\n\n* **0.27.0** (2018-09-26)\n - Jump to Java 8 as minimal Java version\n - Fix NPE in docker:remove-volumes when no volume configuration is given ([#1086](https://github.com/fabric8io/docker-maven-plugin/issues/1086))\n - Fix NPE when no networks are configured ([#1055](https://github.com/fabric8io/docker-maven-plugin/issues/1055))\n - Fix Base64 encoding for X-Registry-Auth used for Docker authentication ([#1084](https://github.com/fabric8io/docker-maven-plugin/issues/1084))\n - Fix property configuration based's build detection ([#1078](https://github.com/fabric8io/docker-maven-plugin/issues/1078))\n - Introduce container name patterns for naming containers ([#931](https://github.com/fabric8io/docker-maven-plugin/issues/931))\n - Respect environment variables DOCKER_CONFIG, KUBECONFIG for looking up credentials ([#1083](https://github.com/fabric8io/docker-maven-plugin/issues/1083))\n - Change from org.json with Gson for less restrictive licensing ([#1016](https://github.com/fabric8io/docker-maven-plugin/issues/1016)) ([#1064](https://github.com/fabric8io/docker-maven-plugin/issues/1064))\n - Fix missing actions in a watch restart ([#1070](https://github.com/fabric8io/docker-maven-plugin/issues/1070))\n - Fix for creating volumes with proper configuration during \"docker:start\" ([#986](https://github.com/fabric8io/docker-maven-plugin/issues/986))\n - Fix logging failure on Windows ([#873](https://github.com/fabric8io/docker-maven-plugin/issues/873))\n\n* **0.26.1** (2018-07-20)\n - Simple Dockerfile triggered also when only a single run section is given\n - Sample added for how to use run-java-sh in simple dockerfile mode\n - Allow both cred helpers and auth in Docker config ([#1041](https://github.com/fabric8io/docker-maven-plugin/issues/1041))\n\n* **0.26.0** (2018-05-16)\n - Always create missing target directory for docker:save ([#1013](https://github.com/fabric8io/docker-maven-plugin/issues/1013))\n - d-m-p plugins for adding extra files introduced. See documentation for more information.\n - Update assembly plugin to 3.1.0 ([#1021](https://github.com/fabric8io/docker-maven-plugin/issues/1021))\n - Add option for regenerating certificates after starting Docker Machine ([#1019](https://github.com/fabric8io/docker-maven-plugin/issues/1019))\n - Add `startPeriod` to `healthCheck` ([#961](https://github.com/fabric8io/docker-maven-plugin/issues/961))\n - Unbreak setting of entrypoint in `exec` form when property mode is enabled ([#1020](https://github.com/fabric8io/docker-maven-plugin/issues/1020))\n - Fix enabling of log configuration ([#1010](https://github.com/fabric8io/docker-maven-plugin/issues/1010))\n - Add possibility to use `docker.imagePropertyConfiguration` with multiple images ([#1001](https://github.com/fabric8io/docker-maven-plugin/issues/1001))\n - Fix network aliases management for docker-compose mode ([#1000](https://github.com/fabric8io/docker-maven-plugin/issues/1000))\n\n* **0.25.2** (2018-04-14)\n - Fix for docker login issue with index.docker.io using a credential helper ([#946](https://github.com/fabric8io/docker-maven-plugin/issues/946))\n\n* **0.25.1** (2018-04-12)\n - Fix regression which broke labels and env with space ([#988](https://github.com/fabric8io/docker-maven-plugin/issues/988))\n - Fix and enhanced zero-config Dockerfile mode\n\n* **0.25.0** (2018-04-04)\n - Fix possible NPE when logging to a file and the parent directory does not exist yet ([#911](https://github.com/fabric8io/docker-maven-plugin/issues/911)) ([#940](https://github.com/fabric8io/docker-maven-plugin/issues/940))\n - Change content type to \"application/json\" when talking to the Docker daemon ([#945](https://github.com/fabric8io/docker-maven-plugin/issues/945))\n - PostStart exec breakOnError now fails fast ([#970](https://github.com/fabric8io/docker-maven-plugin/issues/970))\n - Use docker.skip.tag property on push and remove ([#954](https://github.com/fabric8io/docker-maven-plugin/issues/954)) ([#869](https://github.com/fabric8io/docker-maven-plugin/issues/869))\n - Property placeholders are not interpolated when they are the only thing in the XML element value ([#960](https://github.com/fabric8io/docker-maven-plugin/issues/960))\n - Fix deadlock waiting on docker log pattern to match ([#767](https://github.com/fabric8io/docker-maven-plugin/issues/767)) ([#981](https://github.com/fabric8io/docker-maven-plugin/issues/981)) ([#947](https://github.com/fabric8io/docker-maven-plugin/issues/947))\n - Support multiline labels and empty labels ([#968](https://github.com/fabric8io/docker-maven-plugin/issues/968))\n - Handle multi line credential helper responses ([#930](https://github.com/fabric8io/docker-maven-plugin/issues/930))\n - Add support for merging external properties with XML configuration ([#938](https://github.com/fabric8io/docker-maven-plugin/issues/938)) ([#948](https://github.com/fabric8io/docker-maven-plugin/issues/948))\n - Allow to specify different environment variables for run and build via properties ([#386](https://github.com/fabric8io/docker-maven-plugin/issues/386))\n - Add simplified configuration which picks up a plain Dockerfile automatically from `src/main/docker` ([#957](https://github.com/fabric8io/docker-maven-plugin/issues/957))\n\n* **0.24.0** (2018-02-07)\n - Respect system properties for ECR authentication ([#897](https://github.com/fabric8io/docker-maven-plugin/issues/897))\n - Simplified auto pull handling and moved to `imagePullPolicy` instead.\n - Initialize shutdown hook early to allow killing of containers when waiting for a condition ([#921](https://github.com/fabric8io/docker-maven-plugin/issues/921))\n - Fix for including in assembly in archive mode when using a Dockerfile ([#916](https://github.com/fabric8io/docker-maven-plugin/issues/916))\n - Fix for hanging wait on log ([#904](https://github.com/fabric8io/docker-maven-plugin/issues/904))\n - Fix for credential helper which do not return a version ([#896](https://github.com/fabric8io/docker-maven-plugin/issues/896))\n - Also remove tagged images when calling `docker:remove` ([#193](https://github.com/fabric8io/docker-maven-plugin/issues/193))\n - Introduced a `removeMode` for selecting the images to remove\n - Introduced a `breakOnError` for the `postStart` and `preStop` hooks in the\n wait configuration ([#914](https://github.com/fabric8io/docker-maven-plugin/issues/914))\n\nPlease note that `autoPullMode` is deprecated now and the behaviour of the `autoPullMode == always` has been changed slightly so that now, it really always pulls the image from the registry. Also `removeAll` for `docker:remove` is deprecated in favor of `removeMode` (and the default mode has changed slightly). Please refer to the documentation for more information.\n\n* **0.23.0** (2017-11-04)\n - Support relative paths when binding volumes in `docker-compose.yml` ([#846](https://github.com/fabric8io/docker-maven-plugin/issues/846))\n - Allow the session token for AWS authentication to be included in order to allow temporary security credentials provided by the AWS Security Token Service (AWS STS) to sign requests ([#883](https://github.com/fabric8io/docker-maven-plugin/issues/883))\n - Add support for credential helper to authenticate against a registry ([#821](https://github.com/fabric8io/docker-maven-plugin/issues/821))\n - Fix registry auth config in plugin configuration ([#858](https://github.com/fabric8io/docker-maven-plugin/issues/858))\n - Preserve leading whitespace in logs ([#875](https://github.com/fabric8io/docker-maven-plugin/issues/875))\n - Maven property interpolation in Dockerfiles ([#877](https://github.com/fabric8io/docker-maven-plugin/issues/877))\n - Allow parameters for the log prefix ([#890](https://github.com/fabric8io/docker-maven-plugin/issues/890))\n - When removing a volume don't error if the volume does not exist ([#788](https://github.com/fabric8io/docker-maven-plugin/issues/788))\n - Fix warning when COPY and/or ADD with parameters are used ([#884](https://github.com/fabric8io/docker-maven-plugin/issues/884))\n\n* **0.22.1** (2017-08-28)\n - Allow Docker compose version \"2\", too ([#829](https://github.com/fabric8io/docker-maven-plugin/issues/829))\n - Allow a registry to be set programmatically ([#853](https://github.com/fabric8io/docker-maven-plugin/issues/853))\n\n* **0.22.0** (2017-08-24)\n - Fix NPE when detecting cert paths ([#764](https://github.com/fabric8io/docker-maven-plugin/issues/764))\n - Fix `skipDockerMachine` ([#759](https://github.com/fabric8io/docker-maven-plugin/issues/759))\n - Fix property config handler to work also with dockerFile and dockerFileDir ([#790](https://github.com/fabric8io/docker-maven-plugin/issues/790))\n - Fix `dockerFile` option when pointing to another Dockerfile name ([#784](https://github.com/fabric8io/docker-maven-plugin/issues/784))\n - Allow comma separated list of container names in dependsOn elements ([#810](https://github.com/fabric8io/docker-maven-plugin/issues/810))\n - Trim whitespace and ignore empty elements in build configuration ports, runCmds, tags, volumes ([#816](https://github.com/fabric8io/docker-maven-plugin/issues/816))\n - Trim whitespace and ignore empty elements in run configuration ports ([#816](https://github.com/fabric8io/docker-maven-plugin/issues/816))\n - Fix \"useAllReactorProjects\" in assembly ([#812](https://github.com/fabric8io/docker-maven-plugin/issues/812))\n - Add ECDSA support ([#824](https://github.com/fabric8io/docker-maven-plugin/issues/824))\n - Fix test failures when build under Windows ([#834](https://github.com/fabric8io/docker-maven-plugin/issues/834))\n - Update dependencies to latest versions where possible\n\n* **0.21.0** (2017-05-16)\n - Add wait checker for checking the exit code of a container ([#498](https://github.com/fabric8io/docker-maven-plugin/issues/498))\n - Check for exited container when doing wait checks ([#757](https://github.com/fabric8io/docker-maven-plugin/issues/757))\n - New assembly configuration \"name\" for specifying the directory which holds the assembly files ([#634](https://github.com/fabric8io/docker-maven-plugin/issues/634))\n - Add support for property replacement in external Dockerfiles ([#777](https://github.com/fabric8io/docker-maven-plugin/issues/777))\n\nPlease note that now filtering in an external Dockerfiles is switched on by default. This might interfere with Docker build args, so should switch filtering off with `false` in the `` configuration if you have issues with this. See also the Documentation about [Filtering](https://dmp.fabric8.io/#build-filtering) for more Details.\n\n* **0.20.1** (2017-03-29)\n - Tune log output for image names ([#737](https://github.com/fabric8io/docker-maven-plugin/issues/737))\n - Allow image with multiple path segments ([#694](https://github.com/fabric8io/docker-maven-plugin/issues/694))\n - Add support for PKCS#8 private keys in pem.key file. ([#730](https://github.com/fabric8io/docker-maven-plugin/issues/730))\n - Improve resource management for certificates and keys. ([#730](https://github.com/fabric8io/docker-maven-plugin/issues/730))\n - When using properties for configuration only build when `from` or `fromExt` is set ([#736](https://github.com/fabric8io/docker-maven-plugin/issues/736))\n - Add new mojo \"docker:save\" for saving the image to a file ([#687](https://github.com/fabric8io/docker-maven-plugin/issues/687))\n - Check whether a temporary tag could be removed and throw an error if not ([#725](https://github.com/fabric8io/docker-maven-plugin/issues/725))\n - Allow multi line matches in log output ([#628](https://github.com/fabric8io/docker-maven-plugin/issues/628))\n - Add a wait condition on a healthcheck when starting up containers ([#719](https://github.com/fabric8io/docker-maven-plugin/issues/719))\n - Don't use authentication from config when no \"auth\" is set ([#731](https://github.com/fabric8io/docker-maven-plugin/issues/731))\n \n* **0.20.0** (2017-02-17)\n - 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.\n\nThe experimental goals `build-nofork` and `source-nofork` have been removed again. Please use `build` and `source` directly when binding to execution phases.\n\n* **0.19.1** (2017-02-09)\n\n - Fix handling of `run` commands from properties ([#684](https://github.com/fabric8io/docker-maven-plugin/issues/684))\n - Fix empty `` causing `NullPointerException` ([#693](https://github.com/fabric8io/docker-maven-plugin/issues/693))\n\n* **0.19.0** (2017-01-03)\n - Better log message when waiting for URL ([#640](https://github.com/fabric8io/docker-maven-plugin/issues/640))\n - Extended authentication for AWS ECR ([#663](https://github.com/fabric8io/docker-maven-plugin/issues/663))\n - Add two new goals: \"volume-create\" and \"volume-remove\" for volume handling independent of images.\n - Support for loading from an tar archive (option ``) ([#645](https://github.com/fabric8io/docker-maven-plugin/issues/645))\n - Support when both `dockerFileDir` and `dockerFile` are set and `dockerFile` is a relative path ([#624](https://github.com/fabric8io/docker-maven-plugin/issues/624))\n - Fix concurrency issue when writing into log files ([#652](https://github.com/fabric8io/docker-maven-plugin/issues/652))\n - Support any Docker build options ([#666](https://github.com/fabric8io/docker-maven-plugin/issues/666))\n\n* **0.18.1** (2016-11-17)\n - Renamed `basedir` and `exportBasedir` in an `` 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.\n - Fix issue with log statements which use a single argument form\n - Fix bug in HTTP wait configuration when using an external property handler ([#613](https://github.com/fabric8io/docker-maven-plugin/issues/613))\n - Fix NPE for \"docker:log\" when the container to log has already been stopped ([#612](https://github.com/fabric8io/docker-maven-plugin/issues/612))\n - Allow a protocol (tcp/udp) for the specification of a port ([#610](https://github.com/fabric8io/docker-maven-plugin/issues/610))\n\nThe following variables in the assembly configuration has been renamed for consistencies sake:\n\n * `basedir` --> `targetDir`\n * `exportBasedir` --> `exportTargetDir`\n\nThe old variable names are still accepted but will be removed for release 1.0\n\n* **0.17.2** (2016-11-3)\n - Fix issues with an empty Docker config file\n\n* **0.17.1** (2016-10-28)\n - Add initial [Docker compose](https://dmp.fabric8.io/#docker-compose) support ([#384](https://github.com/fabric8io/docker-maven-plugin/issues/384))\n - Made `docker:run` running in the foreground\n - Add lifecycle fork to package for `docker:build` and `docker:source` for ease of use. Introduced `docker:build-nofork` and `docker:source-nofork`\n - Removed lifecycle forks for all other Mojos ([#567](https://github.com/fabric8io/docker-maven-plugin/issues/567)) ([#599](https://github.com/fabric8io/docker-maven-plugin/issues/599))\n - Add new option `tarLongFileMode` for the assembly configuration to avoid warning for too long files ([#591](https://github.com/fabric8io/docker-maven-plugin/issues/591))\n - Add new option `tmpfs` for `` to add mount pathes for temorary file systems ([#455](https://github.com/fabric8io/docker-maven-plugin/issues/455))\n - Changed `docker.image` to `docker.filter` and `` to ``.\n\nFor 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 `` please use `build-nofork` and `source-nofork` instead, otherwise the package phase will be called twice.\n\nAlso 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 `` has been renamed to ``.\n\n* **0.16.9** (2016-10-23)\n - Removed (undocumented) property `docker.image.name` which could be used to be inserted as a `%a` specifier part in an image name.\n - Fixed exposing of all property and port mappings ([#583](https://github.com/fabric8io/docker-maven-plugin/issues/583))\n - Fix concurrency issue on log wait ([#596](https://github.com/fabric8io/docker-maven-plugin/issues/596))\n - Add Dockerfile HEALTHCHECK support ([#594](https://github.com/fabric8io/docker-maven-plugin/issues/594))\n - Fix writing empty property files ([#592](https://github.com/fabric8io/docker-maven-plugin/issues/592))\n\n* **0.16.8** (2016-10-14)\n - Allow multiple network links per `` element ([#558](https://github.com/fabric8io/docker-maven-plugin/issues/558))\n - Fix startup of dependent containers when using links with specific container ids ([#586](https://github.com/fabric8io/docker-maven-plugin/issues/586))\n\n* **0.16.7** (2016-10-07)\n - Even better logging\n\n* **0.16.6** (2016-10-07)\n - Fix concurrency issues when doing a watch on logs ([#574](https://github.com/fabric8io/docker-maven-plugin/issues/574))\n - Break push with dedicated registry if temporary image tag already exists ([#575](https://github.com/fabric8io/docker-maven-plugin/issues/575))\n - Reduce log output for the non color case when pulling images ([#568](https://github.com/fabric8io/docker-maven-plugin/issues/568))\n - Add possibility to change colors in log messages\n - Don't print a progressbar when in batch mode (mvn -B) ([#564](https://github.com/fabric8io/docker-maven-plugin/issues/564))\n - Add `exposedProperty` key to change the alias part of the exposed container properties ([#557](https://github.com/fabric8io/docker-maven-plugin/issues/557))\n\n* **0.16.5** (2016-09-27)\n - Refactored Docker connection parameter detection\n - Added a for extended definition of base images ([#572](https://github.com/fabric8io/docker-maven-plugin/issues/572))\n\n* **0.16.4** (2016-09-26)\n - Fix issue with DOCKER_HOST coming from Docker Machine\n - Don't pull a 'scratch' base image ([#565](https://github.com/fabric8io/docker-maven-plugin/issues/565))\n - Fix handling when looking up non-existing containers ([#566](https://github.com/fabric8io/docker-maven-plugin/issues/566))\n\n* **0.16.3** (2016-09-22)\n - Add 'allowAllHosts' to ping wait checker ([#559](https://github.com/fabric8io/docker-maven-plugin/issues/559))\n - Allow 'stopAllContainers' also as Maven properties ([#536](https://github.com/fabric8io/docker-maven-plugin/issues/536))\n - Use alias for stopping containers when naming strategy \"alias\" is used ([#536](https://github.com/fabric8io/docker-maven-plugin/issues/536))\n - New option 'startParallel' for docker:start to speedup execution ([#531](https://github.com/fabric8io/docker-maven-plugin/issues/531))\n - Tuned detection of docker host connection parameters to be more extensible\n\n* **0.16.2** (2016-09-15)\n - Fixed naming of 'buildArgs' for `docker:build` (was `args` formerly)\n - Experimental Support for 'Docker for Windows' ([#523](https://github.com/fabric8io/docker-maven-plugin/issues/523))\n - Remove versions from custom lifecycle deps ([#539](https://github.com/fabric8io/docker-maven-plugin/issues/539))\n - Fix extra new line in logoutput ([#538](https://github.com/fabric8io/docker-maven-plugin/issues/538))\n\n* **0.15.16** (2016-08-03)\n - Run 'stopContainer' in a Future to short circuit extra waiting ([#518](https://github.com/fabric8io/docker-maven-plugin/issues/518))\n - Don't pass `docker.buildArg` values that are empty ([#529](https://github.com/fabric8io/docker-maven-plugin/issues/529))\n - Add new implicit generated properties `docker.container..net..ip` when custom networks are used ([#533](https://github.com/fabric8io/docker-maven-plugin/issues/533))\n\n* **0.15.14** (2016-07-29)\n - Pattern match fix for multiline log output. Related to ([#259](https://github.com/fabric8io/docker-maven-plugin/issues/259))\n\n* **0.15.13** (2016-07-29)\n - Add for running containers in special security contexts ([#524](https://github.com/fabric8io/docker-maven-plugin/issues/524))\n - Add support for multiples network aliases ([#466](https://github.com/fabric8io/docker-maven-plugin/issues/466))\n\n* **0.15.12** (2016-07-25)\n - API and documentation updates\n\n* **0.15.11** (2016-07-20)\n - Invoke the `initialize` phase before docker goals ([#315](https://github.com/fabric8io/docker-maven-plugin/issues/315))\n - Allow images to only be pulled once per build (useful for reactor projects) ([#504](https://github.com/fabric8io/docker-maven-plugin/issues/504))\n - Allow retry of pushing a docker image in case of a 500 error ([#508](https://github.com/fabric8io/docker-maven-plugin/issues/508))\n - Add \"ulimits\" to run-configuration ([#484](https://github.com/fabric8io/docker-maven-plugin/issues/484))\n\n* **0.15.10** (2016-07-19)\n - Don't do redirect when waiting on an HTTP port ([#499](https://github.com/fabric8io/docker-maven-plugin/issues/499))\n - Removed the container fetch limit of 100 and optimized getting containers by name and image ([#513](https://github.com/fabric8io/docker-maven-plugin/issues/513))\n\n* **0.15.9** (2016-06-28)\n - Fixed issue when target directory does not exist yet ([#497](https://github.com/fabric8io/docker-maven-plugin/issues/497))\n\n* **0.15.8** (2016-06-27)\n - Removed image configuration caching ([#495](https://github.com/fabric8io/docker-maven-plugin/issues/495))\n - Fix for tcp wait when used with Docker for Mac ([#430](https://github.com/fabric8io/docker-maven-plugin/issues/430))\n - Add warning when assembly is empty when watching a Docker image ([#490](https://github.com/fabric8io/docker-maven-plugin/issues/490))\n - Add `docker.skip.build`, `docker.skip.run`, `docker.skip.push` properties and\n renamed `docker.skipTags` to `docker.skip.tag` ([#483](https://github.com/fabric8io/docker-maven-plugin/issues/483))\n - Reverted jansi back to version 1.11 because of [this issue](https://github.com/fusesource/jansi/issues/58)\n - Add new assembly config options `permissions` for fine tuning permissions in the docker.tar ([#477](https://github.com/fabric8io/docker-maven-plugin/issues/477)). Deprecated `ignorePermissions`\n in favor of a `ignore`\n - Add auto creation of custom networks if the option `autoCreateCustomNetwork` is set ([#482](https://github.com/fabric8io/docker-maven-plugin/issues/482))\n - Support for docker machine added ([#481](https://github.com/fabric8io/docker-maven-plugin/issues/481))\n\n* **0.15.7** (2016-06-09)\n - Add support for '.maven-dockerinclude' for including certain files in plain Dockerfile build ([#471](https://github.com/fabric8io/docker-maven-plugin/issues/471))\n - Add support for placeholders in image names.\n - Expose container id as Maven property `docker.container..id` ([#412](https://github.com/fabric8io/docker-maven-plugin/issues/412))\n - Fix broken link in documentation ([#468](https://github.com/fabric8io/docker-maven-plugin/issues/468))\n\n* **0.15.4** (2016-06-03)\n - Update dependencies: Apache HttpClient 4.5.2, JMockit 1.23, ...\n - Fix read-only bindings ([#462](https://github.com/fabric8io/docker-maven-plugin/issues/462))\n - Add 'shmSize' as option to the build config ([#463](https://github.com/fabric8io/docker-maven-plugin/issues/463))\n - Fixed issue with `memory` and `\n\n* **0.15.3** (2016-05-27)\n - Add duration information when pulling, building and pushing images ([#313](https://github.com/fabric8io/docker-maven-plugin/issues/313))\n - Fixed logging to always use format strings ([#457](https://github.com/fabric8io/docker-maven-plugin/issues/457))\n - Allow extended image names ([#459](https://github.com/fabric8io/docker-maven-plugin/issues/459))\n\n* **0.15.2** (2016-05-19)\n - More robust response stream parsing ([#436](https://github.com/fabric8io/docker-maven-plugin/issues/436))\n - Add `docker.dockerFileDir` and `docker.dockerFile` to the properties configuration provider. ([#438](https://github.com/fabric8io/docker-maven-plugin/issues/438))\n - Fix splitting of bind volumes for Windows pathes ([#443](https://github.com/fabric8io/docker-maven-plugin/issues/443))\n - Add new build config option `user` for switching the user at the end of the Dockerfile. `docker.user` can be used\n for the properties configuration provider ([#441](https://github.com/fabric8io/docker-maven-plugin/issues/441))\n - Include dot dirs when creating the build tar ([#446](https://github.com/fabric8io/docker-maven-plugin/issues/446))\n - Fix property handler with wait config but empty tcp wait connection ([#451](https://github.com/fabric8io/docker-maven-plugin/issues/451))\n\n* **0.15.1** (2016-05-03)\n - Fix push / pull progress bar ([#91](https://github.com/fabric8io/docker-maven-plugin/issues/91))\n - Allow empty environment variable ([#434](https://github.com/fabric8io/docker-maven-plugin/issues/434))\n - Async log request get now their own HTTP client ([#344](https://github.com/fabric8io/docker-maven-plugin/issues/344)) ([#259](https://github.com/fabric8io/docker-maven-plugin/issues/259))\n\n* **0.15.0** (2016-04-27)\n - Be more conservative when no \"warnings\" are returned on create ([#407](https://github.com/fabric8io/docker-maven-plugin/issues/407))\n - Fix parsing of timestamps with numeric timezone ([#410](https://github.com/fabric8io/docker-maven-plugin/issues/410))\n - Validate image names to fit Docker conventions ([#423](https://github.com/fabric8io/docker-maven-plugin/issues/423)) ([#419](https://github.com/fabric8io/docker-maven-plugin/issues/419))\n - Add support for builds args in external Dockerfiles ([#334](https://github.com/fabric8io/docker-maven-plugin/issues/334))\n - Move `dockerFileDir` to topLevel `` and introduced `dockerFile` directive\n `build>assembly>dockerFileDir` is now deprecated and will be removed.\n - Add new packaging \"docker\" (build + run), \"docker-build\" (build only) and\n \"docker-tar\" (creating source) ([#433](https://github.com/fabric8io/docker-maven-plugin/issues/433))\n - Add `docker:run` as an alias to `docker:start`\n - Expose certain container properties also as Maven properties. By default\n the format is `docker.container..ip` for the internal IP address of container with alias ``.\n ([#198](https://github.com/fabric8io/docker-maven-plugin/issues/198))\n\n* **0.14.2**\n - Introduce a mode `try` for `` so that an image gets removed if not being still used.\n This is the default now, which should be close enough to `true` (except that it won't fail the build\n when the image couldn't be removed) ([#401](https://github.com/fabric8io/docker-maven-plugin/issues/401))\n\n* **0.14.1**\n - First (test) release performed with a fabric8 CD pipeline. No new features.\n\n* **0.14.0**\n - Add support for Docker network and `host`, `bridge` and `container` network modes ([#335](https://github.com/fabric8io/docker-maven-plugin/issues/335))\n - Add support for older Maven versions, minimum required version is now 3.0.5 ([#290](https://github.com/fabric8io/docker-maven-plugin/issues/290))\n - Update to maven-assembly-plugin 2.6 which fixes issue with line endings on windows ([#127](https://github.com/fabric8io/docker-maven-plugin/issues/127))\n - Disabled color output on Windows because ANSI emulation can't be enabled in Maven's sl4j logger which\n caches system out/err\n - Moved to [fabric8io](https://github.com/orgs/fabric8io/dashboard) as GitHub organization which implies\n also changes in the maven coordinates (Maven group-id is now **io.fabric8**)\n - Fix wait section in samples ([#385](https://github.com/fabric8io/docker-maven-plugin/issues/385))\n - Add logging configuration to property handler\n - Add support for a logging driver ([#379](https://github.com/fabric8io/docker-maven-plugin/issues/379))\n\nWith version `0.14.0` this plugin moved to the [fabric8](http://fabric8.io) community in order to provide\neven better services. This include a change in the Maven coordinates. I.e. the Maven group id is now **io.fabric8**\n(formerly: \"org.jolokia\"). Please adapt your pom files accordingly.\n\n* **0.13.9**\n - Check also registry stored with an `https` prefix ([#367](https://github.com/fabric8io/docker-maven-plugin/issues/367))\n - Don't stop containers not started by the project during parallel reactor builds ([#372](https://github.com/fabric8io/docker-maven-plugin/issues/372))\n\n* **0.13.8**\n - Add option `nocache` to build configuration ([#348](https://github.com/fabric8io/docker-maven-plugin/issues/348))\n - Add system property `docker.nocache` to disable build caching globally ([#349](https://github.com/fabric8io/docker-maven-plugin/issues/349))\n - Add support for '.maven-dockerignore' for excluding certain files in plain Dockerfile build ([#362](https://github.com/fabric8io/docker-maven-plugin/issues/362))\n - If naming strategy is \"alias\" stop only the container with the given alias with `docker:stop` ([#359](https://github.com/fabric8io/docker-maven-plugin/issues/359))\n - Fix that containers without d-m-p label where still stopped\n - Add support for OpenShift login (use `-DuseOpenShiftAuth` for enabling this) ([#350](https://github.com/fabric8io/docker-maven-plugin/issues/350))\n - Add support for dedicated pull and push registry configuration respectively ([#351](https://github.com/fabric8io/docker-maven-plugin/issues/351))\n\n* **0.13.7**\n - Fix default for \"cleanup\" in build configuration to `true` (as documented) ([#338](https://github.com/fabric8io/docker-maven-plugin/issues/338))\n - Fix dynamic host property update in port mapping ([#323](https://github.com/fabric8io/docker-maven-plugin/issues/323))\n - New goal 'docker:source' for attaching a Docker tar archive to the Maven project with an classifier \"docker-\" ([#311](https://github.com/fabric8io/docker-maven-plugin/issues/311))\n - Be more careful with chowning the user when is used in an assembly ([#336](https://github.com/fabric8io/docker-maven-plugin/issues/336))\n - Move VOLUME to the end of the Dockerfile to allow initialization via RUN commands ([#341](https://github.com/fabric8io/docker-maven-plugin/issues/341))\n - Allow multiple configurations with different Docker hosts again ([#320](https://github.com/fabric8io/docker-maven-plugin/issues/320))\n - `docker:start` blocks now only when system property docker.follow is given ([#249](https://github.com/fabric8io/docker-maven-plugin/issues/249))\n - `docker:stop` only stops containers started by this plugin by default ([#87](https://github.com/fabric8io/docker-maven-plugin/issues/87))\n - Lookup `~/.docker/config.json` for registry credentials as fallback ([#147](https://github.com/fabric8io/docker-maven-plugin/issues/147))\n\n* **0.13.6**\n - Don't use user from image when pulling base images ([#147](https://github.com/fabric8io/docker-maven-plugin/issues/147))\n - Add a new assembly descriptor reference `hawt-app` for using assemblies created by\n [hawt-app](https://github.com/fabric8io/fabric8/tree/master/hawt-app-maven-plugin)\n\n* **0.13.5**\n - Improvements for `docker:watch` ([#288](https://github.com/fabric8io/docker-maven-plugin/issues/288))\n - Add parameter `kill` to `` configuration for waiting before\n sending SIGKILL when stopping containers ([#293](https://github.com/fabric8io/docker-maven-plugin/issues/293))\n - Add `file` for `` to store the logout put in a file. Use\n `docker.logStdout` to show logs nevertheless to stdout ([#287](https://github.com/fabric8io/docker-maven-plugin/issues/287))\n - Support `watchMode == copy` for copying changed assembly files\n into a running container ([#268](https://github.com/fabric8io/docker-maven-plugin/issues/268))\n - Add a `target/classpath` file to the assembly as `classpath` for\n `artifact-with-dependencies` predefined assembly descriptor ([#283](https://github.com/fabric8io/docker-maven-plugin/issues/283))\n - Disable Apache HTTP Client retry in WaitUtil ([#297](https://github.com/fabric8io/docker-maven-plugin/issues/297))\n\n* **0.13.4**\n - Support explicit exec arguments for `start.cmd` and\n `start.entrypoint`. ([#253](https://github.com/fabric8io/docker-maven-plugin/issues/253))\n - Fix processing of split chunked JSON responses\n ([#259](https://github.com/fabric8io/docker-maven-plugin/issues/259))\n - Fix for default registry handling. Again and\n again. ([#261](https://github.com/fabric8io/docker-maven-plugin/issues/261))\n - Allow `runCmds` to be compressed into a single command with the\n build config option\n `optimise`. ([#263](https://github.com/fabric8io/docker-maven-plugin/issues/263))\n - Proper error message when default timeout is hit while waiting\n ([#274](https://github.com/fabric8io/docker-maven-plugin/issues/274))\n - Add proper error message when docker host URL is malformed\n ([#277](https://github.com/fabric8io/docker-maven-plugin/issues/277))\n - If no wait condition is given in wait continue immediately\n ([#276](https://github.com/fabric8io/docker-maven-plugin/issues/276))\n - Add logic to specify exec commands during postStart and preStop\n ([#272](https://github.com/fabric8io/docker-maven-plugin/issues/272))\n - Fixed docker:watch bug when watching on plain files\n\n* **0.13.3**\n - Allow dangling images to be cleaned up after build\n ([#20](https://github.com/fabric8io/docker-maven-plugin/issues/20))\n - Adapt order of WORKDIR and RUN when building images\n ([#222](https://github.com/fabric8io/docker-maven-plugin/issues/222))\n - Allow 'build' and/or 'run' configuration to be skipped\n ([#207](https://github.com/fabric8io/docker-maven-plugin/issues/207))\n - Refactored to use 'inspect' instead of 'list' for checking the\n existence of an image\n ([#230](https://github.com/fabric8io/docker-maven-plugin/issues/230))\n - Refactored ApacheHttpClientDelegate to avoid leaking connections\n ([#232](https://github.com/fabric8io/docker-maven-plugin/issues/232))\n - Allow empty `build` or `assembly` elements\n ([#214](https://github.com/fabric8io/docker-maven-plugin/issues/214))\n ([#236](https://github.com/fabric8io/docker-maven-plugin/issues/236))\n - Add new configuration parameter 'maxConnections' to allow to\n specify the number of parallel connections to the Docker\n Host. Default: 100\n ([#254](https://github.com/fabric8io/docker-maven-plugin/issues/254))\n - Allow multiple containers of the same image to be linked\n ([#182](https://github.com/fabric8io/docker-maven-plugin/issues/182))\n - HTTP method and status code can be specified when waiting on an\n HTTP URL\n ([#258](https://github.com/fabric8io/docker-maven-plugin/issues/258))\n - Introduced global `portPropertyFile` setting\n ([#90](https://github.com/fabric8io/docker-maven-plugin/issues/90))\n - Allow the container's host ip to be bound to a maven property and\n exported\n\n* **0.13.2**\n - \"run\" directives can be added to the Dockerfile\n ([#191](https://github.com/fabric8io/docker-maven-plugin/issues/191))\n - Support user information in wait URL\n ([#211](https://github.com/fabric8io/docker-maven-plugin/issues/211))\n - Stop started container in case of an error during startup\n ([#217](https://github.com/fabric8io/docker-maven-plugin/issues/217))\n - Allow linking to external containers\n ([#195](https://github.com/fabric8io/docker-maven-plugin/issues/195))\n - Allow volume mounting from external containers\n ([#73](https://github.com/fabric8io/docker-maven-plugin/issues/73))\n\n* **0.13.1**\n - Allow autoPull to be forced on docker:build and docker:start\n ([#96](https://github.com/fabric8io/docker-maven-plugin/issues/96))\n - Respect username when looking up credentials for a Docker registry\n ([#174](https://github.com/fabric8io/docker-maven-plugin/issues/174))\n - Add \"force=1\" to push for Fedora/CentOs images allowing to push to\n docker hub\n\nNote that the default registry has been changed to `docker.io` as\ndocker hub doesn't use `registry.hub.docker.com` as the default\nregistry and refused to authenticate against this registry. For\nbackward compatibility reasons `registry.hub.docker.com`,\n`index.docker.io` and `docker.io` can be used as a server id in\n`~/.m2/settings.xml` for the default credentials for pushing without\nregistry to Docker hub.\n\n* **0.13.0**\n - Add `docker:watch`\n ([#187](https://github.com/fabric8io/docker-maven-plugin/issues/187))\n - Allow `extraHosts` IPs to be resolved at runtime\n ([#196](https://github.com/fabric8io/docker-maven-plugin/issues/196))\n - Add `workDir` as configuration option to ``\n ([#204](https://github.com/fabric8io/docker-maven-plugin/issues/204))\n - Fix problem with log output and wait\n ([#200](https://github.com/fabric8io/docker-maven-plugin/issues/200))\n - Don't verify SSL server certificates if `DOCKER_TLS_VERIFY` is not\n set\n ([#192](https://github.com/fabric8io/docker-maven-plugin/issues/192))\n - For bind path on Windows machines\n ([#188](https://github.com/fabric8io/docker-maven-plugin/issues/188))\n - No 'from' required when using a Dockerfile\n ([#201](https://github.com/fabric8io/docker-maven-plugin/issues/201))\n - Support for LABEL for build and run.\n\nNote that since version 0.13.0 this plugin requires Docker API version v1.17 or later in order to support labels.\n\nThe watch feature has changed: Instead of using paramters like\n`docker.watch` or `docker.watch.interval` for `docker:start` a\ndedicated `docker:watch` has been introduced. Also the\n`...` configuration has been moved one level\nup so that `` and `` are on the same level. Please refer\nto the [manual](manual.md#watching-for-image-changes) for an in depth\nexplanation of the much enhanced watch functionality.\n\n* **0.12.0**\n - Allow CMD and ENTRYPOINT with shell and exec arguments\n ([#130](https://github.com/fabric8io/docker-maven-plugin/issues/130))\n ([#149](https://github.com/fabric8io/docker-maven-plugin/issues/149))\n - Unix Socket support\n ([#179](https://github.com/fabric8io/docker-maven-plugin/issues/179))\n - Add a new parameter 'skipTags' for avoiding configured tagging of\n images\n ([#145](https://github.com/fabric8io/docker-maven-plugin/issues/145))\n - Break build if log check or URL check runs into a timeout\n ([#173](https://github.com/fabric8io/docker-maven-plugin/issues/173))\n\nPlease note that for consistencies sake `` has been renamed\nto `` which contains inner elements to match better the\nequivalent Dockerfile argument. The update should be trivial and easy\nto spot since a build will croak immediately.\n\nThe old format\n\n````xml\n\n java -jar /server.jar\n\n````\n\nbecomes now\n\n````xml\n\n \n \n java\n -jar\n /server.jar\n \n \n\n````\n\nor\n\n````xml\n\n \n java -jar /server.jar\n \n\n````\n\ndepending on whether you prefer the `exec` or `shell` form.\n\n* **0.11.5**\n - Fix problem with http:// URLs when a CERT path is set\n - Fix warnings when parsing a pull response\n - Add a new parameter 'docker.follow' which makes a `docker:start`\n blocking until the CTRL-C is pressed\n ([#176](https://github.com/fabric8io/docker-maven-plugin/issues/176))\n - Add a `user` parameter to the assembly configuration so that the\n added files are created for this user\n - Fix problem when creating intermediate archive for collecting\n assembly files introduced with #139. The container can be now set\n with \"mode\" in the assembly configuration with the possible values\n `dir`, `tar`, `tgz` and `zip`\n ([#171](https://github.com/fabric8io/docker-maven-plugin/issues/171))\n - Workaround Docker problem when using an implicit registry\n `index.docker.io` when no registry is explicitly given.\n - Fixed references to docker hub in documentation\n ([#169](https://github.com/fabric8io/docker-maven-plugin/issues/169))\n - Fixed registry authentication lookup\n ([#146](https://github.com/fabric8io/docker-maven-plugin/issues/146))\n\n* **0.11.4**\n - Fixed documentation for available properties\n - Changed property `docker.assembly.exportBase` to\n `docker.assembly.exportBaseDir`\n ([#164](https://github.com/fabric8io/docker-maven-plugin/issues/164))\n - Changed default behaviour of `exportBaseDir` (true if no base\n image used with `from`, false otherwise)\n - Fix log messages getting cut off in the build\n ([#163](https://github.com/fabric8io/docker-maven-plugin/issues/163))\n - Allow system properties to overwrite dynamic port mapping\n ([#161](https://github.com/fabric8io/docker-maven-plugin/issues/161))\n - Fix for empty authentication when pushing to registries\n ([#102](https://github.com/fabric8io/docker-maven-plugin/issues/102))\n - Added watch mode for images with `-Ddocker.watch`\n ([#141](https://github.com/fabric8io/docker-maven-plugin/issues/141))\n - Added support for inline assemblies (#157, #158)\n - Add support for variable substitution is environment declarations\n ([#137](https://github.com/fabric8io/docker-maven-plugin/issues/137))\n - Use Tar archive as intermediate container when creating image ([#139](https://github.com/fabric8io/docker-maven-plugin/issues/139))\n - Better error handling for Docker errors wrapped in JSON response\n only\n ([#167](https://github.com/fabric8io/docker-maven-plugin/issues/167))\n\n* **0.11.3**\n - Add support for removeVolumes in `docker:stop` configuration\n ([#120](https://github.com/fabric8io/docker-maven-plugin/issues/120))\n - Add support for setting a custom maintainer in images\n ([#117](https://github.com/fabric8io/docker-maven-plugin/issues/117))\n - Allow containers to be named using\n `alias` when started\n ([#48](https://github.com/fabric8io/docker-maven-plugin/issues/48))\n - Add new global property 'docker.verbose' for switching verbose\n image build output\n ([#36](https://github.com/fabric8io/docker-maven-plugin/issues/36))\n - Add support for environment variables specified in a property file\n ([#128](https://github.com/fabric8io/docker-maven-plugin/issues/128))\n - Documentation improvements (#107, #121)\n - Allow to use a dockerFileDir without any assembly\n\n* **0.11.2**\n - Fix maven parse error when specifying restart policy\n ([#99](https://github.com/fabric8io/docker-maven-plugin/issues/99))\n - Allow host names to be used in port bindings\n ([#101](https://github.com/fabric8io/docker-maven-plugin/issues/101))\n - Add support for tagging at build and push time\n ([#104](https://github.com/fabric8io/docker-maven-plugin/issues/104))\n - Use correct output dir during multi-project builds\n ([#97](https://github.com/fabric8io/docker-maven-plugin/issues/97))\n - `descriptor` and `descriptorRef` in the assembly configuration are\n now optional\n ([#66](https://github.com/fabric8io/docker-maven-plugin/issues/66))\n - Fix NPE when filtering enabled during assembly creation\n ([#82](https://github.com/fabric8io/docker-maven-plugin/issues/82))\n - Allow `${project.build.finalName}` to be overridden when using a\n pre-packaged assembly descriptor for artifacts\n ([#111](https://github.com/fabric8io/docker-maven-plugin/issues/111))\n\n* **0.11.1**\n - Add support for binding UDP ports\n ([#83](https://github.com/fabric8io/docker-maven-plugin/issues/83))\n - \"Entrypoint\" supports now arguments\n ([#84](https://github.com/fabric8io/docker-maven-plugin/issues/84))\n - Fix basedir for multi module projects\n ([#89](https://github.com/fabric8io/docker-maven-plugin/issues/89))\n - Pull base images before building when \"autoPull\" is switched on\n (#76, #77, #88)\n - Fix for stopping containers without tag\n ([#86](https://github.com/fabric8io/docker-maven-plugin/issues/86))\n\n* **0.11.0**\n - Add support for binding/exporting containers during startup\n ([#55](https://github.com/fabric8io/docker-maven-plugin/issues/55))\n - Provide better control of the build assembly configuration. In\n addition, the plugin will now search for assembly descriptors in\n `src/main/docker`. This default can be overridden via the global\n configuration option `sourceDirectory`.\n - An external `Dockerfile` can now be specified to build an image.\n - When \"creating\" containers they get now all host configuration\n instead of during \"start\". This is the default behaviour since\n v1.15 while the older variant where the host configuration is fed\n into the \"start\" call is deprecated and will go away.\n - Allow selecting the API version with the configuration\n \"apiVersion\". Default and minimum API version is now \"v1.15\"\n - A registry can be specified as system property `docker.registry`\n or environment variable `DOCKER_REGISTRY`\n ([#26](https://github.com/fabric8io/docker-maven-plugin/issues/26))\n - Add new wait parameter `shutdown` which allows to specify the\n amount of time to wait between stopping a container and removing\n it ([#54](https://github.com/fabric8io/docker-maven-plugin/issues/54))\n\nPlease note, that the syntax for binding volumes from another\ncontainer has changed slightly in 0.10.6. See\n\"[Volume binding](manual.md#volume-binding)\" for details but in short:\n\n````xml\n\n \n data\n fabric8/demo\n \n....\n\n````\n\nbecomes\n\n````xml\n\n \n \n data\n fabric8/demo\n \n \n....\n\n````\n\nThe syntax for specifying the build assembly configuration has also\nchanged. See \"[Build Assembly] (manual.md#build-assembly)\" for details\nbut in short:\n\n````xml\n\n ...\n /export\n src/main/docker/assembly.xml\n\n````\n\nbecomes\n\n````xml\n\n ...\n \n /export\n assembly.xml\n \n\n````\n\n* **0.10.5**\n - Add hooks for external configurations\n - Add property based configuration for images\n ([#42](https://github.com/fabric8io/docker-maven-plugin/issues/42))\n - Add new goal `docker:logs` for showing logs of configured\n containers\n ([#49](https://github.com/fabric8io/docker-maven-plugin/issues/49))\n - Support for showing logs during `docker:start`\n ([#8](https://github.com/fabric8io/docker-maven-plugin/issues/8))\n - Use `COPY` instead of `ADD` when putting a Maven assembly into the\n container\n ([#53](https://github.com/fabric8io/docker-maven-plugin/issues/53))\n - If `exportDir` is `/` then do not actually export (since it\n doesn't make much sense) (see #62)\n\n* **0.10.4**\n - Restructured and updated documentation\n - Fixed push issue when using a private registry\n ([#40](https://github.com/fabric8io/docker-maven-plugin/issues/40))\n - Add support for binding to an arbitrary host IP\n ([#39](https://github.com/fabric8io/docker-maven-plugin/issues/39))\n\n* **0.10.3**\n - Added \"remove\" goal for cleaning up images\n - Allow \"stop\" also as standalone goal for stopping all managed\n builds\n\n* **0.10.2**\n - Support for SSL Authentication with Docker 1.3. Plugin will\n respect `DOCKER_CERT_PATH` with fallback to `~/.docker/`. The\n plugin configuration `certPath` can be used, too and has the\n highest priority.\n - Getting rid of UniRest, using\n [Apache HttpComponents](http://hc.apache.org/) exclusively for\n contacting the Docker host.\n - Support for linking of containers (see the configuration in the\n [shootout-docker-maven](https://github.com/fabric8io/shootout-docker-maven/blob/master/pom.xml)\n POM) Images can be specified in any order, the plugin takes care\n of the right startup order when running containers.\n - Support for waiting on a container's log output before continuing\n\n## 0.9.x Series\n\nOriginal configuration syntax (as described in the old\n[README](readme-0.9.x.md))\n\n* **0.9.12**\n - Fixed push issue when using a private registry\n ([#40](https://github.com/fabric8io/docker-maven-plugin/issues/40))\n\n* **0.9.11**\n - Support for SSL Authentication with Docker 1.3. Plugin will\n respect `DOCKER_CERT_PATH` with fallback to `~/.docker/`. The\n plugin configuration `certPath` can be used, too and has the\n highest priority.\n" }, { "path": "doc/ci-docs.sh", "content": "echo ===========================================\necho Deploying docker-maven-plugin documentation\necho ===========================================\n\nmvn -Pdoc-html && \\\nmvn -Pdoc-pdf && \\\ngit clone -b gh-pages git@github.com:fabric8io/docker-maven-plugin.git gh-pages && \\\ncp -rv target/generated-docs/* gh-pages/ && \\\ncd gh-pages && \\\nmv index.pdf docker-maven-plugin.pdf && \\\ngit add --ignore-errors * && \\\ngit commit -m \"generated documentation\" && \\\ngit push origin gh-pages && \\\ncd .. && \\\nrm -rf gh-pages target\n" }, { "path": "doc/examples.md", "content": "## Examples\n\nThis plugin comes with some commented examples in the `samples/` directory:\n\n### Jolokia Demo\n\n[data-jolokia](https://github.com/fabric8io/docker-maven-plugin/tree/master/samples/data-jolokia)\nis a setup for testing the [Jolokia](http://www.jolokia.org) HTTP-JMX\nbridge in a tomcat. It uses a Docker data container which is linked\ninto the Tomcat container and contains the WAR files to deploy. There\nare two flavor of tests\n\n* One with two image where a (almost naked) data container with the\n war file is created and then mounted into the server image during\n startup before the integration test.\n\n* When using the profile `-Pmerge` then a single image with Tomcat and\n the dependent war files is created. During startup of a container\n from the created image, a deploy script will link over the war files\n into Tomat so that they are automatically deployed.\n \nFor running the tests call\n\n```bash\n# Use two (\"data\" and \"server\") connected containers\nmvn clean install\n# Use a single image with tomcat and data:\nmvn -Pmerge clean install\n# Use a property based configuration:\nmvn -Pprops clean install\n```\n\nThe sever used is by default Tomcat 7. This server can easily be\nchanged with the system properties `server.name` and\n`server.version`. The following variants are available:\n\n* For `server.name=tomcat` the `server.version` can be 3.3, 4.0, 5.5, 6.0, 7.0\n or 8.0\n* For `server.name=jetty` the `server.version` can be 4, 5, 6, 7, 8 or 9\n\nExample:\n\n```bash\nmvn -Dserver.name=jetty -Dserver.version=9 clean install\n```\n\nIn addition to running the integration test with building images, starting containers, \nrunning tests and stopping containers one can also only start the containers:\n\n```bash\nmvn docker:start\n```\n\nIn order to get the dynamically exposed port, use `docker ps`. You can connect to the \nJolokia agent inside the container then with an URL like `http://localhost:http://localhost:49171/jolokia` to \nthe Agent.\n\nFor stopping the server simply call\n\n```bash\nmvn docker:stop\n```\n\n### Cargo Demo\n\n[cargo-jolokia](https://github.com/fabric8io/docker-maven-plugin/tree/master/samples/cargo-jolokia)\nwill use Docker to start a Tomcat 7 server with dynamic port mapping,\nwhich is used for remote deployment via\n[Cargo](https://codehaus-cargo.github.io/cargo/Maven2+plugin.html) and running the\nintegration tests.\n\n### docker-maven-plugin Shootout\n\nIn order to help in the decision, which plugin to use, there is a\nsample project\n[rhuss/shootout-docker-maven](https://github.com/rhuss/shootout-docker-maven),\nwhich has more complex sample project involving two images:\n\n* Vanilla PostgreSQL 9 Image\n* HTTP Request Logging Service\n - MicroService with embedded Tomcat\n - DB Schema is created during startup via [Flyway](http://flywaydb.org/)\n* PostgreSQL container is connected via a Docker 'link'\n* Simple integration test which exercises the service\n\nThe different plugins can be enabled with different Maven profiles,\nthe one for this plugin is called `fabric8io` (and the others `wouterd`,\n`alexec` and `spotify`).\n\nFor more information please look over there.\n" }, { "path": "doc/howto-release.md", "content": "\n# Release instructions\n\n## Preparation\n\n* Increase version numbers in the poms below samples/ (they are not automatically updated)\n\n```\ncd samples\nmvn versions:set -DgenerateBackupPoms=false -DnewVersion=0.15.4\n```\n\n* Run \"update_issue_links.sh\" in \"doc/\"\n* Check into Git, push, create PR and apply\n\n## Building and deploying\n\n* Run the build over the fabric8 CD Pipeline \n\nor in the _classic_ way:\n\n```\nmvn -Dmaven.repo.local=/tmp/clean-repo -DdevelopmentVersion=0.23-SNAPSHOT -DreleaseVersion=0.23.0 -Dtag=v0.23.0 -Prelease release:prepare\nmvn -Dmaven.repo.local=/tmp/clean-repo -DdevelopmentVersion=0.23-SNAPSHOT -DreleaseVersion=0.23.0 -Dtag=v0.23.0 -Prelease release:perform\n```\n\nand then push to Maven central manually via https://oss.sonatype.org/\n\n## Update from upstream\n\n```\ngit co master\ngit pull upstream master\ngit rebase upstream/master\n```\n\n## After the build\n\n* Set sample version back to the snapshot version\n\n```\nmvn versions:set -DgenerateBackupPoms=false -DnewVersion=0.15-SNAPSHOT\n```\n\n* Check-In and create PR\n\n## Update documentation\n\n* Update branch `dmp.fabric8.io` with the exact version of the plugin build and push it to upstream (https://github.com/fabric8io/docker-maven-plugin)\n\n```\ngit fetch -u upstream --tags\ngit co dmp.fabric8.io\ngit merge v0.19.0\ngit push -u upstream dmp.fabric8.io\n```\n\n* The docs will be then build by `circleci.com`\n" }, { "path": "doc/integration-tests.md", "content": "\n# Integration Testing\n\nThis document currently only holds some ideas of how and what to integration test this plugin\n\n### Registry Handling\n\n* Specify registry via environment variable, global configuration, as image configuration or with name\n* Test that `autoPull` works for `docker:start`\n* Check that push works with the registry. Also check, that no temporary docker images names (which needs to\n be created before pushing) are left over." }, { "path": "doc/intro.md", "content": "## Introduction \n\nIt focuses on two major aspects:\n\n* **Building** and **pushing** Docker images which contain build artifacts\n* **Starting** and **stopping** Docker containers for integration\n testing and development \n\nDocker *images* are the central entity which can be configured. \nContainers, on the other hand, are more or less volatile. They are\ncreated and destroyed on the fly from the configured images and are\ncompletely managed internally.\n\n### Building docker images\n\nOne purpose of this plugin is to create docker images holding the\nactual application. This is done with the `docker:build` goal. It\nis easy to include build artifacts and their dependencies into an image. \nTherefore, this plugin uses the\n[assembly descriptor format](http://maven.apache.org/plugins/maven-assembly-plugin/assembly.html)\nfrom the\n[maven-assembly-plugin](http://maven.apache.org/plugins/maven-assembly-plugin/)\nto specify the content which will be added from a sub-directory in the image \n(`/maven` by default). Images that are built with this plugin can be pushed \nto public or private Docker registries with `docker:push`.\n\n### Running containers\n\nWith this plugin it is possible to run completely isolated integration\ntests so you don't need to take care of shared resources. Ports can be\nmapped dynamically and made available as Maven properties to your\nintegration test code. \n\nMultiple containers can be managed at once, which can be linked\ntogether or share data via volumes. Containers are created and started\nwith the `docker:start` goal and stopped and destroyed with the\n`docker:stop` goal. For integration tests, both goals are typically\nbound to the `pre-integration-test` and `post-integration-test` phase,\nrespectively. It is recommended to use the \n[`maven-failsafe-plugin`](http://maven.apache.org/surefire/maven-failsafe-plugin/) \nfor integration testing in order to stop the docker container even when\nthe tests fail.\n\nFor proper isolation, container exposed ports can be dynamically and\nflexibly mapped to localhost ports. It is easy to specify a Maven\nproperty which will be filled in with a dynamically assigned port\nafter a container has been started. This can then be used as\na parameter for integration tests to connect to the application.\n\n### Configuration\n\nThe plugin configuration contains a *general part* and a list\nof *image-specific* configurations, one for each image. \n\nThe general part contains global configuration like the Docker URL or\nthe path to the SSL certificates for communication with the Docker Host.\n\nThen, each specific image configuration has three parts:\n\n* A general image part containing the image's name and alias.\n* A `` configuration specifying how images are built.\n* A `` configuration describing how containers should be created and started.\n\nThe `` and `` parts are optional and can be omitted.\n\nLet's look at a plugin configuration example:\n\n````xml\n\n \n \n service\n fabric8/docker-demo:${project.version}\n\n \n java:8\n \n docker-assembly.xml\n \n \n 8080\n \n \n java -jar /maven/service.jar\n \n \n\n \n \n tomcat.port:8080\n \n \n \n http://localhost:${tomcat.port}/access\n \n \n \n \n database:db\n \n \n \n\n \n database\n postgres:9\n \n \n database system is ready to accept connections\n \n \n \n \n \n\n````\n\nHere, two images are specified. One is the official PostgreSQL 9 image from\nDocker Hub, which internally is referenced as \"*database*\" (``). It\nonly has a `` section which declares that the startup should wait\nuntil the given text pattern is matched in the log output. Next is a\n\"*service*\" image, which is specified in the `` section. It\ncreates an image which has artifacts and dependencies in the\n`/maven` directory (and which are specified with an assembly\ndescriptor). Additionally it specifies the startup command for the\ncontainer, which in this example fires up a microservice from a jar\nfile copied over via the assembly descriptor. It also exposes\nport 8080. In the `` section this port is dynamically mapped to a\ndynamically chosen port, and then assigned to the\nMaven property `${tomcat.port}`. This property could be used, for example,\nby an integration test to access this microservice. An important part is\nthe `` section which indicates that the image with the alias of\n\"*database*\" is linked into the \"*service*\" container, which can access\nthe internal ports in the usual Docker way (via environment variables\nprefixed with `DB_`).\n\nImages can be specified in any order and the plugin will take care of the\nproper startup order (and will bail out if it detects circular\ndependencies). \n\n### Other highlights\n\nSome other highlights in random order (and not complete):\n\n* Auto pulling of images (with a progress indicator)\n* Waiting for a container to startup based on time, the reachability\n of an URL, or a pattern in the log output\n* Support for SSL authentication (since Docker 1.3)\n* Specification of encrypted registry passwords for push and pull in\n `~/.m2/settings.xml` (i.e., outside the `pom.xml`)\n* Color output ;-)\n\n### Why another Maven Plugin ?\n\nIf you search on GitHub you will find a whole cosmos of Maven Docker\nplugins (As of November 2014: 12 (!) plugins which 4 actively maintained).\nOn the one hand, variety is a good thing, but on the other hand for\nusers it is hard to decide which one to choose. So, you might wonder\nwhy you should choose this one.\n\nThere s a dedicated [shootout project](https://github.com/fabric8io/shootout-docker-maven)\nwhich compares the four most active plugins. It contains a simple demo\nproject with a database and a microservice image, along with an integration\ntest. Each plugin is configured to create images and run the\nintegration test (if possible). Although it might be a bit biased, it can \nbe useful for figuring out which plugin suits you best.\n\nThe high-level design goals and initial motivation for this plugin are:\n\n* A flexible, **dynamic port mapping** from container to host\n ports so that truly isolated builds could be made. This should\n work on indirect setups with VMs like\n [boot2docker](https://github.com/boot2docker/boot2docker) or\n [docker-machine](https://docs.docker.com/machine/) for\n running on OS X/Windows.\n\n* It should be possible to **pull images** on the fly to get\n self-contained and repeatable builds with the only requirement to\n have Docker installed.\n\n* The configuration of the plugin should be **simple**, since developers\n don't want to be forced to dive into specific Docker details only to\n start a container. So, only a handful options should be exposed,\n which needs not necessarily map directly to docker config setup.\n\n* There should be as **few dependencies** as possible for this plugin. So it\n does *not* use the Java Docker API\n [docker-java](https://github.com/docker-java/docker-java) which is\n external to docker and has a different lifecycle than Docker's\n [remote API](http://docs.docker.io/en/latest/reference/api/docker_remote_api/).\n Since this plugin needs only a small subset of the whole API,\n it is OK to do the REST calls directly. That way the plugin has\n to deal only with Docker peculiarities and not docker-java's as well.\n As a side-effect, it has fewer transitive dependencies.\n FYI: There are other Docker Java/Groovy client libraries out, which\n might be suitable for plugins like this:\n [fabric/fabric-docker-api](https://github.com/fabric8io/fabric8/tree/master/fabric/fabric-docker-api),\n [spotify/docker-client](https://github.com/spotify/docker-client)\n or\n [gesellix-docker/docker-client](https://github.com/gesellix-docker/docker-client).\n Can you see the pattern ;-) ?\n \nSo, final words: Enjoy this plugin, and please use the\n[issue tracker](https://github.com/fabric8io/docker-maven-plugin/issues)\nfor anything that hurts, or when you have a wish list. \n\n" }, { "path": "doc/migration-0.9.x.md", "content": "## Migration Guide\n\nThis recipes gives you some hint and help for migrating from the old\n(0.9.x) configuration syntax to the new one (0.10.x and later).\n\nIf there are any issue when doing the migration or you do need some\nhelp, please raise an\n[issue](https://github.com/fabric8io/docker-maven-plugin/issues) with your\noriginal configuration and you will get some help for the migration.\n\nThe biggest change was support for multiple images. The whole story\nabout the change can be found in this\n[blog post](https://ro14nd.de/Docker-Maven-Plugin-Rewrite/). In the\nold version there was a single configurtion which resulted in one or\ntwo images, depending on the `mergeData` property.\n\nIn general now all build aspects are collected now below a ``\nsection and all runtime aspects in a `` section for each image. \n\nTypically it should be clear what configuration from the original,\nflat configuration list is a runtime or build aspect, here are some\nhints, depending on whether data merging is on or off (property\n`mergeData`) \n\n* `image` becomes the name of an image with a `` configuration\n (non-merging) or the base image within a ``\n element in the `` section (merging). \n* `dataImage` is used for the name of the data image (non-merging)\n with only a `` section or the name of the single image with\n both `` and `` section when merging is used.\n\nThe [Examples](#examples) below show sample migrations for these two\ndifferent situations and make this transformation clearer.\n\n### Wait configuration\n\nWhen waiting for certain conditions during startup, in the old format\nthere where dedicated configuration params for each possible\nconditions. Now they are collected within a subelement `` which\nis part of a `` configuration.\n\nFor example:\n\n```xml\nhttp://localhost:${port}/jolokia\n10000\n```\n\nbecomes \n\n```\n\n \n http://localhost:${port}/jolokia\n \n \n\n```\n\nIn addition the new syntax support also waiting on a log outpbut\n(``). \n\n### Lifecycle binding\n\nThe old version of the plugin combined some task: E.g. if you used\n`docker:start` or `docker:pull` a `docker:build` was done\nimplicitely. In order to make stuff more explicite and easier to\nunderstand this is not the case anymore. So, when you bind to a\nlifecycle phase you have to add all steps explicitely:\n\n```xml\n\n \n start\n pre-integration-test\n \n build\n start\n \n \n ...\n\n``` \n\n### Examples\n\nThe migration is different depending on whether you use `mergeData`\nor not. \n\n## Non merged images\n\nWhen `mergeData` was false, two images where created: One holding the\ndata and one for the server which is connected to the data container\nduring startup. So, the following old configuration \n\n```xml\n\n false\n consol/tomcat-7.0\n jolokia/data\n src/main/docker-assembly.xml\n \n -Xmx32m\n \n \n jolokia.port:8080\n \n http://localhost:${jolokia.port}/jolokia\n 10000\n\n```\nbecomes in the new syntax a configuration for two images\n\n```xml\n\n \n \n server\n consol/tomcat-7.0\n \n \n data\n \n \n -Xmx32m\n \n \n jolokia.port:8080\n \n \n \n http://localhost:${jolokia.port}/jolokia\n \n \n \n \n \n \n data\n jolokia/data\n \n src/main/docker-assembly.xml\n \n \n \n\n```\n\nPlease note, that one image only has a `` configuration, the\ndata image has a `` section only. They both are linked together\nduring startup of the `server` container via `` (where the\nsymbolic name of the data container can be used). \n\n## Merged images\n\nWhen `mergeData` was true, only a single image was created. So\nthe original configuration which looks like\n\n```xml\n\n true\n consol/tomcat-7.0\n jolokia/data\n src/main/docker-assembly.xml\n \n -Xmx32m\n \n \n jolokia.port:8080\n \n http://localhost:${jolokia.port}/jolokia\n 10000\n\n```\n\ncan be directly translated to a single image configuration\n\n```xml\n\n \n \n jolokia/data\n \n consol/tomcat-7.0\n src/main/docker-assembly.xml\n \n \n \n -Xmx32m\n \n \n jolokia.port:8080\n \n \n \n http://localhost:${jolokia.port}/jolokia\n \n \n \n \n \n \n\n```\n\n### Misc renamings\n\nSome properties where renamed for consistencies sake:\n\n* `url` to `dockerHost` and the corresponding system property\n `docker.url` to `docker.host`\n* `color` to `useColor` \n" }, { "path": "doc/readme-0.9.x.md", "content": "# docker-maven-plugin 0.9.x\n\n[![endorse](http://api.coderwall.com/fabric8io/endorsecount.png)](http://coderwall.com/fabric8io)\n[![Build Status](https://secure.travis-ci.org/fabric8io/docker-maven-plugin.png)](http://travis-ci.org/fabric8io/docker-maven-plugin)\n[![Flattr](http://api.flattr.com/button/flattr-badge-large.png)](http://flattr.com/thing/73919/Jolokia-JMX-on-Capsaicin)\n\nThis is a Maven plugin for managing Docker images and containers from within Maven builds. \n\n> **This document describes version 0.9.x of this plugin. Starting\n> with version 0.10.1 a new configuration syntax was introduced which\n> as documented in the [README](../README.md). See the\n> [CHANGELOG](changelog.md) for more details about the differences and\n> this [blog post](http://ro14nd.de/Docker-Maven-Plugin-Rewrite/) for\n> the motivation behind this restructuring. The 0.9.x version is\n> deprecated and won't be updated in the futuer. For a migration to\n> the new syntax please refer to this [guide](migration-0.9.x.md)**\n\nWith this plugin it is possible to run completely isolated integration tests so you don't need to take care of shared resources. Ports can be mapped dynamically and made available as Maven properties. \n\nBuild artifacts and dependencies can be accessed from within \nrunning containers, so that a file based deployment is easily possible and there is no need to use dedicated deployment support from plugins like [Cargo](https://codehaus-cargo.github.io/cargo/Maven2+plugin.html).\n \nThis plugin's **highlights** are:\n\n* Configurable port mapping\n* Assigning dynamically selected host ports to Maven variables\n* Pulling of images (with progress indicator) if not yet downloaded\n* Optional waiting on a successful HTTP ping to the container\n* On-the-fly creation of Docker data images and containers with Maven artifacts and dependencies linked or merged into the containers under test.\n* Pushing data images to a registry\n* Setting of environment variables when creating the container\n* Support for SSL authentication (since Docker 1.3)\n* Color output ;-)\n\nThis plugin is available from Maven central and can be connected to pre- and post-integration phase as seen below.\nPlease refer also to the examples provided in the `samples/` directory.\n\n````xml\n\n org.jolokia\n docker-maven-plugin\n 0.9.11\n\n \n \n \n\n \n \n \n start\n pre-integration-test\n \n start\n \n \n \n stop\n post-integration-test\n \n stop\n \n \n \n\n````\n\n## Maven Goals\n\n### `docker:start`\n\nCreates and starts a specified docker container with the additional possibility to link artifacts and dependencies to this \n container, or, if `mergeData` is set to `true`, create a new image based on the given image and the assembly artifacts specified. \n\n#### Configuration\n\n| Parameter | Descriptions | Property | Default |\n| ------------ | ------------------------------------------------------- | -------------- | ----------------------- |\n| **url** | URL to the docker daemon | `docker.url` | `http://localhost:2375` |\n| **image** | Name of the docker image (e.g. `jolokia/tomcat:7.0.52`) | `docker.image` | none, required |\n| **ports** | List of ports to be mapped statically or dynamically. | | |\n| **env** | Additional environment variables used when creating a container | | | \n| **autoPull** | Set to `true` if an yet unloaded image should be automatically pulled | `docker.autoPull` | `true` |\n| **command** | Command to execute in the docker container |`docker.command`| |\n| **assemblyDescriptor** | Path to the data container assembly descriptor. See below for an explanation and example. | | |\n| **assemblyDescriptorRef** | Predefined assemblies which can be directly used. For possible values, see below. | | |\n| **mergeData** | If set to `true` create a new image based on the configured image and containing the assembly as described with `assemblyDescriptor` or `assemblyDescriptorRef` | `docker.mergeData` | `false` |\n| **dataBaseImage** | Base for the data image (used only when `mergeData` is false) | `docker.baseImage` | `busybox:latest` |\n| **dataImage** | Name to use for the created data image | `docker.dataImage` | `/:` |\n| **dataExportDir** | Name of the volume which gets exported | `docker.dataExportDir` | `/maven` |\n| **authConfig** | Authentication configuration when autopulling images. See below for details. | | |\n| **portPropertyFile** | Path to a file where dynamically mapped ports are written to | | |\n| **wait** | Ramp up time in milliseconds | `docker.wait` | |\n| **waitHttp** | Wait until this URL is reachable with an HTTP HEAD request. Dynamic port variables can be given, too | `docker.waitHttp` | |\n| **color** | Set to `true` for colored output | `docker.color` | `true` if TTY connected |\n| **skip** | If set to `true` skip the execution of this goal | `docker.skip` | |\n\n### `docker:stop`\n\nStops and removes a docker container. \n\n#### Configuration\n\n| Parameter | Descriptions | Property | Default |\n| ---------- | -------------------------------- | -------------- | ----------------------- |\n| **url** | URL to the docker daemon | `docker.url` | `http://localhost:4243` |\n| **image** | Which image to stop. All containers for this named image are stopped | `docker.image` | |\n| **keepContainer** | Set to `true` for not automatically removing the container after stopping it. | `docker.keepContainer` | |\n| **keepRunning** | Set to `true` for not stopping the container even when this goals runs. | `docker.keepRunning` | `false` |\n| **keepData** | Keep the data container and image after the build if set to `true` | `docker.keepData` | `false` |\n| **color** | Set to `true` for colored output | `docker.color` | `true` if TTY connected |\n| **skip** | If set to `true` skip the execution of this goal | `docker.skip` | |\n\n### `docker:push`\n\nPush a data image to the registry. The data image is the same created during the `start` goal. See below for more information about how the data image is created. The registry to push is by \ndefault `registry.hub.docker.io` but can be specified as part of the `dataImage` name the Docker way. E.g. `docker.test.org:5000/data:1.5` will push the repository `data` with tag `1.5` to \nthe registry `docker.test.org` at port `5000`. Security information (i.e. user and password) can be specified in multiple ways as described in an extra section. \n\n#### Configuration\n\n| Parameter | Descriptions | Property | Default |\n| ------------ | ------------------------------------------------------- | -------------- | ----------------------- |\n| **url** | URL to the docker daemon | `docker.url` | `http://localhost:2375` |\n| **image** | Name of the docker base image (e.g. `consol/tomcat:7.0.52`) | `docker.image` | none |\n| **autoPull** | Set to `true` if an yet unloaded image should be automatically pulled | `docker.autoPull` | `true` |\n| **assemblyDescriptor** | Path to the data container assembly descriptor. See below for an explanation and example | | |\n| **assemblyDescriptorRef** | Predefined assemblies which can be directly used. Possible values are given below | | |\n| **mergeData** | If set to `true` create a new image based on the configured image and containing the assembly as described with `assemblyDescriptor` or `assemblyDescriptorRef` | `docker.mergeData` | `false` |\n| **dataBaseImage** | Base for the data image (used only when `mergeData` is false) | `docker.baseImage` | `busybox:latest` |\n| **dataImage** | Name to use for the created data image | `docker.dataImage` | `/:` |\n| **dataExportDir** | Name of the volume which gets exported | `docker.dataExportDir` | `/maven` |\n| **keepData** | Keep the data image after the build if set to `true` | `docker.keepData` | `true` |\n| **authConfig** | Authentication configuration when pushing images. See below for details. | | |\n| **color** | Set to `true` for colored output | `docker.color` | `true` if TTY connected |\n| **skip** | If set to `true` skip the execution of this goal | `docker.skip` | |\n\n### `docker:build`\n\nBuild a data image without pushing. It works essentially the same as `docker:push` but does not push to a registry\nand does not delete the image afterwards. \n\n#### Configuration\n\n| Parameter | Descriptions | Property | Default |\n| ------------ | ------------------------------------------------------- | -------------- | ----------------------- |\n| **url** | URL to the docker daemon | `docker.url` | `http://localhost:2375` |\n| **image** | Name of the docker base image (e.g. `consol/tomcat:7.0.52`) | `docker.image` | none |\n| **autoPull** | Set to `true` if an yet unloaded base image should be automatically pulled | `docker.autoPull` | `true` |\n| **assemblyDescriptor** | Path to the data container assembly descriptor. See below for an explanation and example | | |\n| **assemblyDescriptorRef** | Predefined assemblies which can be directly used. Possible values are given below | | |\n| **mergeData** | If set to `true` create a new image based on the configured image and containing the assembly as described with `assemblyDescriptor` or `assemblyDescriptorRef` | `docker.mergeData` | `false` |\n| **dataBaseImage** | Base for the data image (used only when `mergeData` is false) | `docker.baseImage` | `busybox:latest` |\n| **dataImage** | Name to use for the created data image | `docker.dataImage` | `/:` |\n| **dataExportDir** | Name of the volume which gets exported | `docker.dataExportDir` | `/maven` |\n| **ports** | List of ports to be exposed | | | \n| **env** | List of environment variables to use for building | | | \n| **color** | Set to `true` for colored output | `docker.color` | `true` if TTY connected |\n| **skip** | If set to `true` skip the execution of this goal | `docker.skip` | |\n\n## Dynamic Port mapping\n\nFor the `start` goal, container port mapping may be configured using a `ports` declaration.\n\n```xml\n\n 18080:8080\n host.port:80\n\n```\n\nA `port` stanza may take one of two forms:\n* A tuple consisting of two numeric values separated by a `:`. This form will result in an explicit mapping between the docker host and the corresponding port inside the container. In the above example, port 18080 would be exposed on the docker host and mapped to port 8080 in the running container.\n* A tuple consisting of a string and a numeric value separated by a `:`. In this form, the string portion of the tuple will correspond to a Maven property. If the property is undefined when the `start` task executes, a port will be dynamically selected by Docker in the range 49000 ... 49900 and assigned to the property which may then be used later in the same POM file. If the property exists and has a numeric value, that value will be used as the exposed port on the docker host as in the previous form. In the above example, the docker service will elect a new port and assign the value to the property `host.port` which may then later be used in a property expression similar to `${host.port}`. This can be used to pin a port from the outside when doing some initial testing similar to:\n\n mvn -Dhost.port=10080 docker:start\n\nAnother useful configuration option is `portPropertyFile` with which a file can be specified to which the real port\nmapping is written after all dynamic ports has been resolved. The keys of this property file are the variable names,\nthe values are the dynamically assigned host ports. This property file might be useful together with other Maven\nplugins which already resolved their Maven variables earlier in the lifecycle than this plugin so that the port variables\nmight not be available to them.\n\n## Setting environment variables\n\nWhen creating a container one or more environment variables can be set via configuration with the `env` parameter\n \n```xml\n\n /opt/jdk8\n -Djava.security.egd=file:/dev/./urandom\n\n```\n\nIf you put this configuration into profiles you can easily create various test variants with a single image (e.g. by \nswitching the JDK or whatever).\n\n## Getting your assembly into the container\n\nWith using the `assemblyDescriptor` or `assemblyDescriptorRef` option it is possible to bring local files, artifacts and dependencies into the running Docker container. This works as follows:\n\n* `assemblyDescriptor` points to a file describing the data to assemble. It has the same format as for creating assemblies with the [maven-assembly-plugin](http://maven.apache.org/plugins/maven-assembly-plugin/) , with some restrictions (see below).\n* Alternatively `assemblyDescriptorRef` can be used with the name of a predefined assembly descriptor. See below for possible values.\n* This plugin will create the assembly and create a Docker image on the fly which exports the assembly below a directory `/maven`. Typically this will be an extra image, but if the configuration parameter `mergeData` is set then the image which was configured for the `start` goal is used as a base image so that the data and e.g. application server are contained in the same image. This is useful for distributing a complete image where artifacts and the server are baked together.\n* From this image a (data) container is created and the 'real' container is started with a `volumesFrom` option pointing to this data container (if `mergeData` is not used).\n* That way, the container started has access to all the data created from the directory `/maven/` within the container.\n* The container command can check for the existence of this directory and deploy everything within this directory.\n\nLet's have a look at an example. In this case, we are deploying a war-dependency into a Tomcat container. The assembly descriptor `src/main/docker-assembly.xml` option may look like\n\n````xml\n\n \n \n \n org.jolokia:jolokia-war\n \n .\n jolokia.war\n \n\n````\n\nThen you will end up with a data container which contains with a file `/maven/jolokia.war` which is mirrored into the main container.\n\nThe plugin configuration could look like\n\n````xml\n\n org.jolokia\n docker-maven-plugin\n ....\n \n jolokia/tomcat-7.0\n src/main/docker-assembly.xml\n ...\n \n\n````\n\nThe image `jolokia/tomcat-7.0` is a [trusted build](https://github.com/fabric8io/jolokia-it/tree/master/docker/tomcat/7.0) available from the central docker registry which uses a command `deploy-and-run.sh` that looks like this:\n\n````bash\n#!/bin/sh\n\nDIR=${DEPLOY_DIR:-/maven}\necho \"Checking *.war in $DIR\"\nif [ -d $DIR ]; then\n for i in $DIR/*.war; do\n file=$(basename $i)\n echo \"Linking $i --> /opt/tomcat/webapps/$file\"\n ln -s $i /opt/tomcat/webapps/$file\n done\nfi\n/opt/tomcat/bin/catalina.sh run\n````\n\nBefore starting tomcat, this script will link every .war file it finds in `/maven` to `/opt/tomcat/webapps` which effectively will deploy them. \n\nAlternatively, the parameter `mergeData` could have been set to `true` in the plugin configuration. In this case no separate data image is created but an image which is based on the specified image (`jolokia/tomcat-7.0` in this example) and the assembly are directly available from `/maven`. This has the advantage that only a single image needs to be pushed containing both, the created artifact and application server.\n\nIt is really that easy to deploy your artifacts. And it's fast (less than 10s for starting, deploying, testing (1 test) and stopping the container on my 4years old MBP using boot2docker).\n\n### Assembly Descriptor\n\nThe assembly descriptor has the same [format](http://maven.apache.org/plugins/maven-assembly-plugin/assembly.html) as the the maven-assembly-plugin with the following exceptions:\n\n* `` are ignored, the assembly will always use a directory when preparing the data container (i.e. the format is fixed to `dir`)\n* The `` is ignored since only a single assembly descriptor is used (no need to distinguish multiple descriptors)\n\nThis `docker-maven-plugin` comes with some predefined assembly descriptors which can be used with `assemblyDescritproRef`:\n\n* **artifact-with-dependencies** will copy your project's artifact and all its dependencies\n* **artifact** will copy only the project's artifact but no dependencies.\n* **project** will copy over the whole Maven project but with out `target/` directory.\n* **rootWar** will copy the artifact as `ROOT.war` to the exposed directory. I.e. Tomcat will then deploy the war under the root context.\n\n## Cleanup\n\nVarious configuration parameters of this plugin are available for cleaning up after a build:\n\n* `keepRunning` specifies that the container should not be stopped after the build. Obviously, the container and any data image created will be left alone as well. This option is especially useful when given as command line option `-Ddocker.keepRunning` for doing some debugging or developing integration tests.\n\n* `keepContainer` tells the plugin to not remove the container created from the image after the build (the container is stopped, though). If a merged container was created via the option `mergeData` then this container will remain as well as the on-the-fly created image this container belongs to. This is useful for post-mortem analysis of the container by e.g. looking at the logs. This option can be switched on with `-Ddocker.keepContainer`. If a separate data container is used, this data container and its image will stay as well.\n\n* `keepData` finally can be used to keep only the data container, but the other container should be be removed. This option has only an effect if `keepContainer` is `false`. That way, the created artifacts can be kept even after the build.\n\n## Authentication\n\nWhen pulling (via the `autoPull` mode of `docker:start` and `docker:push`) or pushing image, it might be necessary to authenticate against a Docker registry. \n\nThere are three different ways for providing credentials:\n\n* Using a `` section in the plugin configuration with `` and `` elements.\n* Providing system properties `docker.username` and `docker.password` from the outside\n* Using a `` configuration in the the `~/.m2/settings.xml` settings\n\nUsing the username and password directly in the `pom.xml` is not recommended since this is widely visible. This is easiest and transparent way, though. Using an `` is straight forward:\n\n````xml\n\n \n consol/tomcat-7.0\n ...\n \n jolokia\n s!cr!t\n \n \n\n````\n\nThe system property provided credentials are a good compromise when using CI servers like Jenkins. You simply provide the credentials from the outside:\n\n\tmvn -Ddocker.username=jolokia -Ddocker.password=s!cr!t docker:push\n\nThe most secure and also the most *mavenish* way is to add a server to the Maven settings file `~/.m2/settings.xml`: \n\n````xml\n\n \n registry.hub.docker.io\n jolokia\n s!cr!t\n \n ....\n\n````\n\nThe server id must specify the registry to push to/pull from, which by default is central index `registry.hub.docker.io`. Here you should add you docker.io account for your repositories.\n\n### Password encryption\n\nRegardless which mode you choose you can encrypt password as described in the [Maven documentation](http://maven.apache.org/guides/mini/guide-encryption.html). Assuming that you have setup a *master password* in `~/.m2/security-settings.xml` you can create easily encrypted passwords:\n\n````bash\n\t$ mvn --encrypt-password\n\tPassword:\n\t{QJ6wvuEfacMHklqsmrtrn1/ClOLqLm8hB7yUL23KOKo=}\n````\n\nThis password then can be used in `authConfig`, `docker.password` and/or the `` setting configuration. However, putting an encrypted password into `authConfig` in the `pom.xml` doesn't make much sense, since this password is encrypted with an individual master password.\n\n## SSL with keys and certificates\n\nThe plugin can communicate with the Docker Host via SSL, too. This is the default now for Docker 1.3 (and Boot2Docker). \nSSL is switched on if the port used is `2376` which is the default, IANA registered SSL port of the Docker host \n(and plain HTTP for `2375`). The directory holding `ca.pem`, `key.pem` and `cert.pem` can be configured with the\nconfiguration parameter `certPath`. Alternatively, the environment variable `DOCKER_CERT_PATH` is evaluated and finally \n`~/.docker` is used as the last fallback.\n\n## Examples\n\nThis plugin comes with some commented examples in the `samples/` directory:\n\n* [data-jolokia-demo](https://github.com/fabric8io/docker-maven-plugin/tree/master/samples/data-jolokia-demo) is a setup for testing the [Jolokia](http://www.jolokia.org) HTTP-JMX bridge in a tomcat. It uses a Docker data container which is linked into the Tomcat container and contains the WAR files to deply\n* [cargo-jolokia-demo](https://github.com/fabric8io/docker-maven-plugin/tree/master/samples/cargo-jolokia-demo) is the same as above except that Jolokia gets deployed via [Cargo](https://codehaus-cargo.github.io/cargo/Maven2+plugin.html)\n\nFor a complete example please refer to `samples/data-jolokia-demo/pom.xml`.\n\nIn order to prove, that self contained builds are not a fiction, you might convince yourself by trying out this (on a UN*X like system):\n\n````bash\n# Move away your local maven repository for a moment\ncd ~/.m2/\nmv repository repository.bak\n\n# Fetch docker-maven-plugin\ncd /tmp/\ngit clone https://github.com/fabric8io/docker-maven-plugin.git\ncd docker-maven-plugin/\n\n# Install plugin\n# (This is only needed until the plugin makes it to maven central)\nmvn install\n\n# Goto the sample\ncd samples/data-jolokia-demo\n\n# Run the integration test\nmvn verify\n\n# Use a 'merged' data image\nmvn -Pmerge-data verify\n\n# Push the data image\nmvn docker:push\n \n# Please note, that first it will take some time to fetch the image\n# from docker.io. The next time running it will be much faster. \n\n# Restore back you .m2 repo\ncd ~/.m2\nmv repository /tmp/\nmv repository.bak repository\n```` \n\n## Misc\n\n* [Script](https://gist.github.com/deinspanjer/9215467) for setting up NAT forwarding rules when using [boot2docker](https://github.com/boot2docker/boot2docker)\non OS X\n\n* It is recommended to use the `maven-failsafe-plugin` for integration testing in order to\nstop the docker container even when the tests are failing.\n\n## Why another docker-maven-plugin ? \n\nSpring feelings in 2014 seems to be quite fertile for the Java crowd's\nDocker awareness\n;-). [Not only I](https://github.com/bibryam/docker-maven-plugin/issues/1)\ncounted ~~5~~ 10 [maven-docker-plugins](https://github.com/search?q=docker-maven-plugin)\non GitHub as of ~~April~~ July 2014, tendency increasing. It seems, that all\nof them have a slightly different focus, but all of them can do the\nmost important tasks: Starting and stopping containers. \n\nSo you might wonder, why I started this plugin if there were already\nquite some out here ?\n\nThe reason is quite simple: I didn't knew them when I started and if\nyou look at the commit history you will see that they all started\ntheir life roughly at the same time (March 2014).\n\nI expect there will be some settling soon and even some merging of\nefforts which I would highly appreciate and support.\n\nFor what it's worth, here are some of my motivations for this plugin\nand what I want to achieve:\n\n* I needed a flexible, **dynamic port mapping** from container to host\n ports so that truly isolated build can be achieved. This should\n work on indirect setups with VMs like\n [boot2docker](https://github.com/boot2docker/boot2docker) for\n running on OS X.\n \n* It should be possible to **pull images** on the fly to get\n self-contained and repeatable builds with the only requirement to\n have docker installed. \n \n* The configuration of the plugin should be **simple** since usually\n developers don't want to dive into specific Docker details only to\n start a container. So, only a handful options should be exposed\n which needs not necessarily map directly to docker config setup.\n \n* The plugin should play nicely with\n [Cargo](https://codehaus-cargo.github.io/cargo/Maven2+plugin.html) so that deployments into\n containers can be easy. \n \n* I want as **less dependencies** as possible for this plugin. So I\n decided to *not* use the\n Java Docker API [docker-java](https://github.com/docker-java/docker-java) which is\n external to docker and has a different lifecycle than Docker's\n [remote API](http://docs.docker.io/en/latest/reference/api/docker_remote_api/). \n That is probably the biggest difference to the other\n docker-maven-plugins since AFAIK they all rely on this API. Since\n for this plugin I really need only a small subset of the whole API,\n I think it is ok to do the REST calls directly. That way I only have\n to deal with Docker peculiarities and not also with docker-java's\n one. As a side effect this plugin has less transitive dependencies.\n FYI: There is now yet another Docker Java client library out, which\n might be used for plugins like this, too:\n [fabric-docker-api](https://github.com/fabric8io/fabric8/tree/master/fabric/fabric-docker-api). (Just\n in case somebody wants to write yet another plugin ;-)\n\nIn the meantime, enjoy this plugin, and please use the\n[issue tracker](https://github.com/fabric8io/docker-maven-plugin/issues) \nfor anything what hurts.\n\n" }, { "path": "doc/update_issue_links.sh", "content": "#!/bin/sh\nperl -i -p -e 's|\\(\\s*#(\\d+)\\s*\\)|([#$1](https://github.com/fabric8io/docker-maven-plugin/issues/$1))|g' changelog.md\n" }, { "path": "it/README.md", "content": "## docker-maven-plugin examples\n\nThis directory holds various examples for the usage of the docker-maven\nplugin. It can be used as starting point for your own projects.\n\nThe examples are\n\n* **jolokia-integration-test** : The same integration test for [Jolokia](http://www.jolokia.org)\n in various way for defining it\n* **net** : Usage of various `net` modes (`bridge`, `none`, `host`, `container` and custom networks)\n\n## Backlog\n\n* **base-layer** : Dependencies are put in a separate base layer\n* **multiple-docker-hosts** : Usage of multiple docker hosts\n" }, { "path": "it/docker-compose/pom.xml", "content": "\n 4.0.0\n\n \n\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.29-SNAPSHOT\n ../pom.xml\n \n\n dmp-sample-docker-compose\n 0.29-SNAPSHOT\n\n http://www.jolokia.org\n\n \n 7\n tomcat\n \n\n \n \n org.jolokia\n jolokia-war\n 1.3.5\n war\n \n \n \n \n \n io.fabric8\n docker-maven-plugin\n \n \n build\n install\n \n build\n \n \n \n start\n install\n \n start\n \n \n \n stop\n install\n \n stop\n \n \n \n \n \n \n jolokia-war\n \n ${project.groupId}/${project.artifactId}:latest\n \n \n \n \n jolokia\n \n \n \n org.jolokia:jolokia-war\n \n .\n jolokia.war\n \n \n \n \n \n \n \n compose\n \n \n \n \n \n \n \n\n\n" }, { "path": "it/docker-compose/src/main/docker/Dockerfile", "content": "FROM busybox:latest\nVOLUME [\"/maven\"]\nCOPY j4p.war /maven/\n" }, { "path": "it/docker-compose/src/main/docker/docker-compose.yml", "content": "version: \"2\"\nservices:\n jolokia-war:\n labels:\n \"dmp.type\": \"example\"\n \"dmp.value\": \"100$$\"\n tomcat:\n image: \"fabric8/tomcat-7:latest\"\n ports:\n - \"8080:8080\"\n environment:\n CATALINA_OPTS: \"-Xmx32m\"\n AB_OFF: \"1\"\n ulimits:\n memlock:\n hard: 2048\n soft: 1024\n volumes_from:\n - jolokia-war" }, { "path": "it/dockerfile/README.md", "content": "## d-m-p sample using a Dockerfile\n\nThis example shows how to use docker-maven-plugin together with a Dockerfile. \nIt is a simple `HelloWorld` servlet running on top of Jetty at the root context.\n \nThe [Dockerfile](src/main/docker/Dockerfile) is located is `src/main/docker`. \nPlease note how the assembly is added using the directory `maven` which will be created on the fly by this plugin when an `` is specified. \n \nTo build and start a Jetty container with a mapped port at 8080 on the Docker host use\n\n```\nmvn package docker:build docker:run\n```" }, { "path": "it/dockerfile/pom.xml", "content": "\n\n \n\n 4.0.0\n\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.29-SNAPSHOT\n ../pom.xml\n \n\n dockerfile\n 0.29-SNAPSHOT\n war\n dmp-sample-dockerfile\n\n \n welcome.txt\n jetty\n ${project.artifactId}\n \n\n \n \n junit\n junit\n 3.8.1\n test\n \n \n javax.servlet\n javax.servlet-api\n 3.1.0\n \n \n commons-io\n commons-io\n 2.5\n \n \n\n \n \n \n io.fabric8\n docker-maven-plugin\n \n \n build\n install\n \n build\n \n \n \n start\n install\n \n start\n \n \n \n stop\n install\n \n stop\n \n \n \n \n \n \n fabric8:dmp-sample-dockerfile\n dockerfile\n \n \n ${project.basedir}/src/main/docker\n \n rootWar\n \n \n \n \n 8080:8080\n \n \n \n \n \n \n \n \n\n" }, { "path": "it/dockerfile/src/main/docker/Dockerfile", "content": "# Sample Dockerfile for use with the Docker file mode\nFROM ${base}\n\nENV SAMPLE_BUILD_MODE=dockerfile\nLABEL PROJECT_NAME=hello-world \\\n PROJECT=${project.artifactId}\n\n# Arbitrary files can be added\nADD ${file} /\n\n# In maven/ the files as specified in the section is stored\n# and need to be added manually\nCOPY maven/ /var/lib/jetty/webapps/\n\nEXPOSE 8080\n" }, { "path": "it/dockerfile/src/main/docker/welcome.txt", "content": "Hello World !!!" }, { "path": "it/dockerfile/src/main/java/io/fabric8/dmp/samples/dockerfile/HelloWorldServlet.java", "content": "package io.fabric8.dmp.samples.dockerfile;\n\nimport java.io.File;\nimport java.io.IOException;\nimport java.nio.charset.Charset;\n\nimport javax.servlet.ServletException;\nimport javax.servlet.http.HttpServlet;\nimport javax.servlet.http.HttpServletRequest;\nimport javax.servlet.http.HttpServletResponse;\n\nimport org.apache.commons.io.FileUtils;\n\n/**\n * @author roland\n * @since 18.04.17\n */\npublic class HelloWorldServlet extends HttpServlet {\n\n @Override\n protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {\n String txt = FileUtils.readFileToString(new File(\"/welcome.txt\"), Charset.defaultCharset());\n resp.getWriter().append(txt).flush();\n resp.setHeader(\"Content-Type\", \"plain/text\");\n }\n}\n" }, { "path": "it/dockerfile/src/main/webapp/WEB-INF/web.xml", "content": "\n\n\n \n HelloWold\n hello-world\n io.fabric8.dmp.samples.dockerfile.HelloWorldServlet\n \n\n \n hello-world\n /\n \n\n" }, { "path": "it/dockerignore/.maven-dockerignore", "content": "target/**\n" }, { "path": "it/dockerignore/Dockerfile", "content": "FROM busybox\n" }, { "path": "it/dockerignore/pom.xml", "content": "\n 4.0.0\n\n \n\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.29-SNAPSHOT\n ../pom.xml\n \n\n dmp-sample-dockerignore\n 0.29-SNAPSHOT\n docker-build\n\n \n \n \n io.fabric8\n docker-maven-plugin\n true\n \n \n start\n install\n \n start\n \n \n \n stop\n install\n \n stop\n \n \n \n \n \n \n simple\n dmp-sample/dockerignore\n \n ${project.basedir}\n gzip\n \n \n \n \n \n \n \n\n" }, { "path": "it/healthcheck/pom.xml", "content": "\n 4.0.0\n\n \n\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.29-SNAPSHOT\n ../pom.xml\n \n\n dmp-sample-healthcheck\n 0.29-SNAPSHOT\n\n\n \n \n \n io.fabric8\n docker-maven-plugin\n \n 500\n default\n true\n always\n \n \n healthybox1\n busybox1\n \n busybox\n \n curl -f http://localhost/ || exit 1\n \n \n sleep 2\n \n \n \n \n true\n \n \n \n \n healthybox2\n busybox2\n \n busybox\n \n 5m\n 3s\n 3\n curl -f http://localhost/ || exit 1\n \n \n \n \n healthybox3\n busybox3\n \n busybox\n \n 5m\n 3\n \n curl -f http://localhost/ || exit 1\n \n \n \n \n \n true\n \n \n \n \n healthybox4\n busybox4\n \n busybox\n \n cmd\n 5m\n \n \n curl\n -f\n http://localhost/\n ||\n exit 1\n \n \n \n \n \n \n healthybox5\n busybox5\n \n busybox\n \n 5m\n 3s\n 3\n curl -f http://localhost/ || exit 1\n \n \n \n \n unhealthybox6\n busybox5\n \n busybox\n \n none\n \n \n \n \n \n \n \n build\n pre-integration-test\n \n build\n \n \n \n \n \n \n\n\n" }, { "path": "it/helloworld/pom.xml", "content": "\n\n \n\n 4.0.0\n\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.29-SNAPSHOT\n ../pom.xml\n \n\n\n dmp-sample-helloworld\n 0.29-SNAPSHOT\n jar\n dmp-sample-helloworld\n\n \n \n junit\n junit\n 3.8.1\n test\n \n \n \n \n \n org.apache.maven.plugins\n maven-compiler-plugin\n 3.6.1\n \n 1.8\n 1.8\n \n \n \n org.codehaus.mojo\n exec-maven-plugin\n 1.5.0\n \n io.fabric8.dmp.sample.helloworld.App\n \n \n \n org.apache.maven.plugins\n maven-jar-plugin\n 3.0.2\n \n \n \n io.fabric8.dmp.sample.helloworld.App\n \n \n \n \n\n \n io.fabric8\n docker-maven-plugin\n \n \n \n hello/sub/project/java:${project.version}\n hello-world\n \n openjdk:latest\n \n artifact\n \n java -jar maven/${project.name}-${project.version}.jar\n \n \n \n Hello World!\n \n \n \n \n \n \n \n docker:build\n install\n \n build\n \n \n \n docker:start\n install\n \n start\n \n \n \n docker:stop\n install\n \n stop\n \n \n \n \n \n \n\n" }, { "path": "it/helloworld/src/main/java/io/fabric8/dmp/sample/helloworld/App.java", "content": "package io.fabric8.dmp.sample.helloworld;\n\n/**\n * Hello world!\n */\npublic class App {\n public static void main(String[] args) {\n System.out.println(\"Hello World!\");\n }\n}\n" }, { "path": "it/helloworld/src/test/java/io/fabric8/dmp/sample/helloworld/AppTest.java", "content": "package io.fabric8.dmp.sample.helloworld;\n\nimport junit.framework.Test;\nimport junit.framework.TestCase;\nimport junit.framework.TestSuite;\n\n/**\n * Unit test for simple App.\n */\npublic class AppTest\n extends TestCase\n{\n /**\n * Create the test case\n *\n * @param testName name of the test case\n */\n public AppTest( String testName )\n {\n super( testName );\n }\n\n /**\n * @return the suite of tests being tested\n */\n public static Test suite()\n {\n return new TestSuite( AppTest.class );\n }\n\n /**\n * Rigourous Test :-)\n */\n public void testApp()\n {\n assertTrue( true );\n }\n}\n" }, { "path": "it/log/pom.xml", "content": "\n 4.0.0\n\n \n\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.29-SNAPSHOT\n ../pom.xml\n \n\n\n io.fabric8\n dmp-sample-log\n 0.29-SNAPSHOT\n\n \n \n \n io.fabric8\n docker-maven-plugin\n \n \n build\n pre-integration-test\n \n build\n \n \n \n \n true\n always\n false\n \n \n jetty1\n jetty\n \n \n .*Server:main: Started @\\d+ms.*\n \n \n true\n \n \n \n jetty2\n jetty\n \n \n .*Server:main: Started @\\d+ms.*\n \n \n true\n \n \n \n \n \n \n \n\n\n" }, { "path": "it/net/pom.xml", "content": "\n 4.0.0\n\n \n\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.29-SNAPSHOT\n ../pom.xml\n \n\n dmp-sample-net\n 0.29-SNAPSHOT\n\n \n \n \n container\n true\n \n container:box2\n bridge\n \n \n\n \n \n bridge\n \n bridge\n bridge\n \n \n\n \n \n host\n \n host\n host\n \n \n\n \n \n none\n \n none\n none\n \n \n\n \n \n custom\n \n test-network\n test-network\n \n \n\n \n \n \n \n io.fabric8\n docker-maven-plugin\n \n 500\n default\n true\n always\n \n \n box1\n busybox\n \n alias\n ${box1.net}\n \n \n sh\n -c\n ip address | grep \"inet \"; echo \"finish\"; tail -f /dev/null\n \n \n \n 1 cyan\n \n \n finish\n \n \n \n \n box2\n busybox\n \n ${box2.net}\n alias\n \n \n sh\n -c\n ip address | grep \"inet \"; echo \"finish\"; tail -f /dev/null\n \n \n \n 2 blue\n \n \n finish\n \n \n \n \n \n \n \n start\n pre-integration-test\n \n start\n \n \n \n stop\n post-integration-test\n \n stop\n \n \n \n \n \n \n\n\n" }, { "path": "it/pom.xml", "content": "\n 4.0.0\n\n \n\n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.29-SNAPSHOT\n pom\n\n http://www.jolokia.org\n\n \n \n ${project.version}\n UTF-8\n UTF-8\n \n\n \n \n \n \n io.fabric8\n docker-maven-plugin\n ${docker.maven.plugin.version}\n \n \n \n \n\n \n net\n volume\n properties\n dockerignore\n docker-compose\n smallest\n zero-config\n healthcheck\n helloworld\n dockerfile\n log\n run-java\n \n\n" }, { "path": "it/properties/pom.xml", "content": "\n 4.0.0\n\n \n\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.29-SNAPSHOT\n ../pom.xml\n \n\n dmp-sample-properties\n 0.29-SNAPSHOT\n docker-build\n\n \n \n \n io.fabric8\n docker-maven-plugin\n \n \n start\n install\n \n start\n \n \n \n stop\n install\n \n stop\n \n \n \n true\n \n \n \n \n properties\n postgres.docker\n \n \n \n \n \n \n \n\n \n postgres:9.5.2\n postgres\n ${itest.postgres.port}:5432\n localhost\n superuser\n superuser-password\n 10000\n PostgreSQL init process complete\n \n\n" }, { "path": "it/run-java/Dockerfile", "content": "FROM openjdk:jre\n\nADD target/${project.build.finalName}.jar /opt/hello-world.jar\nADD target/docker-extra/run-java/run-java.sh /opt\n\n# See https://github.com/fabric8io-images/run-java-sh/ for more information\n# about run-java.sh\nCMD JAVA_MAIN_CLASS=HelloWorld sh /opt/run-java.sh\n\n" }, { "path": "it/run-java/pom.xml", "content": "\n\n 4.0.0\n\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.29-SNAPSHOT\n ../pom.xml\n \n\n io.fabric8.dmp.samples\n dmp-sample-run-java\n jar\n 0.29-SNAPSHOT\n\n \n\n \n \n io.fabric8\n docker-maven-plugin\n \n \n docker:build\n install\n \n build\n \n \n \n \n \n io.fabric8\n run-java-sh\n 1.2.2\n \n \n \n \n \n\n\n" }, { "path": "it/run-java/src/main/java/HelloWorld.java", "content": "public class HelloWorld {\n\n public static void main(String[] args) {\n System.out.println(\"Hello world !\");\n }\n}\n" }, { "path": "it/smallest/Dockerfile", "content": "FROM busybox\nCMD [\"echo\", \"Hello\", \"world!\"]\n" }, { "path": "it/smallest/pom.xml", "content": "\n 4.0.0\n\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.29-SNAPSHOT\n ../pom.xml\n \n\n fabric8io\n dmp-sample-smallest\n 0.29-SNAPSHOT\n\n \n \n \n io.fabric8\n docker-maven-plugin\n \n \n build\n pre-integration-test\n \n build\n \n \n \n \n \n \n\n" }, { "path": "it/test.xml", "content": "\n build\n blas\n blub\n \n \n \n\n \n Test\n blub\n \n \n \n \n \n" }, { "path": "it/volume/pom.xml", "content": "\n 4.0.0\n\n \n\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.29-SNAPSHOT\n ../pom.xml\n \n\n dmp-sample-volume\n 0.29-SNAPSHOT\n\n \n \n \n io.fabric8\n docker-maven-plugin\n \n true\n always\n true\n \n \n newVolume\n \n \n \n \n \n start\n pre-integration-test\n \n volume-create\n start\n \n \n \n stop\n post-integration-test\n \n stop\n volume-remove\n \n \n \n \n \n \n\n\n" }, { "path": "it/zero-config/Dockerfile", "content": "FROM openjdk:jre\n\n#RUN VERSION=$(mvn -q -Dexec.executable=echo -Dexec.args='${project.version}' --non-recursive exec:exec)\nARG jar_file=target/zero-config-${project.version}.jar\n\nADD $jar_file /tmp/zero-config.jar\nCMD java -cp /tmp/zero-config.jar HelloWorld\n" }, { "path": "it/zero-config/pom.xml", "content": "\n\n 4.0.0\n\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.29-SNAPSHOT\n ../pom.xml\n \n\n\n io.fabric8.dmp.samples\n zero-config\n jar\n 0.29-SNAPSHOT\n\n \n ${project.build.directory}/${project.build.finalName}.jar\n \n\n \n \n \n io.fabric8\n docker-maven-plugin\n \n \n build\n pre-integration-test\n \n build\n \n \n \n \n \n \n\n\n" }, { "path": "it/zero-config/src/main/java/HelloWorld.java", "content": "public class HelloWorld {\n\n public static void main(String[] args) {\n System.out.println(\"Hello world !\");\n }\n}\n" }, { "path": "mvnw", "content": "#!/bin/sh\n# ----------------------------------------------------------------------------\n# Licensed to the Apache Software Foundation (ASF) under one\n# or more contributor license agreements. See the NOTICE file\n# distributed with this work for additional information\n# regarding copyright ownership. The ASF licenses this file\n# to you under the Apache License, Version 2.0 (the\n# \"License\"); you may not use this file except in compliance\n# with the License. You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing,\n# software distributed under the License is distributed on an\n# \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n# KIND, either express or implied. See the License for the\n# specific language governing permissions and limitations\n# under the License.\n# ----------------------------------------------------------------------------\n\n# ----------------------------------------------------------------------------\n# Maven2 Start Up Batch script\n#\n# Required ENV vars:\n# ------------------\n# JAVA_HOME - location of a JDK home dir\n#\n# Optional ENV vars\n# -----------------\n# M2_HOME - location of maven2's installed home dir\n# MAVEN_OPTS - parameters passed to the Java VM when running Maven\n# e.g. to debug Maven itself, use\n# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000\n# MAVEN_SKIP_RC - flag to disable loading of mavenrc files\n# ----------------------------------------------------------------------------\n\nif [ -z \"$MAVEN_SKIP_RC\" ] ; then\n\n if [ -f /etc/mavenrc ] ; then\n . /etc/mavenrc\n fi\n\n if [ -f \"$HOME/.mavenrc\" ] ; then\n . \"$HOME/.mavenrc\"\n fi\n\nfi\n\n# OS specific support. $var _must_ be set to either true or false.\ncygwin=false;\ndarwin=false;\nmingw=false\ncase \"`uname`\" in\n CYGWIN*) cygwin=true ;;\n MINGW*) mingw=true;;\n Darwin*) darwin=true\n # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home\n # See https://developer.apple.com/library/mac/qa/qa1170/_index.html\n if [ -z \"$JAVA_HOME\" ]; then\n if [ -x \"/usr/libexec/java_home\" ]; then\n export JAVA_HOME=\"`/usr/libexec/java_home`\"\n else\n export JAVA_HOME=\"/Library/Java/Home\"\n fi\n fi\n ;;\nesac\n\nif [ -z \"$JAVA_HOME\" ] ; then\n if [ -r /etc/gentoo-release ] ; then\n JAVA_HOME=`java-config --jre-home`\n fi\nfi\n\nif [ -z \"$M2_HOME\" ] ; then\n ## resolve links - $0 may be a link to maven's home\n PRG=\"$0\"\n\n # need this for relative symlinks\n while [ -h \"$PRG\" ] ; do\n ls=`ls -ld \"$PRG\"`\n link=`expr \"$ls\" : '.*-> \\(.*\\)$'`\n if expr \"$link\" : '/.*' > /dev/null; then\n PRG=\"$link\"\n else\n PRG=\"`dirname \"$PRG\"`/$link\"\n fi\n done\n\n saveddir=`pwd`\n\n M2_HOME=`dirname \"$PRG\"`/..\n\n # make it fully qualified\n M2_HOME=`cd \"$M2_HOME\" && pwd`\n\n cd \"$saveddir\"\n # echo Using m2 at $M2_HOME\nfi\n\n# For Cygwin, ensure paths are in UNIX format before anything is touched\nif $cygwin ; then\n [ -n \"$M2_HOME\" ] &&\n M2_HOME=`cygpath --unix \"$M2_HOME\"`\n [ -n \"$JAVA_HOME\" ] &&\n JAVA_HOME=`cygpath --unix \"$JAVA_HOME\"`\n [ -n \"$CLASSPATH\" ] &&\n CLASSPATH=`cygpath --path --unix \"$CLASSPATH\"`\nfi\n\n# For Mingw, ensure paths are in UNIX format before anything is touched\nif $mingw ; then\n [ -n \"$M2_HOME\" ] &&\n M2_HOME=\"`(cd \"$M2_HOME\"; pwd)`\"\n [ -n \"$JAVA_HOME\" ] &&\n JAVA_HOME=\"`(cd \"$JAVA_HOME\"; pwd)`\"\n # TODO classpath?\nfi\n\nif [ -z \"$JAVA_HOME\" ]; then\n javaExecutable=\"`which javac`\"\n if [ -n \"$javaExecutable\" ] && ! [ \"`expr \\\"$javaExecutable\\\" : '\\([^ ]*\\)'`\" = \"no\" ]; then\n # readlink(1) is not available as standard on Solaris 10.\n readLink=`which readlink`\n if [ ! `expr \"$readLink\" : '\\([^ ]*\\)'` = \"no\" ]; then\n if $darwin ; then\n javaHome=\"`dirname \\\"$javaExecutable\\\"`\"\n javaExecutable=\"`cd \\\"$javaHome\\\" && pwd -P`/javac\"\n else\n javaExecutable=\"`readlink -f \\\"$javaExecutable\\\"`\"\n fi\n javaHome=\"`dirname \\\"$javaExecutable\\\"`\"\n javaHome=`expr \"$javaHome\" : '\\(.*\\)/bin'`\n JAVA_HOME=\"$javaHome\"\n export JAVA_HOME\n fi\n fi\nfi\n\nif [ -z \"$JAVACMD\" ] ; then\n if [ -n \"$JAVA_HOME\" ] ; then\n if [ -x \"$JAVA_HOME/jre/sh/java\" ] ; then\n # IBM's JDK on AIX uses strange locations for the executables\n JAVACMD=\"$JAVA_HOME/jre/sh/java\"\n else\n JAVACMD=\"$JAVA_HOME/bin/java\"\n fi\n else\n JAVACMD=\"`which java`\"\n fi\nfi\n\nif [ ! -x \"$JAVACMD\" ] ; then\n echo \"Error: JAVA_HOME is not defined correctly.\" >&2\n echo \" We cannot execute $JAVACMD\" >&2\n exit 1\nfi\n\nif [ -z \"$JAVA_HOME\" ] ; then\n echo \"Warning: JAVA_HOME environment variable is not set.\"\nfi\n\nCLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher\n\n# traverses directory structure from process work directory to filesystem root\n# first directory with .mvn subdirectory is considered project base directory\nfind_maven_basedir() {\n\n if [ -z \"$1\" ]\n then\n echo \"Path not specified to find_maven_basedir\"\n return 1\n fi\n\n basedir=\"$1\"\n wdir=\"$1\"\n while [ \"$wdir\" != '/' ] ; do\n if [ -d \"$wdir\"/.mvn ] ; then\n basedir=$wdir\n break\n fi\n # workaround for JBEAP-8937 (on Solaris 10/Sparc)\n if [ -d \"${wdir}\" ]; then\n wdir=`cd \"$wdir/..\"; pwd`\n fi\n # end of workaround\n done\n echo \"${basedir}\"\n}\n\n# concatenates all lines of a file\nconcat_lines() {\n if [ -f \"$1\" ]; then\n echo \"$(tr -s '\\n' ' ' < \"$1\")\"\n fi\n}\n\nBASE_DIR=`find_maven_basedir \"$(pwd)\"`\nif [ -z \"$BASE_DIR\" ]; then\n exit 1;\nfi\n\nexport MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-\"$BASE_DIR\"}\nif [ \"$MVNW_VERBOSE\" = true ]; then\n echo $MAVEN_PROJECTBASEDIR\nfi\nMAVEN_OPTS=\"$(concat_lines \"$MAVEN_PROJECTBASEDIR/.mvn/jvm.config\") $MAVEN_OPTS\"\n\n# For Cygwin, switch paths to Windows format before running java\nif $cygwin; then\n [ -n \"$M2_HOME\" ] &&\n M2_HOME=`cygpath --path --windows \"$M2_HOME\"`\n [ -n \"$JAVA_HOME\" ] &&\n JAVA_HOME=`cygpath --path --windows \"$JAVA_HOME\"`\n [ -n \"$CLASSPATH\" ] &&\n CLASSPATH=`cygpath --path --windows \"$CLASSPATH\"`\n [ -n \"$MAVEN_PROJECTBASEDIR\" ] &&\n MAVEN_PROJECTBASEDIR=`cygpath --path --windows \"$MAVEN_PROJECTBASEDIR\"`\nfi\n\nWRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain\n\nexec \"$JAVACMD\" \\\n $MAVEN_OPTS \\\n -classpath \"$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar\" \\\n \"-Dmaven.home=${M2_HOME}\" \"-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}\" \\\n ${WRAPPER_LAUNCHER} $MAVEN_CONFIG \"$@\"\n" }, { "path": "pom.xml", "content": "\n 4.0.0\n \n 3.0.3\n \n\n io.fabric8\n docker-maven-plugin\n 0.34-SNAPSHOT\n maven-plugin\n\n docker-maven-plugin\n Docker Maven Plugin\n\n http://github.com/fabric8io/docker-maven-plugin\n\n \n \n Roland Huss\n roland\n rhuss@redhat.com\n \n Developer\n \n \n \n Jae Gangemi\n jgangemi\n \n Developer\n \n \n \n\n \n UTF-8\n 3.3.9\n 1.43\n 3.0.0-M2\n 0.12.0\n \n\n \n \n org.apache.maven\n maven-plugin-api\n provided\n ${maven.version}\n \n\n \n org.apache.maven\n maven-core\n ${maven.version}\n provided\n \n\n \n org.apache.maven\n maven-model\n ${maven.version}\n provided\n \n\n \n org.apache.maven\n maven-artifact\n ${maven.version}\n provided\n \n\n \n org.sonatype.plexus\n plexus-sec-dispatcher\n provided\n 1.3\n \n\n \n org.codehaus.plexus\n plexus-utils\n provided\n 3.0.24\n \n\n \n org.codehaus.plexus\n plexus-component-annotations\n provided\n 1.6\n \n\n \n org.apache.maven.plugin-tools\n maven-plugin-annotations\n 3.5\n provided\n \n\n \n\n \n org.apache.httpcomponents\n httpclient\n 4.5.5\n \n\n \n com.github.jnr\n jnr-unixsocket\n 0.25\n \n\n \n org.apache.commons\n commons-lang3\n 3.6\n \n\n \n org.apache.commons\n commons-text\n 1.1\n \n\n \n com.google.code.gson\n gson\n 2.8.5\n \n\n \n org.fusesource.jansi\n jansi\n 1.16\n \n\n \n org.bouncycastle\n bcpkix-jdk15on\n 1.65\n \n\n \n org.apache.maven.plugins\n maven-assembly-plugin\n 3.1.0\n \n \n org.apache.maven\n maven-project\n \n \n \n com.google.collections\n google-collections\n \n \n \n\n \n com.google.cloud.tools\n jib-core\n ${jib-core.version}\n \n\n \n org.yaml\n snakeyaml\n 1.26\n \n\n \n com.google.guava\n guava\n 27.0.1-jre\n \n\n \n org.codehaus.plexus\n plexus-interpolation\n 1.24\n \n\n\n \n\n \n org.hamcrest\n hamcrest-all\n 1.3\n test\n \n\n \n org.jmockit\n jmockit\n ${jmockit.version}\n test\n \n\n \n junit\n junit\n 4.12\n test\n \n\n \n org.skyscreamer\n jsonassert\n 1.5.0\n test\n \n\n \n pl.pragmatists\n JUnitParams\n 1.1.0\n test\n \n\n \n org.assertj\n assertj-core\n 2.6.0\n test\n \n\n \n com.github.stefanbirkner\n system-rules\n 1.19.0\n test\n \n \n\n \n \n\n \n maven-compiler-plugin\n 3.6.2\n \n 1.8\n 1.8\n -Xlint:deprecation\n true\n \n \n\n \n org.apache.maven.plugins\n maven-plugin-plugin\n 3.5\n \n docker\n true\n \n \n \n mojo-descriptor\n process-classes\n \n descriptor\n \n \n \n help-goal\n \n helpmojo\n \n \n \n \n\n \n maven-resources-plugin\n 3.0.2\n \n \n copy-plexus-resources\n process-resources\n \n copy-resources\n \n \n ${basedir}/target/filtered-resources/META-INF/plexus\n \n \n src/main/resources/META-INF/plexus\n true\n \n \n \n \n \n copy-asciidoc\n process-resources\n \n copy-resources\n \n \n ${project.build.outputDirectory}/META-INF/doc/dmp\n \n \n src/main/asciidoc\n false\n \n \n \n \n \n \n\n \n org.codehaus.plexus\n plexus-component-metadata\n 1.7.1\n \n ${basedir}/target/filtered-resources/META-INF/plexus\n \n \n \n \n generate-metadata\n \n \n \n \n \n\n \n \n \n org.apache.maven.plugins\n maven-release-plugin\n 2.5.3\n \n\n \n maven-jar-plugin\n 3.0.2\n \n \n true\n \n \n \n\n \n maven-deploy-plugin\n 2.8.2\n \n\n \n org.apache.maven.plugins\n maven-source-plugin\n 3.0.0\n \n\n \n org.apache.maven.plugins\n maven-javadoc-plugin\n 2.10.4\n \n\n \n org.asciidoctor\n asciidoctor-maven-plugin\n 1.5.5\n \n \n org.asciidoctor\n asciidoctorj\n 1.5.6\n \n \n \n src/main/asciidoc\n \n font\n \n ${project.version}\n \n \n -\n \n \n \n\n \n org.apache.maven.plugins\n maven-surefire-plugin\n ${surefire.version}\n \n \n -javaagent:${settings.localRepository}/org/jmockit/jmockit/${jmockit.version}/jmockit-${jmockit.version}.jar\n \n \n \n\n \n\n \n\n \n \n org.apache.maven.wagon\n wagon-ssh-external\n 3.1.0\n \n \n \n\n \n \n sonatype-nexus-snapshots\n Sonatype Nexus Snapshots\n https://oss.sonatype.org/content/repositories/snapshots/\n \n \n sonatype-nexus-staging\n Nexus Release Repository\n https://oss.sonatype.org/service/local/staging/deploy/maven2/\n \n \n\n \n GitHub\n https://github.com/fabric8io/docker-maven-plugin/issues/\n \n\n \n scm:git:git://github.com/fabric8io/docker-maven-plugin.git\n scm:git:ssh://git@github.com/fabric8io/docker-maven-plugin.git\n HEAD\n git://github.com/fabric8io/docker-maven-plugin.git\n \n\n \n \n Apache 2\n http://www.apache.org/licenses/LICENSE-2.0.txt\n repo\n A business-friendly OSS license\n \n \n\n \n \n \n release\n \n \n\n \n org.apache.maven.plugins\n maven-deploy-plugin\n \n true\n \n \n\n \n org.sonatype.plugins\n nexus-staging-maven-plugin\n 1.6.8\n \n \n default-deploy\n deploy\n \n deploy\n \n \n \n \n https://oss.sonatype.org/\n oss-sonatype-staging\n \n \n\n \n org.apache.maven.plugins\n maven-gpg-plugin\n 1.6\n \n false\n \n \n \n sign-artifacts\n verify\n \n sign\n \n \n \n \n\n \n org.apache.maven.plugins\n maven-source-plugin\n \n false\n \n \n \n attach-sources\n \n jar\n \n \n \n \n\n \n org.apache.maven.plugins\n maven-javadoc-plugin\n \n false\n -Xdoclint:none\n \n \n \n attach-javadocs\n \n jar\n \n \n \n \n \n \n \n\n \n \n jacoco\n\n \n 0.7.9\n \n\n \n \n \n org.jacoco\n org.jacoco.agent\n runtime\n ${jacoco.version}\n test\n \n \n\n \n \n \n org.jacoco\n jacoco-maven-plugin\n ${jacoco.version}\n \n \n instrument\n process-classes\n \n instrument\n \n \n \n restore\n test\n \n restore-instrumented-classes\n report\n \n \n \n \n\n \n org.apache.maven.plugins\n maven-surefire-plugin\n\t ${surefire.version}\n \n \n \n target/jacoco.exec\n \n \n \n\n \n \n \n\n \n doc-html\n \n \n \n org.asciidoctor\n asciidoctor-maven-plugin\n \n html\n coderay\n \n left\n \n \n \n \n generate-resources asciidoctor:process-asciidoc\n \n \n \n doc-pdf\n \n \n \n org.asciidoctor\n asciidoctor-maven-plugin\n \n pdf\n rouge\n \n \n \n org.asciidoctor\n asciidoctorj-pdf\n 1.5.0-alpha.16\n \n \n \n \n generate-resources asciidoctor:process-asciidoc\n \n \n \n\n" }, { "path": "release.groovy", "content": "#!/usr/bin/groovy\ndef repo(){\n return 'fabric8io/docker-maven-plugin'\n}\n\ndef stage(){\n return stageProject{\n project = repo()\n useGitTagForNextVersion = true\n }\n}\n\ndef approveRelease(project){\n def releaseVersion = project[1]\n approve{\n room = null\n version = releaseVersion\n console = null\n environment = 'fabric8'\n }\n}\n\ndef release(project){\n releaseProject{\n stagedProject = project\n useGitTagForNextVersion = true\n helmPush = false\n groupId = 'io.fabric8'\n githubOrganisation = 'fabric8io'\n artifactIdToWatchInCentral = 'docker-maven-plugin'\n artifactExtensionToWatchInCentral = 'jar'\n }\n}\n\ndef mergePullRequest(prId){\n mergeAndWaitForPullRequest{\n project = repo()\n pullRequestId = prId\n }\n\n}\nreturn this\n" }, { "path": "release.sh", "content": "#!/bin/bash\n\n# ======================================\n# Release script for docker-maven-plugin\n# ======================================\n\n# Exit if any error occurs\n# Fail on a single failed command in a pipeline (if supported)\nset -o pipefail\n\n# Save global script args, use \"build\" as default\nif [ -z \"$1\" ]; then\n ARGS=(\"\")\nelse\n ARGS=(\"$@\")\nfi\n\n# Fail on error and undefined vars (please don't use global vars, but evaluation of functions for return values)\nset -eu\n\nusage() {\n cat - < Version to release (e.g. \"1.2.1\"). One version arg is mandatory\n --snapshot-release Snapshot release which can be created on a daily basis.\n --settings Path to a custom settings.xml to use for the release.\n This file must contain all the credentials to be used for Sonatype.\n By default ~/.m2/settings.xml is used.\n --local-maven-repo Local dir for holding the local Maven repo cache. If not given, then a new\n temporary directory will be used (and removed after the release)\n --no-git-push Don't push the release tag (and symbolic major.minor tag) at the end\n --git-remote Name of the git remote to push to. If not given, its trying to be pushed\n to the git remote to which the currently checked out branch is attached to.\n Works only when on a branch, not when checked out directly.\n --log Write full log to , only print progress to screen\nEOT\n}\n\n\n# Dir where this script is located\nbasedir() {\n # Default is current directory\n local script=${BASH_SOURCE[0]}\n\n # Resolve symbolic links\n if [ -L $script ]; then\n if readlink -f $script >/dev/null 2>&1; then\n script=$(readlink -f $script)\n elif readlink $script >/dev/null 2>&1; then\n script=$(readlink $script)\n elif realpath $script >/dev/null 2>&1; then\n script=$(realpath $script)\n else\n echo \"ERROR: Cannot resolve symbolic link $script\"\n exit 1\n fi\n fi\n\n local dir=$(dirname \"$script\")\n local full_dir=$(cd \"${dir}\" && pwd)\n echo ${full_dir}\n}\n\n# Checks if a flag is present in the arguments.\nhasflag() {\n filters=\"$@\"\n for var in \"${ARGS[@]}\"; do\n for filter in $filters; do\n if [ \"$var\" = \"$filter\" ]; then\n echo 'true'\n return\n fi\n done\n done\n}\n\n# Read the value of an option.\nreadopt() {\n filters=\"$@\"\n next=false\n for var in \"${ARGS[@]}\"; do\n if $next; then\n echo $var\n break;\n fi\n for filter in $filters; do\n if [[ \"$var\" = ${filter}* ]]; then\n local value=\"${var//${filter}=/}\"\n if [ \"$value\" != \"$var\" ]; then\n echo $value\n return\n fi\n next=true\n fi\n done\n done\n}\n\ncheck_error() {\n local msg=\"$*\"\n if [ \"${msg//ERROR/}\" != \"${msg}\" ]; then\n echo \"===============================================================\"\n echo $msg\n exit 1\n fi\n}\n\nget_release_version() {\n if [ $(hasflag --snapshot-release) ]; then\n echo $(calc_timestamp_version)\n return\n fi\n\n local release_version=$(readopt --release-version)\n if [ -z \"${release_version}\" ]; then\n echo \"ERROR: Please specify --release-version\"\n return\n fi\n echo $release_version\n}\n\ncalc_timestamp_version() {\n # ./mvnw -N help:evaluate -Dexpression=\"project.version\"\n local pom_version=$(./mvnw -N help:evaluate -Dexpression=\"project.version\" | grep '^[0-9]' | sed -e 's/\\([0-9]*\\.[0-9]*\\).*/\\1/')\n if [ -z \"${pom_version}\" ]; then\n echo \"ERROR: Cannot extract version from pom.xml\"\n exit 1\n fi\n local patch_level=$(git tag | grep ^$pom_version | grep -v '-' | grep '[0-9]*\\.[0-9]*\\.' | sed -e s/${pom_version}.// | sort -n -r | head -1)\n echo \"${pom_version}.$((patch_level+1))-$(date '+%Y%m%d')\"\n}\n\ncheck_git_clean() {\n echo \"==== Checking for clean Git Repo\"\n set +e\n git diff-index --quiet HEAD --\n local git_uncommitted=$?\n set -e\n if [ $git_uncommitted != 0 ]; then\n echo \"Untracked or changed files exist. Please run release on a clean repo\"\n git status\n exit 1\n fi\n}\n\nupdate_pom_versions() {\n local version=\"$1\"\n local maven_opts=\"$2\"\n\n echo \"==== Updating pom.xml versions to $version\"\n ./mvnw ${maven_opts} versions:set -DnewVersion=$version -DprocessAllModules=true -DgenerateBackupPoms=false\n}\n\nextract_maven_opts() {\n local maven_opts=\"-Dmaven.repo.local=$1 --batch-mode\"\n\n local settings_xml=$(readopt --settings-xml --settings)\n if [ -n \"${settings_xml}\" ]; then\n maven_opts=\"$maven_opts -s $settings_xml\"\n fi\n\n echo $maven_opts\n}\n\nmvn_clean_install() {\n local maven_opts=\"$1\"\n\n echo \"==== Running 'mvn clean install'\"\n ./mvnw ${maven_opts} clean install -DskipTests\n}\n\nbuild_and_stage_artefacts() {\n local maven_opts=\"$1\"\n\n if [ $(hasflag --snapshot-release) ]; then\n echo \"==== Building locally (--no-maven-release)\"\n ./mvnw ${maven_opts} clean install -Pflash\n else\n echo \"==== Building and staging Maven artefacts to Sonatype\"\n ./mvnw ${maven_opts} -Prelease clean deploy -DstagingDescription=\"Staging Syndesis for $(readopt --release-version)\"\n fi\n}\n\ndrop_staging_repo() {\n local maven_opts=\"$1\"\n\n if [ $(hasflag --snapshot-release) ]; then\n return\n fi\n\n echo \"==== Dropping Sonatype staging repo\"\n ./mvnw ${maven_opts} nexus-staging:drop -Prelease -DstagingDescription=\"Dropping repo\"\n}\n\nrelease_staging_repo() {\n local maven_opts=\"$1\"\n\n if [ $(hasflag --snapshot-release) ]; then\n return\n fi\n\n echo \"==== Releasing Sonatype staging repo\"\n ./mvnw ${maven_opts} -Prelease nexus-staging:release -DstagingDescription=\"Releasing $(readopt --release-version)\"\n}\n\ngit_commit_files() {\n local version=$1\n\n echo \"==== Committing files to local git\"\n git_commit pom.xml \"Update pom.xmls to $version\"\n}\n\ngit_tag_release() {\n local release_version=${1}\n\n echo \"==== Tagging version $release_version\"\n git tag -f \"$release_version\"\n}\n\ngit_push() {\n local release_version=${1:-}\n\n if [ ! $(hasflag --no-git-push) ] && [ ! $(hasflag --dry-run -n) ]; then\n local remote=$(readopt --git-remote)\n if [ -z \"${remote}\" ]; then\n # Push to the remote attached to the local checkout branch\n remote=$(git for-each-ref --format='%(upstream:short)' $(git symbolic-ref -q HEAD) | sed -e 's/\\([^\\/]*\\)\\/.*/\\1/')\n if [ -z \"${remote}\" ]; then\n echo \"ERROR: Cannot find remote repository to git push to\"\n exit 1\n fi\n fi\n\n echo \"==== Pushing to GitHub\"\n if [ -n \"$release_version\" ]; then\n echo \"* Pushing $release_version\"\n if [ $(hasflag --snapshot-release) ]; then\n # Force push to allow multiple releases per day\n git push -f -u $remote $release_version\n else\n git push -u $remote $release_version\n fi\n fi\n fi\n}\n\n# ===================================================================================\n\nif [ $(hasflag --help -h) ]; then\n usage\n exit 0\nfi\n\ncd $(basedir)\nrelease_version=$(get_release_version)\ncheck_error \"$release_version\"\n\n# Write to logfile if requested\nif [ $(readopt --log) ]; then\n logfile=$(readopt --log)\n touch $logfile\n tail -f $logfile > >(grep ^====) &\n tail_pid=$!\n trap \"kill $tail_pid\" EXIT\n exec >>$logfile 2>&1\n sleep 1\nfi\n\n# Verify that there are no modified file in git repo\ncheck_git_clean\n\n# Temporary local repository to guarantee a clean build\nlocal_maven_repo=$(readopt --local-maven-repo)\nif [ -z \"$local_maven_repo\" ]; then\n local_maven_repo=$(mktemp -d 2>/dev/null || mktemp -d -t 'maven_repo')\n trap \"echo 'Removing temp maven repo $local_maven_repo' && rm -rf $local_maven_repo\" \"EXIT\"\nfi\n\n# Calculate common maven options\nmaven_opts=\"$(extract_maven_opts $local_maven_repo)\"\ncheck_error $maven_opts\n\n# Set pom.xml version to the given release_version\nupdate_pom_versions \"$release_version\" \"$maven_opts\"\n\n# Make a clean install\nmvn_clean_install \"$maven_opts\"\n\n# Build and stage artefacts to Sonatype\nbuild_and_stage_artefacts \"$maven_opts\"\n\n# For a test run, we are done\nif [ $(hasflag --dry-run -n) ]; then\n drop_staging_repo \"$maven_opts\"\n\n echo \"==== Dry run finished, nothing has been committed\"\n echo \"==== Use 'git reset --hard' to cleanup\"\n exit 0\nfi\n\n# ========================================================================\n# Commit, tag, release, push\n# --------------------------\n\n# Git Commit all changed files\ngit_commit_files \"$release_version\"\n\n# Tag the release version\ngit_tag_release \"$release_version\"\n\n# Push everything (if configured)\ngit_push \"$release_version\"\n\n# Release staging repo\nrelease_staging_repo \"$maven_opts\"\n" }, { "path": "samples/README.md", "content": "## docker-maven-plugin examples\n\nThis directory holds various examples for the usage of the docker-maven\nplugin. It can be used as starting point for your own projects.\n\nThe examples are\n\n* **jolokia-integration-test** : The same integration test for [Jolokia](http://www.jolokia.org)\n in various way for defining it\n* **net** : Usage of various `net` modes (`bridge`, `none`, `host`, `container` and custom networks)\n\n## Backlog\n\n* **base-layer** : Dependencies are put in a separate base layer\n* **multiple-docker-hosts** : Usage of multiple docker hosts\n" }, { "path": "samples/cargo-jolokia/pom.xml", "content": "\n 4.0.0\n\n \n\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.34-SNAPSHOT\n ../pom.xml\n \n\n io.fabric8\n dmp-sample-cargo-jolokia\n 0.34-SNAPSHOT\n\n http://www.jolokia.org\n\n \n 7.0\n consol/tomcat-${tomcat}\n 1.2.1\n UTF-8\n UTF-8\n \n\n \n \n \n \n org.jolokia\n jolokia-war\n ${jolokia.version}\n war\n \n\n \n \n \n junit\n junit\n 4.11\n test\n \n\n \n com.jayway.restassured\n rest-assured\n 2.3.1\n test\n \n \n\n \n \n \n io.fabric8\n docker-maven-plugin\n \n \n true\n \n 10000\n \n \n \n \n \n ${image}\n \n \n \n jolokia.port:8080\n \n \n \n \n http://${docker.host.address}:${jolokia.port}/jolokia\n \n \n \n \n \n \n \n \n \n\n\n \n org.codehaus.cargo\n cargo-maven2-plugin\n \n\n \n \n tomcat7x\n remote\n \n\n \n \n runtime\n \n localhost\n\n \n ${jolokia.port}\n\n \n admin\n admin\n \n \n\n \n \n \n org.jolokia\n jolokia-war\n war\n \n /jolokia\n \n \n \n \n \n \n start-server\n pre-integration-test\n \n deploy\n \n \n \n \n\n\n \n \n maven-failsafe-plugin\n 2.17\n \n \n \n ${jolokia.port}\n\n \n http://localhost:${jolokia.port}/jolokia\n ${jolokia.version}\n \n \n \n\n \n \n\n" }, { "path": "samples/cargo-jolokia/src/test/java/io/fabric8/maven/docker/sample/jolokia/VersionIT.java", "content": "package io.fabric8.maven.docker.sample.jolokia;\n\nimport com.jayway.restassured.RestAssured;\nimport com.jayway.restassured.parsing.Parser;\nimport com.jayway.restassured.path.json.JsonPath;\nimport org.junit.Test;\n\nimport static com.jayway.restassured.RestAssured.*;\nimport static com.jayway.restassured.path.json.JsonPath.with;\nimport static org.hamcrest.Matchers.*;\nimport static org.junit.Assert.assertEquals;\n\n/**\n * @author roland\n * @since 15.05.14\n */\npublic class VersionIT {\n\n @Test\n public void testVersion() {\n String versionExpected = System.getProperty(\"jolokia.version\");\n String jolokiaUrl = System.getProperty(\"jolokia.url\");\n\n RestAssured.baseURI = jolokiaUrl;\n RestAssured.defaultParser = Parser.JSON;\n System.out.println(\"Checking URL: \" + jolokiaUrl);\n\n // Need to do it that way since Jolokia doesnt return application/json as mimetype by default\n JsonPath json = with(get(\"/version\").asString());\n json.prettyPrint();\n assertEquals(versionExpected, json.get(\"value.agent\"));\n\n // Alternatively, set the mime type before, then Rest-assured's fluent API can be used\n given()\n .param(\"mimeType\", \"application/json\")\n .get(\"/version\")\n .then().assertThat()\n .header(\"content-type\", containsString(\"application/json\"))\n .body(\"value.agent\", equalTo(versionExpected))\n .body(\"timestamp\", lessThanOrEqualTo((int) (System.currentTimeMillis() / 1000)))\n .body(\"status\", equalTo(200))\n .body(\"value.protocol\", equalTo(\"7.1\"))\n .body(\"value.config\",notNullValue());\n\n }\n\n}\n" }, { "path": "samples/custom-net/pom.xml", "content": "\n 4.0.0\n\n \n\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.34-SNAPSHOT\n ../pom.xml\n \n\n dmp-custom-net\n 0.34-SNAPSHOT\n\n \n \n \n io.fabric8\n docker-maven-plugin\n \n true\n 500\n default\n true\n always\n true\n \n \n box1\n busybox\n \n \n test-network\n box1\n box1-alternative\n \n none\n \n \n sh\n -c\n tail -f /dev/null\n \n \n \n 1 cyan\n \n \n \n \n box2\n busybox\n \n \n test-network\n box2\n \n \n box1\n \n none\n \n \n sh\n -c\n nslookup box1-alternative; tail -f /dev/null\n \n \n \n box1.test-network\n \n \n 2 blue\n \n \n \n \n \n \n \n start\n pre-integration-test\n \n start\n \n \n \n stop\n post-integration-test\n \n stop\n \n \n \n \n \n \n\n\n" }, { "path": "samples/data-jolokia/pom.xml", "content": "\n 4.0.0\n\n \n\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.34-SNAPSHOT\n ../pom.xml\n \n\n dmp-sample-data-jolokia\n 0.34-SNAPSHOT\n \n docker\n\n http://www.jolokia.org\n\n \n 8\n tomcat\n docker.io/fabric8/${server.name}-${server.version}:latest\n 1.3.2\n UTF-8\n UTF-8\n \n\n \n \n \n \n org.jolokia\n jolokia-war\n ${jolokia.version}\n war\n \n \n \n org.jolokia\n jolokia-it-war\n ${jolokia.version}\n war\n \n\n \n \n \n junit\n junit\n 4.11\n \n\n \n com.jayway.restassured\n rest-assured\n 2.3.1\n \n \n\n \n \n \n io.fabric8\n docker-maven-plugin\n true \n \n 500\n default\n true\n IfNotPresent\n org.apache.maven.plugins:maven-help-plugin:help\n \n \n \n \n server\n ${image}\n \n none\n \n \n data\n \n \n \n -Xmx32m\n \n 1\n \n \n ${project.basedir}/src/main/docker/environment.properties\n \n \n ${jolokia.host}:${jolokia.port}:8080\n \n \n \n Server startup\n \n http://${jolokia.host}:${jolokia.port}/jolokia\n GET\n 200\n \n \n ls -l /maven\n \n \n 500\n \n \n true\n red\n \n \n \n memlock\n 2048\n 1024\n \n \n \n /var/lib/temp:size=10m\n \n \n \n none\n \n \n \n data\n \n fabric8/${project.artifactId}:latest\n \n \n ${project.version}\n \n \n \n app\n /maven\n dir\n www-data:www-data:www-data\n assembly.xml\n \n \n \n 5000\n both\n \n \n \n \n \n\n \n \n maven-failsafe-plugin\n 2.17\n \n \n \n ${jolokia.port}\n\n \n http://${docker.host.address}:${jolokia.port}/jolokia\n ${jolokia.version}\n \n \n \n\n \n org.apache.maven.plugins\n maven-compiler-plugin\n 3.2\n \n 1.7\n 1.7\n \n \n\n \n org.apache.maven.plugins\n maven-help-plugin\n 2.2\n \n \n \n\n \n \n snapshots-repo\n https://oss.sonatype.org/content/repositories/snapshots\n \n false\n \n \n true\n \n \n \n\n \n \n merge\n \n \n \n io.fabric8\n docker-maven-plugin\n \n org.apache.maven.plugins:maven-help-plugin:help\n \n \n \n jolokia/${project.artifactId}:${project.version}\n jolokia\n \n ${image}\n \n ${project.version}\n ${project.artifactId}\n \n \n assembly.xml\n \n \n \n \n -Xmx32m\n 1\n \n \n \n jolokia.port:8080\n \n \n example\n \n \n \n \n http://${docker.host.address}:${jolokia.port}/jolokia\n \n \n \n \n true\n TC\n yellow\n \n \n \n copy\n ls -l /maven\n \n \n\n \n \n \n \n \n \n\n \n inline\n \n \n \n io.fabric8\n docker-maven-plugin\n \n \n \n \n jolokia/${project.artifactId}:${project.version}\n jolokia\n \n ${image}\n \n dir\n \n jolokia-it\n\n \n \n \n org.jolokia:jolokia-war\n \n .\n jolokia.war\n \n \n \n org.jolokia:jolokia-it-war\n \n .\n jolokia-it.war\n \n \n \n \n \n \n \n jolokia.port:8080\n \n \n \n \n http://${docker.host.address}:${jolokia.port}/jolokia\n \n \n \n \n \n \n \n \n \n \n \n\n\n \n dockerfile\n \n demo/Dockerfile\n \n \n \n \n io.fabric8\n docker-maven-plugin\n \n true\n \n \n \n jolokia/${project.artifactId}-dockerfile:${project.version}\n jolokia\n \n ${dockerfile}\n \n maven\n \n \n \n \n jolokia.port:8080\n \n \n \n \n http://${docker.host.address}:${jolokia.port}/jolokia\n \n \n \n \n \n \n \n \n \n \n \n\n \n props\n \n jolokia/${project.artifactId}:${project.version}\n service\n ${image}\n assembly.xml\n -Xmx32m\n 1\n jolokia.port:8080\n http://${docker.host.address}:${jolokia.port}/jolokia\n 10000\n \n \n \n \n io.fabric8\n docker-maven-plugin\n \n \n \n \n props\n docker\n \n \n \n \n \n \n \n \n\n \n wildfly\n \n \n \n io.fabric8\n docker-maven-plugin\n \n \n \n \n jolokia/${project.artifactId}-wildfly:${project.version}\n \n jboss/wildfly:8.2.0.Final\n \n jboss:jboss:jboss\n /opt/jboss/wildfly/standalone/deployments\n assembly.xml\n \n \n \n \n jolokia.port:8080\n \n \n \n \n http://${docker.host.address}:${jolokia.port}/jolokia\n \n \n \n \n \n \n \n \n \n \n \n\n \n tomcat\n \n tomcat\n 8\n \n \n true\n \n \n\n \n jetty\n \n jetty\n 8\n \n \n\n \n properties\n \n \n \n com.soebes.maven.plugins\n echo-maven-plugin\n 0.2\n \n \n integration-test\n \n echo\n \n \n \n \n \n ============= Props =============\n IP : ${docker.container.server.ip}\n \n \n \n\n \n \n \n\n \n machine\n \n \n \n io.fabric8\n docker-maven-plugin\n \n \n maven\n true\n \n virtualbox\n \n \n \n \n \n \n \n \n\n" }, { "path": "samples/data-jolokia/src/main/docker/assembly.xml", "content": "\n jolokia-it\n \n \n \n org.jolokia:jolokia-war\n \n .\n jolokia.war\n false\n \n \n \n org.jolokia:jolokia-it-war\n \n .\n jolokia-it.war\n false\n \n \n \n \n ${project.basedir}/src/main/docker\n test/\n true\n \n hello.sh\n \n 755\n \n \n\n" }, { "path": "samples/data-jolokia/src/main/docker/demo/.maven-dockerignore", "content": "# Ignore patterns\nplease-ignore/**" }, { "path": "samples/data-jolokia/src/main/docker/demo/Dockerfile", "content": "FROM consol/tomcat-7.0:latest\nARG deploymentDir\nADD jolokia.war /${deploymentDir}/\nADD jolokia-it.war /${deploymentDir}/\n" }, { "path": "samples/data-jolokia/src/main/docker/demo/Dockerfile.test", "content": "FROM consol/tomcat-8.0:latest\nARG deploymentDir\nADD jolokia.war /maven/\nADD jolokia-it.war /maven/\n" }, { "path": "samples/data-jolokia/src/main/docker/demo/please-ignore/me.md", "content": "Yep, please ignore !" }, { "path": "samples/data-jolokia/src/main/docker/environment.properties", "content": "EXAMPLE_OF_AN_EXTERNAL_VARIABLE=Yes, it is" }, { "path": "samples/data-jolokia/src/main/docker/hello.sh", "content": "#!/bin/sh\n\necho \"Hello world\"\n" }, { "path": "samples/data-jolokia/src/test/java/io/fabric8/maven/docker/sample/jolokia/VersionIT.java", "content": "package io.fabric8.maven.docker.sample.jolokia;\n\nimport com.jayway.restassured.RestAssured;\nimport com.jayway.restassured.parsing.Parser;\nimport com.jayway.restassured.path.json.JsonPath;\nimport org.junit.Test;\n\nimport static com.jayway.restassured.RestAssured.*;\nimport static com.jayway.restassured.path.json.JsonPath.with;\nimport static org.hamcrest.Matchers.*;\nimport static org.junit.Assert.assertEquals;\n\n/**\n * @author roland\n * @since 15.05.14\n */\npublic class VersionIT {\n\n @Test\n public void testVersion() {\n String versionExpected = System.getProperty(\"jolokia.version\");\n String jolokiaUrl = System.getProperty(\"jolokia.url\");\n\n RestAssured.baseURI = jolokiaUrl;\n RestAssured.defaultParser = Parser.JSON;\n System.out.println(\"Checking URL: \" + jolokiaUrl);\n\n // Need to do it that way since Jolokia doesnt return application/json as mimetype by default\n JsonPath json = with(get(\"/version\").asString());\n json.prettyPrint();\n assertEquals(versionExpected, json.get(\"value.agent\"));\n\n // Alternatively, set the mime type before, then Rest-assured's fluent API can be used\n given()\n .param(\"mimeType\", \"application/json\")\n .get(\"/version\")\n .then().assertThat()\n .header(\"content-type\", containsString(\"application/json\"))\n .body(\"value.agent\", equalTo(versionExpected))\n .body(\"timestamp\", lessThanOrEqualTo((int) (System.currentTimeMillis() / 1000)))\n .body(\"status\", equalTo(200))\n .body(\"value.protocol\", equalTo(\"7.2\"))\n .body(\"value.config\",notNullValue());\n\n }\n\n}\n" }, { "path": "samples/docker-compose/pom.xml", "content": "\n 4.0.0\n\n \n\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.34-SNAPSHOT\n ../pom.xml\n \n\n dmp-sample-docker-compose\n 0.34-SNAPSHOT\n\n http://www.jolokia.org\n\n \n 7\n tomcat\n \n\n \n \n org.jolokia\n jolokia-war\n 1.3.5\n war\n \n \n \n \n \n io.fabric8\n docker-maven-plugin\n \n \n \n jolokia-war\n \n ${project.groupId}/${project.artifactId}:latest\n \n \n \n \n jolokia\n \n \n \n org.jolokia:jolokia-war\n \n .\n jolokia.war\n \n \n \n \n \n \n \n compose\n \n \n \n \n \n \n \n\n\n" }, { "path": "samples/docker-compose/src/main/docker/Dockerfile", "content": "FROM busybox:latest\nVOLUME [\"/maven\"]\nCOPY j4p.war /maven/\n" }, { "path": "samples/docker-compose/src/main/docker/docker-compose.yml", "content": "version: \"2\"\nservices:\n jolokia-war:\n labels:\n \"dmp.type\": \"example\"\n \"dmp.value\": \"100$$\"\n tomcat:\n image: \"fabric8/tomcat-7:latest\"\n ports:\n - \"8080:8080\"\n environment:\n CATALINA_OPTS: \"-Xmx32m\"\n AB_OFF: \"1\"\n ulimits:\n memlock:\n hard: 2048\n soft: 1024\n volumes_from:\n - jolokia-war" }, { "path": "samples/dockerfile/README.md", "content": "## d-m-p sample using a Dockerfile\n\nThis example shows how to use docker-maven-plugin together with a Dockerfile. \nIt is a simple `HelloWorld` servlet running on top of Jetty at the root context.\n \nThe [Dockerfile](src/main/docker/Dockerfile) is located is `src/main/docker`. \nPlease note how the assembly is added using the directory `maven` which will be created on the fly by this plugin when an `` is specified. \n \nTo build and start a Jetty container with a mapped port at 8080 on the Docker host use\n\n```\nmvn package docker:build docker:run\n```" }, { "path": "samples/dockerfile/pom.xml", "content": "\n\n \n\n 4.0.0\n\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.34-SNAPSHOT\n ../pom.xml\n \n\n dockerfile\n 0.34-SNAPSHOT\n war\n dmp-sample-dockerfile\n\n \n welcome.txt\n jetty\n ${project.artifactId}\n \n\n \n \n junit\n junit\n 3.8.1\n test\n \n \n javax.servlet\n javax.servlet-api\n 3.1.0\n \n \n commons-io\n commons-io\n 2.5\n \n \n\n \n \n \n io.fabric8\n docker-maven-plugin\n \n \n \n fabric8:dmp-sample-dockerfile\n dockerfile\n \n \n ${project.basedir}/src/main/docker\n \n rootWar\n \n \n \n \n 8080:8080\n \n \n \n \n \n \n \n \n\n" }, { "path": "samples/dockerfile/src/main/docker/Dockerfile", "content": "# Sample Dockerfile for use with the Docker file mode\nFROM ${base}\n\nENV SAMPLE_BUILD_MODE=dockerfile\nLABEL PROJECT_NAME=hello-world \\\n PROJECT=${project.artifactId}\n\n# Arbitrary files can be added\nADD ${file} /\n\n# In maven/ the files as specified in the section is stored\n# and need to be added manually\nCOPY maven/ /var/lib/jetty/webapps/\n\nEXPOSE 8080\n" }, { "path": "samples/dockerfile/src/main/docker/welcome.txt", "content": "Hello World !!!" }, { "path": "samples/dockerfile/src/main/java/io/fabric8/dmp/samples/dockerfile/HelloWorldServlet.java", "content": "package io.fabric8.dmp.samples.dockerfile;\n\nimport java.io.File;\nimport java.io.IOException;\nimport java.nio.charset.Charset;\n\nimport javax.servlet.ServletException;\nimport javax.servlet.http.HttpServlet;\nimport javax.servlet.http.HttpServletRequest;\nimport javax.servlet.http.HttpServletResponse;\n\nimport org.apache.commons.io.FileUtils;\n\n/**\n * @author roland\n * @since 18.04.17\n */\npublic class HelloWorldServlet extends HttpServlet {\n\n @Override\n protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {\n String txt = FileUtils.readFileToString(new File(\"/welcome.txt\"), Charset.defaultCharset());\n resp.getWriter().append(txt).flush();\n resp.setHeader(\"Content-Type\", \"plain/text\");\n }\n}\n" }, { "path": "samples/dockerfile/src/main/webapp/WEB-INF/web.xml", "content": "\n\n\n \n HelloWold\n hello-world\n io.fabric8.dmp.samples.dockerfile.HelloWorldServlet\n \n\n \n hello-world\n /\n \n\n" }, { "path": "samples/dockerignore/.maven-dockerignore", "content": "target/**\n" }, { "path": "samples/dockerignore/Dockerfile", "content": "FROM busybox\n" }, { "path": "samples/dockerignore/pom.xml", "content": "\n 4.0.0\n\n \n\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.34-SNAPSHOT\n ../pom.xml\n \n\n dmp-sample-dockerignore\n 0.34-SNAPSHOT\n docker-build\n\n \n \n \n io.fabric8\n docker-maven-plugin\n true\n \n \n \n simple\n dmp-sample/dockerignore\n \n ${project.basedir}\n gzip\n \n \n \n \n \n \n \n\n" }, { "path": "samples/healthcheck/pom.xml", "content": "\n 4.0.0\n\n \n\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.34-SNAPSHOT\n ../pom.xml\n \n\n dmp-sample-healthcheck\n 0.34-SNAPSHOT\n\n\n \n \n \n io.fabric8\n docker-maven-plugin\n \n 500\n default\n true\n always\n \n \n healthybox1\n busybox1\n \n busybox\n \n curl -f http://localhost/ || exit 1\n \n \n sleep 2\n \n \n \n \n true\n \n \n \n \n healthybox2\n busybox2\n \n busybox\n \n 5m\n 3s\n 3\n curl -f http://localhost/ || exit 1\n \n \n \n \n healthybox3\n busybox3\n \n busybox\n \n 5m\n 3\n \n curl -f http://localhost/ || exit 1\n \n \n \n \n \n true\n \n \n \n \n healthybox4\n busybox4\n \n busybox\n \n cmd\n 5m\n \n \n curl\n -f\n http://localhost/\n ||\n exit 1\n \n \n \n \n \n \n healthybox5\n busybox5\n \n busybox\n \n 5m\n 3s\n 30m\n 3\n curl -f http://localhost/ || exit 1\n \n \n \n \n unhealthybox6\n busybox5\n \n busybox\n \n none\n \n \n \n \n \n \n \n start\n pre-integration-test\n \n start\n \n \n \n stop\n post-integration-test\n \n stop\n \n \n \n \n \n \n\n\n" }, { "path": "samples/helloworld/pom.xml", "content": "\n\n \n\n 4.0.0\n\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.34-SNAPSHOT\n ../pom.xml\n \n\n\n dmp-sample-helloworld\n 0.34-SNAPSHOT\n jar\n dmp-sample-helloworld\n\n \n \n junit\n junit\n 3.8.1\n test\n \n \n \n \n \n org.apache.maven.plugins\n maven-compiler-plugin\n 3.6.1\n \n 1.8\n 1.8\n \n \n \n org.codehaus.mojo\n exec-maven-plugin\n 1.5.0\n \n io.fabric8.dmp.sample.helloworld.App\n \n \n \n org.apache.maven.plugins\n maven-jar-plugin\n 3.0.2\n \n \n \n io.fabric8.dmp.sample.helloworld.App\n \n \n \n \n\n \n io.fabric8\n docker-maven-plugin\n \n \n \n hello/sub/project/java:${project.version}\n hello-world\n \n openjdk:latest\n \n artifact\n \n java -jar maven/${project.name}-${project.version}.jar\n \n \n \n Hello World!\n \n \n \n \n \n \n \n docker:start\n install\n \n run\n \n \n \n \n \n \n\n" }, { "path": "samples/helloworld/src/main/java/io/fabric8/dmp/sample/helloworld/App.java", "content": "package io.fabric8.dmp.sample.helloworld;\n\n/**\n * Hello world!\n */\npublic class App {\n public static void main(String[] args) {\n System.out.println(\"Hello World!\");\n }\n}\n" }, { "path": "samples/helloworld/src/test/java/io/fabric8/dmp/sample/helloworld/AppTest.java", "content": "package io.fabric8.dmp.sample.helloworld;\n\nimport junit.framework.Test;\nimport junit.framework.TestCase;\nimport junit.framework.TestSuite;\n\n/**\n * Unit test for simple App.\n */\npublic class AppTest\n extends TestCase\n{\n /**\n * Create the test case\n *\n * @param testName name of the test case\n */\n public AppTest( String testName )\n {\n super( testName );\n }\n\n /**\n * @return the suite of tests being tested\n */\n public static Test suite()\n {\n return new TestSuite( AppTest.class );\n }\n\n /**\n * Rigourous Test :-)\n */\n public void testApp()\n {\n assertTrue( true );\n }\n}\n" }, { "path": "samples/log/pom.xml", "content": "\n 4.0.0\n\n \n\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.34-SNAPSHOT\n ../pom.xml\n \n\n\n io.fabric8\n dmp-sample-log\n 0.34-SNAPSHOT\n\n \n \n \n io.fabric8\n docker-maven-plugin\n \n true\n always\n false\n \n \n jetty1\n jetty\n \n \n .*Server:main: Started @\\d+ms.*\n \n \n true\n \n \n \n jetty2\n jetty\n \n \n .*Server:main: Started @\\d+ms.*\n \n \n true\n \n \n \n \n \n \n \n\n\n" }, { "path": "samples/multi-wait/pom.xml", "content": "\n 4.0.0\n io.fabric8\n dmp-sample-multi-wait\n 0.34-SNAPSHOT\n \n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.34-SNAPSHOT\n ../pom.xml\n \n \n \n \n io.fabric8\n docker-maven-plugin\n \n none\n \n \n db\n postgres:9.6.0\n \n \n password\n \n \n database system is ready to accept connections\n \n \n \n \n db2\n postgres:9.6.0\n \n \n password\n \n \n database system is ready to accept connections\n \n \n \n \n web\n jboss/wildfly:9.0.2.Final\n \n \n db,db2\n \n \n web.port:8080\n \n \n WildFly Full .* \\(WildFly Core .*\\) started\n \n \n \n \n \n \n \n start\n pre-integration-test\n \n start\n \n \n \n stop\n post-integration-test\n \n stop\n \n \n \n \n \n org.apache.maven.plugins\n maven-failsafe-plugin\n \n \n \n integration-test\n verify\n \n \n \n \n \n \n\n" }, { "path": "samples/net/pom.xml", "content": "\n 4.0.0\n\n \n\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.34-SNAPSHOT\n ../pom.xml\n \n\n dmp-sample-net\n 0.34-SNAPSHOT\n\n \n \n \n container\n true\n \n container:box2\n bridge\n \n \n\n \n \n bridge\n \n bridge\n bridge\n \n \n\n \n \n host\n \n host\n host\n \n \n\n \n \n none\n \n none\n none\n \n \n\n \n \n custom\n \n test-network\n test-network\n \n \n\n \n \n \n \n io.fabric8\n docker-maven-plugin\n \n 500\n default\n true\n always\n \n \n box1\n busybox\n \n alias\n ${box1.net}\n \n \n sh\n -c\n ip address | grep \"inet \"; echo \"finish\"; tail -f /dev/null\n \n \n \n 1 cyan\n \n \n finish\n \n \n \n \n box2\n busybox\n \n ${box2.net}\n alias\n \n \n sh\n -c\n ip address | grep \"inet \"; echo \"finish\"; tail -f /dev/null\n \n \n \n 2 blue\n \n \n finish\n \n \n \n \n \n \n \n start\n pre-integration-test\n \n start\n \n \n \n stop\n post-integration-test\n \n stop\n \n \n \n \n \n \n\n\n" }, { "path": "samples/pom.xml", "content": "\n 4.0.0\n\n \n\n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.34-SNAPSHOT\n pom\n\n http://www.jolokia.org\n\n \n \n ${project.version}\n UTF-8\n UTF-8\n \n\n \n \n \n \n io.fabric8\n docker-maven-plugin\n ${docker.maven.plugin.version}\n \n \n \n \n\n \n net\n custom-net\n volume\n properties\n dockerignore\n docker-compose\n data-jolokia\n smallest\n zero-config\n healthcheck\n multi-wait\n helloworld\n dockerfile\n cargo-jolokia\n log\n run-java\n spring-boot-with-jib\n \n\n" }, { "path": "samples/properties/pom.xml", "content": "\n 4.0.0\n\n \n\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.34-SNAPSHOT\n ../pom.xml\n \n\n dmp-sample-properties\n 0.34-SNAPSHOT\n docker-build\n\n \n \n \n io.fabric8\n docker-maven-plugin\n true\n \n \n \n \n properties\n postgres.docker\n \n \n \n \n \n \n \n\n \n postgres:9.5.2\n postgres\n ${itest.postgres.port}:5432\n localhost\n superuser\n superuser-password\n 10000\n PostgreSQL init process complete\n \n\n" }, { "path": "samples/run-java/Dockerfile", "content": "FROM openjdk:jre\n\nADD target/${project.build.finalName}.jar /opt/hello-world.jar\nADD target/docker-extra/run-java/run-java.sh /opt\n\n# See https://github.com/fabric8io-images/run-java-sh/ for more information\n# about run-java.sh\nCMD JAVA_MAIN_CLASS=HelloWorld sh /opt/run-java.sh\n\n" }, { "path": "samples/run-java/pom.xml", "content": "\n\n 4.0.0\n\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.34-SNAPSHOT\n ../pom.xml\n \n\n io.fabric8.dmp.samples\n dmp-sample-run-java\n jar\n 0.34-SNAPSHOT\n\n \n\n \n \n io.fabric8\n docker-maven-plugin\n \n \n io.fabric8\n run-java-sh\n 1.2.2\n \n \n \n \n \n\n\n" }, { "path": "samples/run-java/src/main/java/HelloWorld.java", "content": "public class HelloWorld {\n\n public static void main(String[] args) {\n System.out.println(\"Hello world !\");\n }\n}\n" }, { "path": "samples/smallest/Dockerfile", "content": "FROM busybox\nCMD [\"echo\", \"Hello\", \"world!\"]\n" }, { "path": "samples/smallest/pom.xml", "content": "\n 4.0.0\n\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.34-SNAPSHOT\n ../pom.xml\n \n\n fabric8io\n dmp-sample-smallest\n 0.34-SNAPSHOT\n\n \n \n \n io.fabric8\n docker-maven-plugin\n \n \n \n\n" }, { "path": "samples/spring-boot-with-jib/README.md", "content": "# Spring Boot Sample with JIB Build Mode\n\nThis is also a Spring Boot application to demonstrate how Docker Maven Plugin handles build workflows by \nintegrating with [JIB](https://github.com/GoogleContainerTools/jib) which makes Docker Maven Plugin independent of docker\ndaemon.\n\n### How to Build?\nYou can compile project as usual by issuing a simple `mvn clean install` command.\n\n## Standard Configuration\nYou can build images in JIB mode by just setting `docker.build.jib=true`. Plugin would switch to JIB Build and build your image tarball into project's output directory. You can either copy this tarball and load into some docker daemon or push your image to some registry. I will be proceeding with building image and pushing to docker hub. So I would modify `pom.xml` properties to set `docker.user` to my dockerhub username:\n```.xml\n exampleuser\n```\n\n### Standard Configuration Build:\n\nYou can see that my local docker daemon is not running:\n```.shell script\n# Check Docker Daemon Status\nspring-boot-with-jib : $ systemctl status docker\n● docker.service - Docker Application Container Engine\n Loaded: loaded (/usr/lib/systemd/system/docker.service; disabled; vendor preset: disabled)\n Active: inactive (dead) since Sat 2020-08-29 16:55:32 IST; 3min 2s ago\nTriggeredBy: ● docker.socket\n Docs: https://docs.docker.com\n Main PID: 4631 (code=exited, status=0/SUCCESS)\n\nAug 29 16:49:28 localhost.localdomain dockerd[4639]: time=\"2020-08-29T16:49:28.401304638+05:30\" level=info msg=\"shim reaped\" id=3c5e5b5555fdd8a020bf248d1a7e09d1578de62c0130>\nAug 29 16:49:28 localhost.localdomain dockerd[4631]: time=\"2020-08-29T16:49:28.410926927+05:30\" level=info msg=\"ignoring event\" module=libcontainerd namespace=moby topic=/t>\nAug 29 16:55:31 localhost.localdomain systemd[1]: Stopping Docker Application Container Engine...\nAug 29 16:55:31 localhost.localdomain dockerd[4631]: time=\"2020-08-29T16:55:31.170170702+05:30\" level=info msg=\"Processing signal 'terminated'\"\nAug 29 16:55:31 localhost.localdomain dockerd[4631]: time=\"2020-08-29T16:55:31.174848312+05:30\" level=info msg=\"Daemon shutdown complete\"\nAug 29 16:55:31 localhost.localdomain dockerd[4631]: time=\"2020-08-29T16:55:31.174895349+05:30\" level=info msg=\"stopping event stream following graceful shutdown\" error=\"co>\nAug 29 16:55:31 localhost.localdomain dockerd[4631]: time=\"2020-08-29T16:55:31.175137692+05:30\" level=info msg=\"stopping healthcheck following graceful shutdown\" module=lib>\nAug 29 16:55:31 localhost.localdomain dockerd[4631]: time=\"2020-08-29T16:55:31.175219226+05:30\" level=info msg=\"stopping event stream following graceful shutdown\" error=\"co>\nAug 29 16:55:32 localhost.localdomain systemd[1]: docker.service: Succeeded.\nAug 29 16:55:32 localhost.localdomain systemd[1]: Stopped Docker Application Container Engine.\nspring-boot-with-jib : $ \n\n```\nTo build project issue this command:\n> mvn docker:build\n```.text\n[INFO] Scanning for projects...\n[INFO] \n[INFO] ---------< io.fabric8.dmp.samples:dmp-sample-spring-boot-jib >----------\n[INFO] Building Docker Maven Plugin :: Spring Boot JIB 0.33-SNAPSHOT\n[INFO] --------------------------------[ jar ]---------------------------------\n[INFO] \n[INFO] --- docker-maven-plugin:0.33-SNAPSHOT:build (default-cli) @ dmp-sample-spring-boot-jib ---\n[INFO] DOCKER> Building Container image with JIB(Java Image Builder) mode\n[INFO] DOCKER> JIB image build started\n[INFO] DOCKER> Preparing assembly files\n[INFO] Copying files to /home/rohaan/work/repos/docker-maven-plugin/samples/spring-boot-with-jib/target/docker/rohankanojia/spring-boot-dmp-sample-jib/build/maven\n[INFO] Building tar: /home/rohaan/work/repos/docker-maven-plugin/samples/spring-boot-with-jib/target/docker/rohankanojia/spring-boot-dmp-sample-jib/tmp/docker-build.tar\n[WARNING] Cannot include project artifact: io.fabric8.dmp.samples:dmp-sample-spring-boot-jib:jar:0.33-SNAPSHOT; it doesn't have an associated file or directory.\n[WARNING] The following patterns were never triggered in this artifact inclusion filter:\no 'io.fabric8.dmp.samples:dmp-sample-spring-boot-jib'\nJIB> Base image 'fabric8/java-centos-openjdk8-jdk:1.5.6' does not use a specific image digest - build may not be reproducible\nJIB> Containerizing application with the following files: \nJIB> \t: \nJIB> \t\t/home/rohaan/work/repos/docker-maven-plugin/samples/spring-boot-with-jib/target/docker/rohankanojia/spring-boot-dmp-sample-jib/build/maven\nJIB> \t\t/home/rohaan/work/repos/docker-maven-plugin/samples/spring-boot-with-jib/target/docker/rohankanojia/spring-boot-dmp-sample-jib/build/maven/dmp-sample-spring-boot-jib-0.33-SNAPSHOT.jar\nJIB> \t: \nJIB> \t\t/home/rohaan/work/repos/docker-maven-plugin/samples/spring-boot-with-jib/target/docker/rohankanojia/spring-boot-dmp-sample-jib/build/Dockerfile\nJIB> Getting manifest for base image fabric8/java-centos-openjdk8-jdk:1.5.6... \nJIB> Building layer... \nJIB> Building layer... \nJIB> The base image requires auth. Trying again for fabric8/java-centos-openjdk8-jdk:1.5.6... \nJIB> Retrieving registry credentials for registry-1.docker.io... \nJIB> Using base image with digest: sha256:92530aa1eb4c49e3b1d033f94e9cd4dc891d49922459e13f84e59c9d68d800eb \nJIB> Container program arguments set to [java, -jar, /maven/dmp-sample-spring-boot-jib-0.33-SNAPSHOT.jar] \nJIB> Building image to tar file... \nJIB> [======================== ] 80.0% complete > writing to tar file\nJIB> [==============================] 100.0% complete\n[INFO] DOCKER> /home/rohaan/work/repos/docker-maven-plugin/samples/spring-boot-with-jib/target/docker/rohankanojia/spring-boot-dmp-sample-jib/tmp/docker-build.tar successfully built\n[INFO] ------------------------------------------------------------------------\n[INFO] BUILD SUCCESS\n[INFO] ------------------------------------------------------------------------\n[INFO] Total time: 13.587 s\n[INFO] Finished at: 2020-08-29T17:08:10+05:30\n[INFO] ------------------------------------------------------------------------\n```\n\nJIB build creates a tarball as image output(You can see in logs that it shows the build image tarball). You can then load this image into some other docker daemon like this:\n```\nspring-boot-with-jib : $ docker load -i /home/rohaan/work/repos/docker-maven-plugin/samples/spring-boot-with-jib/target/docker/rohankanojia/spring-boot-dmp-sample-jib/tmp/docker-build.tar\nf38418c08d5d: Loading layer [==================================================>] 17.85MB/17.85MB\nf1ef686aa9e0: Loading layer [==================================================>] 215B/215B\nLoaded image: rohankanojia/spring-boot-dmp-sample-jib:latest\n```\n\n**Note**: Make sure that `docker.build.jib` is disabled when you're using other plugin goals. Jib mode does not work with other goals. \nAfter this, you can use [`docker:start`](http://dmp.fabric8.io/#docker:start) as usual\n\nOr you may want to push image to some registry as described in next section.\n### Zero Configuration Push\nIn order to push image, you need to make sure that your image name is set with respect to your registry. I'm going to push the image to docker hub so `${docker.user}/spring-boot-dmp-sample-jib` would be my image name.\n\nYou can push image with [`docker:push`](http://dmp.fabric8.io/#docker:push) goal as usual, I already have `docker.build.jib=true` set in project properties:\n```\nspring-boot-with-jib : $ mvn docker:push\n[INFO] Scanning for projects...\n[INFO] \n[INFO] ---------< io.fabric8.dmp.samples:dmp-sample-spring-boot-jib >----------\n[INFO] Building Docker Maven Plugin :: Spring Boot JIB 0.33-SNAPSHOT\n[INFO] --------------------------------[ jar ]---------------------------------\n[INFO] \n[INFO] --- docker-maven-plugin:0.33-SNAPSHOT:push (default-cli) @ dmp-sample-spring-boot-jib ---\n[INFO] DOCKER> Pushing Container image with JIB(Java Image Builder) mode\n[INFO] DOCKER> This push refers to: rohankanojia/spring-boot-dmp-sample-jib\nJIB> Containerizing application with the following files: \nJIB> Retrieving registry credentials for registry-1.docker.io... \nJIB> Container program arguments set to [java, -jar, /maven/dmp-sample-spring-boot-jib-0.33-SNAPSHOT.jar] (inherited from base image)\nJIB> Pushing manifest for latest... \n\nJIB> [==============================] 100.0% complete\n[INFO] ------------------------------------------------------------------------\n[INFO] BUILD SUCCESS\n[INFO] ------------------------------------------------------------------------\n[INFO] Total time: 02:57 min\n[INFO] Finished at: 2020-08-29T17:36:11+05:30\n[INFO] ------------------------------------------------------------------------\nspring-boot-with-jib : $ \n```\n\n## JIB with Customized Assembly\nThis profile tries to add some extra files inside the image. If you see there is an extra directory `static` in project base directory. It is the copied to target image.\n\n### JIB with Customized Assembly Build\nNow to build you need to issue same build goal but with different profile, build goal generates a tarball which needs to be loaded into your docker daemon afterwards. Or maybe you can push it to some registry:\n> mvn docker:build -PJib-With-Assembly\n```\nspring-boot-with-jib : $ mvn docker:build -PJib-With-Assembly\n[INFO] Scanning for projects...\n[INFO] \n[INFO] ---------< io.fabric8.dmp.samples:dmp-sample-spring-boot-jib >----------\n[INFO] Building Docker Maven Plugin :: Spring Boot JIB 0.33-SNAPSHOT\n[INFO] --------------------------------[ jar ]---------------------------------\n[INFO] \n[INFO] --- docker-maven-plugin:0.33-SNAPSHOT:build (default-cli) @ dmp-sample-spring-boot-jib ---\n[INFO] DOCKER> Building Container image with JIB(Java Image Builder) mode\n[INFO] DOCKER> JIB image build started\n[INFO] DOCKER> Preparing assembly files\n[INFO] Copying files to /home/rohaan/work/repos/docker-maven-plugin/samples/spring-boot-with-jib/target/docker/rohankanojia/spring-boot-sample/build/my-project-assembly\nJIB> Base image 'fabric8/java-centos-openjdk8-jdk:1.5.6' does not use a specific image digest - build may not be reproducible\nJIB> Containerizing application with the following files: \nJIB> \t: \nJIB> \t\t/home/rohaan/work/repos/docker-maven-plugin/samples/spring-boot-with-jib/target/docker/rohankanojia/spring-boot-sample/build/my-project-assembly\nJIB> \t\t/home/rohaan/work/repos/docker-maven-plugin/samples/spring-boot-with-jib/target/docker/rohankanojia/spring-boot-sample/build/my-project-assembly/static\nJIB> \t\t/home/rohaan/work/repos/docker-maven-plugin/samples/spring-boot-with-jib/target/docker/rohankanojia/spring-boot-sample/build/my-project-assembly/static/testFile.txt\nJIB> \t\t/home/rohaan/work/repos/docker-maven-plugin/samples/spring-boot-with-jib/target/docker/rohankanojia/spring-boot-sample/build/my-project-assembly/dmp-sample-spring-boot-jib-0.33-SNAPSHOT.jar\nJIB> \t: \nJIB> \t\t/home/rohaan/work/repos/docker-maven-plugin/samples/spring-boot-with-jib/target/docker/rohankanojia/spring-boot-sample/build/Dockerfile\nJIB> Getting manifest for base image fabric8/java-centos-openjdk8-jdk:1.5.6... \nJIB> Building layer... \nJIB> Building layer... \nJIB> The base image requires auth. Trying again for fabric8/java-centos-openjdk8-jdk:1.5.6... \nJIB> Retrieving registry credentials for registry-1.docker.io... \nJIB> Using base image with digest: sha256:92530aa1eb4c49e3b1d033f94e9cd4dc891d49922459e13f84e59c9d68d800eb \nJIB> Container program arguments set to [java, -jar, /my-project-assembly/dmp-sample-spring-boot-jib-0.33-SNAPSHOT.jar] \nJIB> Building image to tar file... \nJIB> [======================== ] 80.0% complete > writing to tar file\nJIB> [==============================] 100.0% complete\n[INFO] DOCKER> /home/rohaan/work/repos/docker-maven-plugin/samples/spring-boot-with-jib/target/docker/rohankanojia/spring-boot-sample/tmp/docker-build.tar successfully built\n[INFO] ------------------------------------------------------------------------\n[INFO] BUILD SUCCESS\n[INFO] ------------------------------------------------------------------------\n[INFO] Total time: 13.173 s\n[INFO] Finished at: 2020-08-29T17:40:13+05:30\n[INFO] ------------------------------------------------------------------------\n```\n\n### Jib With Customized Assembly Push\nPushing image to docker hub in this case, you can provide registry credentials in plugin XML config, in `~/.m2/settings.xml` or in `~/.docker/config.json`:\n> mvn docker:push -PJib-With-Assembly \n```\nspring-boot-with-jib : $ mvn docker:push -PJib-With-Assembly\n[INFO] Scanning for projects...\n[INFO] \n[INFO] ---------< io.fabric8.dmp.samples:dmp-sample-spring-boot-jib >----------\n[INFO] Building Docker Maven Plugin :: Spring Boot JIB 0.33-SNAPSHOT\n[INFO] --------------------------------[ jar ]---------------------------------\n[INFO] \n[INFO] --- docker-maven-plugin:0.33-SNAPSHOT:push (default-cli) @ dmp-sample-spring-boot-jib ---\n[INFO] DOCKER> Pushing Container image with JIB(Java Image Builder) mode\n[INFO] DOCKER> This push refers to: rohankanojia/spring-boot-sample\nJIB> Containerizing application with the following files: \nJIB> Retrieving registry credentials for registry-1.docker.io... \nJIB> Container program arguments set to [java, -jar, /my-project-assembly/dmp-sample-spring-boot-jib-0.33-SNAPSHOT.jar] (inherited from base image)\nJIB> [==================== ] 66.7% complete > pushing blob sha256:0a2b4dc56d7e822495adcdfa8a2c2316e9ae420d84a6JIB> Skipping push; BLOB already exists on target registry : digest: sha256:707713df6baa24192428099d6444fed7fe3c91dc10bad2742b7350f0147b1b3b, size: 8851\nJIB> [==================== ] 67.7% complete > pushing blob sha256:0a2b4dc56d7e822495adcdfa8a2c2316e9ae420d84a6JIB> Skipping push; BLOB already exists on target registry : digest: sha256:109b828942fdee847c02ec43b13105bf0d1bc1701675a4306781193f11c997df, size: 6543\nJIB> [===================== ] 68.7% complete > pushing blob sha256:0a2b4dc56d7e822495adcdfa8a2c2316e9ae420d84a6JIB> Skipping push; BLOB already exists on target registry : digest: sha256:a44f5f69f08a44895565ad9cdfa05f3378a46205cf81c64de068efed4f644a46, size: 467\nJIB> Skipping push; BLOB already exists on target registry : digest: sha256:8e2fef958d6c5532e73960cab9b4acf1de2fa0dac8ce1d404751de240157e5cd, size: 739790\nJIB> [===================== ] 70.7% complete > pushing blob sha256:0a2b4dc56d7e822495adcdfa8a2c2316e9ae420d84a6JIB> Skipping push; BLOB already exists on target registry : digest: sha256:743ce65d298dc1684e06ba2d255db095cceaf75060dcbdff43baa8a7e525255a, size: 100\nJIB> [===================== ] 69.7% complete > pushing blob sha256:0a2b4dc56d7e822495adcdfa8a2c2316e9ae420d84a6JIB> Skipping push; BLOB already exists on target registry : digest: sha256:ac9208207adaac3a48e54a4dc6b49c69e78c3072d2b3add7efdabf814db2133b, size: 75161332\nJIB> [====================== ] 72.7% complete > pushing blob sha256:0a2b4dc56d7e822495adcdfa8a2c2316e9ae420d84a6JIB> [====================== ] 71.7% complete > pushing blob sha256:0a2b4dc56d7e822495adcdfa8a2c2316e9ae420d84a6JIB> Skipping push; BLOB already exists on target registry : digest: sha256:6b82b8ee52d8ef43d1b35637e65d9134277e63fd23316516c084ab0dad7a017b, size: 1375\nJIB> [====================== ] 73.7% complete > pushing blob sha256:0a2b4dc56d7e822495adcdfa8a2c2316e9ae420d84a6JIB> Skipping push; BLOB already exists on target registry : digest: sha256:0a2b4dc56d7e822495adcdfa8a2c2316e9ae420d84a6a5e8e9d0b505a5fddcd1, size: 6539\nJIB> [====================== ] 74.7% complete > pushing blob sha256:46839fd680b76fed7005bc63ae1207193c129051c10dJIB> Skipping push; BLOB already exists on target registry : digest: sha256:08f3d26bbf994fd2c8ce6418a0b090bee22878c7998f0e78b7247a860411bbb2, size: 86409418\nJIB> [======================= ] 75.8% complete > pushing blob sha256:46839fd680b76fed7005bc63ae1207193c129051c10dJIB> Skipping push; BLOB already exists on target registry : digest: sha256:99230c1ff85faaf8fd0c9ba8db6b20d009db4fb35f17f7b6a24a6baa6821c306, size: 4702\nJIB> [========================== ] 86.9% complete > pushing blob sha256:46839fd680b76fed7005bc63ae1207193c129051c10dJIB> Skipping push; BLOB already exists on target registry : digest: sha256:18e8deddb3f584f36c47b481067a6fa0a3a977b71df199a8d89ee8720b9c587c, size: 239\nJIB> [========================== ] 87.9% complete > pushing blob sha256:46839fd680b76fed7005bc63ae1207193c129051c10dJIB> [========================== ] 87.9% complete > pushing blob sha256:46839fd680b76fed7005bc63ae1207193c129051c10dJIB> [========================== ] 87.9% complete > pushing blob sha256:46839fd680b76fed7005bc63ae1207193c129051c10dJIB> [========================== ] 87.9% complete > pushing blob sha256:46839fd680b76fed7005bc63ae1207193c129051c10dJIB> [========================== ] 87.9% complete > pushing blob sha256:46839fd680b76fed7005bc63ae1207193c129051c10dJIB> [========================== ] 87.9% complete > pushing blob sha256:46839fd680b76fed7005bc63ae1207193c129051c10dJIB> [========================== ] 87.9% complete > pushing blob sha256:46839fd680b76fed7005bc63ae1207193c129051c10dJIB> [========================== ] 88.0% complete > pushing blob sha256:46839fd680b76fed7005bc63ae1207193c129051c10dJIB> [========================== ] 88.0% complete > pushing blob sha256:46839fd680b76fed7005bc63ae1207193c129051c10dJIB> [========================== ] 88.0% complete > pushing blob sha256:46839fd680b76fed7005bc63ae1207193c129051c10dJIB> [========================== ] 88.1% complete > pushing blob sha256:46839fd680b76fed7005bc63ae1207193c129051c10dJIB> [========================== ] 88.1% complete > pushing blob sha256:46839fd680b76fed7005bc63ae1207193c129051c10dJIB> [========================== ] 88.2% complete > pushing blob sha256:46839fd680b76fed7005bc63ae1207193c129051c10dJIB> [========================== ] 88.3% complete > pushing blob sha256:46839fd680b76fed7005bc63ae1207193c129051c10dJIB> [========================== ] 88.3% complete > pushing blob sha256:46839fd680b76fed7005bc63ae1207193c129051c10dJIB> [=========================== ] 88.4% complete > pushing blob sha256:46839fd680b76fed7005bc63ae1207193c129051c10dJIB> [=========================== ] 88.5% complete > pushing blob sha256:46839fd680b76fed7005bc63ae1207193c129051c10dJIB> [=========================== ] 88.6% complete > pushing blob sha256:46839fd680b76fed7005bc63ae1207193c129051c10dJIB> [=========================== ] 88.7% complete > pushing blob sha256:46839fd680b76fed7005bc63ae1207193c129051c10dJIB> [=========================== ] 88.8% complete > pushing blob sha256:46839fd680b76fed7005bc63ae1207193c129051c10dJIB> [=========================== ] 88.8% complete > pushing blob sha256:46839fd680b76fed7005bc63ae1207193c129051c10dJIB> Pushing manifest for latest... \n\nJIB> [==============================] 100.0% complete\n[INFO] ------------------------------------------------------------------------\n[INFO] BUILD SUCCESS\n[INFO] ------------------------------------------------------------------------\n[INFO] Total time: 29.416 s\n[INFO] Finished at: 2020-08-29T17:43:57+05:30\n[INFO] ------------------------------------------------------------------------\n```\n\nYou can check afterwards whether the loaded container contains the file you mentioned in assembly or not:\n```\nspring-boot-with-jib : $ docker container run -it rohankanojia/spring-boot-sample:latest /bin/bash\n[root@c402fe994291 /]# ls \nDockerfile bin dev home lib64 mnt opt root sbin sys usr\nanaconda-post.log deployments etc lib media my-project-assembly proc run srv tmp var\n[root@c402fe994291 /]# ls my-project-assembly/\ndmp-sample-spring-boot-jib-0.33-SNAPSHOT.jar static\n[root@c402fe994291 /]# ls my-project-assembly/static/\ntestFile.txt\n[root@c402fe994291 /]# cat my-project-assembly/static/testFile.txt \nI should be present\n[root@c402fe994291 /]# exit\nexit\n```\n\n### Registry Configuration\nYou can provide registry credentials in 3 formats:\n- You can do a `docker login`(for Docker Hub) or `docker login \n\n\n \n \n docker.io\n testuser\n testpassword\n \n \n quay.io\n testuser\n testpassword\n \n \n\n\n\n```\n\n- You can provide registry credentials as part of XML configuration:\n```\n\n org.eclipse.jkube\n kubernetes-maven-plugin\n ${project.version}\n \n \n \n \n \n testuser\n testpassword\n \n \n\n\n```\n" }, { "path": "samples/spring-boot-with-jib/pom.xml", "content": "\n\n\n 4.0.0\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.34-SNAPSHOT\n ../pom.xml\n \n\n dmp-sample-spring-boot-jib\n 0.33-SNAPSHOT\n jar\n\n Docker Maven Plugin Example with Spring Boot With Build Mode JIB\n\n \n \n sonatype-nexus-snapshots\n Sonatype Nexus Snapshots\n https://oss.sonatype.org/content/repositories/snapshots/\n \n \n sonatype-nexus-staging\n Nexus Release Repository\n https://oss.sonatype.org/service/local/staging/deploy/maven2/\n \n \n \n 1.8\n 1.8\n true\n fabric8\n 2.3.3.RELEASE\n \n\n \n\n \n \n org.springframework.boot\n spring-boot-starter-web\n ${spring.version}\n \n\n \n org.springframework.boot\n spring-boot-starter-actuator\n ${spring.version}\n \n\n \n \n jakarta.xml.bind\n jakarta.xml.bind-api\n 2.3.2\n \n\n \n \n org.glassfish.jaxb\n jaxb-runtime\n 2.3.2\n \n\n \n\n \n \n \n org.springframework.boot\n spring-boot-maven-plugin\n ${spring.version}\n \n \n \n repackage\n \n \n \n \n \n io.fabric8\n docker-maven-plugin\n 0.33-SNAPSHOT\n \n \n \n ${docker.user}/spring-boot-dmp-sample-jib\n \n fabric8/java-centos-openjdk8-jdk:1.5.6\n \n artifact\n \n java -jar /maven/${project.artifactId}-${project.version}.jar\n \n 8080\n \n \n \n \n \n \n \n \n\n \n \n Jib-With-Assembly\n \n \n \n io.fabric8\n docker-maven-plugin\n 0.33-SNAPSHOT\n \n \n \n ${docker.user}/spring-boot-dmp-sample-jib\n \n fabric8/java-centos-openjdk8-jdk:1.5.6\n \n my-project-assembly\n \n copy-test-file\n \n \n \n ${project.basedir}/static/testFile.txt\n \n static\n \n \n ${project.basedir}/target/${project.artifactId}-${project.version}.jar\n .\n \n \n \n /deployments\n \n java -jar /my-project-assembly/${project.artifactId}-${project.version}.jar\n \n 8080\n \n \n \n \n \n \n\n \n \n \n \n\n\n" }, { "path": "samples/spring-boot-with-jib/src/main/java/io/fabric8/maven/sample/springboot/jib/Application.java", "content": "package io.fabric8.maven.sample.springboot.jib;\n\nimport org.springframework.boot.SpringApplication;\nimport org.springframework.boot.autoconfigure.SpringBootApplication;\n\n@SpringBootApplication\npublic class Application {\n\n public static void main(String[] args) {\n SpringApplication.run(Application.class, args);\n }\n\n}\n" }, { "path": "samples/spring-boot-with-jib/src/main/java/io/fabric8/maven/sample/springboot/jib/HelloController.java", "content": "package io.fabric8.maven.sample.springboot.jib;\n\nimport org.springframework.web.bind.annotation.RequestMapping;\nimport org.springframework.web.bind.annotation.RestController;\n\n\n@RestController\npublic class HelloController {\n\n @RequestMapping(\"/\")\n public String index() {\n return \"

Greetings from Spring Boot(Powered by JIB)!!

\";\n }\n\n}\n" }, { "path": "samples/spring-boot-with-jib/static/testFile.txt", "content": "I should be present\n" }, { "path": "samples/test.xml", "content": "\n build\n blas\n blub\n \n \n \n\n \n Test\n blub\n \n \n \n \n \n" }, { "path": "samples/volume/pom.xml", "content": "\n 4.0.0\n\n \n\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.34-SNAPSHOT\n ../pom.xml\n \n\n dmp-sample-volume\n 0.34-SNAPSHOT\n\n \n \n \n io.fabric8\n docker-maven-plugin\n \n true\n always\n true\n \n \n newVolume\n \n \n \n \n \n start\n pre-integration-test\n \n volume-create\n start\n \n \n \n stop\n post-integration-test\n \n stop\n volume-remove\n \n \n \n \n \n \n\n\n" }, { "path": "samples/zero-config/Dockerfile", "content": "FROM openjdk:jre\n\nARG jar_file=target/dmp-sample-zero-config.jar\n\nARG FOO=${}\nADD $jar_file /tmp/zero-config.jar\nCMD java -cp /tmp/zero-config.jar HelloWorld\n" }, { "path": "samples/zero-config/pom.xml", "content": "\n\n 4.0.0\n\n \n io.fabric8.dmp.samples\n dmp-sample-parent\n 0.34-SNAPSHOT\n ../pom.xml\n \n\n\n io.fabric8.dmp.samples\n dmp-sample-zero-config\n jar\n 0.34-SNAPSHOT\n\n \n ${project.build.directory}/${project.build.finalName}.jar\n 1.8\n 1.8\n \n\n \n dmp-sample-zero-config\n \n \n io.fabric8\n docker-maven-plugin\n \n \n \n\n\n" }, { "path": "samples/zero-config/src/main/java/HelloWorld.java", "content": "public class HelloWorld {\n\n public static void main(String[] args) {\n System.out.println(\"Hello world !\");\n }\n}\n" }, { "path": "src/main/asciidoc/inc/_authentication.adoc", "content": "\n[[authentication]]\n= Authentication\n\nWhen pulling (via the `autoPull` mode of `{plugin}:start`) or pushing image, it\nmight be necessary to authenticate against a Docker registry.\n\nThere are six different locations searched for credentials. In order, these are:\n\n* Providing system properties `docker.username` and `docker.password` from the outside.\n* Providing system properties `registry.username` and `registry.password` from the outside.\n* Using a `` section in the plugin configuration with `` and `` elements.\n* Using OpenShift configuration in `~/.config/kube`\n* Using a `` configuration in `~/.m2/settings.xml`\n* Login into a registry with `docker login` (credentials in a credential helper or in `~/.docker/config.json`)\n\nUsing the username and password directly in the `pom.xml` is not\nrecommended since this is widely visible. This is easiest and\ntransparent way, though. Using an `` is straight forward:\n\n[source,xml]\n----\n\n \n consol/tomcat-7.0\n ...\n \n jolokia\n s!cr!t\n \n \n\n----\n\nThe system property provided credentials are a good compromise when\nusing CI servers like Jenkins. You simply provide the credentials from\nthe outside:\n\n.Example\n[source, sh, subs=\"+attributes\"]\n----\nmvn -Ddocker.username=jolokia -Ddocker.password=s!cr!t {plugin}:push\n----\n\nThe most _mavenish_ way is to add a server to the Maven settings file `~/.m2/settings.xml`:\n\n.Example\n[source,xml]\n----\n\n \n docker.io\n jolokia\n s!cr!t\n \n ....\n\n----\n\nThe server id must specify the registry to push to/pull from, which by\ndefault is central index `docker.io` (or `index.docker.io` / `registry.hub.docker.com` as fallbacks).\nHere you should add your docker.io account for your repositories. If you have multiple accounts\nfor the same registry, the second user can be specified as part of the ID. In the example above, if you\nhave a second account 'fabric8io' then use an `docker.io/fabric8io` for this second entry. I.e. add the\nusername with a slash to the id name. The default without username is only taken if no server entry with\na username appended id is chosen.\n\nThe most _secure_ way is to rely on docker's credential store or credential helper and read confidential information\nfrom an external credentials store, such as the native keychain of the operating system. Follow the instruction on\nhttps://docs.docker.com/engine/reference/commandline/login/#credentials-store[the docker login documentation].\n\nAs a final fallback, this plugin consults `$DOCKER_CONFIG/config.json` if `DOCKER_CONFIG` is set, or `~/.docker/config.json` if not, and reads credentials stored directly within this\nfile. This unsafe behavior happened when connecting to a registry with the command `docker login` from the command line\nwith older versions of docker (pre 1.13.0) or when docker is not configured to use a\nhttps://docs.docker.com/engine/reference/commandline/login/#credentials-store[credential store].\n\n== Pull vs. Push Authentication\n\nThe credentials lookup described above is valid for both push and\npull operations. In order to narrow things down, credentials can be\nprovided for pull or push operations alone:\n\nIn an `` section a sub-section `` and/or ``\ncan be added. In the example below the credentials provider are only\nused for image push operations:\n\n.Example\n[source,xml]\n----\n\n \n consol/tomcat-7.0\n ...\n \n \n jolokia\n s!cr!t\n \n \n \n\n----\n\nWhen the credentials are given on the command line as system\nproperties, then the properties `docker.pull.username` /\n`docker.pull.password` and `docker.push.username` /\n`docker.push.password` are used for pull and push operations,\nrespectively (when given). Either way, the standard lookup algorithm\nas described in the previous section is used as fallback.\n\n== OpenShift Authentication\n\nWhen working with the default registry in OpenShift, the credentials\nto authenticate are the OpenShift username and access token. So, a\ntypical interaction with the OpenShift registry from the outside is:\n\n----\noc login\n...\nmvn -Ddocker.registry=docker-registry.domain.com:80/default/myimage \\\n -Ddocker.username=$(oc whoami) \\\n -Ddocker.password=$(oc whoami -t)\n----\n\n(note, that the image's username part (\"default\" here\") must\ncorrespond to an OpenShift project with the same name to which you\ncurrently connected account has access).\n\nThis can be simplified by using the system property\n`docker.useOpenShiftAuth` in which case the plugin does the\nlookup. The equivalent to the example above is\n\n----\noc login\n...\nmvn -Ddocker.registry=docker-registry.domain.com:80/default/myimage \\\n -Ddocker.useOpenShiftAuth\n----\n\nAlternatively the configuration option `` can be\nadded to the `` section.\n\nFor dedicated _pull_ and _push_ configuration the system properties\n`docker.pull.useOpenShiftAuth` and `docker.push.useOpenShiftAuth` are\navailable as well as the configuration option `` in\nan `` or `` section within the ``\nconfiguration.\n\nIf `useOpenShiftAuth` is enabled then the OpenShift Konfiguration will be looked up in `$KUBECONFIG` or, if this environment variable is not set, in `~/.kube/config`.\n\n[[password-encryption]]\n== Password encryption\n\nRegardless which mode you choose you can encrypt password as described\nin the\nhttp://maven.apache.org/guides/mini/guide-encryption.html[Maven documentation]. Assuming\nthat you have setup a _master password_ in\n`~/.m2/security-settings.xml` you can create easily encrypt\npasswords:\n\n.Example\n[source,bash]\n----\n$ mvn --encrypt-password\nPassword:\n{QJ6wvuEfacMHklqsmrtrn1/ClOLqLm8hB7yUL23KOKo=}\n----\n\nThis password then can be used in `authConfig`, `docker.password`\nand/or the `` setting configuration. However, putting an\nencrypted password into `authConfig` in the `pom.xml` doesn't make\nmuch sense, since this password is encrypted with an individual master\npassword.\n\n[[extended-authentication]]\n== Extended Authentication\n\nSome docker registries require additional steps to authenticate.\nlink:https://docs.aws.amazon.com/AmazonECR/latest/userguide/ECR_GetStarted.html[Amazon ECR] requires using an IAM access key to obtain temporary docker login credentials.\nThe `docker:push` and `docker:pull` goals automatically execute this exchange for any registry of the form __ *.dkr.ecr.* __ *.amazonaws.com*, unless the `skipExtendedAuth` configuration (`docker.skip.extendedAuth` property) is set true.\n\nNote that for an ECR repository with URI `123456789012.dkr.ecr.eu-west-1.amazonaws.com/example/image` the d-m-p's `docker.registry` should be set to `123456789012.dkr.ecr.eu-west-1.amazonaws.com` and `example/image` is the `` of the image.\n\nYou can use any IAM access key with the necessary permissions in any of the locations mentioned above except `~/.docker/config.json`.\nUse the IAM *Access key ID* as the username and the *Secret access key* as the password.\nIn case you're using temporary security credentials provided by the AWS Security Token Service (AWS STS), you have to provide the *security token* as well.\nTo do so, either specify the `docker.auth` system property or provide an `` element alongside username & password in the `authConfig`.\n\nd-m-p will attempt to read AWS credentials from some well-known spots in case there is no explicit configuration:\n\n* it will pick up ENV variables link:https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html[as documented for the AWS CLI]\n\n* it will pick up temporary credentials of link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html[the IAM role of an EC2 instance]\n\n* it will pick up temporary credentials of link:https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html[the IAM role of a fargate task (OR ECS with EC2 with ECS_AWSVPC_BLOCK_IMDS as \"true\")]\n\nIf any of these authentication information is accessible, it will be used.\n\n[NOTE]\n====\nFor a more complete, robust and reliable authentication experience, you can add the AWS SDK for Java as a dependency.\n\n[source,xml]\n----\n\n \n io.fabric8\n docker-maven-plugin\n \n \n com.amazonaws\n aws-java-sdk-core\n 1.11.707\n \n \n \n\n----\n\nThis extra dependency allows the usage of all link:https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/credentials.html[options] that the AWS default credential provider chain provides.\n\nIf the AWS SDK is found in the classpath, it takes precedence over the custom AWS credentials lookup mechanisms listed above.\n====\n" }, { "path": "src/main/asciidoc/inc/_docker-build.adoc", "content": "\n[[docker:build]]\n== *docker:build*\n\nThis goal will build all images which have a `` configuration section, or, if the global configuration variable `filter` (property:\n`docker.filter`) is set, only the images contained in this variable (comma separated) will be built.\n\ninclude::build/_overview.adoc[]\n\n\n[[build-configuration]]\n=== Configuration\n\ninclude::build/_configuration.adoc[]\n\n[[build-assembly]]\n=== Assembly\n\ninclude::build/_assembly.adoc[]\n\n[[misc-startup]]\n=== Startup Arguments\n\ninclude::misc/_startup.adoc[]\n\n[[build-buildargs]]\n=== Build Args\n\ninclude::build/_buildargs.adoc[]\n\n[[build-healthcheck]]\n=== Healthcheck\n\ninclude::build/_healthcheck.adoc[]\n" }, { "path": "src/main/asciidoc/inc/_docker-logs.adoc", "content": "\n[[docker:logs]]\n== *docker:logs*\n\nWith this goal it is possible to print out the logs of containers\nstarted from images configured in this plugin. By default only the\nlatest container started is printed, but this can be changed with a\nproperty. The format of the log output is influenced by run\nconfiguration of the configured images. The following system\nproperties can the behaviour of this goal:\n\n.Logging options\n[cols=\"1,5\"]\n|===\n| Property | Description\n\n| *docker.logAll*\n| If set to `true` the logs of all containers created from images configured for this plugin are printed. The container id is then prefixed before every log line. These images can contain many containers which are already stopped. It is probably a better idea to use `docker logs` diretly from the command line.\n\n| *docker.follow*\n| If given will wait for subsequent log output until CRTL-C is pressed. This is similar to the behaviour of `docker logs -f` (or `tail -f`).\n\n| *docker.filter*\n| Filter to restrict the set of images for which log should be fetched. This can be a comma separated list of image or alias names.\n\n| *docker.logDate*\n| Date format to use. See \"<>\" for available formats.\n|===\n\n.Example\n[source, sh, subs=\"+attributes\"]\n----\n$ mvn {plugin}:logs -Ddocker.follow -Ddocker.logDate=DEFAULT\n----\n" }, { "path": "src/main/asciidoc/inc/_docker-push.adoc", "content": "\n[[docker:push]]\n== *docker:push*\n\ninclude::push/_overview.adoc[]\n\ninclude::push/_configuration.adoc[]\n" }, { "path": "src/main/asciidoc/inc/_docker-remove.adoc", "content": "\n[[docker:remove]]\n== *docker:remove*\n\nThis goal can be used to clean up images. By default all images with a build configuration are removed.\nYou can tune this by setting the property `removeMode` (property: `docker.removeMode`) to one of the following values:\n\n.removeMode Values\n[cols=\"1,5\"]\n|===\n| Value | Description\n\n| `build`\n| All images with a <>\n\n| `run`\n| All images without a <>\n\n| `all`\n| All configured images\n\n| `data`\n| All data images, which are images without a <>.\n|===\n\nPreviously, this could be tuned also by providing the property `removeAll` which indicates to remove all images managed by this build. Otherwise only data images were delete before 0.24.0. `removeAll` is deprecated and will be removed soone. Please use `removeMode` instead.\n\nAs with the other goals, the configuration `image` can be used to tune the images to remove. All containers belonging to the images are removed as well as the all tags assigned to this image\n\nConsidering three images 'db','tomcat' and 'data' where 'data' is the only image with a build configuration:\n\n* `mvn {plugin}:remove` will remove 'data'\n* `mvn -Ddocker.removeMode=all {plugin}:remove` will remove all three images\n* `mvn -Ddocker.filter=data,tomcat {plugin}:remove` will remove 'data'\n* `mvn -Ddocker.filter=data,tomcat -Ddocker.removeMode=all {plugin}:remove` will remove 'data' and 'tomcat'\n\n.Remove options\n[cols=\"1,5,1\"]\n|===\n| Element | Description | Property\n\n| *skipTag*\n| If set to `true` this plugin won't remove any tags\n| `docker.skip.tag`\n\n| *removeNamePattern*\n| If a list of <> is provided, any images matching the patterns will be removed,\nindependently of whether there is an <> marked for removal.\n| `docker.removeNamePattern`\n|===" }, { "path": "src/main/asciidoc/inc/_docker-save.adoc", "content": "\n[[docker:save]]\n== *docker:save*\n\nThe `{plugin}:save` target saves an image defined in the build configuration to a local file, analogous to `docker save`.\nIf the option `saveFile` is not set, the file name is calculated automatically:\n\n* If `saveAlias` is used then the file is stored as `target/-.tar.gz`\n* Otherwise the archive is stored as `target/-.tar.gz`\n\nPlease note that the exported image contains all image layers and can be quite large (also, it takes a bit to export the image).\n\n.Controlling image compression\nThe file name extension is used to select a compression method for the output.\n[cols=\"3,2,1\"]\n|===\n| Extensions | Compression | Type\n\n| .tar or unrecognized\n| No compression\n| .tar\n\n| .tar.gz, .tgz\n| GZIP compression\n| .tar.gz\n\n| .tar.bz, .tar.bz2, .tar.bzip2\n| BZIP2 compression\n| .tar.bz\n\n|===\n\n.Attaching the saved image as an artifact\nIf `saveClassifier` is set, the saved archive will be attached to the project using the provided classifier and the type determined from the file name. The placeholder `%a` will be replaced with the image alias.\n\nNote that using overriding the default to use `docker` or `docker-%a` may lead to a conflict if a source archive is also attached with <<{plugin}:source>>.\n\n.Save options\n[cols=\"1,5,1\"]\n|===\n| Element | Description | Property\n\n| *saveName*\n| The name of the image configuration to save. Must not be used together with `alias`.\n| `docker.save.name`\n\n| *saveAlias*\n| The alias of the image configuration to save. Must not be used together with `name`.\n| `docker.save.alias`\n\n| *saveFile*\n| The filename to save.\n| `docker.save.file` or `docker.file` or `file`\n\n| *saveClassifier*\n| If set, attach the the saved archive to the project with the provided classifier. A placeholder of `%a` will be replaced with the image alias.\n| `docker.save.classifier`\n\n| *skipSave*\n| A boolean flag whether to skip execution of the goal.\n| `docker.skip.save`\n|===\n" }, { "path": "src/main/asciidoc/inc/_docker-source.adoc", "content": "\n[[docker:source]]\n== *docker:source*\n\nThe `{plugin}:source` target can be used to attach a docker build archive containing the Dockerfile and all added files to the Maven project with a certain classifier. It reuses the configuration from <<{plugin}:build>>.\n\nBy default, only the first image configuration is used for creating the source archive.\nYou can export all image configurations by setting the `sourceMode` configuration to `all`:\n\n.Export all image configs\n[source,xml]\n----\n\n docker-maven-plugin\n \n \n all\n \n \n\n----\n\nFor exporting all image configurations, `{plugin}:source` uses the image's link:image-configuration.md[alias] as part of the classifier, so it is mandatory that the alias is set for\nthis goal to work when all images should be exported this way.\nThe classifier is calculated as `docker-` so when the alias is set to `service`, then the classifier is `docker-service`.\n\nIf you only export the first image configuration (which is the default), then the classifier is just `docker` (without alias).\n\n`{plugin}:source` can be attached to a Maven execution phase, which is `generate-sources` by default.\n\nFor example, this configuration will attach the docker build archive to the artifacts to store in the repository:\n\n.Example\n[source,xml]\n----\n\n docker-maven-plugin\n \n \n \n sources\n \n source\n \n \n \n\n----\n\nIf not bound to an execution phase, `docker:source` requires that the artifact has been created so you call it best together with `package`\n" }, { "path": "src/main/asciidoc/inc/_docker-start.adoc", "content": "\n[[docker:start]]\n== *docker:start*\n\ninclude::start/_overview.adoc[]\n\n[[start-configuration]]\n=== Configuration\n\ninclude::start/_configuration.adoc[]\n\n[[misc-env]]\n=== Environment and Labels\n\ninclude::misc/_env.adoc[]\n\n[[start-port-mapping]]\n=== Port Mapping\n\ninclude::start/_port-mapping.adoc[]\n\n[[start-links]]\n=== Links\n\ninclude::start/_links.adoc[]\n\n[[network-configuration]]\n=== Network\n\ninclude::start/_network.adoc[]\n\n[[start-depends-on]]\n=== Depends-On\n\ninclude::start/_depends-on.adoc[]\n\n[[start-restart]]\n=== Restart Policy\n\ninclude::start/_restart.adoc[]\n\n[[start-volumes]]\n=== Volumes\n\ninclude::start/_volumes.adoc[]\n\n[[start-wait]]\n=== Wait\n\ninclude::start/_wait.adoc[]\n\n[[start-logging]]\n=== Logging\n\ninclude::start/_logging.adoc[]\n" }, { "path": "src/main/asciidoc/inc/_docker-stop.adoc", "content": "\n[[docker:stop]]\n== *docker:stop*\n\nStops and removes a docker container. This goal stops every container started with `<{plugin}:start>` either during the same build (e.g. when bound to lifecycle phases when doing integration tests) or for containers created by a previous call to `<{plugin}:start>`\n\nIf called within the same build run, only the containers that were explicitly started during the run will be stopped. Existing containers started using `{plugin}:start` for the project will not be affected.\n\nIf called as a separate invocation, the plugin will stop and remove any container it finds whose image is defined in the project's configuration. Any existing containers found running whose image name matches but were not started by the plugin will not be affected.\n\nIn case the naming strategy for an image is `alias` (i.e. the container name is set to the given alias), then only the container with this alias is stopped. Other containers originating from the same image are not touched.\n\nIt should be noted that any containers created prior to version `0.13.7` of the plugin may not be stopped correctly by the plugin because the label needed to tie the container to the project may not exist. Should this happen, you will need to use the Docker CLI to clean up the containers and/or use the `docker.allContainers` option listed below.\n\nFor tuning what should happen when stopping there are four global parameters which are typically used as system properties:\n`allContainers`, `keepContainer`, `keepRunning` and `removeVolumes`.\n\n.Stop configuration\n[cols=\"1,5,1\"]\n|===\n| Element | Description | Parameter\n\n| *allContainers*\n| Stops and removes any container that matches an image defined in the current project's configuration. This was the default behavior of the plugin prior up to version 0.13.6\n| `docker.allContainers`\n\n| <>\n| Default pattern that <<{plugin}:start>> uses for naming containers when they are created. See <> for details.\nThis should match the setting for <<{plugin}:start>> goals if the goals are configured in separate executions.\n| `docker.containerNamePattern`\n\n| *keepContainer*\n| If set to `true` not destroy container after they have been stopped. Default is false.\n| `docker.keepContainer`\n\n| *keepRunning*\n| If set to `true` actually don't stop the container. This apparently makes only sense when used on the command line when doing integration testing (i.e. calling `{plugin}:stop` during a lifecycle binding) so that the container are still running after an integration test. This is useful for analysis of the containers (e.g. by entering it with `docker exec`).\n| `docker.keepRunning`\n\n| *removeVolumes*\n| If set to `true` will remove any volumes associated to the container as well. This option will be ignored if either `keepContainer` or `keepRunning` are true.\n| `docker.removeVolumes`\n\n| *stopNamePattern*\n| If a list of <> is provided, any containers matching the patterns will be stopped and\nremoved (depending on the values of `keepContainer` and `keepRunning`),\nindependently of whether there is an <>.\n| `docker.stopNamePattern`\n|===\n\n.Example\n[source,sh]\n----\n$ mvn -Ddocker.keepRunning clean install\n----\n" }, { "path": "src/main/asciidoc/inc/_docker-tag.adoc", "content": "[[docker:tag]]\n== *docker:tag*\n\nThe `{plugin}:tag` tags an image so that it becomes part of a repository. You can use it to tag an already built image. Here is an example of it's usage:\n\n[source]\n----\n~/work/repos/docker-maven-plugin/samples/zero-config : $ mvn docker:tag -Ddocker.image.tag=0.9.0\n[INFO] Scanning for projects...\n[INFO]\n[INFO] -----------< io.fabric8.dmp.samples:demp-sample-zero-config >-----------\n[INFO] Building demp-sample-zero-config 0.33-SNAPSHOT\n[INFO] --------------------------------[ jar ]---------------------------------\n[INFO]\n[INFO] --- docker-maven-plugin:0.33-SNAPSHOT:tag (default-cli) @ demp-sample-zero-config ---\n[INFO] DOCKER> Tagging image samples/demp-sample-zero-config:0.9.0 successful!\n[INFO] ------------------------------------------------------------------------\n[INFO] BUILD SUCCESS\n[INFO] ------------------------------------------------------------------------\n[INFO] Total time: 1.155 s\n[INFO] Finished at: 2020-06-27T14:05:33+05:30\n[INFO] ------------------------------------------------------------------------\n~/work/repos/docker-maven-plugin/samples/zero-config : $ docker images | grep 0.9.0\nsamples/demp-sample-zero-config 0.9.0 ac5c5991505d About an hour ago 479MB\n----\n.Supported options\n[cols=\"1,2,1\"]\n|===\n| Element | Description | Property\n\n| *tagName*\n| The name of the new tag.\n| `docker.image.tag`\n\n| *repo*\n| The repository to tag in. For example, `someuser/someimage`.\n| `docker.image.repo`\n|===\n" }, { "path": "src/main/asciidoc/inc/_docker-volume-create.adoc", "content": "\n[[docker:volume-create]]\n== *docker:volume-create*\n\nThis goals creates one or more standalone https://docs.docker.com/engine/tutorials/dockervolumes/[Docker volume], which can be referenced in a <> configuration for linking to a volume during runtime.\nEach volume has therefore a unique and referenceable name. Beside the volume driver and driver options can be specified.\n\n.Example for a volume configuration\n[source,xml]\n----\n\n \n \n \n temp-volume\n local\n \n tmpfs\n tmpfs\n size=100m,uid=1000\n \n \n true\n \n \n \n ...\n \n\n----\n\n[[volume-create-configuration]]\n.Configuration\n\nThe following options are available when creating volumes:\n\n.Volume configuration\n|===\n| Element | Description\n\n| *name*\n| Name of the volume\n\n| *driver*\n| Volume driver to use. By default the driver `local` is used which is created on the local file system. Please refer to your Docker installation which additional drivers are available.\n\n| *opts*\n| Driver specific options passed in as custom `value` where its maps to `key=value` pairs for driver options as they can be provided from the Docker CLI, too. Each volume driver supports different options. The options supported by the `local` driver are the well known http://man7.org/linux/man-pages/man8/mount.8.html[Linux mount options].\n\n|*labels*\n| Labels given as `value` similar to image labels described in <>. These labels are used to tag the volumes themselves.\n|===\n" }, { "path": "src/main/asciidoc/inc/_docker-volume-remove.adoc", "content": "[[docker:volume-remove]]\n== *docker:volume-remove*\n\nThis goals is the counterpart to <> and removes a volume.\nDocker volumes are configured outside of Docker images, but can be referenced by them.\nThe configuration is the same as for <>\n\n*Example:*\n\n[source,xml]\n----\n\n \n \n \n temp-volume\n ....\n \n \n ...\n \n\n----\n\n[[volume-remove-configuration]]\n.Configuration\n\nThe configuration is quite simple. Only the name of the volume to delete is required.\n\n.Volume configuration\n[options=\"header\"]\n|===\n| Element | Description\n\n| *name*\n| Name of the volume\n\n|===\n" }, { "path": "src/main/asciidoc/inc/_docker-watch.adoc", "content": "\n[[docker:watch]]\n== *docker:watch*\n\ninclude::watch/_overview.adoc[]\n\n[[watch-configuration]]\ninclude::watch/_configuration.adoc[]\n" }, { "path": "src/main/asciidoc/inc/_external-configuration.adoc", "content": "\n[[external-configuration]]\n= External Configuration\n\nFor special configuration needs, there is the possibility to get the\nruntime and build configuration from places outside the plugin's\nconfiguration. This is done with the help of ``\nconfiguration sections which at least has a `` subelement. This\n`` element selects a specific so called \"handler\" which is\nresponsible for creating the full image configuration. A handler can\ndecide to use the `` and `` configuration which could\nbe provided in addition to this `` section or it can decide\nto completely ignore any extra configuration option.\n\nA handler can also decide to expand this single image configuration to\na list of image configurations. The image configurations resulting\nfrom such a external configuration are added to the _regular_\n`` configurations without an `` section.\n\nThe available handlers are described in the following.\n\n[[property-configuration]]\n== Properties\n\ninclude::external/_property_configuration.adoc[]\n\n[[docker-compose]]\n== Docker Compose\n\ninclude::external/_docker_compose.adoc[]\n" }, { "path": "src/main/asciidoc/inc/_global-configuration.adoc", "content": "\n[[global-configuration]]\n= Global configuration\n\nGlobal configuration parameters specify overall behavior like the\nconnection to the Docker host. The corresponding system properties\nwhich can be used to set it from the outside are given in\nparentheses.\n\nThe docker-maven-plugin uses the Docker remote API so the URL of your\nDocker Daemon must somehow be specified. The URL can be specified by\nthe dockerHost or machine configuration, or by the `DOCKER_HOST`\nenvironment variable.\n\nThe Docker remote API supports communication via SSL and\nauthentication with certificates. The path to the certificates can\nbe specified by the certPath or machine configuration, or by the\n`DOCKER_CERT_PATH` environment variable.\n\n.Global Configuration\n[cols=\"1,5,1\"]\n|===\n| Element | Description | Property\n\n| *apiVersion*\n| Use this variable if you are using an older version of docker not compatible with the current default use to communicate with the server.\n| `docker.apiVersion`\n\n| *authConfig*\n| Authentication information when pulling from or pushing to Docker registry. There is a dedicated section <> for how doing security.\n|\n\n| *autoCreate CustomNetworks*\n| Create automatically Docker networks during `{plugin}:start` and remove it during `{plugin}:stop` if you provide a custom network in the run configuration of an image. The default is `false`.\n| `docker.autoCreate` `CustomNetworks`\n\n| *autoPull*\na| Decide how to pull missing base images or images to start. This option is *deprecated*, please use <> instead.\n\nThe following values are supported:\n\n * `on` or `once`: Automatic download any missing images (default)\n * `off` : Automatic pulling is switched off always\n * `always` : Pull images always even when they already exist locally.\n\n| `docker.autoPull`\n\n| *buildArchiveOnly*\na| Skip the actual Docker image build and only create the archive holding the Dockerfile and build context. The following values are supported:\n\n* `/path/to/archive` : Create the build tar archive as file with name `/path/to/archive` and then stop without doing the actual image build\n* `true` (or an empty value) : Skip building the image, but don't copy the generated build archive.\n* `false` : Build the image. This is the default behaviour.\n| `docker.buildArchiveOnly`\n\n| *certPath*\n| Path to SSL certificate when SSL is used for communicating with the Docker daemon. These certificates are normally stored in `~/.docker/`. With this configuration the path can be set explicitly. If not set, the fallback is first taken from the environment variable `DOCKER_CERT_PATH` and then as last resort `~/.docker/`. The keys in this are expected with it standard names `ca.pem`, `cert.pem` and `key.pem`. Please refer to the https://docs.docker.com/articles/https[Docker documentation] for more information about SSL security with Docker.\n| `docker.certPath`\n\n| *dockerHost*\na| The URL of the Docker Daemon. If this configuration option is not given, then the optional `` configuration section is consulted. The scheme of the URL can be either given directly as `http` or `https`\ndepending on whether plain HTTP communication is enabled or SSL should\nbe used. Alternatively the scheme could be `tcp` in which case the\nprotocol is determined via the IANA assigned port: 2375 for `http`\nand 2376 for `https`. Finally, Unix sockets are supported by using\nthe scheme `unix` together with the filesystem path to the unix socket.\nThe discovery sequence used by the docker-maven-plugin to determine\nthe URL is:\n\n. value of *dockerHost* (`docker.host`)\n. the Docker host associated with the docker-machine named in ``, i.e. the `DOCKER_HOST` from `docker-machine env`. See <> for more information about Docker machine support. If `` is not set, then no docker-machine detection is used.\n. the value of the environment variable `DOCKER_HOST`.\n. `/var/run/docker.sock` if it is a readable socket (Unix & OS X).\n. `//./pipe/docker_engine` if it is a readable named pipe (Windows)\n| `docker.host`\n\n| *filter*\n| In order to temporarily restrict the operation of plugin goals this configuration option can be used. Typically this will be set via the system property `docker.filter` when Maven is called. The value can be a single image name (either its alias or full name) or it can be a comma separated list with multiple image names. Any name which doesn't refer an image in the configuration will be ignored.\n| `docker.filter`\n\n| [[image-pull-policy]] *imagePullPolicy*\na| Specify whether images should be pull when looking for base images while building or images for starting.\nThis property can take the following values (case insensitive):\n\n * `IfNotPresent`: Automatic download any missing images (default)\n * `Never` : Automatic pulling is switched off always\n * `Always` : Pull images always even when they already exist locally.\n\nBy default a progress meter is printed out on the console, which is omitted when using Maven in batch mode (option `-B`). A very simplified progress meter is provided when using no color output (i.e. with `-Ddocker.useColor=false`).\n| `docker.imagePullPolicy`\n\n| *logDate*\n| Date format which is used for printing out container logs. This configuration can be overwritten by individual run configurations and described below. The format is described in <>.\n| `docker.logDate`\n\n| *logStdout*\n| For all container logging to standard output if set to `true`, regardless whether a `file` for log output is specified. See also <>\n| `docker.logStdout`\n\n| *machine*\n| Docker machine configuration. See <> for possible values\n|\n\n| *maxConnections*\n| Number of parallel connections are allowed to be opened to the Docker Host. For parsing log output, a connection needs to be kept open (as well for the wait features), so don't put that number to low. Default is 100 which should be suitable for most of the cases.\n| `docker.maxConnections`\n\n| *jib*\n| Delegate Image Build process to https://github.com/GoogleContainerTools/jib[JIB], `false` by default. Note that this option is applicable only for <> and <> goals, other goals won't work if this is enabled (since they dependend on Docker specific features)\n| `docker.build.jib`\n\n| *outputDirectory*\n| Default output directory to be used by this plugin. The default value is `target/docker` and is only used for the goal `{plugin}:build`.\n| `docker.target.dir`\n\n| *portPropertyFile*\n| Global property file into which the mapped properties should be written to. The format of this file and its purpose are also described in <>.\n|\n\n| *registry*\n| Specify globally a registry to use for pulling and pushing images. See <> for details.\n| `docker.registry`\n\n| *skip*\n| With this parameter the execution of this plugin can be skipped completely.\n| `docker.skip`\n\n| *skipBuild*\n| If set no images will be build (which implies also _skip.tag_) with `{plugin}:build`\n| `docker.skip.build`\n\n| *skipPush*\n| If set dont push any images even when `{plugin}:push` is called.\n| `docker.skip.push`\n\n| *skipRun*\n| If set dont create and start any containers with `{plugin}:start` or `{plugin}:run`\n| `docker.skip.run`\n\n| *skipTag*\n| If set to `true` this plugin won't add any tags to images that have been built with `{plugin}:build`. +\nIf set to `true` this plugin won't push any tags with `{plugin}:push`. +\nIf set to `true` this plugin won't remove any tags with `{plugin}:remove`. +\n| `docker.skip.tag`\n\n| *skipMachine*\n| Skip using docker machine in any case\n| `docker.skip.machine`\n\n| *sourceDirectory*\n| Default directory that contains the assembly descriptor(s) used by the plugin. The default value is `src/main/docker`. This option is only relevant for the `{plugin}:build` goal.\n| `docker.source.dir`\n\n| *useColor*\n| Whether to use colored log output. By default this is switched on when running on a console, off otherwise.\n| `docker.useColor`\n\n| *verbose*\n| String attribute for switching on verbose output on standard output (stdout). It takes a comma separated list of string values to switch on various verbosity groups.\n\nThe currently known groups are:\n\nbuild::\n Print out Docker build instructions\napi::\n API calls to the Docker daemons are logged\nall::\n All levels are enabled\n\nIf you set an empty string (or only e.g. `-Ddocker.verbose`) then the \"build\" group is enabled. You can also use \"true\" / \"false\" to switch on / off verbose logging.\n\nDefault is that verbose logging is disabled.\n| `docker.verbose`\n|===\n\n.Example\n[source,xml]\n----\n\n https://localhost:2376\n src/main/dockerCerts\n true\n .....\n\n----\n\n[[docker-machine]]\n.Docker Machine\nThis plugin supports also Docker machine (which must be installed locally, of course). A Docker machine configuration can be provided with a top-level `` configuration section. This configuration section knows the following options:\n\n.Docker Machine Options\n[cols=\"1,4\"]\n|===\n| Element | Description\n\n| *name*\n| Docker machine's name. Default is `default`\n\n| *autoCreate*\n| if set to `true` then a Docker machine will automatically created. Default is `false`.\n\n| *regenerateCertsAfterStart*\n| if set to `true` then certificates will be regenerated after starting the Docker Machine. This is useful if using the AWS EC2 driver, which will assign machines new IP addresses after each start. Default is `false`.\n\n| *createOptions*\n| Map with options for Docker machine when auto-creating a machine. See the docker machine documentation for possible options.\n|===\n\n\nWhen no Docker host is configured or available as an environment variable, then the configured Docker machine is used. If the machine exists but is not running, it is started automatically. If it does not exists but `autoCreate` is true, then the machine is created and started. Otherwise, an error is printed. Please note, that a machine which has been created because of `autoCreate` gets never deleted by docker-maven-plugin. This needs to be done manually if required.\n\nIn absence of a `` configuration section the Maven property `docker.machine.name` can be used to provide the name of a Docker machine. Similarly, the property `docker.machine.autoCreate` can be set to true for creating a Docker machine, too.\n\nYou can use the property `docker.skip.machine` if you want to override the internal detection mechanism to always disable docker machine support.\n\n.Example\n[source,xml]\n----\n\n\n \n maven\n true\n \n virtualbox\n 2\n \n \n .....\n\n----\n" }, { "path": "src/main/asciidoc/inc/_goals.adoc", "content": "= Maven Goals\n\nThis plugin supports the following goals which are explained in detail\nin the next sections.\n\n.Plugin Goals\n[cols=\"2,3,2\"]\n|===\n|Goal | Description | Default Lifecycle Phase\n\n|**<<{plugin}:build>>**\n|Build images\n|install\n\n|**<<{plugin}:start>>** or **<<{plugin}:start,{plugin}:run>>**\n|Create and start containers\n|pre-integration-test\n\n|**<<{plugin}:stop>>**\n|Stop and destroy containers\n|post-integration-test\n\n|**<<{plugin}:push>>**\n|Push images to a registry\n|deploy\n\n|**<<{plugin}:watch>>**\n|Watch for doing rebuilds and restarts\n|\n\n|**<<{plugin}:remove>>**\n|Remove images from local docker host\n|post-integration-test\n\n|**<<{plugin}:logs>>**\n|Show container logs\n|\n\n|**<<{plugin}:source>>**\n|Attach docker build archive to Maven project\n|package\n\n|**<<{plugin}:save>>**\n|Save images to a file\n|\n\n|**<<{plugin}:volume-create>>**\n|Create a volume for containers to share data\n|pre-integration-test\n\n|**<<{plugin}:volume-remove>>**\n|Remove a volume\n|post-integration-test\n|===\n\nNote that all goals are orthogonal to each other. For example in order\nto start a container for your application you typically have to build\nits image before. `{plugin}:start` does *not* imply building the image\nso you should use it then in combination with `{plugin}:build`.\n" }, { "path": "src/main/asciidoc/inc/_image-configuration.adoc", "content": "[[image-configuration]]\n= Image configuration\n\nThe plugin's configuration is centered around _images_. These are\nspecified for each image within the `` element of the\nconfiguration with one `` element per image to use.\n\nThe `` element can contain the following sub elements:\n\ninclude::image/_configuration.adoc[]\n\nEither a `` or `` section must be present (except when you are using the <> mode). These are explained in details in the corresponding goal sections.\n\ninclude::image/_example.adoc[]\n\nWhen using Maven profiles, it can be useful to override settings\nof a particular image. To facilitate this, the element ``\ncan be used alongside the `` element. Each entry in ``\ntranslates to an image configuration where the **alias** of the image\nis set to the map entry's **key**. The examples above and below produce\nidentical image configurations.\n\ninclude::image/_example_imagesMap.adoc[]\n\ninclude::image/_naming.adoc[]\n" }, { "path": "src/main/asciidoc/inc/_implicit-properties.adoc", "content": "= Implicit properties\n\nThere are some implicit configurations in docker maven plugin that are not so straightforward. These are simply workarouds to get docker-maven-plugin's flow right; just to overcome limitations of Maven and other things. Some of these are mentioned below:\n\n* If the only value of the `env` parameter is a docker-maven-plugin internal property which has been set implicitly you have to prefix the property with a single `+` like in `+${docker.container.test.ip}`. This is necessary due to some Maven limitations which simply interpolates a lone, non defined property, to an empty string which can't then be replaced by this plugin after the initial interpolation phase.\n\n* When providing port mapping in a format like `host.ip:host.port:80`, you need to prefix property with a single `+`. In this form, the host ip of the container will be placed into a Maven property name host.ip. If docker reports that value to be 0.0.0.0, the value of docker.host.address will be substituted instead. In the event you want to use this form and have the container bind to a specific hostname/ip address, you can declare a Maven property of the same name (host.ip in this example) containing the value to use. host:port works in the same way as described above.\n" }, { "path": "src/main/asciidoc/inc/_installation.adoc", "content": "= Installation\n\nThis plugin is available from Maven central and can be connected to\npre- and post-integration phase as seen below. The configuration and\navailable goals are described below.\n\n.Example\n[source,xml,indent=0,subs=\"verbatim,quotes,attributes\"]\n----\n\n io.fabric8\n docker-maven-plugin\n {version}\n\n \n ....\n \n \n \n ....\n \n ....\n \n \n\n \n \n \n start\n pre-integration-test\n \n \n build\n start\n \n \n \n stop\n post-integration-test\n \n stop\n \n \n \n\n----\n\nWhen working with this plugin you can use an own packaging with a specialized lifecycle in order to keep your pom files small. Three packaging variants are available:\n\n* *docker* : This binds `{plugin}:build` to the package phase and `{plugin}:start` / `{plugin}:stop` to the pre- and post-integration phase respectively. Also `{plugin}:push` is bound to the deploy phase.\n* *docker-build* : Much like the _docker_ packaging, except that there are no integration tests configured by default.\n* *docker-tar* : Create a so called _Docker tar_ archive which is used as the artifact and which later can be used for building an image. It contains essentially a `Dockerfile` with supporting files. See link:docker-source[{plugin}:source] for more details.\n\nThese packaging definitions include the _jar_ lifecycle methods so they are well suited for simple Microservice style projects.\n\n.Example\n[source,xml]\n----\n\n demo\n 0.0.1\n docker\n ...\n \n \n \n io.fabric8\n docker-maven-plugin\n true\n \n \n \n ...\n \n \n \n \n \n ....\n \n\n----\n\nThis will create the jar (if any), build the Docker images, start the configured Docker containers, runs the integration tests, stops the configured Docker container when you enter `mvn install`. With `mvn deploy` you can additionally push the images to a Docker configuration. Please note the `true` which is mandatory when you use a custom lifecycle.\n\nThe rest of this manual is now about how to configure the plugin for your images.\n" }, { "path": "src/main/asciidoc/inc/_introduction.adoc", "content": "\n= Introduction\n\nThis is a Maven plugin for managing Docker images and containers. It focuses on two major aspects for a Docker build integration:\n\n== Building Images\n\nOne purpose of this plugin is to create Docker images holding the actual application. This is done with the <<{plugin}:build>> goal. It is easy to include build artefacts and their dependencies into an image.\n\nSeveral ways for configuring the builds are supported:\n\n* An own configuration syntax can be used to create a Dockerfile. For specifying artefacts and other files, the plugin uses the assembly descriptor format from the maven-assembly-plugin to copy over those file into the Docker image.\n* An external Dockerfile can be specified in which Maven properties can be inserted. This is also the default mode, if only a single image should be built and a top-level `Dockerfile` exists. See <> for details of this zero XML configuration mode.\n\nImages that are built with this plugin can be pushed to public or private Docker registries with <<{plugin}:push>>.\n\n== Running Containers\n\nWith this plugin it is possible to run completely isolated integration tests so you don't need to take care of shared resources. Ports can be mapped dynamically and made available as Maven properties to your integration test code.\n\nMultiple containers can be managed at once, which can be linked together or share data via volumes. Containers are created and started with the <<{plugin}:start>> goal and stopped and destroyed with the <<{plugin}:stop>> goal. For integration tests both goals are typically bound to the the pre-integration-test and post-integration-test phase, respectively. It is recommended to use the maven-failsafe-plugin for integration testing in order to stop the docker container even when the tests fail.\n\nFor proper isolation, container exposed ports can be dynamically and flexibly mapped to local host ports. It is easy to specify a Maven property which will be filled in with a dynamically assigned port after a container has been started. This can then be used as parameter for integration tests to connect to the application.\n\n== Configuration\n\nThe plugin configuration contains a global part and a list of image-specific configuration within a `` list, where each image is defined within a `` tag. See <> for an example.\n\nThe <> contains configuration applicable to all images like the Docker URL or the path to the SSL certificates for communication with the Docker Host.\n\nThen, each specific image configuration has three parts:\n\n* A general image part containing the image name and alias.\n* A <<{plugin}:build, >> configuration specifying how images are built\n* A <<{plugin}:start, >> configuration describing how containers should be created and started.\n\nThe `` and `` parts are optional and can be omitted.\n\n[[example]]\n== Example\n\nIn the following examples, two images are specified. One is the official PostgreSQL 9 image from Docker Hub, which internally is referenced with an alias \"database\". It only has a <<{plugin}:start, >> section which declares that the startup should wait until the given text pattern is matched in the log output. Next is a \"service\" image, which has a <<{plugin}:build, >> section. It creates an image which has artifacts and dependencies in the `/maven` directory (and which are specified with an assembly descriptor). Additionally, it specifies the startup command for the container, which in this example fires up a microservice from a jar file copied over via the assembly descriptor. It also exposes port 8080. In the `` section this port is mapped to a dynamically chosen port and then assigned to the Maven property `${tomcat.port}`. This property could be used, for example, by an integration test to access this microservice. An important part is the `` section which indicates that the image with the alias of \"database\" is linked into the \"service\" container, which can access the internal ports in the usual Docker way (via environment variables prefixed with `DB_`).\n\nImages can be specified in any order and the plugin will take care of the proper startup order (and will bail out if it detects circular dependencies).\n\n[source,xml,indent=0,subs=\"verbatim,quotes\"]\n.Example plugin configuration\n----\n\n \n \n service \n fabric8/docker-demo:${project.version}\n\n \n java:8 \n \n docker-assembly.xml \n \n \n java -jar /maven/service.jar\n \n \n\n \n \n tomcat.port:8080\n \n \n \n http://localhost:${tomcat.port}/access\n \n \n \n \n database:db\n \n \n \n\n \n database \n postgres:9\n \n \n database system is ready to accept connections\n \n \n \n \n \n\n----\n<1> Image configuration for a Java service with alias \"service\" and name `fabric8/docker-demo:${project.version}`\n<2> <<{plugin}:build,build configuration>> defines how a Docker image should be created\n<3> Base image, in this case `java:8`\n<4> Content of the image can be specified with an <>\n<5> <> to run when a container is created.\n<6> <<{plugin}:start,Run configuration>> defines how a container should be created from this image\n<7> <> defines how container ports should be mapped to host ports\n<8> <> section which is a readiness check when starting the service\n<9> <> describes how this service's container is linked to the database container\n<10> Second image is a plain database image which is only needed for running (hence there is no `` section). The alias is used in the network link section above\n<11> Wait until the corresponding output appears on stdout when starting the Docker container.\n\n== Features\n\nSome other highlights, in random order:\n\n* Auto pulling of images with a progress indicator\n* Waiting for a container to startup based on time, the reachability of an URL, or a pattern in the log output\n* Support for SSL <> and OpenShift credentials\n* Docker machine support\n* Flexible registry handling (i.e. registries can be specified as metadata)\n* Specification of <> registry passwords for push and pull in ~/.m2/settings.xml (i.e., outside the pom.xml)\n* Color output\n* <<{plugin}:watch,Watching>> on project changes and automatic recreation of image\n* <> as alternative to the XML configuration\n* Support for Docker daemons accepting http or https request via TCP and for Unix sockets\n" }, { "path": "src/main/asciidoc/inc/_links.adoc", "content": "\n= Further reading\n\n* Examples:\n** https://github.com/fabric8io/docker-maven-plugin/blob/master/doc/examples.md[Examples]\nare below `samples/` and contain example\nsetups which you can use as blueprints for your own projects.\n** A https://github.com/fabric8io/shootout-docker-maven[Shootout] for\ncomparing docker maven plugins\n** Another\nhttps://github.com/fabric8io/docker-maven-sample[sample project]\nwith a Microservice and a Database.\n* https://github.com/fabric8io/docker-maven-plugin/blob/master/doc/changelog.md[ChangeLog]\nhas the release history of this plugin.\n* https://github.com/fabric8io/docker-maven-plugin/blob/master/CONTRIBUTING.md[Contributing]\nexplains how you can contribute to this project. Pull requests are highly appreciated!\n" }, { "path": "src/main/asciidoc/inc/_registry.adoc", "content": "\n[[registry]]\n= Registry handling\n\nDocker uses registries to store images. The registry is typically\nspecified as part of the name. I.e. if the first part (everything\nbefore the first `/`) contains a dot (`.`) or colon (`:`) this part is\ninterpreted as an address (with an optionally port) of a remote\nregistry. This registry (or the default `docker.io` if no\nregistry is given) is used during push and pull operations. This\nplugin follows the same semantics, so if an image name is specified\nwith a registry part, this registry is contacted. Authentication is\nexplained in the next <<_authentication,section>>.\n\nThere are some situations however where you want to have more\nflexibility for specifying a remote registry. This might be because\nyou do not want to hard code a registry into `pom.xml` but\nprovide it from the outside with an environment variable or a system\nproperty.\n\nThis plugin supports various ways of specifying a registry:\n\n* If the image name contains a registry part, this registry is used\nunconditionally and can not be overwritten from the outside.\n* If an image name doesn't contain a registry, then by default the\ndefault Docker registry `docker.io` is used for push and pull\noperations. But this can be overwritten through various means:\n** If the `` configuration contains a `` subelement\nthis registry is used.\n** Otherwise, a global configuration element `` is\nevaluated which can be also provided as system property via\n`-Ddocker.registry`.\n** Finally an environment variable `DOCKER_REGISTRY` is looked up for\ndetecting a registry.\n\nThis registry is used for pulling (i.e. for autopull the base image\nwhen doing a `{plugin}:build`) and pushing with `{plugin}:push`. However,\nwhen these two goals a are combined on the command line like in `mvn\n-Ddocker.registry=myregistry:5000 package {plugin}:build {plugin}:push`\nthe same registry is used for both operation. For a more fine grained\ncontrol, separate registries for _pull_ and _push_ can be specified.\n\n* In the plugin's configuration with the parameters `` and\n``, respectively.\n* With the system properties `docker.pull.registry` and\n`docker.push.registry`, respectively.\n\n.Example\n[source,xml]\n----\n\n docker.jolokia.org:443\n \n \n \n jolokia/jolokia-java\n \n docker.ro14nd.de\n ....\n \n \n postgresql\n \n ....\n \n \n \n docker.example.com:5000/another/server\n \n \n\n----\n\nThere is some special behaviour when using an externally provided\nregistry like described above:\n\n* When _pulling_, the image pulled will be also tagged with a repository\nname *without* registry. The reasoning behind this is that this\nimage then can be referenced also by the configuration when the\nregistry is not specified anymore explicitly.\n* When _pushing_ a local image, temporarily a tag including the\nregistry is added and removed after the push. This is required\nbecause Docker can only push registry-named images.\n" }, { "path": "src/main/asciidoc/inc/build/_assembly.adoc", "content": "\nThe `` element within `` is has an XML struture and defines how build artifacts and other files can enter the Docker image.\n\n[[config-image-build-assembly]]\n.Assembly Configuration (< >> : < >>)\n[cols=\"1,5\"]\n|===\n| Element | Description\n\n| *name*\n| Assembly name, which is `maven` by default. This name is used for the archives and directories created during the build. This directory holds the files specified by the assembly. If an <> is used than this name is also the relative directory which contains the assembly files.\n\n| *targetDir*\n| Directory under which the files and artifacts contained in the assembly will be copied within the container. The default value for this is `/`, so `/maven` if *name* is not set to a different value. This option has no meaning when an <> is used.\n\n| <>\n| Inlined assembly descriptor as described in <> below.\n\n| <>\n| Path to an assembly descriptor file, whose format is described <> below.\n\n| <>\n| Alias to a predefined assembly descriptor. The available aliases are also described in <> below.\n\n| *dockerFileDir*\n| Directory containing an external Dockerfile. _This option is deprecated, please use directly in the section_.\n\n| *exportTargetDir*\n| Specification whether the `targetDir` should be exported as a volume. This value is `true` by default except in the case the `targetDir` is set to the container root (`/`). It is also `false` by default when a base image is used with `from` since exporting makes no sense in this case and will waste disk space unnecessarily.\n\n| *ignorePermissions*\n| Specification if existing file permissions should be ignored\nwhen creating the assembly archive with a mode `dir`. This value is `false` by default. _This property is deprecated, use a `permissions` of `ignore` instead._\n\n| *mode*\na| Mode how the how the assembled files should be collected:\n\n* `dir` : Files are simply copied (default),\n* `tar` : Transfer via tar archive\n* `tgz` : Transfer via compressed tar archive\n* `zip` : Transfer via ZIP archive\n\nThe archive formats have the advantage that file permission can be preserved better (since the copying is independent from the underlying files systems), but might triggers internal bugs from the Maven assembler (as it has been reported in https://github.com/fabric8io/docker-maven-plugin/issues/171[#171])\n\n| *permissions*\na| Permission of the files to add:\n\n* `ignore` to use the permission as found on files regardless on any\nassembly configuration\n* `keep` to respect the assembly provided permissions, `exec` for setting the executable bit on all files (required for Windows when using an assembly mode `dir`)\n* `auto` to let the plugin select `exec` on Windows and `keep` on others.\n\n`keep` is the default value.\n\n| *tarLongFileMode*\n| Sets the TarArchiver behaviour on file paths with more than 100 characters length. Valid values are: \"warn\"(default), \"fail\", \"truncate\", \"gnu\", \"posix\", \"posix_warn\" or \"omit\"\n\n| [[config-image-build-assembly-user]] *user*\n| User and/or group under which the files should be added. The user must already exist in the base image.\n\nIt has the general format `user[:group[:run-user]]`. The user and group can be given either as numeric user- and group-id or as names. The group id is optional.\n\nIf a third part is given, then the build changes to user `root` before changing the ownerships, changes the ownerships and then change to user `run-user` which is then used for the final command to execute. This feature might be needed, if the base image already changed the user (e.g. to 'jboss') so that a `chown` from root to this user would fail.\n(_**This third user part has been marked as deprecated and will not be supported in future versions of this plugin.**_)\n\nFor example, the image `jboss/wildfly` use a \"jboss\" user under which all commands are executed. Adding files in Docker always happens under the UID root. These files can only be changed to \"jboss\" is the `chown` command is executed as root. For the following commands to be run again as \"jboss\" (like the final `standalone.sh`), the plugin switches back to user `jboss` (this is this \"run-user\") after changing the file ownership. For this example a specification of\n`jboss:jboss:jboss` would be required.\n|===\n\nIn the event you do not need to include any artifacts with the image, you may safely omit this element from the configuration.\n\n[[build-assembly-descriptor]]\n==== Assembly Descriptor\n\nWith using the `inline`, `descriptor` or `descriptorRef` option\nit is possible to bring local files, artifacts and dependencies into\nthe running Docker container. A `descriptor` points to a file\ndescribing the data to put into an image to build. It has the same\nhttp://maven.apache.org/plugins/maven-assembly-plugin/assembly.html[format] as for creating assemblies with the\nhttp://maven.apache.org/plugins/maven-assembly-plugin[maven-assembly-plugin] with following exceptions:\n\n* `` are ignored, the assembly will allways use a directory\nwhen preparing the data container (i.e. the format is fixed to\n`dir`)\n* The `` is ignored since only a single assembly descriptor is\nused (no need to distinguish multiple descriptors)\n\nAlso you can inline the assembly description with a `inline` description\ndirectly into the pom file. Adding the proper namespace even allows for\nIDE autocompletion. As an example, refer to the profile `inline` in\nthe `data-jolokia-demo` 's pom.xml.\n\nAlternatively `descriptorRef` can be used with the name of a\npredefined assembly descriptor. The following symbolic names can be\nused for `descriptorRef`:\n\n[[build-assembly-descriptor-refs]]\n.Predefined Assembly Descriptors\n[cols=\"1,3\"]\n|===\n| Assembly Reference | Description\n\n| *artifact-with-dependencies*\n| Attaches project's artifact and all its dependencies. Also, when a `classpath` file exists in the target directory, this will be added to.\n\n| *artifact*\n| Attaches only the project's artifact but no dependencies.\n\n| *project*\n| Attaches the whole Maven project but with out the `target/` directory.\n\n| *rootWar*\n| Copies the artifact as `ROOT.war` to the exposed directory. I.e. Tomcat will then deploy the war under the root context.\n|===\n\n.Example\n[source,xml]\n----\n\n \n \n \n artifact-with-dependencies\n .....\n----\n\nwill add the created artifact with the name `${project.build.finalName}.${artifact.extension}` and all jar dependencies in the the `targetDir` (which is `/maven` by default).\n\nAll declared files end up in the configured `targetDir` (or `/maven` by default) in the created image.\n\n.Maven peculiarities when including the artifact\nIf the assembly references the artifact to build with this pom, it is required that the `package` phase is included in the run. Otherwise the artifact file, can't be found by `docker:build`. This is an old https://issues.apache.org/jira/browse/MASSEMBLY-94[outstanding issue] of the assembly plugin which probably can't be fixed because of the way how Maven works. We tried hard to workaround this issue and in 90% of all cases, you won't experience any problem. However, when the following warning happens which might lead to the given error:\n\n[source]\n----\n[WARNING] Cannot include project artifact: io.fabric8:helloworld:jar:0.20.0; it doesn't have an associated file or directory.\n[WARNING] The following patterns were never triggered in this artifact inclusion filter:\no 'io.fabric8:helloworld'\n\n[ERROR] DOCKER> Failed to create assembly for docker image (with mode 'dir'): Error creating assembly archive docker: You must set at least one file.\n----\n\nthen you have two options to fix this:\n\n* Call `mvn package {plugin}:build` to explicitly run \"package\" and \"docker:build\" in a chain.\n* Bind `build` to an to an execution phase in the plugin's definition. By default `{plugin}:build` will bind to the `install` phase is set in an execution. Then you can use a plain `mvn install` for building the artifact and creating the image.\n\n[source,xml]\n----\n\n \n docker-build\n \n build\n \n \n\n----\n\n.Example\n\nIn the following example a dependency from the pom.xml is included and\nmapped to the name `jolokia.war`. With this configuration you will end\nup with an image, based on `busybox` which has a directory `/maven`\ncontaining a single file `jolokia.war`. This volume is also exported\nautomatically.\n\n[source,xml]\n----\n\n \n \n \n \n org.jolokia:jolokia-war\n \n .\n jolokia.war\n \n \n \n\n----\n\nAnother container can now connect to the volume an 'mount' the\n`/maven` directory. A container from `consol/tomcat-7.0` will look\ninto `/maven` and copy over everything to `/opt/tomcat/webapps` before\nstarting Tomcat.\n\nIf you are using the `artifact` or `artifact-with-dependencies` descriptor, it is\npossible to change the name of the final build artifact with the following:\n\n.Example\n[source,xml]\n----\n\n your-desired-final-name\n ...\n\n----\n\nPlease note, based upon the following documentation listed http://maven.apache.org/pom.html#BaseBuild_Element[here], there is no guarantee the plugin creating your artifact will honor it in which case you will need to use a custom descriptor like above to achieve the desired naming.\n\nCurrently the `jar` and `war` plugins properly honor the usage of `finalName`.\n" }, { "path": "src/main/asciidoc/inc/build/_buildargs.adoc", "content": "[[property-buildargs]]\nAs described in section <> for external Dockerfiles https://docs.docker.com/engine/reference/commandline/build/#set-build-time-variables-build-arg[Docker build arg] can be used. In addition to the\nconfiguration within the plugin configuration you can also use properties to specify them:\n\n* Set a system property when running Maven, eg.: `-Ddocker.buildArg.http_proxy=http://proxy:8001`. This is especially\nuseful when using predefined Docker arguments for setting proxies transparently.\n* Set a project property within the `pom.xml`, eg.:\n\n.Example\n[source,xml]\n----\n myValue\n----\n\nPlease note that the system property setting will always override the project property. Also note that for all properties which are not Docker https://docs.docker.com/engine/reference/builder/#arg[predefined] properties, the external Dockerfile must contain an `ARGS` instruction.\n" }, { "path": "src/main/asciidoc/inc/build/_configuration.adoc", "content": "\nAll build relevant configuration is contained in the `` section\nof an image configuration. The following configuration options are supported:\n\n[[config-image-build]]\n.Build configuration (< >>)\n[cols=\"1,5\"]\n|===\n| Element | Description\n\n| <>\n| specifies the assembly configuration as described in <>\n\n| <>\n| Map specifying the value of https://docs.docker.com/engine/reference/commandline/build/#set-build-time-variables-build-arg[Docker build args]\nwhich 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`).\nThis argument is ignored when no external Dockerfile is used. Build args can also be specified as properties as\ndescribed in <>\n\n| *buildOptions*\n| 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\nhttps://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#build-image-from-a-dockerfile[Docker Remote API] and are restricted to simple options\n(e.g.: memory, shmsize). If you use the respective configuration options for build options natively supported by the build configuration (i.e. `squash`, `noCache`, `cleanup=remove` for buildoption `forcerm=1` and `args` for build args) then these will override any corresponding options given here. The key-value syntax is the same as when defining environment variables or labels as described in <>.\n\n| *cleanup*\n| Cleanup dangling (untagged) images after each build (including any containers created from them). Default is `try` which tries to remove the old image, but doesn't fail the build if this is not possible because e.g. the image is still used by a running container. Use `remove` if you want to fail the build and `none` if no cleanup is requested.\n\n| [[context-dir]]*contextDir*\n| 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. See <> for details.\n\n| <>\n| A command to execute by default (i.e. if no command is provided when a container for this image is started). See <> for details.\n\n| *compression*\n| The compression mode how the build archive is transmitted to the docker daemon (`{plugin}:build`) and how docker build archives are attached to this build as sources (`{plugin}:source`). The value can be `none` (default), `gzip` or `bzip2`.\n\n| *dockerFile*\n| Path to a `Dockerfile` which also triggers _Dockerfile mode_. See <> for details.\n\n| *dockerFileDir* (_deprecated_ in favor of *<>*)\n| Path to a directory holding a `Dockerfile` and switch on _Dockerfile mode_. See <> for details. _This option is deprecated in favor of _contextDir_ and will be removed for the next major release_.\n\n| *dockerArchive*\n| Path to a saved image archive which is then imported. See <> for details.\n\n| <>\n| An entrypoint allows you to configure a container that will run as an executable. See <> for details.\n\n| <>\n| The environments as described in <>.\n\n| *filter*\n| Enable and set the delimiters for property replacements. By default properties in the format `${..}` are replaced with Maven properties. You can switch off property replacement by setting this property to `false`. When using a single char like `@` then this is used as a delimiter (e.g `@...@`). See <> for more details.\n\n| [[build-config-from]]*from*\n| 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.\nifeval::[\"{plugin}\" == \"fabric8\"]\nIn case of an <> this parameter specifies the S2I Builder Image to use, which by default is `fabric8/s2i-java:latest`. See also <> how to add additional properties for the base image.\n\nendif::[]\n\n| [[build-config-from-ext]]**fromExt**\na| Extended definition for a base image. This field holds a map of defined in `value` format. The known keys are:\n\n* `` : Name of the base image\nifeval::[\"{plugin}\" == \"fabric8\"]\n* `` : Kind of the reference to the builder image when in S2I build mode. By default its `ImageStreamTag` but can be also `ImageStream`. An alternative would be `DockerImage`\n* `` : Namespace where this builder image lives.\n\nendif::[]\n\nA provided `` takes precedence over the name given here. This tag is useful for extensions of this plugin like the https://maven.fabric8.io[fabric8-maven-plugin] which can evaluate the additional information given here.\n\n| <>\n| Definition of a health check as described in <>\n\n| *imagePullPolicy*\n| Specific pull policy for the base image. This overwrites any global pull policy. See the globale configuration option <> for the possible values and the default.\n\n| [[build-config-load-name-pattern]]*loadNamePattern*\na| Scan the archive specified in `dockerArchive` and find the actual repository and tag in the archive that matches this <>. After loading the archive, link the <> configured in the POM to the repository and tag matched in the archive.\n\n| <>\n| Labels as described in <>.\n\n| *maintainer*\n| The author (`MAINTAINER`) field for the generated image\n\n| *noCache*\n| Don't use Docker's build cache. This can be overwritten by setting a system property `docker.noCache` when running Maven.\n\n| *squash*\n| Squash newly built layers into a single new layer. This can be overwritten by setting a system property `docker.squash` when running Maven.\n\n| *cacheFrom*\n| A list of `` elements specifying image names to use as cache sources.\n\n| *optimise*\n| if set to true then it will compress all the `runCmds` into a single `RUN` directive so that only one image layer is created.\n\n| *ports*\n| The exposed ports which is a list of `` 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\").\n\n| *shell*\n| Shell to be used for the *runCmds*. It contains *arg* elements which are defining the executable and its params.\n\n| *runCmds*\n| 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 *workdir* into the Dockerfile. This tag is not to be confused with the `` section for this image which specifies the runtime behaviour when starting containers.\n\n| *skip*\n| if set to true disables building of the image. This config option is best used together with a maven property\n\n| *skipPush*\n| if set to true disables pushing of the image. This config option is best used together with a maven property\n\n| *skipTag*\n| If set to `true` this plugin won't add any tags to images. Property: `docker.skip.tag`\n\n| *tags*\n| 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.\n\n| *user*\n| User to which the Dockerfile should switch to the end (corresponds to the `USER` Dockerfile directive).\n\n| *volumes*\n| List of `volume` elements to create a container volume. Whitespace is trimmed from each element and empty elements are ignored.\n\n| *workdir*\n| Directory to change to when starting the container.\n|===\n\nFrom this configuration this Plugin creates an in-memory Dockerfile,\ncopies over the assembled files and calls the Docker daemon via its\nremote API.\n\n.Example\n[source,xml]\n----\n\n java:8u40\n john.doe@example.com\n \n latest\n ${project.version}\n \n \n 8080\n \n \n /path/to/expose\n \n \n 2147483648\n \n\n \n \n /bin/sh\n -c\n \n \n \n groupadd -r appUser\n useradd -r -g appUser appUser\n \n\n \n \n \n java\n -jar\n /opt/demo/server.jar\n \n \n\n \n dir\n /opt/demo\n assembly.xml\n \n\n----\n\nIn order to see the individual build steps you can switch on `verbose` mode either by setting the property `docker.verbose` or by using `true` in the <>\n" }, { "path": "src/main/asciidoc/inc/build/_healthcheck.adoc", "content": "\nHealthchecks has been introduced since Docker 1.12 and are a way to tell Docker how to test a container to check that it's still working. With a health check you specify a command which is periodically executed and checked for its return value. If the healtcheck return with an exit 0 the container is considered to be healthy, if it returns with 1 then the container is not working correctly.\n\nThe healtcheck configuration can have the following options\n\n.Healthcheck Configuration\n[cols=\"1,5\"]\n|===\n| Element | Description\n\n\n| *cmd*\n| Command to execute, which can be given in an shell or exec format as described in <>.\n\n| *interval*\n| Interval for how often to run the healthcheck. The time is specified in seconds, but a time unit can be appended to change this.\n\n| *mode*\n| Mode of the healthcheck. This can be `cmd` which is the default and specifies that the health check should be executed. Or `none` to disable a health check from the base image. Only use this option with `none` for disabling some healthcheck from the base image.\n\n| *retries*\n| How many retries should be performed before the container is to be considered unhealthy.\n\n| *startPeriod*\n| Initialization time for containers that need time to bootstrap. Probe failure during that period will not be counted towards the maximum number of retries. However, if a health check succeeds during the start period, the container is considered started and all consecutive failures will be counted towards the maximum number of retries. Given in seconds, but another time unit can be appended.\n\n| *timeout*\n| Timeout after which healthckeck should be stopped and considered to have failed. Given in seconds, but another time unit can be appended.\n|===\n\nThe following example queries an URL every 10s as an healthcheck:\n\n.Example\n[source,xml]\n----\n\n \n 5m\n \n 3s\n \n 30m\n \n 3\n \n curl -f http://localhost/ || exit 1\n\n----\n" }, { "path": "src/main/asciidoc/inc/build/_overview.adoc", "content": "\n[[build-overview]]\nThere are two different modes how images can be built:\n\n.Inline plugin configuration\nWith an inline plugin configuration all information required to build the image is contained in the plugin configuration. By default its the standard XML based configuration for the plugin but can be switched to a property based configuration syntax as described in the section <>. The XML configuration syntax is recommended because of its more structured and typed nature.\n\nWhen using this mode, the Dockerfile is created on the fly with all instructions extracted from the configuration given.\n\n[[external-dockerfile]]\n.External Dockerfile or Docker archive\nAlternatively an external Dockerfile template or Docker archive can be used. This mode is switched on by using one of these three configuration options within\n\n* *contextDir* specifies docker build context if an external dockerfile is located outside of Docker build context. If not specified, Dockerfile's parent directory is used as build context.\n* *dockerFile* specifies a specific Dockerfile path. 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.\n* *dockerArchive* specifies a previously saved image archive to load directly. Such a tar archive can be created with `docker save` or the <<{plugin}:save>> goal. If a `dockerArchive` is provided, no `dockerFile` or `dockerFileDir` must be given.\n* *dockerFileDir* (_deprecated_, use *contextDir*) specifies a directory containing a Dockerfile that will be used to create the image. The name of the Dockerfile is `Dockerfile` by default but can be also set with the option `dockerFile` (see below).\n\nAll paths can be either absolute or relative paths (except when both `dockerFileDir` and `dockerFile` are provided in which case `dockerFile` must not be absolute). A relative path is looked up in `${project.basedir}/src/main/docker` by default. You can make it easily an absolute path by using `${project.basedir}` in your configuration.\n\n.Adding assemblies in Dockerfile mode\nAny additional files located in the `dockerFileDir` directory will also be added to the build context as well.\nYou can also use an assembly if specified in an <>.\nHowever, you need to add the files on your own in the Dockerfile with an `ADD` or `COPY` command.\nThe files of the assembly are stored in a build context relative directory `maven/` but can be changed by changing the assembly name with the option `` in the assembly configuration.\n\nE.g. the files can be added with\n\n.Example\n[source,dockerfile]\n----\nCOPY maven/ /my/target/directory\n----\n\nso that the assembly files will end up in `/my/target/directory` within the container.\n\nIf this directory contains a `.maven-dockerignore` (or alternatively, a `.maven-dockerexclude` file), then it is used for excluding files for the build. Each line in this file is treated as a http://ant.apache.org/manual/Types/fileset.html[FileSet exclude pattern] as used by the http://maven.apache.org/plugins/maven-assembly-plugin[maven-assembly-plugin]. It is similar to `.dockerignore` when using Docker but has a slightly different syntax (hence the different name).\n<> is an example which excludes all compiled Java classes.\n\n[[ex-build-dockerexclude]]\n.Example `.maven-dockerexclude` or `.maven-dockerignore`\n====\n[source]\n----\ntarget/classes/** # <1>\n----\n<1> Exclude all compiled classes\n====\n\n\nIf this directory contains a `.maven-dockerinclude` file, then it is used for including only those files for the build. Each line in this file is also treated as a http://ant.apache.org/manual/Types/fileset.html[FileSet exclude pattern] as used by the http://maven.apache.org/plugins/maven-assembly-plugin[maven-assembly-plugin]. <> shows how to include only jar file that have build to the Docker build context.\n\n[[ex-build-dockerinclude]]\n.Example `.maven-dockerinclude`\n====\n[source]\n----\ntarget/*.jar # <1>\n----\n<1> Only add jar file to you Docker build context.\n====\n\nExcept for the <> all other configuration options are ignored for now.\n\n[[simple-dockerfile-build]]\n.Simple Dockerfile build\n\nWhen only a single image should be built with a Dockerfile no XML configuration is needed at all.\nAll what need to be done is to place a `Dockerfile` into the top-level module directory, alongside to `pom.xml`.\nYou can still configure <> in the plugin configuration, but as soon as you add an `` in the XML configuration, you need to configure also the build explicitly.\n\nThe image name is by default set from the Maven coordinates (`%g/%a:%l`, see <> for an explanation of the params which are essentially the Maven GAV)\nThis name can be set with the property `docker.name`.\n\nIf you want to add some `` configuration to this image for starting it with `docker:run` then you can add an image configuration but without a `` section in which case the Dockerfile will be picked up, too. This works only for a single image, though.\n\n[[build-filtering]]\n.Filtering\nfabric8-maven-plugin filters given Dockerfile with Maven properties, much like the `maven-resource-plugin` does. Filtering is enabled by default and can be switched off with a build config `false`. Properties which we want to replace are specified with the `${..}` syntax.\nReplacement includes Maven project properties such as `${project.artifactId}`, properties set in the build, command-line properties, and system properties. Unresolved properties remain untouched.\n\nThis partial replacement means that you can easily mix it with Docker build arguments and environment variable reference, but you need to be careful.\nIf you want to be more explicit about the property delimiter to clearly separate Docker properties and Maven properties you can redefine the delimiter.\nIn general, the `filter` option can be specified the same way as delimiters in the resource plugin.\nIn particular, if this configuration contains a * then the parts left, and right of the asterisks are used as delimiters.\n\nFor example, the default `${*}` parse Maven properties in the format that we know.\nIf you specify a single character for `` then this delimiter is taken for both, the start and the end.\nE.g a `@` triggers on parameters in the format `@...@`, much like in the `maven-invoker-plugin`.\nUse something like this if you want to clearly separate from Docker builds args.\nThis form of property replacement works for Dockerfile only.\nFor replacing other data in other files targeted for the Docker image, please use the `maven-resource-plugin` or an <> with filtering to make them available in the docker build context.\n\n.Example\nThe following example uses a Dockerfile in the directory\n`src/main/docker/demo` and replaces all properties in the format `@property@` within the Dockerfile.\n[source,xml]\n----\n\n \n \n \n user/demo\n \n demo\n @\n \n \n \n \n ...\n\n----\n\n[[build-plugin]]\n.Build Plugins\n\nThis plugin supports so call *dmp-plugins* which are used during the build phase.\ndmp-plugins are enabled by just declaring a dependency in the plugin declaration:\n\n[source, xml]\n----\n\n io.fabric8\n docker-maven-plugin\n\n \n \n io.fabric8\n run-java-sh\n 1.2.2\n \n \n\n----\n\nThese plugins contain a descriptor `META-INF/maven/io.fabric8/dmp-plugin` with class names, line-by-line:\n\n[source]\n----\nio.fabric8.runsh.RunShLoader\n----\n\nDuring a build with `docker:build`, those classes are loaded and certain fixed method are called.\n\nThe following methods are supported:\n\n[[build-plugin-methods]]\n[cols=\"1,5\"]\n|===\n| Method | Description\n\n| *addExtraFiles*\n| A _static_ method called by dmp with a single `File` argument. This will point to a directory `docker-extra` which can be referenced easily by a Dockerfile or an assembly. A dmp plugin typically will create an own subdirectory to avoid a clash with other dmp-plugins.\n|===\n\nIf a configured plugin does not provide method of this name and signature, then it will be simply ignored.\nAlso, no interface needs to be implemented to keep the coupling low.\n\nThe following official dmp-plugins are known and supported:\n\n[[build-plugins-official]]\n[cols=\"1,1,5\"]\n|===\n| Name | G,A | Description\n\n| https://github.com/fabric8io-images/run-java-sh[run-java.sh]\n| `fabric8.io`, `run-java`\n| General purpose startup script fo running Java applications. The dmp plugin creates a `target/docker-extra/run-java/run-java.sh` which can be included in a Dockerfile (see the example above). See the https://github.com/fabric8io-images/run-java-sh[run-java.sh Documentation] for more details.\n|===\n\nCheck out `samples/run-java` for a fully working example.\n" }, { "path": "src/main/asciidoc/inc/external/_docker_compose.adoc", "content": "\nThis plugin supports also configuration via a https://docs.docker.com/compose/[docker-compose] file, especially for running containers specified in `docker-compose.yml`. Docker Compose handling is available also as an external configuration provider.\n\n.Example\n[source,xml]\n----\n\n webapp \n fabric8/compose-demo:latest\n\n \n compose \n src/main/docker \n docker-compose.yml\n \n\n \n ....\n \n ...\n ...\n\n----\n<1> The alias of the image is used as correlation key mapping to a service in the Docker Compose file\n<2> An `` configuration handler needs to be used for Docker Compose support\n<3> The type for the external configuration provider must be set to **compose**\n<4> Additional configuration for the handler where to find the compose file\n<5> Extra ``, `` and `` configuration can be provided which are used as default configuration for the Docker compose service `webapp` (as specified with the alias)\n\nThe following options can be provided:\n\n.Docker compose configuration\n[cols=\"1,5,1\"]\n|===\n| Element | Description | Default\n\n| *basedir*\n| Basedir where to find the compose file and which is also used as the current directory when examing the compose file. Any relative volume bindings will be resolved relative to this directory.\n| `${basedir}/src/main/docker`\n\n| *composeFile*\n| Name of the compose file to use\n| `docker-compose.yml`\n\n| *ignoreBuild*\n| Ignore the compose file's `build:` section and use the plugin's build configuration exclusively.\n| `false`\n|===\n\nThe Docker Compose file can contain variables as described in the https://docs.docker.com/compose/compose-file/#/variable-substitution[Docker Compose documentation]. These are substituted with Maven project properties. Please note, when the `docker-compose.yml` with variables is to be used with the `docker-compose` CLI command, that these variables must also be valid environment variables (i.e. must not contain a `.`).\n\nIn addition to the `docker-compose.yml` you can add all known options for < >>, < >> and < >> configuration elements which are then used as defaults and are overwritten by the configuration defined in the `docker-compose.yml` file. The merging between the XML configuration and the information found in `docker-compose.yml` is correlated via the `` name. E.g. if the XML image configuration is aliased with `webapp` then its is used as a default configuration for a Docker Compose _service_ name `webapp`. All other services defined in the compose file are left untouched.\n\n=== Limitations\n\nThe following Docker Compose file keywords are not yet supported:\n\n* `cgroup_parent`, `devices`, `env_file`, `expose`, `pid`, `security_opt`, `stop_signal`, `cpu_quota`, `ipc`, `mac_address`, `read_only` are not yet supported (but might be in a future version).\n* `extend` for including other Docker Compose files is not yet implemented.\n* Only **services** are currently evaluated, there is no supported yet for **volumes** and **networks**.\n" }, { "path": "src/main/asciidoc/inc/external/_property_configuration.adoc", "content": "\nFor simple needs the image configuration can be completely defined via\nMaven properties which are defined outside of this plugin's\nconfiguration. Such a property based configuration can be selected\nwith an `` of `properties`. As extra configuration a prefix for the\nproperties can be defined which by default is `docker`.\n\nFor single-image configurations it is also possible to active property\nbased configuration via an externally set property.\n\nBy default, property based configuration uses only properties, ignoring\nany `` and `` sections. To combine values from both sources,\nuse the <>.\n\nProperties are read from the Maven project (defined in `` or global\nMaven configuration from `settings.xml`) and, since 0.25.0, from any `-D`\nflags given to Maven (takes priority over project properties).\n\n.Example\n[source,xml]\n----\n\n \n properties\n docker \n only \n \n\n----\n\nGiven this example configuration a single image configuration is built\nup from the following properties, which correspond to the corresponding\nvalues in the `` and `` sections. A build configuration is only created\nwhen a `docker.from` or a `docker.fromExt` is set.\n\n\n.External properties\n[cols=\"1,5\"]\n|===\n| *docker.alias*\n| Alias name\n\n| *docker.args.BUILDVAR*\n| Set the value of a build variable. The syntax is the same as for specifying environment variables (see below).\n\n| *docker.assembly.baseDir*\n| Directory name for the exported artifacts as described in an assembly (which is `/maven` by default).\n\n| *docker.assembly.descriptor*\n| Path to the assembly descriptor when building an image\n\n| *docker.assembly.descriptorRef*\n| Name of a predefined assembly to use.\n\n| *docker.assembly.exportBaseDir*\n| If `true` export base directory\n\n| *docker.assembly.ignorePermissions*\n| If set to `true` existing file permissions are ignored when creating the assembly archive. Deprecated, use a permission mode of `ignore` instead.\n\n| *docker.assembly.permissions*\n| can be `ignore` to use the permission as found on files regardless on any assembly configuration, `keep` to respect the assembly provided permissions, `exec` for setting the executable bit on all files (required for Windows when using an assembly mode `dir`) or `auto` to let the plugin select `exec` on Windows and `keep` on others. `keep` is the default value.\n\n| *docker.assembly.dockerFileDir*\n| specifies a directory containing an external Dockerfile that will be used to create the image. This is deprecated please use `docker.dockerFileDir` or `docker.dockerFile` instead.\n\n| *docker.noCache*\n| Don't use Docker's build cache. This can be overwritten by setting a system property `docker.noCache` when running Maven.\n\n| *docker.bind.idx*\n| Sets a list of paths to bind/expose in the container\n\n| *docker.buildArg.VARIABLE*\n| Set a ARG to be available during build of image. *Note*: this is handled separately from external configuration, and is always available. See <> for more details.\n\n| *docker.capAdd.idx*\n| List of kernel capabilities to add to the container\n\n| *docker.capDrop.idx*\n| List of kernel capabilities to remove from the container\n\n| *docker.cleanup*\n| Cleanup dangling (untagged) images after each build (including any containers created from them). Default is `try` (which wont fail the build if removing fails), other possible values are `none` (no cleanup) or `remove` (remove but fail if unsuccessful)\n\n| *docker.cmd*\n| Command to execute. This is used both when running a container and as default command when creating an image.\n\n| *docker.cpus*\n| Specify how much of the available CPU resources a container can use\n\n| *docker.cpuset*\n| Limit the container to specific CPUs or cores. This can be provided either as a comma-separated list or a hyphen-separated range.\n\n| *docker.cpushares*\n| Set the proportion of the host machine's cpu cycles available to the container\n\n| *docker.cacheFrom*\n| List of image names to use as cache sources\n\n| *docker.domainname*\n| Container domain name\n\n| *docker.dns.idx*\n| List of dns servers to use\n\n| *docker.dnsSearch.idx*\n| List of dns search domains\n\n| *docker.dockerArchive*\n| specify an archive which can be loaded with `docker load`. Use this as an alternative to `docker.dockerFile` or `docker.dockerFileDir`\n\n| *docker.dockerFile*\n| specifies a Dockerfile to use. This property must point to the Dockerfile itself.\n\n| *docker.dockerFileDir*\n| specifies a directory containing an external dockerfile that will be used to create the image. The dockerfile must be name `Dockerfile`\n\n| *docker.entrypoint*\n| Container entry point\n\n| *docker.exposedPropertyKey*\n| Property part for the exposed container properties like internal IP addresses as described in <>.\n\n| *docker.env.VARIABLE*\n| Sets an environment variable used in build and run. E.g. `-Xmx512m` sets the environment variable `JAVA_OPTS`. Multiple such entries can be provided. This environment is used both for building images and running containers. The value cannot be empty but can contain Maven property names which are resolved before the Dockerfile is created.\n\n| *docker.envBuild.VARIABLE*\n| Sets an environment variable used in build only. E.g. `-Xmx512m` sets the environment variable `JAVA_OPTS`. Multiple such entries can be provided. This environment is building images only. The value cannot be empty but can contain Maven property names which are resolved before the Dockerfile is created.\n\n| *docker.envRun.VARIABLE*\n| Sets an environment variable used in run only. E.g. `-Xmx512m` sets the environment variable `JAVA_OPTS`. Multiple such entries can be provided. This environment is used both for running containers only. The value cannot be empty but can contain Maven property names which are resolved before the Dockerfile is created.\n\n| *docker.envPropertyFile*\n| specifies the path to a property file whose properties are used as environment variables in run. The environment variables takes precedence over any other environment variables specified.\n\n| *docker.extraHosts.idx*\n| List of `host:ip` to add to `/etc/hosts`\n\n| *docker.filter*\n| Enable and set the delimiters for property replacements. By default properties in the format `${..}` are replaced with Maven properties. You can switch off property replacement by setting this property to `false`. When using a single char like `@` then this is used as a delimiter (e.g `@...@`). See <> for more details.\n\n| *docker.from*\n| Base image for building an image. Must be set when an image is created (or `fromExt`)\n\n| *docker.fromExt.VARIABLE*\n| Base image for building an image (extended format), which also triggers a build of an image.\n\n| *docker.healthcheck.cmd*\n| Command to use for a healthcheck\n\n| *docker.healthcheck.interval*\n| Interval for how often to run a healthcheck (in seconds or with a given time unit)\n\n| *docker.healthcheck.mode*\n| If se to `none` disable a healthcheck from a base image\n\n| *docker.healthcheck.retries*\n| Number of retries for how often to retry a healthcheck until it is considered to have failed\n\n| *docker.healthcheck.startPeriod*\n| Initialization time for containers that need time to bootstrap. Probe failure during that period will not be counted towards the maximum number of retries. However, if a health check succeeds during the start period, the container is considered started and all consecutive failures will be counted towards the maximum number of retries. (in seconds or with a given time unit)\n\n| *docker.healthcheck.timeout*\n| Timeout after which a healthcheck command is considered to be failed (in seconds or with a given time unit)\n\n| *docker.hostname*\n| Container hostname\n\n| *docker.imagePropertyConfiguration*\n| Special property to activate property configuration without altering XML file (see <>).\n\n| *docker.imagePullPolicy.build*\n| Specific pull policy used when building images. See <> for the possible values.\n\n| *docker.imagePullPolicy.run*\n| Specific pull policy used for downloading images to run. See <> for the possible values.\n\n| *docker.labels.LABEL*\n| Sets a label which works similarly like setting environment variables.\n\n| *docker.loadNamePattern*\n| Search the archive specified in `docker.dockerArchive` for the specified image name and creates a tag from the matched name to the build image name specified in `docker.name`.\n\n| *docker.log.enabled*\n| Use logging (default: `true`)\n\n| *docker.log.prefix*\n| Output prefix\n\n| *docker.log.color*\n| ANSI color to use for the prefix\n\n| *docker.log.date*\n| Date format for printing the timestamp\n\n| *docker.log.driver.name*\n| Name of an alternative log driver\n\n| *docker.log.driver.opts.VARIABLE*\n| Logging driver options (specified similarly as in `docker.env.VARIABLE`)\n\n| *docker.links.idx*\n| defines a list of links to other containers when starting a container. _idx_ can be any suffix which is not used except when _idx_ is numeric it specifies the order within the list (i.e. the list contains first entries with numeric indexes sorted and the all non-numeric indexes in arbitrary order). For example `db` specifies a link to the image with alias 'db'.\n\n| *docker.maintainer*\n| defines the maintainer's email as used when building an image\n\n| *docker.memory*\n| Container memory (in bytes)\n\n| *docker.memorySwap*\n| Total memory (swap + memory) `-1` to disable swap\n\n| *docker.name*\n| Image name\n\n| *docker.namingStrategy*\n| Container naming (either `none` or `alias`)\n\n| *docker.network.mode*\n| Network mode to use which can be `none`, `host`, `bridged`, `container` or `custom`\n\n| *docker.network.name*\n| Name of the custom network when mode is `custom`, or for mode `container` the image alias name used to create the container.\n\n| *docker.network.alias.idx*\n| One or more aliase for a custom network. Only used when the network mode is `custom`\n\n| *docker.noCache*\n| Don't use a cache when building the image\n\n| *docker.squash*\n| Squash newly built layers into a single layer (API 1.25+, need to be enabled in the Docker daemon configuration)\n\n| *docker.optimise*\n| if set to true then it will compress all the `runCmds` into a single RUN directive so that only one image layer is created.\n\n| *docker.portPropertyFile*\n| specifies a path to a port mapping used when starting a container.\n\n| *docker.ports.idx*\n| Sets a port mapping. For example `jolokia.ports:8080` maps the container port 8080 dynamically to a host port and assigns this host port to the Maven property `${jolokia.port}`. See <<_port-mapping,Port mapping>> for possible mapping options. When creating images images only the right most port is used for exposing the port. For providing multiple port mappings, the index should be count up.\n\n| *docker.registry*\n| Registry to use for pushing images.\n\n| *docker.restartPolicy.name*\n| Container restart policy\n\n| *docker.restartPolicy.retry*\n| Max restart retries if `on-failure` used\n\n| *docker.run.idx*\n| List of commands to `RUN` when creating the image\n\n| *docker.securityOpts.idx*\n| List of `opt` elements to specify kernel security options to add to the container. For example `docker.securityOpt.1=seccomp=unconfined`\n\n| *docker.shmsize*\n| Size of `/dev/shm` in bytes.\n\n| *docker.tags.idx*\n| List of tags to apply to a built image\n\n| *docker.tmpfs.idx*\n| One or more mount points for a *tmpfs*. Add mount options after a `:`\n\n| *docker.ulimits.idx*\n| Ulimits for the container. Ulimit is specified with a soft and hard limit `=[:]`. For example `docker.ulimits.1=memlock=-1:-1`\n\n| *docker.user*\n| User to switch to at the end of a Dockerfile. Not to confuse with `docker.username` which is used for authentication when interacting with a Docker registry.\n\n| *docker.volumes.idx*\n| defines a list of volumes to expose when building an image\n\n| *docker.volumesFrom.idx*\n| defines a list of image aliases from which the volumes should be mounted of the container. The list semantics is the same as for links (see above). For examples `data` will mount all volumes exported by the `data` image.\n\n| *docker.wait.http.url*\n| URL to wait for during startup of a container\n\n| *docker.wait.http.method*\n| HTTP method to use for ping check\n\n| *docker.wait.http.status*\n| Status code to wait for when doing HTTP ping check\n\n| *docker.wait.time*\n| Amount of time to wait during startup of a container (in ms)\n\n| *docker.wait.log*\n| Wait for a log output to appear.\n\n| *docker.wait.exec.postStart*\n| Command to execute after the container has start up.\n\n| *docker.wait.exec.preStop*\n| Command to execute before command stops.\n\n| *docker.wait.exec.breakOnError*\n| If set to \"true\" then stop the build if the a `postStart` or `preStop` command failed\n\n| *docker.wait.shutdown*\n| Time in milliseconds to wait between stopping a container and removing it.\n\n| *docker.wait.tcp.mode*\n| Either `mapped` or `direct` when waiting on TCP connections\n\n| *docker.wait.tcp.host*\n| Hostname to use for a TCP wait checks\n\n| *docker.wait.tcp.port.idx*\n| List of ports to use for a TCP check.\n\n| *docker.wait.kill*\n| Time in milliseconds to wait between sending SIGTERM and SIGKILL to a container when stopping it.\n\n| *docker.workdir*\n| Container working directory where the image is build in\n\n| *docker.workingDir*\n| Current Working dir for commands to run in when running containers\n|===\n\nMultiple property configuration handlers can be used if they\nuse different prefixes. As stated above the environment and ports\nconfiguration are both used for running container and building\nimages. If you need a separate configuration you should use explicit\nrun and build configuration sections.\n\n[[combining-property-config]]\n.Combining property and XML configuration\nBy default the property handler will only consider properties and ignore any other image\nconfiguration in the XML/POM file. This can be changed by adding the ``\nconfiguration (since version 0.25.0), which can have one of the following values:\n\n.Property mode\n[cols=\"1,5\"]\n|===\n|`only`\n| Only look at properties, ignore any `` or `` sections for this image. This is the default, and also the behavior in versions before 0.25.0.\n\n|`override`\n| Use property if set, else fall back to value found in `` or `` sections for this image.\n\n|`fallback`\n| Use value found in `` or `` sections for this image, else fall back to to property value.\n\n|`skip`\n| Effectively disable properties, same as not specifying the `` section at all.\n|===\n\n[[combining-property-config-externally]]\n.Activating property configuration externally\nIt also possible to activate property configuration by setting the property `docker.imagePropertyConfiguration` to a\nvalid `property mode`, without adding an `` section. The plugin will then use any properties with default `docker.` prefix.\nThis can be useful if most of the configuration is specified in XML/POM file, but there\nis need to override certain configuration values without altering the POM file (instead add this to a parent POM or\nglobal settings.xml).\n\nIf set in parent POM, but not wanted in specific project, the property could be overriden locally with the value `skip`\nto disabled property configuration for that particular project.\nIf set in settings.xml however, by Maven design, that value will always take precedence over any properties defined in\npom.xml.\n\nFor configurations with multiple images, using this property will by default produce an error. All images would then\nuse the same `docker` property prefix, resulting in multiple identical configurations.\nThis can be overruled by adding an explicit configuration element with an explicit to all\nimages (or at least all but one). Normally you'd want to use different prefix for each image, but if explicitly set\nit does allow you to use the same prefix (even `docker`) on all images. This is useful in case you just want to share\na few properties. This only makes sense when `property mode` is _override_ or _fallback_ and image-specific configuration\nare defined in the POM configuration.\n\nFor examples, see <>\n\n.Merging POM and property values\nFor some fields it may be desired to merge values from both POM and properties. For example, in a certain run environment\nwe might want to inject a `http_proxy` environment variable, but we do not want to add this to the POM file.\n\nThis is solved using a *Combine policy* which can be either `replace` or `merge`. Merge is only available for\nconfiguration of Map or List type. For scalar values such as strings and integers, it is not supported.\nFor Maps, both sources are merged, with the priority source taking precedence. For Lists, they are concatenated, with values\nfrom the priority source being added first.\n\nCombine policy is specified per configuration key/property, and the default in most cases is currently `replace`. The following\nkeys have `merge` as default policy:\n\n* docker.args\n* docker.envBuild\n* docker.envRun\n* docker.labels\n* docker.ports\n* docker.tags\n\nThis can be overridden individually for all configuration keys (of map/list type) by setting an additional property suffixed `._combine`.\nFor example, to not merge ports, set `docker.ports._combine=replace`, and to enable merging of dns, set `docker.dns._combine=merge`.\n\n\n.Example, properties only\n[source,xml]\n----\n\n jolokia/demo\n service\n consol/tomcat:7.0\n src/main/docker-assembly.xml\n -Xmx32m\n ${project.version}\n 8080\n http://localhost:${jolokia.port}/jolokia\n\n\n\n \n \n io.fabric8\n docker-maven-plugin\n \n \n \n \n properties\n docker\n \n \n \n \n \n \n\n----\n\n\n[[externally-property-config-example]]\n.Example, combining properties and XML/POM configuration\n[source,xml]\n----\n\n src/main/docker-assembly.xml\n -Xmx32m\n ${project.version}\n 8080\n http://localhost:${jolokia.port}/jolokia\n\n\n\n \n \n io.fabric8\n docker-maven-plugin\n \n \n \n \n properties\n docker\n override\n \n\n jolokia/demo\n service\n\n \n consol/tomcat:7.0\n \n tomcat\n \n \n \n \n \n \n \n\n----\n\nThis would build the same image as the previous example.\nIf instead built with `mvn docker:build -Pdocker.from=console/tomcat:8.0 -Ddocker.tags.0=tc8-test` it would build from that image instead, and also add that tag to the image.\n\nIf `-Ddocker.labels.status=beta` is added, the image would be given two labels: `status=beta` and `software=tomcat`.\nIf `-Ddocker.labels._combine=replace` is added, the image would be given one label only: `status=beta`.\n\n\n.Example, external activation of property configuration, single image\n\nGlobal ~/.m2/settings.xml file:\n[source,xml]\n----\n\n \n http-proxy\n \n http://proxy.example.com:8080\n http://proxy.example.com:8080\n override\n \n \n\n----\n\n[source,xml]\n----\n\n \n \n io.fabric8\n docker-maven-plugin\n \n \n \n jolokia/demo\n service\n \n consol/tomcat:7.0\n \n \n \n \n \n \n\n----\n\nWhen the plugin is executed, on a machine with the given settings.xml, the plugin will see the `docker.imagePropertyConfiguration` configuration and enable\nthe property merging feature. When building, it will inject the http_proxy build ARG, and when running, it will inject the http_proxy ENV variable.\nThe rest of the configuration will be sourced from the XML, unless the Maven project has any other `docker.*` properties defined.\n\n\n.Example, external activation of property configuration, two images\nUsing the same global ~/.m2/settings.xml file as in previous example, but with two image definitions and no extra configuration will cause\nan error, saying that you cannot use property docker.imagePropertyConfiguration on projects with multiple images.\n\nBy adding an explicit external configuration directive with the same prefix in both images, this error is disabled.\n\n[source,xml]\n----\n\n \n \n io.fabric8\n docker-maven-plugin\n \n \n \n \n properties\n docker\n override\n \n\n jolokia/demo\n service\n \n consol/tomcat:7.0\n \n \n\n \n \n properties\n docker\n override\n \n\n jolokia/demo2\n service2\n \n consol/tomcat:7.0\n \n \n \n \n \n \n\n----\n\nThe behaviour will now be same as previous example.\nNote that you must explicitly state `override`, otherwise it will use the default `only`." }, { "path": "src/main/asciidoc/inc/image/_configuration.adoc", "content": "\n[[config-image]]\n.Image Configuration\n[cols=\"1,5\"]\n|===\n| Element | Description\n\n| *name*\n| Each `` configuration has a mandatory, unique docker\nrepository _name_. This can include registry and tag parts, but also placeholder parameters. See below for a detailed explanation.\n\n| *alias*\n| Shortcut name for an image which can be used for\nidentifying the image within this configuration. This is used when\nlinking images together or for specifying it with the global *image* configuration element.\n\n| <>\n| Registry to use for this image. If the `name` already contains a registry this takes precedence. See <> for more details.\n\n| <>\n| Element which contains all the configuration aspects when doing a <<{plugin}:build>>. This element can be omitted if the image is only pulled from a registry e.g. as support for integration tests like database images.\n\nifeval::[\"{plugin}\" == \"docker\"]\n| <>\n| Element which describe how containers should be\ncreated and run when <<{plugin}:start>> is called. If this image is only used a _data container_ (i.e. is supposed only to be mounted as a volume) for exporting artifacts via volumes this section can be missing.\n\n| <>\n| Specification of external configuration as an alternative to this XML based configuration with `` and ``. It contains a `` element specifying the handler for getting the configuration. See <> for details.\nendif::[]\n\n| *removeNamePattern*\n| When this image is to be removed by <<{plugin}:remove>>, use this <> to find images to\nremove rather than just using the name.\n\n| *stopNamePattern*\n| When containers associated with this image will be stopped by <<{plugin}:stop>>, use this <>\nto find containers to remove rather than just using the associated container name.\n\n|===\n" }, { "path": "src/main/asciidoc/inc/image/_example.adoc", "content": "\n.Example\n[source,xml]\n----\n\n ....\n \n \n %g/docker-demo:0.1\n service\n ....\n ....\n \n \n\n----\n" }, { "path": "src/main/asciidoc/inc/image/_example_imagesMap.adoc", "content": "\n.Example\n[source,xml]\n----\n\n ....\n \n \n %g/docker-demo:0.1\n ....\n ....\n \n \n\n----\n" }, { "path": "src/main/asciidoc/inc/image/_naming.adoc", "content": "[[image-name]]\n## Image Names\nWhen specifying the image name in the configuration with the `` field you can use several placeholders which are replaced during runtime by this plugin. In addition you can use regular Maven properties which are resolved by Maven itself.\n\n[cols=\"1,5\"]\n|===\n| Placeholder | Description\n\n| *%g*\n| The last part of the Maven group name, sanitized so that it can be used as username on GitHub. Only the part after the last dot is used. E.g. for a group id `io.fabric8` this placeholder would insert `fabric8`\n\n| *%a*\n| A sanitized version of the artefact id so that it can be used as part of an Docker image name. I.e. it is converted to all lower case (as required by Docker)\n\n| *%v*\n| The project version. Synonym to `${project.version}`\n\n| *%l*\n| If the project version ends with `-SNAPSHOT` then this placeholder is `latest`, otherwise its the full version (same as `%v`)\n\n| *%t*\n| If the project version ends with `-SNAPSHOT` this placeholder resolves to `snapshot-` where timestamp has the date format `yyMMdd-HHmmss-SSSS` (eg `snapshot-`). This feature is especially useful during development in oder to avoid conflicts when images are to be updated which are still in use. You need to take care yourself of cleaning up old images afterwards, though.\n|===\n\nifeval::[\"{plugin}\" == \"docker\"]\n[[container-name]]\n## Container Names\n\nSimilar to image name placeholders, for starting and stopping containers and alternate set of placeholders can be configured in order to the name the containers to create.\n\nThese placeholders can be used in the top-level configuration value `containerNamePattern` which is used globally for every container that is created.\nThis global pattern can be overwritten individually by each image's <> configuration.\nIf neither is given, then by default the pattern `%n-%i` is used.\n\nWhen specifying the container name pattern the following placeholders can be used:\n\n[cols=\"1,5\"]\n|===\n| Placeholder | Description\n\n| *%a*\n| The `` of an image which must be set. The alias is set in the top-level image configuration\n\n| *%n*\n| A sanitized version of the imag's short name from which this container is created. \"Sanitized\" means that any non letter, digit, dot or dash is replaced by an underscore.\n\n| *%t*\n| The build time stamp. This is the timestamp which created during the building of an image and locally cached. A rebuild of the image will update the timestamp.\n\n| *%i*\n| An index which is incremented if a container has already been created. With this parameter it is easily possible to have multiple, similar containers. See the example below for more details.\n\n|===\n\nYou can combine the placeholders in any combination and will be resolved during `docker:start`, `docker:stop` and `docker:watch`.\n\nThe following example is using a container name pattern of `%n-%i` which is also the default.\nGiven an image `fabric8io/dmp-sample-jolokia:latest`, then during `mvn docker:start` a container with the name `dmp-sample-jolokia-1` is first tried.\nIf there is already a container with this name, then `dmp-sample-jolokia-2` is the second attempt.\nThis goes on until a \"free\" name is found.\n\nSimilar, when stopping containers with `mvn docker:stop` then only the container with the highest index is stopped.\nHowever, if you don't use an index via `%i` then _all_ containers started with `docker:start` are stopped.\nUse `mvn docker:stop -Ddocker.allContainers` to also stop every container named via a `%i` pattern.\nendif::[]\n\n[[name-patterns]]\n## Name Patterns\n\nGoals that need to refer to images or containers where the name of the image or container is not fixed may support name\npatterns for matching. Patterns can use an Ant-like syntax or Java regular expressions.\n\n### Ant-like Name Patterns\nAnt path matching patterns that operate on path names use the convention that a `$$*$$` matches within a single path\ncomponent, while `$$**$$` can match multiple components.\n\nAdapting this style to image names requires some tweaks since image names may include registry information, a path-like\nrepository name and a tag. Consider the following image names:\n\n* `alpine:latest`\n* `fluent/fluentd:edge`\n* `quay.io/operator-framework/helm-operator:v0.9.0`\n* `company.local:5000/division/project/artifact:version`\n\nUnlike in Ant matching of file system paths, the `:` is an important marker, but only at the end where it separates the\nversion from the repository. Also, patterns that match repository names need to anticipate that there may be a registry\nname at the beginning if the image has been tagged for pushing to a registry.\n\nTaking this into account, the name pattern wildcards are:\n\n* `?` matches a single character\n* `*` matches zero or more characters, up to the next slash or the tag separator\n* `**` matches zero or more characters, up to the tag separator\n* `**/` matches zero or more characters, up to the tag separator, and ensures that if any characters are matched, the\nfinal character matched is a slash\n\n#### Examples of Ant-like Name Patterns\n\n[cols=\"1,3,3\"]\n|===\n| Pattern | Matches | Does Not Match\n\n| `$$**tomcat:jdk-11*$$`\na|\n* megacorp/tomcat:jdk-11-alpine\n* megacorp.com:5000/megacorp/project-x-tomcat:jdk-11\n\na|\n* megacorp/tomcat__-operator__:jdk-11\n* megacorp/project-x-tomcat:__jdk-9-alpine__\n\n| `$$**/megacorp/tomcat:*alpine$$`\na|\n* megacorp/tomcat:alpine\n* megacorp.com:5000/megacorp/tomcat:jdk-11-alpine\n\na|\n* megacorp/tomcat:__jdk-11__\n* megacorp.com:5000/__ultra__megacorp/tomcat:jdk-11-alpine\n\n| `$$megacorp/*-operator:*$$`\na|\n* megacorp/tomcat-operator:alpine\n* megacorp/mysql-operator:latest\n\na|\n* megacorp/__tomcat__:jdk-11\n* __megacorp.com:5000/__megacorp/tomcat-operator:alpine\n\n|===\n\n### Java Regular Expression Patterns\n\nTo indicate that a name pattern is a Java regular expression, prefix the regular expression with `$$%regex[$$` and\nsuffix with `$$]$$`.\n\n#### Examples of Java Regular Expression Patterns\n\n[cols=\"1,3,3\"]\n|===\n| Pattern | Matches | Does Not Match\n\n| `$$%regex[j(dk\\|re)-11]$$`\na|\n* megacorp/tomcat:jdk-11-alpine\n* openjdk-11:latest\n\na|\n* openjdk:11-alpine\n\n| `$$%regex[tomcat]$$`\na|\n* megacorp/tomcat:alpine\n* megacorp.com:5000/tomcat-projects/project-x:latest\n\na|\n* megacorp/topcat:edge\n\n|===\n\n[[name-pattern-lists]]\n### Name Pattern Lists\n\nIn goals such as <<{plugin}:stop>> and <<{plugin}:remove>> where multiple patterns are supported, separate patterns\nwith commas.\n\n" }, { "path": "src/main/asciidoc/inc/misc/_env.adoc", "content": "\n\nWhen creating a container one or more environment variables can be set via configuration with the `env` parameter\n\n.Example\n[source,xml]\n----\n\n /opt/jdk8\n -Djava.security.egd=file:/dev/./urandom\n\n----\n\nIf you put this configuration into profiles you can easily create various test variants with a single image (e.g. by switching the JDK or whatever).\n\nIt is also possible to set the environment variables from the outside of the plugin's configuration with the parameter `envPropertyFile`. If given, this property file is used to set the environment variables where the keys and values specify the environment variable. Environment variables specified in this file override any environment variables specified in the configuration.\n\nLabels can be set inline the same way as environment variables:\n\n.Example\n[source,xml]\n----\n\n foo\n ${project.version}\n ${project.artifactId}\n\n----\n" }, { "path": "src/main/asciidoc/inc/misc/_startup.adoc", "content": "\n\nUsing `entrypoint` and `cmd` it is possible to specify the https://docs.docker.com/reference/builder/#entrypoint[entry point]\nor https://docs.docker.com/reference/builder/#cmd[cmd] for a container.\n\nThe difference is, that an `entrypoint` is the command that always be executed, with the `cmd` as argument. If no `entrypoint` is provided, it defaults to `/bin/sh -c` so any `cmd` given is executed with a shell. The arguments given to `docker run` are always given as arguments to the\n`entrypoint`, overriding any given `cmd` option. On the other hand if no extra arguments are given to `docker run` the default `cmd` is used as argument to `entrypoint`.\n\n****\nSee this http://stackoverflow.com/questions/21553353/what-is-the-difference-between-cmd-and-entrypoint-in-a-dockerfile[stackoverflow question] for a detailed explanation.\n****\n\nAn entry point or command can be specified in two alternative formats:\n\n.Entrypoint and Command Configuration\n[cols=\"1,5\"]\n|===\n| Mode | Description\n\n| *shell*\n| Shell form in which the whole line is given to `shell -c` for interpretation.\n\n| *exec*\n| List of arguments (with inner ``) arguments which will be given to the `exec` call directly without any shell interpretation.\n|===\n\nEither shell or params should be specified.\n\n.Example\n[source,xml]\n----\n\n \n java -jar $HOME/server.jar\n\n----\n\nor\n\n.Example\n[source,xml]\n----\n\n \n \n java\n -jar\n /opt/demo/server.jar\n \n\n----\n\nThis can be formulated also more dense with:\n\n.Example\n[source,xml]\n----\n\njava -jar $HOME/server.jar\n----\n\nor\n\n.Example\n[source,xml]\n----\n\n \n java\n -jar\n /opt/demo/server.jar\n\n----\n\n" }, { "path": "src/main/asciidoc/inc/push/_configuration.adoc", "content": "\n\n.Push options\n[cols=\"1,5,1\"]\n|===\n| Element | Description | Property\n\n| *skipPush*\n| If set to `true` the plugin won't push any images that have been built.\n| `docker.skip.push`\n\n| *skipTag*\n| If set to `true` this plugin won't push any tags\n| `docker.skip.tag`\n\n| *pushRegistry*\n| The registry to use when pushing the image. See <> for\nmore details.\n| `docker.push.registry`\n\n| *retries*\n| How often should a push be retried before giving up. This useful for flaky registries which tend to return 500 error codes from time to time. The default is 0 which means no retry at all.\n| `docker.push.retries`\n|===\n" }, { "path": "src/main/asciidoc/inc/push/_overview.adoc", "content": "\nThis goal uploads images to the registry which have a `` configuration section. The images to push can be restricted with\nthe global option `filter` (see <> for details). The registry to push is by default `docker.io` but can be specified as part of the images's `name` name the Docker way. E.g. `docker.test.org:5000/data:1.5` will push the image `data` with tag `1.5` to the registry `docker.test.org` at port `5000`. Security information (i.e. user and password) can be specified in multiple ways as described in section <>.\n\nBy default a progress meter is printed out on the console, which is omitted when using Maven in batch mode (option `-B`). A very simplified progress meter is provided when using no color output (i.e. with `-Ddocker.useColor=false`).\n" }, { "path": "src/main/asciidoc/inc/start/_configuration.adoc", "content": "In addition to the <>, this goal supports the following global configuration options.\n\n.Start options\n[cols=\"1,5,1\"]\n|===\n| Element | Description | Property\n\n| <>\n| Default pattern for naming all containers when they are created. See <> for details.\n| `docker.containerNamePattern`\n\n| *showLogs*\n| In order to switch on globally the logs *showLogs* can be used as global configuration (i.e. outside of ``). If set it will print out all standard\n output and standard error messages for all containers started. As value the images for which logs should be shown can be given as a comma separated list.\n This is probably most useful when used from the command line as system property `docker.showLogs`.\n| `docker.showLogs`\n\n| *startParallel*\n| Starts docker images in parallel while dependencies expressed as <> or <> are respected. This option can significantly reduce the startup time because independent containers do not need to wait for each other.\n| `docker.startParallel`\n\n|===\n\nThe `` configuration element knows the following sub elements:\n\n[[config-image-run]]\n.Run configuration (< >>)\n[cols=\"1,5\"]\n|===\n| Element | Description\n\n| *capAdd*\n| List of `add` elements to specify kernel parameters to add to the container.\n\n| *capDrop*\n| List of `drop` elements to specify kernel parameters to remove from the container.\n\n| <>\n| Command which should be executed at the end of the container's startup. If not given, the image's default command is used. See <> for details.\n\n| <>\n| Pattern for naming the container when it is created. See <> for details.\n\n| *domainname*\n| Domain name for the container\n\n| *dns*\n| List of `host` elements specifying dns servers for the container to use\n\n| *dnsSearch*\n| List of `host` elements specifying dns search domains\n\n| *entrypoint*\n| Entry point for the container. See <> for details.\n\n| <>\n| Environment variables as subelements which are set during startup of the container. They are specified in the typical maven property format as described <>.\n\n| *envPropertyFile*\n| Path to a property file holding environment variables. If given, the variables specified in this property file overrides the environment variables specified in the configuration.\n\n| *extraHosts*\n| List of `host` elements in the form `host:ip` to add to the container's `/etc/hosts` file. Additionally, you may specify a `host` element in the form `host:host` to have the right side host ip address resolved at container startup.\n\n| *exposedPropertyKey*\n| Set the property part for the exposed container properties as described <>. This will take precedence of the image's `alias` which is the default value. For example, when this property is set to `jboss`, then for this container its IP address is exposed in Maven property `docker.container.jboss.ip` regardless how the image is named.\n\n| *hostname*\n| Hostname of the container\n\n| *imagePullPolicy*\n| Specific pull policy for downloading the image. This overwrites any global pull policy. See the global <> configuration option for the possible values and the default.\n\n| <>\n| Labels which should be attached to the container. They are specified in the typical maven property format as described in <>.\n\n| <>\n| Network links for connecting containers together as described in <>.\n\n| <>\n| Log configuration for whether and how log messages from the running containers should be printed. This also can configure the https://docs.docker.com/engine/admin/logging/overview[log driver] to use. See <> for a detailed description.\n\n| *memory*\n| Memory limit in bytes\n\n| *memorySwap*\n| Total memory usage (memory + swap); use -1 to disable swap.\n\n| *namingStrategy*\na| *This option is deprecated, please use a `containerNamePattern` instead* Naming strategy for how the container name is created:\n\n* *none* : uses randomly assigned names from docker (default)\n* *alias* : uses the `alias` specified in the `image` configuration. An error is thrown, if a container already exists with this name.\n\n| <>\n| Network configuration for your container.\n\n| <>\n| File path into which the mapped port properties are written. The format of this file and its purpose are also described in <>\n\n| <>\n| <> for exposing container ports to host ports.\n\n| *privileged*\n| If `true` give container full access to host\n\n| *readOnly*\n| If `true` mount the container's root filesystem as read only\n\n| *autoRemove*\n| If `true` automatically remove the container when it exits. This has no effect if <> has been set.\n\n| <>\n| Restart Policy\n\n| *securityOpts*\n| List of `` elements to specify kernel security options to add to the container. See below for an example.\n\n| *shmSize*\n| Size of `/dev/shm` in bytes.\n\n| *skip*\n| If `true` disable creating and starting of the container. This option is best used together with a Maven property which can be set from the outside.\n\n| *stopMode*\n| Specifies how to stop a running container. It supports the modes `graceful` and `kill` as values, with `graceful` being the default.\n\n| *tmpfs*\na| List countaintin `` elements for directories to mount with a temporary filesystem. Optionally, mount options can be appended after a ':'. See below for an example.\n\n| *ulimits*\na| ulimits for the container. This list contains `` elements which three sub elements:\n\n* `` : The ulimit to set (e.g. `memlock`). Please refer to the Docker documentation for the possible values to set\n* `` : The hard limit\n* `` : The soft limit\n\nSee below for an example.\n\n| *user*\n| User used inside the container\n\n| <>\n| Volume configuration for binding to host directories and from other containers. See Volumes for details.\n\n| <>\n| Condition which must be fulfilled for the startup to complete. See <> for all possible ways to wait for a startup condition.\n\n| *workingDir*\n| Working directory for commands to run in\n|===\n\n.Example\n[source,xml]\n----\n\n \n -Xmx32m\n \n \n \n development\n ${project.version}\n \n \n jolokia.port:8080\n \n \n \n memlock\n -1\n -1\n \n \n \n /var/lib/mysql:size=10m\n /opt/mydata\n \n \n seccomp=unconfined\n \n \n db\n \n \n \n http://localhost:${jolokia.port}/jolokia\n \n \n \n \n DEMO\n ISO8601\n blue\n \n java -jar /maven/docker-demo.jar\n\n----\n" }, { "path": "src/main/asciidoc/inc/start/_depends-on.adoc", "content": "Custom networks do not provide a mechanism like `` to express strong links between containers. They are normally not required because docker ensures that all containers within the same custom network can eventually resolve each other via DNS.\n\nYour containers should preferably be able to deal with temporarily unresolvable dependencies but in some cases it is helpful to be able to rely the availability of other infrastructure containers.\n\nThe `` configuration can be used to expresses custom network dependencies between your containers. `docker:start` will ensure that all dependencies a container depends on are completely started (fulfilling all `` conditions) before the depending container is started.\n\nAdditionally, each `` element can specify a comma separated set of containers. Comma (and whitespace) can be used to separate containers since valid docker container names contain only characters, digits, underscores, periods and dashes.\n\n.Example\n[source,xml]\n----\n\n \n \n \n postgres\n logstash\n \n \n\n----\n" }, { "path": "src/main/asciidoc/inc/start/_links.adoc", "content": "\nThe `` configuration contains a list of containers that should\nbe linked to this container according to https://docs.docker.com/userguide/dockerlinks[Docker Links]. Each link can have two parts where the optional right side is separated by a `:` and will be used as the name in the environment variables and the left side refers to the name of the container linking to. This is equivalent to the linking when using the Docker CLI `--link` option.\n\nExample for linking to a container with name or alias _postgres_ :\n\n.Example\n[source,xml]\n----\n\n postgres:db\n\n----\n\nThis will create the following environment variables, given that the postgres image exposes TCP port 5432:\n\n.Example\n[source,bash]\n----\nDB_NAME=/web2/db\nDB_PORT=tcp://172.17.0.5:5432\nDB_PORT_5432_TCP=tcp://172.17.0.5:5432\nDB_PORT_5432_TCP_PROTO=tcp\nDB_PORT_5432_TCP_PORT=5432\nDB_PORT_5432_TCP_ADDR=172.17.0.5\n----\n\nAdditionally, each `` element can specify a comma separated set of links. Comma (and whitespace) can be used to separate links since valid docker link names/aliases contain only characters, digits, underscores, periods and dashes.\n\n.Example\n[source,xml]\n----\n\n postgres:db, search, saml:identity\n\n----\n\nIf you wish to link to existing containers not managed by the plugin, you may do so by specifying the container name obtained via `docker ps` in the configuration.\n\nPlease note that the link behaviour also depends on the network mode selected. Links as described are referred to by Docker as _legacy links_ and might vanish in the future. For custom networks no environments variables are set and links create merely network aliases for the linked container. To express start order dependencies using custom networks refer to the <> configuration.\n\nFor a more detailed documentation for the new link handling please refer to the https://docs.docker.com/engine/userguide/networking/work-with-networks/#linking-containers-in-user-defined-networks[Docker network documentation]\n" }, { "path": "src/main/asciidoc/inc/start/_logging.adoc", "content": "\nWhen running containers the standard output and standard error of the container can be printed out. Several options are available for configuring the log output:\n\n.Logging configuration\n[cols=\"1,5\"]\n|===\n| Element | Description\n\n| *enabled*\n| If set to `false` log output is disabled. This is useful if you want to disable log output by default but want to use the other configuration options when log output is switched on on the command line with `-Ddocker.showLogs`. Logging is enabled by default if a `` section is given.\n\n| *prefix*\na| Prefix to use for the log output in order to identify the container. You can use placeholders in the prefix which are replaced on the fly:\n\n* `%a`: Alias of the image, or, if not set, the short container id.\n* `%c`: Short container id (i.e. the first 6 chars of the container id\n* `%C`: The full container id\n* `%n`: The image name\n* `%z`: An empty string\n\nBy default the format is \"%a> \".\n\n| *date*\na| Dateformat to use for log timestamps. If `` is not given no timestamp will be shown. The date specification can be either a constant or a date format. The recognized constants are:\n\n* `NONE` Switch off timestamp output. Useful on the command line\n(`-Ddocker.logDate=NONE`) for switching off otherwise enabled\nlogging.\n* `DEFAULT` A default format in the form `HH:mm:ss.SSS`\n* `MEDIUM` java.time medium date time format\n* `SHORT` java.time short date time format\n* `LONG` java.time long date time format\n* `ISO8601` Full ISO-8601 formatted date time with milliseconds\n\nAs an alternative a date-time format string as recognized by\nhttps://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html[java.time] is possible. In order to set a consistent date format, the global configuration parameter `logDate` can be used.\n\n| *color*\n| Color used for coloring the prefix when coloring is enabled (i.e. if running in a console and `useColor` is set). The available colors are `YELLOW`, `CYAN`, `MAGENTA`, `GREEN`, `RED`, `BLUE`. If coloring is enabled and now color is provided a color is picked for you.\n\n| *file*\n| Path to a file to which the log output is written. This file is overwritten for every run and colors are switched off.\n\n| *driver*\n| Section which can specify a dedicated log driver to use. A `` tag within this section depicts the logging driver with the options specified in ``. See the example below for how to use this.\n|===\n\n.Example\n[source,xml]\n----\n\n TC\n default\n cyan\n\n----\n\nThe following example switches on the `gelf` https://docs.docker.com/engine/admin/logging/overview[logging driver] .\nThis is equivalent to the options `--log-driver=gelf --log-opt gelf-address=udp://localhost:12201` when using `docker run`.\n\n[source,xml]\n----\n\n ...\n \n gelf\n \n udp://localhost:12201\n \n \n\n----\n" }, { "path": "src/main/asciidoc/inc/start/_network.adoc", "content": "\nThe `` element in the < >> configuration section can be used to configure the network mode of the container. This is now the preferred way for linking containers together. It knows the following sub elements:\n\n.Network configuration\n[cols=\"1,7\"]\n|===\n| Element | Description\n\n| *mode*\na| The network mode, which can be one of the following values:\n\n* *bridge* : Bridged mode with the default Docker bridge (default)\n* *host* : Share the Docker host network interfaces\n* *container* : Connect to the network of the specified container. The name of the container is taken from the `` element.\n* *custom* : Use a custom network, which must be created before by using `docker network create`. Alternatively you can set the ```docker.autoCreateCustomNetworks``` <> parameter to ```true``` to automatically create custom networks. Custom networks are available for Docker 1.9 and newer. For more about the networking options please refer to the https://docs.docker.com/engine/userguide/networking/work-with-networks[Docker documentation].\n\n* *none* : No network will be setup.\n\n| *name*\n| For mode `container` this is the container name, which is this image alias. For Mode `custom` this is the name of the custom network.\n\n| *alias*\n| One or more alias element can be provided which gives a way for a container to be discovered by alternate names by any other container within the scope of a particular network. This configuration only has effect for when the network mode is `custom`. More than one alias can be given by providing multiple entries.\n|===\n\nIf no `mode` is given but a `name`, then a `custom` network mode is assumed. For the simple modes which does not take an argument (`none`, `bridge` or `host`) a single `` _mode_ `` can be used as alternative to using `` with a `` subelement.\n\n.Example \n[source,xml]\n----\n\n custom\n my-network\n box1\n box2\n\n----\n\nor for a simple `host` network:\n\n.Example \n[source, xml]\n----\nhost\n----\n" }, { "path": "src/main/asciidoc/inc/start/_overview.adoc", "content": "\n[[start-overview]]\nThis goal creates and starts docker containers. This goal evaluates the configuration's `` section of all given (and enabled images).\n\nAlso you can specify `docker.follow` as system property so that the `{plugin}:start` will never return but block until CTRL-C is pressed. That similar to the option `-i` for `docker run`. This will automatically switch on `showLogs` so that you can see what is happening within the container. Also, after stopping with CTRL-C, the container is stopped (but not removed so that you can make postmortem analysis). `{plugin}:run` is an alias for `{plugin}:start` with `docker.follow` enabled.\n\nBy default container specific properties are exposed as Maven properties. These properties have the format `docker.container..` where `` is the name of the container (see below) and `` is one of the following container properties:\n\n.Properties provided\n[cols=\"1,5\"]\n|===\n| Property | Description\n\n| *ip*\n| Internal IP address of the container.\n\n| *id*\n| Container id\n\n| *net*.__.*ip*\n| Internal IP address of the container in the specified custom network. This works only for custom networks.\n|===\n\nInstead of the `` a fixed property key can be configured in the image's < >> configuration with the option `exposedPropertyKey`.\n\nFor example the Maven property `docker.container.tomcat.ip` would hold the Docker internal IP for a container with an alias \"tomcat\". You can set the global configuration *exposeContainerInfo* to an empty string to not expose container information that way or to a string for an other prefix than `docker.container`.\n" }, { "path": "src/main/asciidoc/inc/start/_port-mapping.adoc", "content": "\nThe `` configuration contains a list of port mappings. Whitespace is trimmed from each element and empty elements are ignored. Each mapping has multiple parts, each separate by a colon. This is equivalent to the port mapping when using the Docker CLI with option `-p`.\n\nA `port` stanza may take one of the following forms:\n\n.Port mapping format\n[cols=\"2,5\"]\n|===\n| Format | Description\n\n| ++18080:8080++\n| Tuple consisting of two numeric values separated by a `:`. This form will result in an explicit mapping between the docker host and the corresponding port inside the container. In the above example, port 18080 would be exposed on the docker host and mapped to port 8080 in the running container.\n\n| **host.port**++:80++\n| Tuple consisting of a string and a numeric value separated by a `:`. In this form, the string portion of the tuple will correspond to a Maven property. If the property is undefined when the `start` task executes, a port will be dynamically selected by Docker in the ephemeral port range and assigned to the property which may then be used later in the same POM file. The ephemeral port range is configured by the `/proc/sys/net/ipv4/ip_local_port_range` kernel parameter, which typically ranges from 32678 to 61000. If the property exists and has numeric value, that value will be used as the exposed port on the docker host as in the previous form. In the above example, the docker service will elect a new port and assign the value to the property `host.port` which may then later be used in a property expression similar to `${host.port}`. This can be used to pin a port from the outside when doing some initial testing similar to `mvn -Dhost.port=10080 {plugin}:start`\n\n| **bindTo**++:++**host.port**++:80++\n| Tuple consisting of two strings and a numeric value separated by a `:`. In this form, `bindTo` is an ip address on the host the container should bind to. As a convenience, a hostname pointing to the docker host may also be specified. The container will fail to start if the hostname can not be resolved.\n\n| +**host.ip**++:++**host.port**++:80++\n| Tuple consisting of two strings and a numeric value separated by a `:`. In this form, the host ip of the container will be placed into a Maven property name `host.ip`. If docker reports that value to be `0.0.0.0`, the value of `docker.host.address` will be substituted instead. In the event you want to use this form and have the container bind to a specific hostname/ip address, you can declare a Maven property of the same name (`host.ip` in this example) containing the value to use. `host:port` works in the same way as described above.\n|===\n\nBy default TCP is used as protocol but you can also use UDP by appending '/udp' to the port number.\n\nThe following are examples of valid configuration entries:\n\n.Example\n[source,xml]\n----\n\n 1.2.3.4\n some.host.pvt\n\n\n...\n\n\n 18080:8080\n 15060:5060/udp\n host.port:80\n 127.0.0.1:80:80\n localhost:host.port:80\n +container.ip.property:host.port:5678\n +bind.host.ip:host.port:5678\n +bind.host.name:5678:5678\n\n----\n\nAnother useful configuration option is `portPropertyFile` which can be used to write out the container's host ip and any dynamic ports that have been resolved. The keys of this property file are the property names defined in the port mapping configuration and their values those of the corresponding docker attributes.\n\nThis property file might be useful with tests or with other maven plugins that will be unable to use the resolved properties because they can only be updated after the container has started and plugins resolve their properties in an earlier lifecycle phase.\n\nIf you don't need to write out such a property file and thus don't need to preserve the property names, you can use normal maven properties as well. E.g. `${host.var}:${port.var}:8080` instead of\n`+host.var:port.var:8080`.\n\n" }, { "path": "src/main/asciidoc/inc/start/_restart.adoc", "content": "\nSpecify the behavior to apply when the container exits. These values can be specified withing a `` section with the following sub-elements:\n\n.Restart Policy configuration\n[cols=\"1,5\"]\n|===\n| Element | Description\n\n| *name*\na| Restart policy name, choose from:\n\n* `always` (_v1.15_) always restart\n* `on-failure` (_v1.15_) restart on container non-exit code of zero\n\n| *retry*\n| If `on-failure` is used, controls max number of attempts to restart before giving up.\n|===\n\nThe behavior to apply when the container exits. The value is an object with a name property of either \"always\" to always restart or \"on-failure\" to restart only when the container exit code is non-zero. If on-failure is used, MaximumRetryCount controls the number of times to retry before giving up. The default is not to restart. (optional)\n\n" }, { "path": "src/main/asciidoc/inc/start/_volumes.adoc", "content": "\nA container can bind (or \"mount\") volumes from various source when starting up: Either from a directory of the host system or from another container which exports one or more directories. The mount configuration is specified within a `` section of the run configuration. It can contain the following sub elements:\n\n.Volume configuration\n[cols=\"1,5\"]\n|===\n| Element | Description\n\n| *from*\n| List of `` elements which specify image names or aliases of containers whose volumes should be imported.\n\n| *bind*\n| List of `` specifications (or _host mounts_). Use `/path` to create and expose a new volume in the container, `/host_path:/container_path` to mount a host path into the container and `/host_path:/container_path:ro` to bind it read-only.\n|===\n\n.Volumes example\n[source,xml]\n----\n\n \n /logs\n /opt/host_export:/opt/container_import\n \n \n jolokia/docker-demo\n \n\n----\n\nIn this example the container creates a new volume named `/logs` on the container and mounts `/opt/host_export` from the host as `/opt/container_import` on the container. In addition all exported volumes from the container which has been created from the image `jolokia/docker-demo` are mounted directly into the container (with the same directory names under which the exporting container exposes these directories). This image must be also configured for this plugin. Instead of the full image name, an alias name can be used, too.\n\nIf a volume name instead of a path is referenced to in `` and a <> exists with this name, then this this volume is created upfront with the provided options instead of using default options.\n\nYou can use Maven variables in the path specifications. This should even work for boot2docker and docker-machine:\n\n.Example with absolute paths\n[source,xml]\n----\n\n \n ${project.build.directory}/${project.artifactId}-${project.version}:/usr/local/tomcat/webapps/${project.name}\n ${project.basedir}/data:/data\n \n\n----\n\nYou can also use relative paths. Relative paths are interpreted relative to the Maven project base directory. Paths\nthat begin with `~` are interpreted relative to the JVM's `user.home` directory.\n\n.Example with relative paths\n[source,xml]\n----\n\n \n src/main/webapps/foo:/usr/local/tomcat/webapps/foo\n ./target:/data\n ~:/home/user\n ~/.m2/repository:/home/user/.m2/repository\n \n\n----\n\nIf you wish to mount volumes from an existing container not managed by the plugin, you may do by specifying the container name obtained via `docker ps` in the configuration.\n" }, { "path": "src/main/asciidoc/inc/start/_wait.adoc", "content": "\nWhile starting a container is it possible to block the execution until\nsome condition is met. These conditions can be specified within a\n`` section which the following sub-elements:\n\n.Wait configuration\n[cols=\"1,5\"]\n|===\n| Element | Description\n\n| *http*\na| HTTP ping check which periodically polls an URL. It knows the following sub-elements:\n\n* *url* holds an URL and is mandatory\n* *method* Optional HTTP method to use.\n* *status* Status code which if returned is considered to be a successful ping. This code can be given either as a single number (200) or as a range (200..399). The default is `200..399`\n* *allowAllHosts* If `url` is an HTTPS url and this option is set, then server certificates are not validated. By default they are checked for a proper CA signature.\n\n| *log*\n| Regular expression which is applied against the log\noutput of an container and blocks until the pattern is matched. You can use `(?s)` in the pattern to switch on multi line matching.\n\n| *time*\n| Time in milliseconds to block.\n\n| *kill*\n| Time in milliseconds between sending `SIGTERM` and `SIGKILL` when stopping a container. Since docker itself uses second granularity, you should use at least 1000 milliseconds.\n\n| *shutdown*\n| Time to wait in milliseconds between stopping a container and removing it. This might be helpful in situation where a Docker croaks with an error when trying to remove a container to fast after it has been stopped.\n\n| *exec*\na| Commands to execute during specified lifecycle of the container. It knows the following sub-elements:\n\n* *postStart* Command to run after the above wait criteria has been met\n* *preStop* Command to run before the container is stopped.\n* *breakOnError* If set to `true` then break the build if a `postStart` or `preStop` command exits with an return code other than 0, otherwise only print an error message.\n\n| *tcp*\na| TCP port check which periodically polls given tcp ports. It knows the following sub-elements:\n\n* *mode* can be either `mapped` which uses the mapped ports or `direct` in which case the container ports are addressed directly. In the later case the host field should be left empty in order to select the container ip (which must be routed which is only the case when running on the Docker daemon's host directly). Default is `direct` when host is _localhost_, `mapped` otherwise. The direct mode might help when a so called _user-proxy_ is enabled on the Docker daemon which makes the mapped ports directly available even when the container is not ready yet.\n* *host* is the hostname or the IP address. It defaults to `${docker.host.address}` for a mapped mode and the container ip address for the direct mode.\n* *ports* is a list of TCP ports to check. These are supposed to be the container internal ports.\n\n| *healthy*\na| Check that waits until the container health state becomes `healthy`. A container is considered healthy when its <> succeeds.\n\nThis behaviour mimics the docker compose dependsOn `condition: service_healthy`.\n\n| *exit*\n| Check that waits until a container finishes with the given exit code.\n\n|===\n\nAs soon as one condition is met the build continues. If you add a `