淺談使用Maven插件構(gòu)建Docker鏡像的方法

2024-07-13 10:15:32

字體：大中小

供稿：網(wǎng)友

本文介紹了使用Maven插件構(gòu)建Docker鏡像的方法，分享給大家，具體如下：

工具

工欲善其事，必先利其器。筆者經(jīng)過(guò)調(diào)研，有以下幾款Docker的Maven插件進(jìn)入筆者視野：

插件名稱	官方地址
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、文檔易用性以及更新頻率三個(gè)緯度考慮，選用了第一款。

使用插件構(gòu)建Docker鏡像

簡(jiǎn)單使用

我們以之前的項(xiàng)目：microservice-discovery-eureka為例：

在pom.xml中添加下面這段

 <build>  <plugins>   <!-- docker的maven插件，官網(wǎng)：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-_.]的，否則構(gòu)建不會(huì)成功 -->     <!-- 詳見(jiàn)：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>

執(zhí)行命令：

mvn clean package docker:build

我們會(huì)發(fā)現(xiàn)控制臺(tái)有類似如下內(nèi)容：

[INFO] Building image microservice-discovery-eurekaStep 1 : FROM javaPulling from library/javaDigest: sha256:581a4afcbbedd8fdf194d597cb5106c1f91463024fb3a49a2d9f025165eb675fStatus: Downloaded newer image for java:latest ---> ea40c858f006Step 2 : ADD /microservice-discovery-eureka-0.0.1-SNAPSHOT.jar // ---> d1c174083bcaRemoving intermediate container 91913d847c20Step 3 : ENTRYPOINT java -jar /microservice-discovery-eureka-0.0.1-SNAPSHOT.jar ---> Running in 0f2aeccdfd46 ---> d57b027ca65aRemoving intermediate container 0f2aeccdfd46Successfully 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

恭喜，構(gòu)建成功了。

我們執(zhí)行docker images 會(huì)發(fā)現(xiàn)該鏡像已經(jīng)被構(gòu)建成功：

REPOSITORY      TAG     IMAGE ID   CREATED    SIZEmicroservice-discovery-eureka latest    d57b027ca65a  About a minute ago 681.5 MB

啟動(dòng)鏡像

docker run -p 8761:8761 microservice-discovery-eureka

我們會(huì)發(fā)現(xiàn)該Docker鏡像會(huì)很快地啟動(dòng)。

訪問(wèn)測(cè)試

訪問(wèn)http://Docker宿主機(jī)IP:8761 ，能夠正常看到Eureka界面。

使用Dockerfile進(jìn)行構(gòu)建

上文講述的方式是最簡(jiǎn)單的方式，很多時(shí)候，我們還是要借助Dockerfile進(jìn)行構(gòu)建的，首先我們?cè)?microservice-discovery-eureka/src/main/docker目錄下，建立文件Dockerfile

FROM java:8VOLUME /tmpADD microservice-discovery-eureka-0.0.1-SNAPSHOT.jar app.jarRUN bash -c 'touch /app.jar'EXPOSE 9000ENTRYPOINT ["java","-Djava.security.egd=file:/dev/./urandom","-jar","/app.jar"]

修改pom.xml

<build>  <plugins>   <!-- docker的maven插件，官網(wǎng)：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-_.]的，否則構(gòu)建不會(huì)成功 -->     <!-- 詳見(jiàn)：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進(jìn)行構(gòu)建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上創(chuàng)建repo

項(xiàng)目pom.xml修改為如下：注意imageName的路徑要和repo的路徑一致

<build>  <plugins>   <!-- docker的maven插件，官網(wǎng)：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-_.]的，否則構(gòu)建不會(huì)成功 -->     <!-- 詳見(jiàn)：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>

執(zhí)行命令：

mvn clean package docker:build -DpushImage

搞定，等構(gòu)建成功后，我們會(huì)發(fā)現(xiàn)Docker鏡像已經(jīng)被push到DockerHub上了。

將鏡像push到私有倉(cāng)庫(kù)

在很多場(chǎng)景下，我們需要將鏡像push到私有倉(cāng)庫(kù)中去，這邊為了講解的全面性，私有倉(cāng)庫(kù)采用的是配置登錄認(rèn)證的私有倉(cāng)庫(kù)。

和push鏡像到DockerHub中一樣，我們首先需要修改Maven的全局配置文件settings.xml，添加以下段落

<servers> <server> <id>docker-registry</id> <username>你的DockerHub用戶名</username> <password>你的DockerHub密碼</password> <configuration>  <email>你的DockerHub郵箱</email> </configuration> </server></servers>

將項(xiàng)目的pom.xml改成如下，

<plugin> <groupId>com.spotify</groupId> <artifactId>docker-maven-plugin</artifactId> <version>0.4.12</version> <configuration> <!-- 路徑為：私有倉(cāng)庫(kù)地址/你想要的鏡像路徑 --> <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>

執(zhí)行：

mvn clean package docker:build -DpushImage

稍等片刻，將會(huì)push成功。

如果想要從私服上下載該鏡像，執(zhí)行：

docker login reg.itmuch.com # 然后輸入賬號(hào)和密碼docker pull reg.itmuch.com/test-pull-registry

將插件綁定在某個(gè)phase執(zhí)行

在很多場(chǎng)景下，我們有這樣的需求，例如執(zhí)行mvn clean package 時(shí)，自動(dòng)地為我們構(gòu)建docker鏡像，可以嗎？答案是肯定的。我們只需要將插件的goal 綁定在某個(gè)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目標(biāo)，綁定在package這個(gè)phase上。也就是說(shuō)，用戶只需要執(zhí)行mvn package ，就自動(dòng)執(zhí)行了mvn docker:build 。

常見(jiàn)異常

連接不上2375（一般在Win7上出現(xiàn)）

復(fù)制代碼代碼如下:

	
	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的問(wèn)題的其中一種方式，注意要跟docker-machine env相一致 --><dockerHost>https://192.168.99.100:2376</dockerHost>    <dockerCertPath>C:/Users/Administrator/.docker/machine/machines/default</dockerCertPath>

修改后插件配置變?yōu)椋?/p>

<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的問(wèn)題的其中一種方式，注意要跟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