Skip to content

快速开始

欢迎使用 Nocalhost! 在这篇指南里,我们将引导您完成安装 Nocalhost 以及使用 Nocalhost 在 Kubernetes 上体验便捷的云原生微服务应用的开发过程。

ARM CPU 支持

目前 Nocalhost 对 ARM 系列 CPU(包括苹果 M1)并未完全支持

前置条件

  • 配置好的 Kubernetes Cluster (2核CPU 和 4G 内存) 可以是本地集群, 如 minikubeDocker Kubernetes 集群, 或远端集群, 比如腾讯的 TKE等公有云服务.
  • RBAC 在上述集群中已经启用
  • Configured kubeconfig file 具备命名空间的管理员权限
  • Visual Studio Code (1.52+)
  • Kubernetes API 服务可以在内部和外部访问

步骤1:安装

确保已经根据安装 IDE 插件 完成 VSCode 插件的安装。

如果你使用的是 linux,应该 增加 inotify limit,否则文件同步可能会很慢。

步骤2:在 VSCode 中安装和配置 Nocalhost

启用插件

打开 VSCode, 在左边工具栏点击 Nocalhost 的图标 , 启用 Nocalhost 插件

Nocalhost VSCode Plugin

添加 Kubernetes 集群

你可以通过两种方式添加 Kubernetes 集群:

- 选择 kubeconfig 文件 在你的本地文件夹中选择一个 kubeconfig 文件.

Note

在插件启动的时候, Nocalhost 会默认从~/.kube/config自动读取你的 kubeconfig

- 粘贴为文本 粘贴 kubeconfig 的文本内容.

Tip

你可以通过此命令 kubectl config view --minify --raw --flatten 查看并复制你的 kubeconfig

在 kubeconfig 成功读取后,选择需要访问的内容,然后添加集群

当成功添加集群后,Nocalhost 会自动显示您的集群列表

Cluster List

步骤3:进入 DevMode

Tip

我们将在这里以 bookinfo 应用程序作为示例。 您可以选择已经部署在您 Kubernetes 集群中应用程序,也可以按照 在K8s中部署示例应用程序 在Kubernetes集群中部署 bookinfo 应用程序。

选择一个你想开发的应用,在这里我们用 bookinfo 应用举例

选择 productpage 服务,点击 进入 DevMode 模式,然后指定源代码目录(从 Git 仓库克隆或使用现有的本地目录)

Select Service

Note

如果要在设置了 Git 仓库需要更改地址,可以单击 打开 yaml 文件,修改其中的 gitUrl 内容

指定源代码目录(或成功克隆代码)后,Nocalhost 将打开一个新的VSCode窗口,然后将自动进入 DevMode。

Nocalhost on DevMode

当成功进入 DevMode 后,你应该看到以下提示信息:

Starting DevMode...

...

Waiting pod to start...
Forwarding 39080:9080
Response: {"errInfo":""}
Port-forward 39080:9080 has been started

 ✓  Dev container has been updated

...

Tip

Nocalhost 将自动将端口转发到 Kubernetes 集群中的 Pod上。 在当前示例中,本地端口 39080 将数据转发到定义 Pod 上的端口 9080。 在主要进程成功启用后,您可以通过http://127.0.0.1:39080访问此 Pod。

步骤4:更改代码并检查结果

让我们进行一些代码更改,看看 Nocalhost 是如何工作的

在远端 Terminal 中执行 sh 命令启动 python 进程

sh run.sh

APP Main Process

Note

在默认情况下,在 DevMode 下,应用中的主进程不会自动在 DevContainer 中启动,因此应用将不响应任何请求。 您需要先手动启动主进程,然后才正常能访问该应用。

打开您的浏览器并输入该地址 http://127.0.0.1:39080,查看应用运行结果

APP Started

修改代码

现在修改 template/index.html 或其它内容,体验 Nocalhost 的代码修改即时生效功能. 别忘记保存您的修改.

APP Make Change

刷新浏览器查看代码改动后带来的效果 http://127.0.0.1:39080

APP Changed

👍 恭喜! 你已经完成了便捷的云原生微服务开发体验。

下一步

以下是一些后续的建议步骤:

  • 阅读 Nocalhost 的核心概念
  • 访问我们的 Github
  • 加入我们的 Slack 或扫码添加小助手后申请加入微信群