目前在学习这一块的内容,但是可能每个人环境都不同,导致找不到一篇博客能够完全操作下来没有错误的,所以自己也写一下,记录一下整个搭建的过程。

Docker 的安装这里就不赘述了,基本上几行命令都可以了,不会的可以搜一下其他的博客。我本地使用的环境如下:

  • Ubuntu16.04
  • Docker19.03
  • 管理工具:IDEA Docker 插件

下面详细讲一下部署的过程。

前言

阅读这篇博客的朋友关注点应该在 Gitlab CI 上,因此假设大家对 Docker 和 Gitlab 本身是有一定的了解,掌握基本使用的。

对于 CI/CD 以及 Gitlab CI,这里也没打算展开讲,本文的目的在于实战,如果想对 CI/CD 概念以及 Gitlab CI 当中的内容有兴趣的可以阅读参考文献 1-2。

安装 Gitlab CE 和 Gitlab Runner

这里推荐在 Linux 系统下学习 Docker,随着镜像和容器在使用上的复杂性越来越来,Win 下出现的坑会越来越多的。Gitlab CE 的搭建很简单,直接使用官方的镜像 docker run 就可以了。但是在我们这里由于还需要部署 Runner,多个容器的管理,使用 Docker-Compose 会更好,因此这里采用它来进行。

可参考我之前写的文章,#1:为 docker-compose 文件的版本号,它和 docker 版本有一个对应,具体在 docker 官方文档中有明确说明。一般写 3 就可以了。

  • #2:当前部署使用 Gitlab 官方最新版的镜像。
  • #3:hostname 填写的是部署成功后,Gitlab 的入口地址。由于我使用的 docker 不在本地,所以配置了一个 ip 地址,本地写 localhost 就可以了。当前配置的意思为,通过 172.17.193.109 的 7780 端口访问 Gitlab 页面。
  • #4:GITLAB_OMNIBUS_CONFIG 为 Gitlab 的配置参数,对应 /etc/gitlab/gitlab.rb。该文件下的所有键值对都可以在这里进行配置,容器启动时会自动配置进去。当然也可以在 Gitlab 容器启动后,手动修改 gitlab.rb 文件。
  • #5:配置了需要用到的两个端口。默认 Gitlab 容器内部 80 端口用于 Gitlab 页面的访问,22 用于 ssh 连接远程仓库。分别对其进行外网映射。
  • #6:volume 映射,三个 volume 和官方文档一致就可以了。
  • #7:这里用的是 gitlab-runner 镜像,部分博客使用的 gitlab-ci-multi-runner 是旧版本,最新的镜像统一修改为 gitlab-runner。
  • 接下来直接在 docker-compose.yml 的根目录运行就 ok 了。

    docker-compose up -d

    这个时候可以看 IDEA 的 Docker 插件。

    这样就说明容器正在初始化,等待一会,打开之前配置好的 ip:port,就能看到 Gitlab 页面了。首次使用需要重置 root 账户密码。接下去就是正常的使用。gitlab-runner 先不管,后面会讲到他,目前不需要做任何的配置工作, 只要正常启动即可。

    创建一个 Spring Boot 项目

    接下来我们使用 Gitlab CI 构建的项目时一个基于 Spring Boot 的 hello world 项目,我们先把他创建出来。为了简化这个过程,我们直接在新建项目的时候选择 Spring Boot 模板,它会为我们生成一个 hello world 项目,并且包含了一个 Dockerfile。


    项目结构上和我们手动创建的是一样的。那么这个时候准备工作基本上就做完了。在进入 Gitlab CI 的流程前,我们可以想象一下,在 Spring Boot 项目部署的过程中,有哪些步骤是可以让 Gitlab CI 来完成的。我们最终的目的是,希望通过 Gitlab CI,直接可以将我们 push 到远端仓库的代码自动构建,并在一个新的容器中运行。那么具体的步骤应该有 2 步:

    1. 拉取最新的代码,打包成 jar。
    2. 将 jar 容器化,进一步构建成为 Docker 镜像并运行起来。

    那么接下来的操作就是围绕着这两步展开的。

    配置 Runner

    安装完 Gitlab-Runner 并且创建好项目后,就需要为我们的项目注册具体的 runner 来执行 CI 任务。

    首先我们打开,Gitlab 项目的设置 --->CI/CD--->Auto DevOps。看到 URL 和注册令牌。

    进入 gitlab-runner 容器内部(exec /bin/bash),执行 gitlab-runner register 开始注册。

    root@bb6040f1cd04:/# gitlab-runner register Runtime platform                                    arch=amd64 os=linux pid=43 revision=a987417a version=12.2.0 Running in system-mode.  Please enter the gitlab-ci coordinator URL (e.g. https://gitlab.com/): http://172.17.193.109:7780/ Please enter the gitlab-ci token for this runner: zpzZ-shsCVxsJDZtAPNZ Please enter the gitlab-ci description for this runner: [bb6040f1cd04]: hello,spring boot! Please enter the gitlab-ci tags for this runner (comma separated): maven,docker Registering runner... succeeded                     runner=zpzZ-shs Please enter the executor: docker-ssh, shell, ssh, virtualbox, docker+machine, custom, parallels, docker-ssh+machine, kubernetes, docker: docker Please enter the default Docker image (e.g. ruby:2.6): docker:latest Runner registered successfully. Feel free to start it, but if it's running already the config should be automatically reloaded!

    根据步骤,依次输入对应的值,显示注册成功则完成注册。这个时候刷新 Gitlab 页面,可以看到刚刚注册成功的 runner。

    由于刚刚我们只是根据流程配置了一些基本的信息,还有额外的参数要配置就需要修改对应的配置文件了。可以直接修改映射到本地的 /home/cache/gitlab/runner-config 目录下的 config.toml。每配置一个 runner 就会在配置文件中生成一个 [[runners]]。

    [[runners]]   name = "hello,spring boot!"   url = "http://172.17.193.109:7780/"   token = "u8_Y5rLQazUmBZar9eys"   executor = "docker"   [runners.custom_build_dir]   [runners.docker]     tls_verify = false     image = "docker:latest"     privileged = true  #1     disable_entrypoint_overwrite = false     oom_kill_disable = false     disable_cache = false     volumes = ["/cache", "/home/cg/.m2:/root/.m2"]  #2     shm_size = 0   [runners.cache]     [runners.cache.s3]     [runners.cache.gcs]

    需要修改的地方:

    • #1:默认为 false,需改为 true。false 时,在 CI 构建的时候 会进行 health check,很耗时而且还是失败,设为 true 就自动跳过了,其中原因暂未深究。
    • #2:如果本地有 maven 环境的话,可以挂在到本地,这样在处理依赖时可以直接使用本地的环境,并且可以用阿里云镜像源。

    那么 runner 是需要触发才能工作的,接下来就需要配置 Gitlab-CI 了 。