Jenkins 和 Kubernetes 云上的神秘代理

作者： Mandy Hubbard / 译者： 于志鹏

来源： Jenkins（ID:Jenkins-Community）

如果你是做微服务，那让我们在开始之前先花些时间想一想。如果只在 Jenkins 上构建单体式应用程序，那你肯定每天都会运行很多 Jenkins job, 而且要不厌其烦地运行很多次。所以，我们应该好好想清楚如何来做出一些改变。其实只需要付出一些努力，Jenkins 就可以很好地解决这种事情。

Jenkins 进阶之路

作为 DevOps 从业者，我遇到的最大问题是如何管理并优化自己的 Jenkins agent 结构。如果只是实验性地 用 Jenkins 跑一些流水线，那根本不用考虑 agent 的事情。如果每天要跑成百上千条流水线的话，那怎么去做优化就是一件非常非常重要的事情。在 Jenkins 进阶之路中，我也尝试了各种不同的方式来寻找Jenkins agent 的最佳使用方式。如果你也和我一样经历过，那下面这些事情你一定会很熟悉。

下面是我在这些年中使用 Jenkins 的各个阶段：

以上这些阶段各有利弊，但都是为了让我们从管理 Jenkins 节点中解放出来。不过，最近我又进阶到了另外一个阶段： Jenkins on Kubernetes 。

一旦在 Jenkins 中把构建节点和 job 都容器化了，迁移工作平台将变得十分简单易行。这里郑重声明一下，在使用这个方法前我一直没有接触过 Kubernetes。也就是说，在 Google Cloud Platform（GCP）GKE 中创建 Kubernetes 集群，使用 Helm Chart启动 Jenkins master ,并在 Kubernetes 集群中的 Jenkins 代理中运行构建是非常简单的。

流水线脚本中启动 K8s 中的代理

如何配置 Jenkins 才能使流水线脚本能够在 K8s 集群中启动 Jenkins 节点。首先要先安装 Kubernetes plugin 插件。有意思的是，当我用 Helm chart 来安装Jenkins 时，安装好的 Jenkins 里面已经有了该插件。还有一个前提，启动的 Jenkins 节点要和 Jenkins master 在同一个 K8s 集群里。

一旦在 K8s 中运行了 Jenkins master 节点，只需要简单配置几步，就能启动一个小构建。

配置 Jenkins Master

为了保证 Jenkins 能够访问 K8s 集群的资源，首先需要按照以下步骤创建一些凭据：

1. 进入 Jenkins 的 UI 界面，点击左边导航栏里的凭据链接

2. 点击 Stores scoped to Jenkins 列表下 global 中的 Add credentials (将鼠标悬停在链接旁边即可看到箭头)

3. 点击添加凭证

4. 写好 Kubernetes Service Account

5. 将范围设置为全局

6. 点击 OK 按钮

这样 Jenkins 就可以使用这个凭据去访问 K8s 的资源。

在 Jenkins Master 中配置云

下一步就是在 Jenkins 中设置云的配置：

你看，只需要几个参数就能在 K8s 集群中启动一些节点了，当然你的环境需要的话也可以做一些其他的调整。

现在你已经可以通过定义一些 pod 实现Jenkins master 访问 K8s 集群了。pod其实是 K8s 中的概念，在一个 pod 里面会有一个或者多个容器，它们共享网络还有存储，我们可以在这个 pod 中执行一些构建工作。每一个 Jenkins 节点都是作为 K8s pod 来启动的。这个 pod 里面经常会包含一个默认的 JNLP 容器，还有一些pod 模板中定义的容器。现在有至少两种方法来定义pod template。

通过 Jenkins UI 配置一个 pod template

1. Manage Jenkins → Configure Systems；

2. 找到之前配置 Jenkins K8s 的地方；

3. 点击 Add Pod Template button 选择 Kubernetes Pod Template；

4. 输入下面的值：

Name 自定义；

Namespace default -除非想换个在上一步自定义的命名空间；

Labels 自定义 - 这个将用来匹配你在 jenkinsfile 中的 label 值；

Usage 如果想让这个 pod 作为默认节点的话，就选择 "Use this node as much as possible"， 如果选择 "Only build jobs with label matching expressions matching this node" 的话 那就是只有在 Jenkins 脚本中定义的label匹配的构建才能使用这个节点；

The name of the pod template to inherit from  这个可以置空，现在还用不到；

Containers 在 pod 中启动的容器，下面会有详细介绍；

EnvVars 在 pod 中注入的环境变量；

Volumes 在 pod 中挂载的任何一种卷；

需要记住，在一个 pod 中会有不止一个容器，它们都是共存的。如果你是用 Helm chart 安装 Jenkins 的话，pod 中就会包含 JNLP 这个容器，这个容器也是 Jenkins agent 中必须包含的。为了完成更多服务的构建，还需要添加一些其他工具链的容器。

添加容器模板

1. 进入 Jenkins UI 界面，回到上一步创建 pod template ；

2. 点击 Add Container 按钮， 选择 Container Template；

3. 输入下面的值：

Name 自定义；

Docker image 根据需求来写，比如在构建一个go 写的应用时，可以输入 golang:1.11-alpine3.8；

Label 表明要用在流水线脚本中引用此容器模板的标签字符串；

Always pull image 如果想让 pod 启动的时候都去拉取镜像就选择这个；

你可以保留其他参数的默认值，但是可以看到该插件可以对 pod 以及在其中运行的各个容器进行详细控制。你可以通过此插件设置在 Kubernetes pod 配置中的任何值。你还可以通过输入原始 YAML 来注入配置数据。无需因选项过多而分心，选择配置它们中的一小部分就可以获得工作环境。

单击容器模板中的“添加环境变量”按钮，将环境变量注入特定容器，也可以单击模板中的“添加环境变量”按钮，将环境变量注入所有的容器。

以下环境变量会自动注入默认的 JNLP 容器，来保障它能自动连接到 Jenkins 主服务器：

* `JENKINS_URL`: Jenkins 网页界面网址

* `JENKINS_JNLP_URL`: Jenkins 特定 slave 中 jnlp 的 url

* `JENKINS_SECRET`: 身份验证的密钥

* `JENKINS_NAME`: Jenkins 代理的名称

如果单击“添加卷”按钮，将看到几个用于添加卷的选项，这里使用 Host Path Volume 选项将 docker socket 安装在 pod 中。然后，可以运行安装了 Docker 客户端的容器，并且来构建和推送 Docker 镜像。

此时，我们为 Kubernetes 集群创建了一个云配置，并定义了一个由一个或多个容器组成的 pod。现在如何使用它来运行 Jenkins 工作？

很简单，只需要我们在 Jenkins 流水线脚本中通过标签引用 pod 和容器就可以了。

本文中的示例是使用脚本流水线，当然您可以使用声明式流水线语法实现相同的结果：

node('test-pod') {

stage('Checkout') {

checkout scm

}

stage('Build'){

container('go-agent') {

// This is where we build our code.

}

}

}

用 jenkinsfile 来实现相同的功能

通过 UI 配置插件现在看起来很不错。但有一个明显的问题，配置不能像源代码一样进行版本控制和存储。幸运的是，您可以直接在 Jenkinsfile 中创建整个 pod 定义。哈哈，在 Jenkinsfile 中有什么不能做的呢?

可以将 UI 或 YAML 定义中可用的任何配置参数添加到 `podTemplate` 和`containerTemplate` 部分。

在下面的示例中，我已经定义了一个包含两个容器模板的 pod。

pod 标签将会用于节点，表示想要启动此 pod 实例。

直接在节点内定义但没有在容器块中定义的任何步骤，都可以在默认的 JNLP 容器中运行。

容器块用于表示该容器块内的步骤应在具有给定标签的容器内运行。我已经定义了一个标签为 `golang` 的容器模板，我将用它来构建 Go 可执行文件，最终将其打包成 Docker 镜像。在 `volumes` 中，已经指出想要挂载主机的 Docker 套接字，但仍然需要 Docker 客户端使用 Docker API 与它进行交互。因此，已经定义了一个标签为 `docker` 的容器模板，该模板使用安装了 Docker 客户端的镜像。

podTemplate(

name: 'test-pod',

label: 'test-pod',

containers: [

containerTemplate(name: 'golang', image: 'golang:1.9.4-alpine3.7'),

containerTemplate(name: 'docker', image:'trion/jenkins-docker-client'),

],

volumes: [

hostPathVolume(mountPath: '/var/run/docker.sock',

hostPath: '/var/run/docker.sock',

],

{

//node = the pod label

node('test-pod'){

//container = the container label

stage('Build'){

container('golang'){

// This is where we build our code.

}

}

stage('Build Docker Image'){

container(‘docker’){

// This is where we build the Docker image

}

}

}

})

在基于 Docker 的流水线脚本中，我构建了 Docker 镜像并将其推送到 Docker 仓库，对我来说，能够复制这些配置信息非常重要。完成后，我已准备好使用`gcloud`（Google Cloud SDK）构建镜像，并将该镜像推送到 Google Container Registry，以便部署到 K8s 群集。

使用 gcloud 镜像指定了一个容器模板，并将 docker 命令更改为 gcloud 命令。、

就这么简单！

podTemplate(

name: 'test-pod',

label: 'test-pod',

containers: [

containerTemplate(name: 'golang', image: 'golang:1.9.4-alpine3.7'),

containerTemplate(name: 'gcloud', image:'gcr.io/cloud-builders/gcloud'),

],

{

//node = the pod label

node('test-pod'){

//container = the container label

stage('Build'){

container('golang'){

// This is where we build our code.

}

}

stage('Build Docker Image'){

container(‘gcloud’){

//This is where we build and push our Docker image.

}

}

}

})

在 Kubernetes 上运行 Jenkins master、Jenkins 代理，构建和部署示例应用程序其实只花了几个小时。但之后，我花了一个周末的时间才深入了解该平台。如果你学得够快，相信你在几天内就可以完全掌握并且灵活运用这个平台了。