Maven构建Docker镜像 浅谈使用Maven插件构建Docker镜像的方法
蛋子哥 人气:0本文介绍了使用Maven插件构建Docker镜像的方法,分享给大家,具体如下:
工具
工欲善其事,必先利其器。笔者经过调研,有以下几款Docker的Maven插件进入笔者视野:
插件名称 | 官方地址 |
---|---|
docker-maven-plugin | https://github.com/spotify/docker-maven-plugin |
docker-maven-plugin | https://github.com/fabric8io/docker-maven-plugin |
docker-maven-plugin | https://github.com/bibryam/docker-maven-plugin |
笔者从Stars、文档易用性以及更新频率三个纬度考虑,选用了第一款。
使用插件构建Docker镜像
简单使用
我们以之前的项目:microservice-discovery-eureka为例:
在pom.xml中添加下面这段
<build> <plugins> <!-- docker的maven插件,官网:https://github.com/spotify/docker-maven-plugin --> <plugin> <groupId>com.spotify</groupId> <artifactId>docker-maven-plugin</artifactId> <version>0.4.12</version> <configuration> <!-- 注意imageName一定要是符合正则[a-z0-9-_.]的,否则构建不会成功 --> <!-- 详见:https://github.com/spotify/docker-maven-plugin Invalid repository name ... only [a-z0-9-_.] are allowed--> <imageName>microservice-discovery-eureka</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>
执行命令:
mvn clean package docker:build
我们会发现控制台有类似如下内容:
[INFO] Building image microservice-discovery-eureka Step 1 : FROM java Pulling from library/java Digest: sha256:581a4afcbbedd8fdf194d597cb5106c1f91463024fb3a49a2d9f025165eb675f Status: Downloaded newer image for java:latest ---> ea40c858f006 Step 2 : ADD /microservice-discovery-eureka-0.0.1-SNAPSHOT.jar // ---> d1c174083bca Removing intermediate container 91913d847c20 Step 3 : ENTRYPOINT java -jar /microservice-discovery-eureka-0.0.1-SNAPSHOT.jar ---> Running in 0f2aeccdfd46 ---> d57b027ca65a Removing intermediate container 0f2aeccdfd46 Successfully built d57b027ca65a [INFO] Built microservice-discovery-eureka [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ [INFO] Total time: 01:38 min [INFO] Finished at: 2016-09-18T01:05:05-07:00 [INFO] Final Memory: 40M/198M
恭喜,构建成功了。
我们执行docker images 会发现该镜像已经被构建成功:
REPOSITORY TAG IMAGE ID CREATED SIZE microservice-discovery-eureka latest d57b027ca65a About a minute ago 681.5 MB
启动镜像
docker run -p 8761:8761 microservice-discovery-eureka
我们会发现该Docker镜像会很快地启动。
访问测试
访问http://Docker宿主机IP:8761 ,能够正常看到Eureka界面。
使用Dockerfile进行构建
上文讲述的方式是最简单的方式,很多时候,我们还是要借助Dockerfile进行构建的,首先我们在/microservice-discovery-eureka/src/main/docker目录下,建立文件Dockerfile
FROM java:8 VOLUME /tmp ADD microservice-discovery-eureka-0.0.1-SNAPSHOT.jar app.jar RUN bash -c 'touch /app.jar' EXPOSE 9000 ENTRYPOINT ["java","-Djava.security.egd=file:/dev/./urandom","-jar","/app.jar"]
修改pom.xml
<build> <plugins> <!-- docker的maven插件,官网:https://github.com/spotify/docker-maven-plugin --> <plugin> <groupId>com.spotify</groupId> <artifactId>docker-maven-plugin</artifactId> <version>0.4.12</version> <configuration> <!-- 注意imageName一定要是符合正则[a-z0-9-_.]的,否则构建不会成功 --> <!-- 详见:https://github.com/spotify/docker-maven-plugin Invalid repository name ... only [a-z0-9-_.] are allowed--> <imageName>microservice-discovery-eureka-dockerfile</imageName> <!-- 指定Dockerfile所在的路径 --> <dockerDirectory>${project.basedir}/src/main/docker</dockerDirectory> <resources> <resource> <targetPath>/</targetPath> <directory>${project.build.directory}</directory> <include>${project.build.finalName}.jar</include> </resource> </resources> </configuration> </plugin> </plugins> </build>
其他步骤一样。这样即可使用Dockerfile进行构建Docker镜像啦。
将Docker镜像push到DockerHub上
首先修改Maven的全局配置文件settings.xml,添加以下段落
<servers> <server> <id>docker-hub</id> <username>你的DockerHub用户名</username> <password>你的DockerHub密码</password> <configuration> <email>你的DockerHub邮箱</email> </configuration> </server> </servers>
在DockerHub上创建repo
项目pom.xml修改为如下:注意imageName的路径要和repo的路径一致
<build> <plugins> <!-- docker的maven插件,官网:https://github.com/spotify/docker-maven-plugin --> <plugin> <groupId>com.spotify</groupId> <artifactId>docker-maven-plugin</artifactId> <version>0.4.12</version> <configuration> <!-- 注意imageName一定要是符合正则[a-z0-9-_.]的,否则构建不会成功 --> <!-- 详见:https://github.com/spotify/docker-maven-plugin Invalid repository name ... only [a-z0-9-_.] are allowed --> <!-- 如果要将docker镜像push到DockerHub上去的话,这边的路径要和repo路径一致 --> <imageName>eacdy/test</imageName> <!-- 指定Dockerfile所在的路径 --> <dockerDirectory>${project.basedir}/src/main/docker</dockerDirectory> <resources> <resource> <targetPath>/</targetPath> <directory>${project.build.directory}</directory> <include>${project.build.finalName}.jar</include> </resource> </resources> <!-- 以下两行是为了docker push到DockerHub使用的。 --> <serverId>docker-hub</serverId> <registryUrl>https://index.docker.io/v1/</registryUrl> </configuration> </plugin> </plugins> </build>
执行命令:
mvn clean package docker:build -DpushImage
搞定,等构建成功后,我们会发现Docker镜像已经被push到DockerHub上了。
将镜像push到私有仓库
在很多场景下,我们需要将镜像push到私有仓库中去,这边为了讲解的全面性,私有仓库采用的是配置登录认证的私有仓库。
和push镜像到DockerHub中一样,我们首先需要修改Maven的全局配置文件settings.xml,添加以下段落
<servers> <server> <id>docker-registry</id> <username>你的DockerHub用户名</username> <password>你的DockerHub密码</password> <configuration> <email>你的DockerHub邮箱</email> </configuration> </server> </servers>
将项目的pom.xml改成如下,
<plugin> <groupId>com.spotify</groupId> <artifactId>docker-maven-plugin</artifactId> <version>0.4.12</version> <configuration> <!-- 路径为:私有仓库地址/你想要的镜像路径 --> <imageName>reg.itmuch.com/test-pull-registry</imageName> <dockerDirectory>${project.basedir}/src/main/docker</dockerDirectory> <resources> <resource> <targetPath>/</targetPath> <directory>${project.build.directory}</directory> <include>${project.build.finalName}.jar</include> </resource> </resources> <!-- 与maven配置文件settings.xml一致 --> <serverId>docker-registry</serverId> </configuration> </plugin>
执行:
mvn clean package docker:build -DpushImage
稍等片刻,将会push成功。
如果想要从私服上下载该镜像,执行:
docker login reg.itmuch.com # 然后输入账号和密码 docker pull reg.itmuch.com/test-pull-registry
将插件绑定在某个phase执行
在很多场景下,我们有这样的需求,例如执行mvn clean package 时,自动地为我们构建docker镜像,可以吗?答案是肯定的。我们只需要将插件的goal 绑定在某个phase即可。
所谓的phase和goal,可以这样理解:maven命令格式是:mvn phase:goal ,例如mvn package docker:build 那么,package 和 docker 都是phase,build 则是goal 。
下面是示例:
首先配置属性:
<properties> <docker.image.prefix>reg.itmuch.com</docker.image.prefix> </properties>
插件配置:
<build> <plugins> <plugin> <groupId>com.spotify</groupId> <artifactId>docker-maven-plugin</artifactId> <executions> <execution> <id>build-image</id> <phase>package</phase> <goals> <goal>build</goal> </goals> </execution> </executions> <configuration> <imageName>${docker.image.prefix}/${project.artifactId}</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>
如上,我们只需要添加:
<executions> <execution> <id>build-image</id> <phase>package</phase> <goals> <goal>build</goal> </goals> </execution> </executions>
即可。本例指的是讲docker的build目标,绑定在package这个phase上。也就是说,用户只需要执行mvn package ,就自动执行了mvn docker:build 。
常见异常
连接不上2375(一般在Win7上出现)
Connect to localhost:2375 [localhost/127.0.0.1, localhost/0:0:0:0:0:0:0:1] failed: Connection refused: connect -> [Help 1]
解决步骤:
输入docker-machine env
$Env:DOCKER_TLS_VERIFY = "1" $Env:DOCKER_HOST = "tcp://192.168.99.100:2376" $Env:DOCKER_CERT_PATH = "C:\Users\Administrator\.docker\machine\machines\default
为插件添加配置
<!-- 解决Connect to localhost:2375的问题的其中一种方式,注意要跟docker-machine env相一致 --> <dockerHost>https://192.168.99.100:2376</dockerHost> <dockerCertPath>C:\Users\Administrator\.docker\machine\machines\default</dockerCertPath>
修改后插件配置变为:
<plugin> <groupId>com.spotify</groupId> <artifactId>docker-maven-plugin</artifactId> <version>0.4.12</version> <configuration> <imageName>eacdy/test</imageName> <dockerDirectory>${project.basedir}/src/main/docker</dockerDirectory> <!-- 解决Connect to localhost:2375的问题的其中一种方式,注意要跟docker-machine env相一致 --> <dockerHost>https://192.168.99.100:2376</dockerHost> <dockerCertPath>C:\Users\Administrator\.docker\machine\machines\default</dockerCertPath> <resources> <resource> <targetPath>/</targetPath> <directory>${project.build.directory}</directory> <include>${project.build.finalName}.jar</include> </resource> </resources> <!-- 以下两行是为了docker push到DockerHub使用的。 --> <serverId>docker-hub</serverId> <registryUrl>https://index.docker.io/v1/</registryUrl> </configuration> </plugin>
参考:https://github.com/spotify/docker-maven-plugin/issues/116
TIPS
- imageName必须符合正则[a-z0-9-_.],否则将会构建失败
- 插件默认使用localhost:2375去连接Docker,如果你的Docker端口不是2375,需要配置环境变量DOCKER_HOST=tcp://<host>:2375
加载全部内容