docker与Spring boot的集成：docker-maven-plugin使用

使用Spring Boot编写了一个微服务后，如何将构建应用并打包成docker镜像，推送到docker仓库，以供测试环境测试。

docker-maven-plugin插件可以完成这项任务。

最近使用了docker-maven-plugin插件，想写一篇关于使用总结的文章，但发现它在github上的README.md写的很好了，决定对它翻译一下。
docker-maven-plugin的Github地址：https://github.com/spotify/docker-maven-plugin

该插件是基于maven插件，用来构建docker镜像，当然也可以通过在系统中配置Dockerfile的方式构建镜像。

目的

你可以使用该插件在你的maven项目中创建一个Docker镜像，比方说，build 过程可以为java服务输出一个可以运行该服务的Docker镜像。

步骤

dockerfile提供了两种配置方式，一种是通过Dockerfile文件，一种是直接在pom.xml配置。

你可以直接在pom.xml文件中指定base image,entry point, cmd, maintainer 和files,而不用通过Dockerfile的方式。

当然通过pom.xml文件的方式支持一些简单的命令，如果你需要VOLUMN命令（或者其他pom.xml不支持使用的命令），还是需要通过将命令写入Dockerfile，并通过在pom中配置dockerDirectory来引入该Dockerfile

默认情况下，该插件通过访问localhost:2375来连接本地docker，可以通过设置DOCKER_HOST 环境变量来连接docker.

DOCKER_HOST=tcp://<host>:2375

在POM中声明构建信息

下面的代码示例是创建了名为example的新镜像，将项目编译的jar包拷贝到镜像中，并设置了一个entrypoint去运行这个jar，在下面的代码中可以改变VERSION GOES HERE改变插件的版本，目前最新的版本是1.0.0

<build>
  <plugins>
    ...
    <plugin>
      <groupId>com.spotify</groupId>
      <artifactId>docker-maven-plugin</artifactId>
      <version>VERSION GOES HERE</version>
      <configuration>
        <imageName>example</imageName>
        <baseImage>java</baseImage>
        <entryPoint>["java", "-jar", "/${project.build.finalName}.jar"]</entryPoint>
        <!-- copy the service‘s jar file from target into the root directory of the image -->
        <resources>
           <resource>
             <targetPath>/</targetPath>
             <directory>${project.build.directory}</directory>
             <include>${project.build.finalName}.jar</include>
           </resource>
        </resources>
      </configuration>
    </plugin>
    ...
  </plugins>
</build>

参数解释：

  • imageName:镜像的名称，可以通过${project.groupId}/${project.artifactId}:${project.version} 动态制定镜像名称
    当然也可以在前面加上镜像地址，比如127.0.0.1:5000,以声明将构建好的镜像存储在本地
  • baseImage: 基础镜像，这里是相当于Dockerfile的FROM java
  • resources 下的配置：构建时会生成docker文件夹，这里指生成文件夹的内容来源，包含了mvn clean package 之后的target的文件和生成的jar包。

使用Dockerfile

为了使用Dockerfile,必须在pom的文件中通过dockerDirectory来指明Dockerfile文件的所在目录。如果配置了dockerDirectory,baseImage,maintainer,cmd和entryPoint配置将忽略。下面的配置会将dockerDirectory的内容拷贝值${project.build.directory}/docker,使用resouces元素可以拷贝其他的文件，比如生成jar包文件。

<build>
  <plugins>
    ...
    <plugin>
      <groupId>com.spotify</groupId>
      <artifactId>docker-maven-plugin</artifactId>
      <version>VERSION GOES HERE</version>
      <configuration>
        <imageName>example</imageName>
        <dockerDirectory>docker</dockerDirectory>
        <resources>
           <resource>
             <targetPath>/</targetPath>
             <directory>${project.build.directory}</directory>
             <include>${project.build.finalName}.jar</include>
           </resource>
        </resources>
      </configuration>
    </plugin>
    ...
  </plugins>
</build>

使用

按照上面的配置之后，可以使用如下命令生成一个镜像

mvn clean package docker:build

将生成的镜像推送到镜像注册中心，通过pushImage标签

mvn clean package docker:build -DpushImage

如果推送制定tags 的镜像，可使用pushImageTag标签

mvn clean package docker:build -DpushImageTag

为了是的上述的命令执行成功，需要在pom中配置imageTag,可以配置多个imageTag

<build>
  <plugins>
    ...
    <plugin>
      <configuration>
        ...
        <imageTags>
           <imageTag>${project.version}</imageTag>
           <imageTag>latest</imageTag>
        </imageTags>
      </configuration>
    </plugin>
    ...
  </plugins>
</build>

如果你想强制docker在每次新的构建上覆盖镜像tags，可配置foreceTags

<build>
  <plugins>
    ...
    <plugin>
      <configuration>
        ...
        <!-- optionally overwrite tags every time image is built with docker:build -->
        <forceTags>true</forceTags>
        <imageTags>
           ...
        </imageTags>
      </configuration>
    </plugin>
    ...
  </plugins>
</build>

也可以在构建的命令行上添加上镜像tags:

mvn ... docker:build -DpushImageTags -DdockerImageTags=latest -DdockerImageTags=another-tag

绑定docker命令到maven phases

你可以将bind,tag&push 目标绑定到maven phases,这样仅仅通过运行mvn deploy命令就能完成项目built,tagged,pushed。如果你有一个多模块项目，当通过绑定，在父项目运行maven命令的同时，子模块项目可以自动构建。镜像

<plugin>
  <groupId>com.spotify</groupId>
  <artifactId>docker-maven-plugin</artifactId>
  <version>VERSION GOES HERE</version>
  <executions>
    <execution>
      <id>build-image</id>
      <phase>package</phase>
      <goals>
        <goal>build</goal>
      </goals>
    </execution>
    <execution>
      <id>tag-image</id>
      <phase>package</phase>
      <goals>
        <goal>tag</goal>
      </goals>
      <configuration>
        <image>my-image:${project.version}</image>
        <newName>registry.example.com/my-image:${project.version}</newName>
      </configuration>
    </execution>
    <execution>
      <id>push-image</id>
      <phase>deploy</phase>
      <goals>
        <goal>push</goal>
      </goals>
      <configuration>
        <imageName>registry.example.com/my-image:${project.version}</imageName>
      </configuration>
    </execution>
  </executions>
</plugin>

可以通过一下命令跳过docker构建的阶段

  • DskipDockerBuild 跳过镜像构建
  • DskipDockerTag 跳过镜像tag设置
  • DskipDockerPush 跳过镜像推送
  • DskipDocker 跳过所有的镜像构建目标

删除一个名称为foobar的镜像，可以运行如下命令

mvn docker:removeImage -DimageName=foobar

获取完成的配置选项列表，可运行如下命令：

mvn com.spotify:docker-maven-plugin:<version>:help -Ddetail=true

使用私有镜像中心

为了将镜像推送到私有的镜像注册中心，docker需要在镜像tag之前用注册中心的地址作为前缀。比如需要推送my-image到registry.example.com，那么这个镜像需要命名为registry.example.com/my-image

最简单的方法就是在<imageName>中配置：

<plugin>
  <groupId>com.spotify</groupId>
  <artifactId>docker-maven-plugin</artifactId>
  <configuration>
    <imageName>registry.example.com/my-image</imageName>
    ...

这样，当你通过命令docker:build -DpushImage或者docker:push推送镜像时，docker引擎会将镜像推送到registry.example.com.

当然你可以在docker:build命令中通过 docker:tag -DpushImage对创建的镜像加上私有镜像注册中心的地址，如不配置，则会推送到默认的镜像中心，即Docker hub;你也可如下这样配置：

<plugin>
  <groupId>com.spotify</groupId>
  <artifactId>docker-maven-plugin</artifactId>
  <configuration>
    <imageName>my-image</imageName>
    ...
  </configuration>
  <executions>
    <execution>
      <id>build-image</id>
      <phase>package</phase>
      <goals>
        <goal>build</goal>
      </goals>
    </execution>
    <execution>
      <id>tag-image</id>
      <phase>package</phase>
      <goals>
        <goal>tag</goal>
      </goals>
      <configuration>
        <image>my-image</image>
        <newName>registry.example.com/my-image</newName>
      </configuration>
    </execution>
  </executions>
</plugin>

认证

支持三种认证方式：
读取本地配置文件，自动认证
从1.0.0版本之后，docker-maven-plugin插件会自动读取到docker-cli的认证配置，默认在~/.dockercfg 和~/.docker/config.json，而无需额外的配置

GCR认证
如果本机配置DOCKER_GOOGLE_CREDENTIALS的环境变量，则会使用GCR认证。

Server认证
也可以在maven的settings.xml配置认证信息：

<servers>
  <server>
    <id>docker-hub</id>
    <username>foo</username>
    <password>secret-password</password>
    <configuration>
      <email>[email protected]</email>
    </configuration>
  </server>
</servers>

在pom.xml则通过如下配置关联上述server id

<plugin>
  <plugin>
    <groupId>com.spotify</groupId>
    <artifactId>docker-maven-plugin</artifactId>
    <version>VERSION GOES HERE</version>
    <configuration>
      [...]
      <serverId>docker-hub</serverId>
      <registryUrl>https://index.docker.io/v1/</registryUrl>
    </configuration>
  </plugin>
</plugins>

以上三种配置方式中，通过读取客户端默认配置的优先级更高。

在server配置中加密密码
为了不在配置文件中不暴露明文密码，可以使用maven加密功能对密码进行加密，通过{ }方式都认为是被加密的密码

<servers>
  <server>
    <id>docker-hub</id>
    <username>foo</username>
    <password>{gc4QPLrlgPwHZjAhPw8JPuGzaPitzuyjeBojwCz88j4=}</password>
  </server>
</servers>

注意

构建的镜像名称不要含有SNAPSHOT，因为镜像名称只允许 [a-z0-9-_.]

作者：billJiang
链接：https://www.jianshu.com/p/3b91b8958c3e

原文地址：https://www.cnblogs.com/panchanggui/p/12161982.html

时间： 2024-10-08 18:54:09

docker与Spring boot的集成：docker-maven-plugin使用的相关文章

微服务架构实践 - 你只懂docker与spring boot就够了吗？

微服务架构实践 - 你只懂docker与spring boot就够了吗? 作者 浮云发发 已关注 2017.02.27 02:50* 字数 2613 阅读 2583评论 6喜欢 35赞赏 2 微服务并不是单独存在的,为了更好地实现微服务架构,需要整合许多组件混搭使用,方能打通任督二脉,天下无敌.网上很多大拿讲了微服务治理的内容,也有人单方面讲微服务的,比如spring boot与docker,本文着重于组件选型的较量,也积累了我们团队多次PK的精华:这些组件包括spring boot.sprin

Spring Boot 2.0(六)：使用 Docker 部署 Spring Boot 开源软件云收

只需三步即可部署开源项目云收藏,打造专属个人的收藏系统,就是这么简单! 云收藏项目已经开源2年多了,作为当初刚开始学习 Spring Boot 的练手项目,使用了很多当时很新的技术,现在看来其实很多新技术是没有必要使用的,但做为学习案例来讲确实是一个绝佳的 Spring Boot 实践. 从开源到现在,写了一些教程给大家介绍如何部署云收藏,如何在IDE中运行云收藏,但是仍然有很多的朋友不知道如何使用,如何部署?就像"请提供一份云收藏数据结构" 这样的问题我至少都回答了一百多次,并且在

【docker】docker部署spring boot服务，但是docker logs查看容器输出控制台日志，没有日志打印，日志未打印，docker logs不打印容器日志

如题: docker部署spring boot服务,但是docker logs查看容器输出控制台日志,没有日志打印,日志未打印,docker logs不打印容器日志 场景再现: docker部署并启动了  springboot服务,容器启动正常,docker exec 也可以正常进入容器内部,但是docker logs 控制台并没有日志打印出来. 同样的,/var/lib/docker/containers目录下的对应容器目录中,也没有对应的 *-json.log日志文件生成. 原因: dock

spring boot admin 集成的简单配置随笔

和我并肩作战的同事也要相继离职了,心里还是有很多不舍得,现在业务也陆陆续续落在了肩头,上午项目经理让我把spring boot admin集成到现在的项目中,已遍后续的监控. 哇!我哪里搞过这个!心里好慌,好在我面向对象虽然不是很精通,但是面向百度我倒是很拿手,于是开启了,面向百度编程,现在已经成功过了~写个博客继续一下,方便以后使用以及分享. 注:此写法适用于 2.0以下版本 高于2.0请直接官方文档走起:http://codecentric.github.io/spring-boot-adm

Spring Boot Admin 集成自定义监控告警

Spring Boot Admin 集成自定义监控告警 前言 Spring Boot Admin 是一个社区项目,可以用来监控和管理 Spring Boot 应用并且提供 UI,详细可以参考 官方文档. Spring Boot Admin 本身提供监控告警功能,但是默认只提供了 Hipchat.Slack 等国外流行的通讯软件的集成,虽然也有邮件通知,不过考虑到使用体检决定二次开发增加 钉钉 通知. 本文基于 Spring Boot Admin 目前最新版 1.5.7. 准备工作 Spring

spring boot 2 集成JWT实现api接口认证

JSON Web Token(JWT)是目前流行的跨域身份验证解决方案.官网:https://jwt.io/本文spring boot 2 集成JWT实现api接口验证. 一.JWT的数据结构 JWT由header(头信息).payload(有效载荷)和signature(签名)三部分组成的,用“.”连接起来的字符串.JWT的计算逻辑如下:(1)signature = HMACSHA256(base64UrlEncode(header) + "." + base64UrlEncode(

Spring Boot 2.0(五)：Docker Compose + Spring Boot + Nginx + Mysql 实践

我知道大家这段时间看了我写关于 docker 相关的几篇文章,不疼不痒的,仍然没有感受 docker 的便利,是的,我也是这样认为的,I know your felling . 前期了解概念什么的确实比较无聊,请不要着急精彩马上开始,当大家对 docker 相关概念有所了解之后,后面我会结合 Spring Boot 给大家来一系列的小例子,会让大家感受到使用 Docker 就是这么爽! 今天给大家演出的导演是 Docker 家族的 docker-compare ,主演是 Spring Boot.

docker部署spring boot项目在服务器上

IDE:idea 工具:docker spring boot:2.0.1 ======================================== 简单记录一下流程,以供参考: 第一步:首先得有一个spring boot的项目[集成了jpa+mybatis的spring boot 例子:https://github.com/AngelSXD/swapping] 第二步:项目打包为jar包 install成功以后 找到项目根目录下的target目录,这里面的jar就是打包好可以部署的jar

实用干货 使用Docker进行Spring Boot开发

通过优锐课的java学习分享,让我们研究一下如何将容器带入Spring Boot项目. 在这里,我们使用Docker来包含Java REST后端,而无需担心操作系统. AtSea Shop是示例店面应用程序,可以部署在不同的操作系统上,并且可以针对企业开发和运营环境进行自定义. 在较早的帖子中,我讨论了该应用程序的体系结构. 在本文中,我将介绍如何设置开发环境以调试在容器中运行的Java REST后端. 构建REST应用我使用Spring Boot框架快速开发了REST后端,该后端管理AtSea