使用docker-maven-plugin将Spring boot的集成docker

傷城~ 2023-02-28 15:21 3阅读 0赞

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

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

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

也可以在构建的命令行上添加上镜像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>foo@foo.bar</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-\_.\]

[https_github.com_spotify_docker-maven-plugin]: https://link.jianshu.com?t=https://github.com/spotify/docker-maven-plugin