Maven一键部署Springboot到Docker仓库,为自动化做准备

1 前言

前面《 Springboot整合MongoDBDocker开发,其它应用也类似 》讲解了如何做 Docker 开发、如何把 Springboot 应用打包成一个镜像,但它是手动的,本文将讲解如何通过 maven 一键打包部署

2 两个maven插件搞定

可以使用 maven 插件实现一键部署,这两个插件还是同一个公司的产品,就是著名的音乐流服务平台 Spotify

Maven一键部署Springboot到Docker仓库,为自动化做准备

2.1 spotify/docker-maven-plugin

2.1.1 基础用法

该插件可以实现镜像打包和 push 到仓库,无 Dockerfile 和有 Dockerfile 两种方式都可以,建议使用 Dockerfile ,更灵活。在 mavenpom.xml 文件加入以下插件配置

<plugin>
  <groupId>com.spotify</groupId>
  <artifactId>docker-maven-plugin</artifactId>
  <version>1.2.2</version>
  <configuration>
    <imageName>pkslow/springboot-mongo</imageName>
    <imageTags>
      <imageTag>${imageVersion}</imageTag>
      <imageTag>latest</imageTag>
    </imageTags>
    <!-- optionally overwrite tags every time image is built with docker:build -->
    <forceTags>true</forceTags>
    <dockerDirectory>${project.basedir}</dockerDirectory>
    <resources>
      <resource>
        <targetPath>/</targetPath>
        <directory>${project.build.directory}</directory>
        <include>${project.build.finalName}.jar</include>
      </resource>
    </resources>
  </configuration>
</plugin>
  • imageName :这是镜像名称;

  • imageTags :标签,支持多标签,即同一个镜像文件多个标签;我指定了一个参数 imageVersion ,可以命令行传入,方便后续整合 Jenkins

  • forceTags :是否覆盖原有标签;

  • dockerDirectory :Dockerfile文件所在的位置;而且该目录下的所有文件都会被复制到 ${project.build.directory}/docker 。因为我的 Dockerfile 放在项目根目录,所以整个项目的文件都复制过去了,包括源代码等。不得不吐槽一下这个设计,这是在强迫大家换个位置放 Dockerfile 吗?

  • resources :用来添加 dockerDirectory 外的其它资源文件。

添加后,通过以下命令执行:

$ mvn clean package docker:build -DimageVersion=0.0.4

通过命令 docker images 查看成功,运行也正常。

通过下面命令可以push到 registry

mvn clean package docker:build -DpushImage

mvn clean package docker:build -DpushImageTag

2.1.2 与maven生命周期绑定

可以通过添加 executions 配置实现与 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>

有了这些绑定配置后,要打包镜像,直接 mvn clean package 即可。

2.1.3 仓库登陆信息配置

首先,插件可以使用配置在本地 ~/.dockercfg~/.docker/config.json 的验证信息,或者可以显式地配置在 maven 上。

如配置在 settings.xml 文件:

<servers>
  <server>
    <id>docker-hub</id>
    <username>foo</username>
    <password>secret-password</password>
    <configuration>
      <email>foo@foo.bar</email>
    </configuration>
  </server>
</servers>

密码是可以加密的,详情请查看: Maven’s built in encryption function 。

在项目的 pom.xml 中使用:

<plugins>
  <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>

2.2 spotify/dockerfile-maven

2.2.1 更简洁的插件

因为 docker-maven-plugin 有一些Bugs,所以 Spotify 开发了更方便简洁的插件 dockerfile-maven

Maven一键部署Springboot到Docker仓库,为自动化做准备

dockerfile-maven-plugin 的配置更简单:

<plugin>
  <groupId>com.spotify</groupId>
  <artifactId>dockerfile-maven-plugin</artifactId>
  <version>${dockerfile-maven-version}</version>
  <executions>
    <execution>
      <id>default</id>
      <goals>
        <goal>build</goal>
        <goal>push</goal>
      </goals>
    </execution>
  </executions>
  <configuration>
    <repository>spotify/foobar</repository>
    <tag>${project.version}</tag>
    <buildArgs>
      <JAR_FILE>${project.build.finalName}.jar</JAR_FILE>
    </buildArgs>
  </configuration>
</plugin>

配置好后,执行以下 maven 命令即可打包成镜像并推送到仓库:

mvn deploy

2.2.2 仓库验证

账号可以配置在 pom.xml 中,如下:

<plugin>
    <groupId>com.spotify</groupId>
    <artifactId>dockerfile-maven-plugin</artifactId>
    <version>${version}</version>
    <configuration>
        <username>repoUserName</username>
        <password>repoPassword</password>
        <repository>${docker.image.prefix}/${project.artifactId}</repository>
        <buildArgs>
            <JAR_FILE>target/${project.build.finalName}.jar</JAR_FILE>
        </buildArgs>
    </configuration>
</plugin>

当然,也可以配置在 maven 的配置文件 settings.xml 中,这样更安全,请参考: https://github.com/spotify/dockerfile-maven/blob/master/docs/authentication.md

3 总结

通过 maven 插件,可以快速方便地一键打包、部署,非常方便,对后续的整个 DevOps 整合也是很有益的。

参考资料:

docker-maven-plugin: https://github.com/spotify/docker-maven-plugin

dockerfile-maven: https://github.com/spotify/dockerfile-maven

欢迎访问 南瓜慢说 www.pkslow.com 获取更多精彩文章

欢迎关注微信公众号< 南瓜慢说 >,将持续为你更新…

Maven一键部署Springboot到Docker仓库,为自动化做准备

多读书,多分享;多写作,多整理。

原文 

https://www.pkslow.com/archives/docker-maven-plugin

本站部分文章源于互联网,本着传播知识、有益学习和研究的目的进行的转载,为网友免费提供。如有著作权人或出版方提出异议,本站将立即删除。如果您对文章转载有任何疑问请告之我们,以便我们及时纠正。

PS:推荐一个微信公众号: askHarries 或者qq群:474807195,里面会分享一些资深架构师录制的视频录像:有Spring,MyBatis,Netty源码分析,高并发、高性能、分布式、微服务架构的原理,JVM性能优化这些成为架构师必备的知识体系。还能领取免费的学习资源,目前受益良多

转载请注明原文出处:Harries Blog™ » Maven一键部署Springboot到Docker仓库,为自动化做准备

赞 (0)
分享到:更多 ()

评论 0

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址