广告

扫码关注官方微信

扫码下载APP
返回顶部
首页 > 资讯 > 后端开发 > Python >Maven插件docker-maven-plugin的使用
  • 781

0
分享到

Maven插件docker-maven-plugin的使用

2024-04-02 19:04:59 781人浏览 薄情痞子

Python 官方文档：入门教程 => 点击学习

摘要

目录1、Docker-Maven-plugin 介绍2、环境、软件准备3、Demo 示例3.1 配置 DOCKER_HOST3.2 示例构建镜像3.3 执行命令3.4 绑定Docke

1、docker-maven-plugin 介绍

在我们持续集成过程中，项目工程一般使用 Maven 编译打包，然后生成镜像，通过镜像上线，能够大大提供上线效率，同时能够快速动态扩容，快速回滚，着实很方便。docker-maven-plugin 插件就是为了帮助我们在Maven工程中，通过简单的配置，自动生成镜像并推送到仓库中。

2、环境、软件准备

本次演示环境，我是在本机 Mac OX 上操作，以下是安装的软件及版本：

  • Docker：version 17.03.1-ce
  • Maven：version 3.3.9
  • Java： version 1.8.0_91
  • docker-maven-plugin：1.0.0

注意：这里我们要测试 Java Maven 项目用 docker-maven 插件打镜像，上传镜像等操作，所以需要先安装一下 Docker、Maven、Java，这里忽略安装过程。

3、Demo 示例

3.1 配置 DOCKER_HOST

docker-maven-plugin 插件默认连接本地 Docker 地址为：localhost:2375，所以我们需要先设置下环境变量。


DOCKER_HOST=tcp://<host>:2375

注意：如果没有设置 DOCKER_HOST 环境变量，可以命令行显示指定 DOCKER_HOST 来执行，如我本机指定 DOCKER_HOST：DOCKER_HOST=unix:///var/run/docker.sock mvn clean install docker:build。

3.2 示例构建镜像

构建镜像可以使用一下两种方式，第一种是将构建信息指定到 POM 中，第二种是使用已存在的 Dockerfile 构建。
第一种方式，支持将 FROM, ENTRYPOINT, CMD, MaiNTAINER 以及 ADD 信息配置在 POM 中，不需要使用 Dockerfile 配置。但是如果使用 VOLUME 或其他 Dockerfile 中的命令的时候，需要使用第二种方式，创建一个 Dockerfile，并在 POM 中配置 dockerDirectory 来指定路径即可。

这里我们以一个 Java Maven 项目 mavendemo 作为示例演示一下。

3.2.1 指定构建信息到 POM 中构建


<build>
    <plugins>
        <plugin>
            <groupId>com.spotify</groupId>
            <artifactId>docker-maven-plugin</artifactId>
            <version>1.0.0</version>
            <configuration>
                <imageName>mavendemo</imageName>
                <baseImage>java</baseImage>
                <maintainer>docker_maven docker_maven@email.com</maintainer>
                <workdir>/ROOT</workdir>
                <cmd>["java", "-version"]</cmd>
                <entryPoint>["java", "-jar", "${project.build.finalName}.jar"]</entryPoint>
                <!-- 这里是复制 jar 包到 docker 容器指定目录配置 -->
                <resources>
                    <resource>
                        <targetPath>/ROOT</targetPath>
                        <directory>${project.build.directory}</directory>
                        <include>${project.build.finalName}.jar</include>
                    </resource>
                </resources>
            </configuration>
        </plugin>
    </plugins>
</build>

3.2.2 使用 Dockerfile 构建

pom.xml配置


<build>
    <plugins>
         <plugin>
            <groupId>com.spotify</groupId>
            <artifactId>docker-maven-plugin</artifactId>
            <version>1.0.0</version>
            <configuration>
                <imageName>mavendemo</imageName>
                <dockerDirectory>${basedir}/docker</dockerDirectory> <!-- 指定 Dockerfile 路径-->
                <!-- 这里是复制 jar 包到 docker 容器指定目录配置，也可以写到 Docokerfile 中 -->
                <resources>
                    <resource>
                        <targetPath>/ROOT</targetPath>
                        <directory>${project.build.directory}</directory>
                        <include>${project.build.finalName}.jar</include>
                    </resource>
                </resources>
            </configuration>
        </plugin>   
    </plugins>
</build>

${basedir}/docker/Dockerfile 配置


FROM java
MAINTAINER docker_maven docker_maven@email.com
WORKDIR /ROOT
CMD ["java", "-version"]
ENTRYPOINT ["java", "-jar", "${project.build.finalName}.jar"]

以上两种方式执行docker:build效果是一样的，执行输出过程大致如下：


[INFO] --- docker-maven-plugin:1.0.0:build (default-cli) @ mavenDemo ---
[INFO] Building image mavendemo
Step 1/5 : FROM java
 ---> d23bdf5b1b1b
Step 2/5 : MAINTAINER docker_maven docker_maven@email.com
 ---> Using cache
 ---> 2faf180d4a50
Step 3/5 : WORKDIR /ROOT
 ---> Using cache
 ---> 862210f7956a
Step 4/5 : ENTRYPOINT java -jar mavenDemo.jar
 ---> Running in 96bbe83De6ec
 ---> c29009c88993
Removing intermediate container 96bbe83de6ec
Step 5/5 : CMD java -version
 ---> Running in f69b8d2a75b1
 ---> bc8d54014325
Removing intermediate container f69b8d2a75b1
Successfully built bc8d54014325

执行完成后，使用docker images查看生成的镜像：


REPOSITORY       TAG           IMAGE ID            CREATED             SIZE
mavendemo        latest        333b429536b2        38 minutes aGo      643 MB

3.3 执行命令

mvn clean package docker:build 只执行 build 操作

mvn clean package docker:build -DpushImage 执行 build 完成后 push 镜像

mvn clean package docker:build -DpushImageTag 执行 build 并 push 指定 tag 的镜像

注意：这里必须指定至少一个 imageTag，它可以配置到 POM 中，也可以在命令行指定。命令行指定如下：mvn clean package docker:build -DpushImageTags -DdockerImageTags=imageTag_1 -DdockerImageTags=imageTag_2，POM 文件中指定配置如下：


<build>
  <plugins>
    ...
    <plugin>
      <configuration>
        ...
        <imageTags>
           <imageTag>imageTag_1</imageTag>
           <imageTag>imageTag_2</imageTag>
        </imageTags>
      </configuration>
    </plugin>
    ...
  </plugins>
</build>

3.4 绑定Docker 命令到 Maven 各个阶段

我们可以绑定 Docker 命令到 Maven 各个阶段，我们可以把 Docker 分为 build、tag、push，然后分别绑定 Maven 的 package、deploy 阶段，此时，我们只需要执行mvn deploy就可以完成整个 build、tag、push操作了，当我们执行mvn build就只完成 build、tag 操作。除此此外，当我们想跳过某些步骤或者只执行某个步骤时，不需要修改 POM 文件，只需要指定跳过 docker 某个步骤即可。比如当我们工程已经配置好了自动化模板了，但是这次我们只需要打镜像到本地自测，不想执行 push 阶段，那么此时执行要指定参数-DskipDockerPush就可跳过 push 操作了。


<build>
    <plugins>
        <plugin>
            <groupId>com.spotify</groupId>
            <artifactId>docker-maven-plugin</artifactId>
            <version>1.0.0</version>
            <configuration>
                <imageName>mavendemo</imageName>
                <baseImage>java</baseImage>
                <maintainer>docker_maven docker_maven@email.com</maintainer>
                <workdir>/ROOT</workdir>
                <cmd>["java", "-version"]</cmd>
                <entryPoint>["java", "-jar", "${project.build.finalName}.jar"]</entryPoint>
                <resources>
                    <resource>
                        <targetPath>/ROOT</targetPath>
                        <directory>${project.build.directory}</directory>
                        <include>${project.build.finalName}.jar</include>
                    </resource>
                </resources>
            </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>mavendemo:latest</image>
                        <newName>docker.io/wanyang3/mavendemo:${project.version}</newName>
                    </configuration>
                </execution>
                <execution>
                    <id>push-image</id>
                    <phase>deploy</phase>
                    <goals>
                        <goal>push</goal>
                    </goals>
                    <configuration>
                        <imageName>docker.io/wanyang3/mavendemo:${project.version}</imageName>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

以上示例，当我们执行mvn package时，执行 build、tag 操作，当执行mvn deploy时，执行build、tag、push 操作。如果我们想跳过 docker 某个过程时，只需要：

  • -DskipDockerBuild 跳过 build 镜像
  • -DskipDockerTag 跳过 tag 镜像
  • -DskipDockerPush 跳过 push 镜像
  • -DskipDocker 跳过整个阶段

例如：我们想执行 package 时，跳过 tag 过程，那么就需要mvn package -DskipDockerTag。

3.5 使用私有 Docker 仓库地址

实际工作环境中，我们需要 push 镜像到我们私有 Docker 仓库中，使用d ocker-maven-plugin 插件我们也是很容易实现，有几种方式实现：

一、修改 POM 文件 imageName 操作


...
<configuration>
    <imageName>reGIStry.example.com/wanyang3/mavendemo:v1.0.0</imageName>
    ...
</configuration>
...

二、修改 POM 文件中 newName 操作


...
<configuration>
    <imageName>mavendemo</imageName>
    ...
</configuration>
<execution>
    <id>tag-image</id>
    <phase>package</phase>
    <goals>
        <goal>tag</goal>
    </goals>
    <configuration>
        <image>mavendemo</image>
        <newName>registry.example.com/wanyang3/mavendemo:v1.0.0</newName>
    </configuration>
</execution>
...

3.6 安全认证配置

当我们 push 镜像到 Docker 仓库中时，不管是共有还是私有，经常会需要安全认证，登录完成之后才可以进行操作。当然，我们可以通过命令行 docker login -u user_name -p passWord docker_registry_host 登录，但是对于自动化流程来说，就不是很方便了。使用 docker-maven-plugin 插件我们可以很容易实现安全认证。

首先在 Maven 的配置文件 setting.xml 中增加相关 server 配置，主要配置 Docker registry用户认证信息。


<servers>
  <server>
    <id>my-docker-registry</id>
    <username>wanyang3</username>
    <password>12345678</password>
    <configuration>
      <email>wanyang3@mail.com</email>
    </configuration>
  </server>
</servers>

然后只需要在 pom.xml 中使用 server id 即可。


<plugin>
  <plugin>
    <groupId>com.spotify</groupId>
    <artifactId>docker-maven-plugin</artifactId>
    <version>1.0.0</version>
    <configuration>
      <imageName>registry.example.com/wanyang3/mavendemo:v1.0.0</imageName>
      ...
      <serverId>my-docker-registry</serverId>
    </configuration>
  </plugin>
</plugins>

3.7 其他参数

docker-maven-plugin 插件还提供了很多很实用的配置，稍微列举几个参数吧。

参数 说明 默认值
<forceTags>true</forceTags> build 时强制覆盖 tag，配合 imageTags 使用 false
<noCache>true</noCache> build 时，指定 –no-cache 不使用缓存 false
<pullOnBuild>true</pullOnBuild> build 时，指定 –pull=true 每次都重新拉取基础镜像 false
<pushImage>true</pushImage> build 完成后 push 镜像 false
<pushImageTag>true</pushImageTag> build 完成后，push 指定 tag 的镜像，配合 imageTags 使用 false
<retryPushCount>5</retryPushCount> push 镜像失败，重试次数 5
<retryPushTimeout>10</retryPushTimeout> push 镜像失败，重试时间 10s
<rm>true</rm> build 时，指定 –rm=true 即 build 完成后删除中间容器 false
<usegitCommitId>true</useGitCommitId> build 时，使用最近的 git commit id 前7位作为tag，例如：image:b50b604，前提是不配置 newName false

4、FAQ

1、执行 build images 时，报错情况一：

[INFO] Building image mavendemo
org.apache.Http.impl.execchain.RetryExec execute
I/O exception (java.io.IOException) caught when processing request to {}->unix://localhost:80: No such file or directory
[ERROR] Failed to execute goal com.spotify:docker-maven-plugin:1.0.0:build (default-cli) on project mavenDemo: Exception caught: java.util.concurrent.ExecutionException: com.spotify.docker.client.shaded.javax.ws.rs.ProcessingException: java.io.IOException: No such file or directory -> [Help 1]

这个是因为 Docker 服务没有启动造成的，启动 Docker 即可。

2、执行 build images 时，报错情况二：

ERROR] Failed to execute goal com.spotify:docker-maven-plugin:1.0.0:build (default-cli) on project mavenDemo: Exception caught: Request error: POST unix://localhost:80/build?t=mavenDemo: 500, body: {"message":"Error parsing reference: \"mavenDemo\" is not a valid repository/tag: repository name must be lowercase"}: HTTP 500 Internal Server Error -> [Help 1]

这个是因为镜像名字不正确，Docker 镜像名称需匹配[a-z0-9-_.]。

参考资料

docker-maven-plugin

到此这篇关于Maven插件docker-maven-plugin的使用的文章就介绍到这了,更多相关docker-maven-plugin 使用内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网！

您可能感兴趣的文档:
点击免费下载>>软考高级考试备考技巧/历年真题/备考精华资料

--结束END--

本文标题: Maven插件docker-maven-plugin的使用

本文链接: https://www.lsjlt.com/news/128707.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑，方便收藏和打印～

下载Word文档
去做题
猜你喜欢
  • Maven插件docker-maven-plugin的使用
    目录1、docker-maven-plugin 介绍2、环境、软件准备3、Demo 示例3.1 配置 DOCKER_HOST3.2 示例构建镜像3.3 执行命令3.4 绑定Docke...
    99+
    2022-11-12
  • maven-resources-plugin插件怎么使用
    这篇文章主要介绍了maven-resources-plugin插件怎么使用的相关知识，内容详细易懂，操作简单快捷，具有一定借鉴价值，相信大家阅读完这篇maven-resources-plugin插件怎么使用文章都会有所收获，下面我们一起来看...
    99+
    2023-06-26
  • ​maven-war-plugin插件怎么使用
    这篇文章主要讲解了“maven-war-plugin插件怎么使用”，文中的讲解内容简单清晰，易于学习与理解，下面请大家跟着小编的思路慢慢深入，一起来研究和学习“maven-war-plugin插件怎么使用”吧！maven-war-plugi...
    99+
    2023-06-26
  • ​maven-assembly-plugin插件怎么使用
    这篇“maven-assembly-plugin插件怎么使用”文章的知识点大部分人都不太理解，所以小编给大家总结了以下内容，内容详细，步骤清晰，具有一定的借鉴价值，希望大家阅读完这篇文章能有所收获，下面我们一起来看看这篇“maven-ass...
    99+
    2023-06-26
  • maven-jar-plugin插件怎么使用
    这篇“maven-jar-plugin插件怎么使用”文章的知识点大部分人都不太理解，所以小编给大家总结了以下内容，内容详细，步骤清晰，具有一定的借鉴价值，希望大家阅读完这篇文章能有所收获，下面我们一起来看看这篇“maven-jar-plug...
    99+
    2023-06-26
  • properties-maven-plugin插件怎么使用
    这篇“properties-maven-plugin插件怎么使用”文章的知识点大部分人都不太理解，所以小编给大家总结了以下内容，内容详细，步骤清晰，具有一定的借鉴价值，希望大家阅读完这篇文章能有所收获，下面我们一起来看看这篇“propert...
    99+
    2023-06-26
  • ​maven-shade-plugin插件怎么使用
    这篇文章主要介绍“maven-shade-plugin插件怎么使用”，在日常操作中，相信很多人在maven-shade-plugin插件怎么使用问题上存在疑惑，小编查阅了各式资料，整理出简单好用的操作方法，希望对大家解答”maven-sha...
    99+
    2023-06-26
  • ​versions-maven-plugin插件怎么使用
    这篇文章主要介绍了versions-maven-plugin插件怎么使用的相关知识，内容详细易懂，操作简单快捷，具有一定借鉴价值，相信大家阅读完这篇versions-maven-plugin插件怎么使用文章都会有所收获，下面我们一起来看看吧...
    99+
    2023-06-26
  • 详细docker-maven-plugin使用方法
    目录Docker-Maven-PluginMaven插件自动部署步骤1、修改宿主机的docker配置，开放2375端口，让其可以远程访问2、刷新配置，重启服务3、配置容器防火墙&nb...
    99+
    2022-11-12
  • 【SpringBoot】Maven 版本管理与 flatten-maven-plugin 插件的使用及分析
    1. flatten-maven-plugin 介绍 1.1 环境 IntelliJ IDEA 2021.3JDK 1.8.0_301Apache Maven 3.8.1org.codehaus.mo...
    99+
    2023-09-05
    spring boot maven java
  • docker-maven-plugin 插件无法拉取对应jar包问题
    使用 docker-maven-plugin 插件时，maven无法拉取对应 jar 包。出现下面问题： maven 版本： 镜像仓库配置： <mirror> ...
    99+
    2022-11-12
  • 找不到插件 ‘org.springframework.boot:spring-boot-maven-plugin:‘问题
    出现pom文件找不到插件 ‘org.springframework.boot:spring-boot-maven-plugin:‘问题， 可能是因为版本没有绑定好，去一级父类依赖找对应的插件版本，在pom文件中加上。 把父类的versio...
    99+
    2023-10-07
    spring maven java
  • 【项目实战】使用Maven插件（jacoco-maven-plugin），实现生成代码覆盖率报告
    一、jacoco-maven-plugin是啥？ jacoco-maven-plugin是一个Maven插件，用于生成代码覆盖率报告。 它可以帮助您了解您的代码中哪些部分已经被测试覆盖，哪些部分需要更多的测试。 注意，jacoco-mave...
    99+
    2023-08-19
    maven 代码覆盖率 java
  • 基于jib-maven-plugin插件快速构建微服务docker镜像的方法
    目录一、说明二、插件使用三、总结四、样例工程一、说明 本文介绍基于 Maven 插件 jib-maven-plugin 实现快速构建 ...
    99+
    2023-02-27
    jib-maven-plugin构建微服务docker镜像 jib-maven-plugin微服务docker镜像
  • 基于jib-maven-plugin插件如何快速构建微服务docker镜像
    这篇文章主要介绍“基于jib-maven-plugin插件如何快速构建微服务docker镜像”，在日常操作中，相信很多人在基于jib-maven-plugin插件如何快速构建微服务docker镜像问题上存在疑惑，小编查阅了各式资料，整理出简...
    99+
    2023-07-05
  • SpringBoot自定义maven-plugin插件整合asm代码插桩
    目录背景项目配置编译拦截 ASM插桩项目使用背景 公司开发框架增加了web系统license授权证书校验模块，实行一台机器一个授权证书，初步方案是增加拦截器针对全局请求进行...
    99+
    2022-11-13
  • maven实现docker自动化部署插件的使用
    构建开发项目 首先打开我们的IDEA构建一个我们的开发项目，配置如下： 接着打开我们的pom.xml修改build的配置，修改以后的代码如下： <build> ...
    99+
    2022-11-12
  • Springboot 整合maven插口调用maven release plugin实现一键打包功能
    maven release plugin配置 参考 https://www.jb51.net/article/240857.htm  配置好pom。 整合mave...
    99+
    2022-11-13
  • Dockerfile Maven 插件的使用方法
    本篇内容介绍了“Dockerfile Maven 插件的使用方法”的有关知识，在实际案例的操作过程中，不少人都会遇到这样的困境，接下来就让小编带领大家学习一下如何处理这些情况吧！希望大家仔细阅读，能够学有所成！Dockerfile Mave...
    99+
    2023-06-19
  • SpringBoot自定义maven-plugin插件整合asm代码插桩的方法
    这篇“SpringBoot自定义maven-plugin插件整合asm代码插桩的方法”文章的知识点大部分人都不太理解，所以小编给大家总结了以下内容，内容详细，步骤清晰，具有一定的借鉴价值，希望大家阅读完这篇文章能有所收获，下面我们一起来看看...
    99+
    2023-06-29
软考高级职称资格查询
软考职称历年真题下载
软考职称资料下载
热门wiki
近期文章
推荐阅读
热门问答
热门标签
编程网，编程工程师的家园，是目前国内优秀的开源技术社区之一，形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容，为IT开发者提供了一个发现、使用、并交流开源技术的平台。

  • 官方手机版

  • 微信公众号

  • 商务合作