Gitlab CI 自动部署 asp.net core web api 到Docker容器

时间:2023-12-29 16:53:56

为什么要写这个?

在一个系统长大的过程中会经历不断重构升级来满足商业的需求,而一个严谨的商业系统需要高效、稳定、可扩展,有时候还不得不考虑成本的问题。我希望能找到比较完整的开源解决方案来解决持续集成、监控报警、以及扩容和高可用性的问题。是学习和探索的过程分享给大家,也欢迎同行的人交流。

先来一个三步曲,我们将完成通过GitLab CI 自动部署 net core web api 到Docker 容器的一个示例。这是第一步,通过此文您将了解如何将net core web api 运行在Docker容器中。

  1. 在Docker 容中运行Asp.net Core web API

  2. 用Docker 5分钟搭一套Gitlab 环境

  3. 用GitLab CI 完成 .Net Core API 的自动部署

以上所有示例将在Mac中完成。

本系列文章会优先发表于我的公众号jessetalk, 会拆成更小篇幅更利于阅读。除了技术还会有一些关于产品、技术管理、学习方法论的一些思考,欢迎大家关注。

如何在Docker容器中运行Asp.net Core web api

这是第一部份, 我们将对Docker进行一些初步的介绍,安装以及基本的操作;然后我们会创建一个最简单的 netcore web api 并让它在Docker中运行。

Docker的安装

当然Mac上的安装是非常简单的,只需要到Docker的官网上下载一个docker for mac的安装包就可以了。安装完之后,就会在顶部的状态栏中看到Docker的图标。
Gitlab CI 自动部署 asp.net core web api 到Docker容器

关于镜像的问题

如果不使用国内镜像的话,下载image将会非常的慢。在阿里云中可以申请一个自己的加速地址,速度是非常不错的。进入阿里云控制台-> 产品与服务-> 容器服务 下的镜像仓库控制台 可以在Docker Hub镜像站点中找到。
Gitlab CI 自动部署 asp.net core web api 到Docker容器
Gitlab CI 自动部署 asp.net core web api 到Docker容器
在Docker中配置镜像:
Gitlab CI 自动部署 asp.net core web api 到Docker容器

安装完之后可以在terminal中输入docker info 来检测是否安装正常。

Docker的入门使用

下面介绍一些简单的Docker命令,以便从来没有实践过Docker的同学来了解我们接下来要做的事情。
Gitlab CI 自动部署 asp.net core web api 到Docker容器
当我们刚开始安装完Docker之后,本地是没有任何的镜像的。永远的入门第一步,下载一个hello-world的镜像然后运行它。
Gitlab CI 自动部署 asp.net core web api 到Docker容器
helloworld是镜像的名称,我们默认连接的是docker hub也就是官方提供的镜像仓库,当然我们也可以连接其它的甚至建立自己的镜像仓库。当本地没有 helloworld这个镜像的时候,Docker就会自动去下载这个镜像到本地。 

关于DockerFile

docker build命令在构建一个image的时候所需要的信息都在DockerFile中。比如我们接下来要运行的一个asp.net core api 的容器大概需要这样几步:
Gitlab CI 自动部署 asp.net core web api 到Docker容器

安装并运行.net core web api

在Mac上安装net core ,首先需要下载更新最新的OpenSSL 
Gitlab CI 自动部署 asp.net core web api 到Docker容器

然后可以到官网下载net core 1.1 on MacOS,完成之后可以在命令行输入 dotnet --version 来检测当前的版本。

初始化项目并运行

通过3个命领我们可以完成初始化项目并运行的全过程: dotnet new|restore|run。 dotnet 框架默认提供一些初始化的项目模板,可以输入dotnet new -all来查看。

Gitlab CI 自动部署 asp.net core web api 到Docker容器

我们可以用 dotnet new webapi 来初始化一个与文件夹名称相同的 webapi项目,也可以在后面加 -n自定义一个项目名称。然后接着在命令行中进入项目的目录输入 dotnet restore,最后用 dotnet run来运行这个web api 项目。

Gitlab CI 自动部署 asp.net core web api 到Docker容器

接着就可以在本地浏览这个api

Gitlab CI 自动部署 asp.net core web api 到Docker容器

到这里我们的dotnet core web api已经运行在本地了,接下来我们就要让它运行在Docker中。

在Docker中运行dotnet core web api

上面我们已经讲过DockerFile以及一个net core web api 中应该如何配置它。我们会把它放到项目的根目录里。 可以用Visual studio for mac 打开整个web api项目。

Gitlab CI 自动部署 asp.net core web api 到Docker容器

接下来我们要做的就是把我们这个代码构建成一个镜像。

Gitlab CI 自动部署 asp.net core web api 到Docker容器

我们在terminal中进行项目的根目录,输入 docker build -t myA=apiimage .

Gitlab CI 自动部署 asp.net core web api 到Docker容器

完成之后输入 docker images 可以查看到我们刚刚创建的镜像

Gitlab CI 自动部署 asp.net core web api 到Docker容器

接下来我们就可以用 docker run 用刚刚这个镜像启动一个容器运行在host的 8080端口。

Gitlab CI 自动部署 asp.net core web api 到Docker容器

这个时候我们再访问之前的api就需要通过8080端口,而此时的 api 已经是在容器中运行的。

Gitlab CI 自动部署 asp.net core web api 到Docker容器

5分钟快速用Docker部署你自己的GitLab

在掌握了Docker的基本用法之后,我们需要了解如何把GitLab通过Docker跑起来。

Gitlab的安装与配置

sudo docker run --detach \
--hostname 127.0.0.1 \
--publish : --publish : --publish : \
--name gitlab \
--restart always \
--volume /srv/gitlab/config:/etc/gitlab:Z \
--volume /srv/gitlab/logs:/var/log/gitlab:Z \
--volume /srv/gitlab/data:/var/opt/gitlab:Z \
gitlab/gitlab-ce:latest

我们用到的参数列表: docker run 的参数配置可以查看官方文档

Gitlab CI 自动部署 asp.net core web api 到Docker容器

在运行安装脚本之前,我们所使用的volume路径需要授权给docker。

Gitlab CI 自动部署 asp.net core web api 到Docker容器

可能会遇到的问题

我在安装及配置的时候遇到了两个问题,可能有人也会遇到。

  1. GitLab 一直在重启(跑不起来)
  2. SSH连接不上

SSH连接的问题我们下面有一小节会讲,这里我简单说一下第一个问题。当我运行脚本之后通过 docker ps 查看当前正在运行的容里面并没有看到 gitlab这个容器,通过 ps -a显示所有容器时发现它的状态一直是 starting 或者 restarting。 这个时候我们可以使用 docker logs 来查看当前容器的运行日志。

Preparing services...
Starting services...
/opt/gitlab/embedded/bin/runsvdir-start: line : ulimit: pending signals: cannot modify limit: Operation not permitted
/opt/gitlab/embedded/bin/runsvdir-start: line : /proc/sys/fs/file-max: Read-only file system
Configuring GitLab package...
Configuring GitLab... ================================================================================
Error executing action `run` on resource 'ruby_block[directory resource: /var/opt/gitlab/git-data/repositories]'
================================================================================

通过 docker logs 可以方便大家来论断错误,一切正常还好,如果一旦出现问题,新手是很懵圈的。这个时候可能通过google 查找错误日志,多数情况下都能找到正确答案,我遇到的是个权限不足的问题, 在这个链接里面有完整的讨论,解决办法就是执行下面这句命令之后就可以正常启行了。

sudo chmod  /srv/gitlab/data/git-data/repositories

SSH 连接GitLab

如果对于SSH不是很了解的同学可以看看阮一峰写的两篇关于SSH原理与运用的文章,非常的不错。 我们直接开始尝试用SSH连接我们本地的gitlab。

首先我们需要得到一个SSH Key,输入
cat ~/.ssh/id_rsa.pub 
如果出现 ssh-rsa打头的字符,说明本地已经有了SSH Key那我们可以直接拿来用,如果没有则需要我们自己创建一个SSH Key。
Gitlab CI 自动部署 asp.net core web api 到Docker容器

创建SSH Key

输入以下命令创建一个SSH Key。

ssh-keygen -t rsa -C "your.email@example.com" -b 

完成之后可以再输入 上面的cat命令 或者pbcopy直接复制生成的ssh key。

pbcopy < ~/.ssh/id_rsa.pub

在GitLab中账号-》设置中找到 SSH Keys中添加这个Key即可。

Gitlab CI 自动部署 asp.net core web api 到Docker容器

Gitlab CI 自动部署 asp.net core web api 到Docker容器

SSH 连接 2222 端口

正常情况下你已经可以通过git命令来连接我们部署的gitlab,但这里不一样的是我们把容器的 22端口映射到了 host的 2222上,我们需要指定端口来进连接。

ssh -p  git@127.0.0.1

同时还需要更改GitLab的配置文件中的 ssh端口,否则GitLab中为我们生成的项目连接地址会连接不上。/gitlab/config/gitlab.rb

gitlab_rails['gitlab_shell_ssh_port'] =  
更改完ssh端口之后重启gitlab容器,之后我们的项目 ssh连接址会变为:ssh://git@127.0.0.1:2222/jesse/webapi.git
到这里我们已经完成了GitLab的部署,可以将我们之前的net core api 项目提交到代码库,都是一些常规的操作,这里就不做过多的说明了。
如果对于git命令不是很熟悉的同学可以参考廖雪峰写的最简懂的git教程
由于篇符的原因,这里先写前面两部份(博客园的编辑器写长文的时候经常崩溃....) 。我们成功地将.net core api运行到了docker容器中,也部署了一套git环境。 Gitlab CI 是Gitlab 8.0以后引进的,目的是更好的支持持续集成,我们第三部分将给大家介绍如果用Gitlab CI 做到在代码提交之后自动部署最新的代码到Docker容器。
本系列文章会优先发表于我的公众号jessetalk, 会拆成更小篇幅更利于阅读。除了技术还会有一些关于产品、技术管理、学习方法论的一些思考,欢迎大家关注。
Gitlab CI 自动部署 asp.net core web api 到Docker容器