首页 资讯 社群 我的社区 搜索

使用Jenkins X实现ChatOps

yimo~
2019-06-10 18:01:25

本文介绍了使用Jenkins X实现ChatOps。很好的阐述了如何使用Jenkins X来实践ChatOps,文中手把手带我们从零开始完成了一次Kubernetes Native的CI/CD之旅。

Jenkins X 主逻辑是基于GitOps理念。每个更改都必须用Git记录,并且只允许Git触发集群中发生更改的事件。这种逻辑是Jenkins X的基石,到目前为止,它为我们提供了很好的服务。但是,我们可能还需要执行一些不会导致源代码或配置更改的操作,由此ChatOps就问世了。

我们可以将ChatOps定义为对话驱动开发。除了单人团队外,沟通对其他所有团队都是必不可少的。当我们开发的特性准备好时,我们需要与他人沟通。我们需要请其他人来review我们的变化。我们可能需要请求合并到主分支的权限。我们可能需要沟通的事情是无限多的。这并不意味着所有的交流都变成了聊天,而是我们交流的一部分变成了聊天。由系统来决定沟通的哪些部分应该导致操作,以及什么是没有实际结果的纯人与人之间的消息传递。

我不会用ChatOps的理论和原则来叨扰你们。相反,我们将看看Jenkins X是如何实现ChatOps的。

快速demo上手实践

我们需要一个Kubernetes集群,它具有Jenkins X的无服务器架构(serverless)风格。如果您手头没有一个,可以使用下面的Gist创建一个新的集群,或者在现有集群中安装Jenkins X。请记住,当您完成上手实践后,Gist还包含允许您销毁该集群的命令。

首先需要安装jx。如果您还没有安装jx,请遵循它的安装教程。

如果对于使用哪个serverless集群犹豫不决,我推荐GKE(谷歌Kubernetes引擎)作为最稳定和功能丰富的Kubernetes托管解决方案。

探索Jenkins X在Git、Prow和系统其余部分之间集成的最佳方法是通过实例。我们首先需要一个项目,现在来创建一个新项目,命令如下。

jx create quickstart 
-l go 
-p jx-prow 
-b

cd jx-prow

由于ChatOps主要与pull请求相关,所以我们需要定义reviewers文件和approvers文件来决定谁可以review和approve。我们可以通过修改Jenkins X quickstart创建项目时生成的所有者文件(OWNERS)来实现这一点。由于允许PR的发起者更改该文件是不安全的,所以在主分支中起作用的是OWNERS文件。这就是我们要探索和修改的。

cat OWNERS

输出如下所示:

approvers:
– vfarcic
reviewers:
– vfarcic

所有者(OWNERS)包含负责此存储库的代码库的用户列表。它被划分为reviewersapprovers两个部分。如果我们想要实现一个两阶段的代码审查流程,其中不同的人将负责review和approve pull请求,这种分割是有用的。然而,这两个角色通常由相同的人执行,所以Jenkins X没有两阶段的开箱即用的评审过程(尽管可以更改)。

接下来,我们需要一个真正的GitHub用户(你的用户除外),所以请联系你的同事或朋友,让她帮你一把。告诉她你需要她的帮助来完成接下来练习的一些步骤。同时,让她知道你需要了解她的GitHub用户。

我们将定义两个环境变量,它们将帮助我们创建所有者文件(OWNERS)的新版本。GH_USER将保存您的用户名,而GH_APPROVER将包含允许review和approve您的pull请求的人的用户。通常,我们会有多个approver,这样review和approval任务就会分布到整个团队中。出于演示的目的,你们两个应该足够了。

在执行以下命令之前,请替换第一个[…]为您的GitHub用户,第二个为将批准您的PR的人的用户。

GH_USER=[…]

GH_APPROVER=[…]

现在我们可以创建所有者文件(OWNERS)的新版本。如前所述,我们将使用相同的用户作为reviewersapprovers

echo "approvers:
– $GH_USER
– $GH_APPROVER
reviewers:
– $GH_USER
– $GH_APPROVER
" | tee OWNERS

剩下的与所有者文件(OWNERS)相关的工作就是将更改推入存储库。

git add .

git commit -m "Added an owner"

git push

即使OWNERS文件定义了谁可以review和approve pull请求,但是如果不允许这些用户在项目上进行协作,那么这将是无用的。我们需要告诉GitHub,您的同事通过添加合作者与您合作(其他Git平台可能会以不同的方式调用它)。

open "https://github.com/$GH_USER/jx-prow/settings/collaboration"

如果您被要求这样做,请登录。键入用户并单击Add collaborator按钮。

您的同事应该会收到一封电子邮件,其中包含邀请作为合作者加入项目的邀请。确保她接受邀请。

并非所有合作者都必须在所有者文件(OWNERS)中。您可能有一些人在您的项目上进行协作,但是不允许他们review或approve pull请求。

由于大多数ChatOps特性都适用于pull请求,所以我们需要创建一个,命令如下所示。

git checkout -b chat-ops

echo "ChatOps" | tee README.md

git add .

git commit -m "My first PR with prow"

git push –set-upstream origin chat-ops

我们创建了一个新的分支chat-ops,对README.md做了一个无脑的更改,提交了这个commit。

现在我们已经拥有了修改过的源代码的分支,我们应该创建一个pull请求。我们可以通过GitHub UI做到这一点。不过有一个更好的方法.jx允许我们通过命令行实现这一点。考虑到我更喜欢终端屏幕而不是UI(而您在这方面没有发言权),我们将选择后者。

jx create pr 
-t "PR with prow" 
–body "What I can say?" 
-b

我们创建了一个pull请求,并显示一个带有链接的确认消息。请在您最喜欢的浏览器中打开它。

考虑到没有小猫的PR不应该被approve,我们将增加一只小猫。

请输入以下PR评论并按下Comment按钮。

No PR should be without a kitten

/meow

你应该能看到猫的照片。我们并不真正需要它,但是它很好地演示了通过注释进行交流,从而自动执行操作。

当我们创建一个pull请求时,它被自动分配给approvers列表中某个人。你的同事应该收到一封通知邮件。请让她知道她应该去pull请求(说明在电子邮件中),键入/lgtm(在我看来不错),并点击Comment按钮。

请注意/approve/lgtm在此上下文中具有相同的目的。我们从一个分支切换到另一个分支,只是为了显示这两个分支都会导致pull请求被合并到主分支。

过一段时间,PR将被合并,并执行Pipeline的构建。正如您所希望的那样,这将导致一个新版本被验证并部署到staging环境中(多亏Jenkins X Pipeline)。

您将注意到电子邮件通知在您和approver之间来回穿梭。我们不仅应用了ChatOps原则,而且还解决了通知的需求,让每个参与者都知道发生了什么,以及是否存在挂起的操作。这些通知由Git本身作为对特定操作的响应发送。控制谁接收哪个通知的方法是每个Git平台特有的,我希望您已经知道如何订阅、取消订阅或修改正在接收的Git通知。

例如,批准PR后发送的邮件如下。

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vfarciccb

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:
OWNERS [vfarciccb]
Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

总之,pull请求得到了批准。结果,Prow将其合并到主分支,并启动了一个Pipeline构建,该构建以将新版本部署到staging环境而告终。

在等到All checks have passed消息出现在PR消息中之后,就意味着整个流程已经结束。

这是对Jenkins x中的ChatOps的一个非常快速的概述。现在,您可以卷起袖子,探索Prow、Tekton、Jenkins X Pipeline Operator以及通过serverless Jenkins X bundle提供的其他工具。

用户评论