使用Gradle docker插件和registry打包应用| SpringBoot实践

上一篇文章《使用kotlin开发最新版的spring boot应用 | SpringBoot实践》中开始动手用kotlin编写spring boot应用，本文将会继续介绍使用gradle docker插件和docker registry，在gradle下实现一站式打包发布。

通过使用gradle和docker，可以在gradle的生态下，打造持续集成流水线，实现spring boot应用的持续集成；配合持续集成工具使用，就可以实现一键发布。

实现思路

通过使用gradle，我们可以只使用gradle一种命令行工具，在gradle构建中，实现一个流水线。

• 首先编译代码；
• 然后运行自动化测试
• 自动化测试通过之后，运行buildDocker任务，打包一个包含应用的docker镜像
• 将docker镜像发布push到docker registry中
• 服务器从docker registry中pull镜像，然后运行

在gradle中使用docker插件

首先需要引入docker plugin，指定gradle-docker插件的版本。在生成docker镜像的时候，默认会使用group配置的值作为生成的docker镜像的组织，version作为TAG。

因为docker的repository名字不能用大写，所以jar.baseName只能使用中划线的方式。在开始docker build之前，需要依赖gradle build的执行结果，所以使用dependsOn参数，指定依赖的前置task；gradle build之后，会生成应用的jar包，buildDocker任务需要先将生成的jar包复制到build目录下。

buildscript {
    ... ...
    dependencies {
        classpath('se.transmode.gradle:gradle-docker:1.2')
    }
}

group 'liuwill'
version '1.0-SNAPSHOT'

... ...
apply plugin: 'docker'

... ...
jar {
    baseName = 'boot-kotlin-app'
    version =  '0.1.0'
}
mainClassName = 'com.liuwill.demo.kotlinBoot.SpringBootKotlinApplicationKt'

task buildDocker(type: Docker, dependsOn: build, group: "custom") {
    push = true
    applicationName = jar.baseName
    dockerfile = file('src/main/docker/Dockerfile')
    doFirst {
        copy {
            from jar
            into stageDir
        }
    }
}

构建docker镜像

要build一个docker镜像，还需要指定Dockerfile文件，这个步骤，跟正常使用docker来build镜像是一样的，区别只是build是由gradle的task触发的。

docker 插件会将src/main/docker中的文件复制到build/docker下，通过自定义的doFirst，我们将gradle build生成的jar包也复制到build/docker下。然后docker build就会根据dockerfile在build/docker下构建docker镜像；生成的镜像是$group/$jar.baseName:$version。

dockerfile指定了将打包好的jar包复制到docker中的路径和文件名，然后使用java -jar作为容器的ENTRYPOINT。

FROM java:openjdk-8-alpine
VOLUME /tmp
ADD boot-kotlin-app-0.1.0.jar app.jar
RUN sh -c 'touch /app.jar'
ENV JAVA_OPTS=""
ENTRYPOINT [ "sh", "-c", "java $JAVA_OPTS -Djava.security.egd=file:/dev/./urandom -jar /app.jar" ]

运行gradle buildDocker命令，就可以生成docker image。

将docker镜像发布到registry

docker registry是docker官方提供的用来构建私有镜像仓库的工具

在本地生成docker镜像之后，我们需要使用docker registry将镜像发布到自己的镜像仓库中。

首先启动一个docker registry服务，端口可以自己指定。
docker run -d -p 5000:5000 --name registry registry:2

然后指定本地镜像在registry中的镜像名
docker tag liuwill/boot-kotlin-app localhost:5000/boot-kotlin-product

将镜像推送到registry中
docker push localhost:5000/boot-kotlin-product

在实际使用中，registry应该部署在可以被整个部署集群通过内网访问的堡垒机上；然后所有的内部服务器，直接从registry拉取镜像运行，就可以完成应用发发布。将localhost:5000替换成自定义的domain或者hostname

查看registry中的镜像
curl http://localhost:5000/v2/_catalog

拉取镜像
docker pull localhost:5000/boot-kotlin-product

运行程序

最后运行docker镜像
docker run -p 8080:8080 -t localhost:5000/boot-kotlin-product

访问服务器

curl 'http://localhost:8080/api/data/show'  \
    -X 'PUT'  \
    -H 'content-type: application/json'  \
    -H 'accept: application/json'  \
    --data-binary '{"data":"hello","data":"ok?"}' --compressed

可以通过docker ps查看运行情况，或者docker exec进入容器。

源代码：https://github.com/liuwill-projects/SpringBootKotlin