使用 Nocalhost 与 KubeVela 端云联调，一键完成多集群混合云环境部署

作者 |  雾雾、玉易才（KubeVela、Nocalhost 团队）

在云原生快速发展的当下，如何让云的技术赋能业务开发?在上线应用时，如何让云的开发者在现代化的多集群、混合云环境中便捷地进行应用的开发和调试?在部署过程中，又该如何让应用部署具备充分的验证和可靠性?

这些至关重要的问题，都是我们急需解决的。

在本文中，我们将结合 KubeVela 以及 Nocalhost 开源项目，给出一个基于 Kubernetes 和容器生态的端云联调、一键完成多集群混合环境部署的解决方案，来回答上述问题。

当一个新应用需要开发上线时，我们希望本地 IDE 中调试的结果能和云端最终部署的状态保持一致。这样一致的姿态，能最大程度上给予我们部署的信心，并且让我们可以采用类似 GitOps 这种更高效、敏捷的方式迭代应用更新。即：当新代码被推送至代码仓库中后，环境中的应用会自动化地实时更新。同时，基于端云联调的模式，可以让这整个过程不仅敏捷高效、同样更加稳定可靠。

基于 KubeVela 和 Nocalhost，我们可以完成这样一种部署过程：

如图：通过 KubeVela 创建应用，将应用部署到测试环境后，暂停部署。使用 Nocalhost 在测试环境中对应用进行云端联调。调试完毕后，将调试完毕的代码推送到代码仓库，通过 KubeVela 进行 GitOps 部署，在测试环境进行验证后，再同步更新到生产环境。

在本文中，我们将介绍如何使用 KubeVela 及 Nocalhost 完成上述云端应用开发及上线的全过程。

一、什么是 KubeVela

KubeVela 是一个简单易用且高度可扩展的应用交付和管理平台，基于 Kubernetes 与 OAM 技术构建。其核心功能是让开发人员方便快捷地在 Kubernetes 上定义与交付现代微服务应用，而无需了解任何 Kubernetes 本身相关的细节。

KubeVela 提供了 VelaUX 功能，能够让整个应用分发的过程可视化，使应用组装、分发、交付的流程变得更简单。在 UX 上，不仅可以便捷地通过页面及时了解整个交付链路状态，还可以通过配置触发器，使应用随着制品仓库的更新而更新。

而在本文的场景中，KubeVela 提供了以下能力：

1.完整的 GitOps 发布：

• KubeVela 同时支持了 Pull 模式以及 Push 模式的 GitOps 发布：我们只需要将更新后的代码推送到代码仓库，KubeVela 就能自动基于最新代码完成部署。在本文中，我们将使用 Push 模式的 GitOps，关于 Pull 模式的 GitOps 支持，可以查看文末文章[1]。

2.强大的工作流能力，实现跨环境(集群)部署、审批以及通知：

• KubeVela 借助其工作流能力，可以轻松让应用实现跨环境部署，并且支持用户在编排工作流的过程中，加入例如人工审批、消息通知等功能，使整个部署过程生产级可用。

3.应用抽象能力，让开发者都能看懂使用并且自定义基础设施能力

KubeVela 遵循 OAM 的开放应用模型，提供了一套简单易用的应用抽象能力，使开发者能够更加清晰地理解应用的功能，并且可以自定义基础设施能力。例如，对于一个简单的应用来说，我们可以将其划分为组件，运维特征，工作流三大部分。在本文的例子中，我们的组件是一个简单的业务应用;在运维特征部分，我们为这个组件绑定了一个 Nocalhost 的运维特征，让这个组件能够使用 Nocalhost 端云联调的能力;在工作流部分，通过多环境管理，我们可以先让这个组件部署在测试环境，部署完成后自动暂停工作流的发布，直至人工验证审批通过后，再进行生产环境的部署。

二、什么是 Nocalhost

Nocalhost 是一个允许开发者直接在 Kubernetes 集群内开发应用的工具。

Nocalhost 的核心功能是：提供 Nocalhost IDE 插件(包括 VSCode 和 Jetbrains 插件)，将远端的工作负载更改为开发模式。在开发模式下，容器的镜像将被替换为包含开发工具(例如 JDK、Go、Python 环境等)的开发镜像。当开发者在本地编写代码时，任何修改都会实时被同步到远端开发容器中，应用程序会立即更新(取决于应用的热加载机制或重新运行应用)，开发容器将继承原始工作负载所有的声明式配置(ConfigMap、Secret、Volume、Env 等)。

Nocalhost 还提供：VSCode 和 Jetbrains IDE 一键 Debug 和 HotReload;在 IDE 内直接提供开发容器的终端，获得和本地开发一致的体验;提供基于 Namespace 隔离的开发空间和 Mesh 开发空间 。此外，Nocalhost 还提供了 Server 端帮助企业管理 Kubernetes 应用、开发者和开发空间，方便企业统一管理各类开发和测试环境。

在使用 Nocalhost 开发 Kubernetes 的应用过程中，免去了镜像构建，更新镜像版本，等待集群调度 Pod 的过程，把编码/测试/调试反馈循环(code/test/debug cycle)从分钟级别降低到了秒级别，大幅提升开发效率。

三、调试云端应用

我们以一个简单的前端应用为例，首先，我们通过 VelaUX 进行多环境部署。

关于如何开启 KubeVela 的 VelaUX 插件，请查看文末官方文档[2]。

1.使用 VelaUX 部署云端应用

在 VelaUX 中创建一个环境，每个环境中可以有多个部署目标，我们以一个包含了测试部署目标以及生产部署目标的环境为例。

首先，创建两个部署目标，一个用于测试部署，一个用于生产部署。这里的部署目标会分别将资源下发到 local 集群的 test 以及 prod namespace 当中。你也可以通过 VelaUX 的集群管理功能，来添加新的集群用于部署。

创建完部署目标后，新建一个环境，环境中包含这两个部署目标。

创建完环境后，新建应用来进行云端调试。这个前端应用会在 80 端口暴露服务，因此，我们把这个应用的 80 端口打开。

创建完应用后，应用会默认带一个工作流，自动将应用部署到两个部署目标当中。但我们并不希望未经过调试的应用直接部署到生产目标中。因此，我们来编辑一下这个默认工作流：在部署到测试目标和生产目标中添加一个暂停步骤。这样，我们就可以在部署到测试环境中后，暂停部署，等待用户调试并验证完成后，再继续部署到生产环境中。

完成这些配置后，我们来为这个应用添加一个 Nocalhost 的 Trait，用于云端调试。

在这里，详细介绍一下 Nocalhost Trait 中的几个参数：

Command 分两种，Debug 和 Run。开发时在插件右键点击 Remote Debug、Remote Run 会在远端 Pod 中运行对应的命令，从而达到云端 Debug 的效果。在这里，我们使用的是前端应用，所以将命令设置为 yarn serve。

这里的 Image 指的是调试镜像，Nocalhost 默认提供了五种语言的镜像(go/java/python/ruby/node)，可以通过填写语言名来使用内置镜像，当然，也可以填写完整镜像名以使用自定义镜像。

开启 HotReload 意味着开启热加载功能，能够在修改代码后直接看到效果。PortForward 会将云端应用的 80 端口转发到本地的 8080 端口。

在 Sync 部分，将 Type 设置为 sendReceive (双向同步)，或者设置为 send (单向发送)。完成配置后，部署该应用。可以看到，应用在部署到测试目标之后，将自动暂停。

此时，打开 VSCode 或者 Jetbrains IDE 中的 Nocalhost 插件页面，可以在 test namespace 下看到我们已部署的应用，点击应用旁边的锤子按钮进入调试模式：

进入 Nocalhost 调试模式后，可以看到，IDE 中的终端已经被替换成了容器的终端。通过 ls 命令，可以看到容器内的所有文件。

此时，右键 Nocalhost 中的应用，可以选择进入 Remote Debug 或者 Remote Run 模式。这两个按键将自动执行我们之前配置的 Debug 和 Run 命令。

进入 Debug 模式后，可以看到，我们的云端应用被转发到了本地的 8080 端口：

打开本地浏览器，可以看到，目前我们部署的前端应用版本为 v1.0.0：

此时，我们可以在本地 IDE 中修改一下代码，将版本修改为 v2.0.0：

在之前的 Nocalhost 配置中，我们已经开启了热加载功能。因此，我们再次刷新一下本地的 8080 端口页面，可以看到，应用版本已经变成了 v2.0.0：

此时，我们可以终止 Nocalhost 的调试模式。将已通过调试的代码推送至代码仓库中。

四、使用 GitOps 进行多环境发布

在我们结束调试后，环境上的应用依旧是之前 v1.0.0 的版本。那么，该使用什么方式来更新环境中的应用呢?

在整个云端调试的过程中，我们修改的是源代码。因此，我们可以借助 GitOps 的模式，以代码作为更新来源，来完成对环境中应用的更新。

查看 VelaUX 中部署的应用，可以看到，每个应用都会拥有一个默认 Trigger：

点击 Manual Trigger 查看详情， 可以看到，VelaUX 为每个应用提供了一个 Webhook URL，请求该地址，并带上需要更新的字段(如：镜像等)，可以方便快捷的完成应用的更新。(注：由于需要对外暴露地址，需要在部署 VelaUX 的时候使用 LoadBalancer 或者使用其他方式暴露 VelaUX 的服务)。

在 Curl Command 里，还提供了手动 Curl 该触发器的请求示例。我们来详细解析一下请求体：

{
  // 必填，此次触发的更新信息
  "upgrade": {
    // Key 为应用的名称
    "<application-name>": {
      // 需要更新的值，这里的内容会被 Patch 更新到应用上
      "image": "<image-name>"
    }
  },
  // 可选，此次触发携带的代码信息
  "codeInfo": {
    "commit": "<commit-id>",
    "branch": "<branch>",
    "user": "<user>",
  }
}

upgrade 下是本次触发要携带的更新信息，在应用名下，是需要被 Patch 更新的值。默认推荐的是更新镜像 image，也可以扩展这里的字段来更新应用的其他属性。

codeInfo 中是代码信息，可以选择性地携带，比如提交 ID、分支、提交者等，一般这些值可以通过在 CI 系统中使用变量替换来指定。

当我们经过更新后的代码被合入代码仓库后，我们可以通过代码仓库中的 CI 配置来完成和 VelaUX Trigger 的对接。以 GitLab CI 为例，可以增加如下步骤：

webhook-request:
  stage: request
  before_script:
    - apk add --update curl && rm -rf /var/cache/apk/*
  script:
    - |
      curl -X POST -H "Content-Type: application/json" -d '{"upgrade":{"'"$APP_NAME"'":{"image":"'"$BUILD_IMAGE"'"}},"codeInfo":{"user":"'"$CI_COMMIT_AUTHOR"'","commit":"'"$CI_COMMIT_SHA"'","branch":"'"$CI_COMMIT_BRANCH"'"}}' $WEBHOOK_URL

配置完成后，当代码被更新时，将自动触发该 CI，并且更新对应 VelaUX 中的应用。

当镜像被更新后，再次查看应用的页面，可以看到，测试环境中的应用已经变成了 v2.0.0 版本。

在测试部署目标中验证完毕后，我们可以点击应用工作流中的 Continue ，使最新版本的应用部署到生产部署目标中。

部署完毕后，查看生产环境中的应用，可以看到，生产环境中已经是最新的 v2.0.0 版本：

至此，我们就通过 KubeVela 首先在测试环境中使用 Nocalhost 进行端云联调，验证通过后，再通过更新代码，使用 GitOps 来完成部署更新，并且继续更新生产环境中的应用，从而完成了一次应用从开发到上线的完整部署流程。

五、总结

使用 KubeVela + Nocalhost，不仅能够便捷地在开发环境中进行云端的联调测试，还能在测试完成后一键更新部署到生产环境，使整个开发上线过程稳定可靠。

参考链接：

[1] Using GitOps + KubeVela for Application Continuous Delivery

https://kubevela.io/blog/2021/10/10/kubevela-gitops

[2] 官方文档地址：https://kubevela.io/docs/install#4-install-velaux