Zadig v1.18.0 文档
  • 快速入门

    • 什么是 Zadig
    • 核心概念
    • 快速安装
    • 第一个项目
    • 接入准备
  • 安装与配置

    • 安装简介
    • All in One 模式
    • 使用 Sealos 一键安装
    • 基于 Helm 命令安装
    • 基于现有 Kubernetes 安装
    • 本地安装
    • 兼容性列表
  • 最佳实践
  • 项目

    • 项目

      • 项目介绍
      • K8s YAML 项目
      • K8s Helm Chart 项目
      • K8s 托管项目
      • 主机项目
      • 权限管理
    • 工作流

      • 简介
      • 产品工作流
      • 自定义工作流
      • 工作流任务
      • 工作流审批
      • 工作流通知
      • 工作流触发器
    • 环境

      • K8s YAML 环境
      • K8s Helm Chart 环境
      • K8s 托管环境
      • 主机环境
      • 服务详情
    • 服务

      • 简介
      • K8s YAML 测试服务
      • K8s Helm Chart 服务
      • K8s 托管服务
      • 服务组件
      • 服务变量
      • 主机服务
    • 构建
    • 测试
    • 代码扫描
  • 模板库

    • K8s YAML 模板
    • Helm Chart 模板
    • Dockerfile 模板
    • 构建模板
  • 工作流

    • 工作流的触发
    • 工作流的构建缓存
    • 工作流任务的并发运行
    • 工作流的镜像版本回退
    • 工作流的变量传递
  • 环境

    • 环境的负载均衡
    • 配置多套环境
    • 自测联调环境
  • 测试中心

    • 测试中心
    • 测试工具实践
    • Apipost 测试平台接入
    • Apifox 测试平台接入
  • 交付中心

    • 交付物追踪
  • 数据视图

    • 数据概览
    • 效能洞察
  • 仪表盘

    • 仪表盘
  • 集成管理

    • 账号系统

      • LDAP
      • OAuth 2.0
      • GitHub
    • 项目管理
    • 代码源

      • 简介
      • GitLab 集成
      • GitHub 集成
      • Gerrit 集成
      • Gitee 公有云集成
      • 其他代码源集成
    • CI/CD 工具
    • 代码扫描
    • 镜像仓库
    • 对象存储
    • Helm 仓库
    • Kubernetes 集群
    • 主机管理
    • 其他系统
    • 软件包管理
    • 自定义镜像管理
  • 系统设置

    • 系统配置
    • 用户管理
    • 公告管理
    • 操作日志
    • 通知设置
  • 账号设置

    • 偏好设置
  • 开发者中心

    • OpenAPI 开发文档

      • API 调用方式
      • 交付中心
      • 工作流
      • 效能洞察
    • 外部系统接入开发文档

      • 自定义账号系统
      • 自定义工作流任务
    • VS Code Toolkit 插件

      • 使用指南
  • 常见问题

    • 产品使用 FAQ
    • 部署运维 FAQ
    • 集群故障 FAQ
    • 认证鉴权 FAQ
    • 诊断手册
  • 版本发布历史

    • Zadig Roadmap
    • v1.18.0 Release Notes
    • v1.17.0 Release Notes
    • v1.16.0 Release Notes
    • v1.15.0 Release Notes
    • v1.14.0 Release Notes
    • v1.13.0 Release Notes
    • v1.12.0 Release Notes
    • v1.11.0 Release Notes
    • v1.10.0 Release Notes
    • v1.9.0 Release Notes
    • v1.8.0 Release Notes
    • v1.7.1 Release Notes
    • v1.7.0 Release Notes
    • v1.6.0 Release Notes
    • v1.5.0 Release Notes
    • v1.4.0 Release Notes
    • v1.3.1 Release Notes
    • v1.3.0 Release Notes
    • v1.2.0 Release Notes
    • v1.1.0 Release Notes
    • v1.0.0 Release Notes
    • v1.0.0-rc.1 Release Notes
  • 术语表

    • 术语表

Zadig Toolkit 是 KodeRover 旗下开源产品 Zadig 的 Visual Studio Code 插件。 该插件让开发者无需关注平台切换的繁琐,在 IDE 中即可获得 Zadig 产品核心能力,轻松地对 Zadig 项目中的 Kubernetes 环境进行查看、做服务调试和升级、重启及日志实时查看等。 在日常开发代码过程,代码修改后无需提交到 Git 仓库,也无需打包镜像,即可将服务热部署到 Zadig 云端,方便开发者做服务自测、联调和集成验证。 目前 Zadig Toolkit 支持的功能如下:

  • Zadig 环境查看
  • 微服务重启、服务镜像更换、服务详情查看、Pod 实时日志查看、登录到服务实例 Pod
  • 远程调试本地应用程序、配置远程开发环境

版本兼容性

Zadig Toolkit 插件支持 v1.12.0 - v1.16.0 版本。

准备工作

  • 系统准备:安装 Zadig v1.12.0+ 版本
  • 项目准备:参考如何使用 GitHub + Zadig 实现产品级持续交付

安装插件

  • 打开 Visual Studio Code 并进入应用市场。
  • 在应用市场中搜索 Zadig Toolkit,查看详情并安装。

plugin-install

配置插件

  1. 打开已安装的 Zadig Toolkit 插件。
  2. 点击设置进入插件配置页。

plugin-settingplugin-setting

配置参数说明:

  1. Zadig 部署地址:请根据实际协议,填写完整的 URI,例如:http://zadig.com。
  2. Zadig API Token:进入 Zadig 系统,点击账号设置,如下图所示。

plugin-setting

配置完成后,可在左侧栏看到 Zadig 系统中的项目。

plugin-setting

如何使用

远程调试本地代码

下面以准备好的 voting-demo 项目为例,介绍如何通过 Zadig Toolkit 进行远程调试。

  • 选择 voting-demo 项目 -> dev 环境,点击环境右侧图标设置 Kube Config(即:dev 环境所在集群的 config 配置文件),可在文件目录中选择该配置文件或手动输入其路径后回车。

plugin-setting

  • 选择 vote 服务,点击调试按钮进入开发模式。

debug-service

  • 选择本地开发代码目录,本例中为 koderover/zadig -> examples -> voting-app。

debug-servicedebug-service

  • 选择开发环境使用的基础镜像 python:3.10.4-buster。

debug-servicedebug-service

  • 稍等片刻待开发模式启动执行完毕后,进入开发容器 dev,所选目录中内容将自动同步到开发容器中。

debug-servicedebug-service

  • 修改本地代码并保存:修改第一个投票按钮的背景颜色。

debug-service

  • 改动的代码会自动同步到远端 dev 开发环境。在终端中进入 vote 目录,执行启动命令。
pip install -r requirements.txt -i https://mirrors.aliyun.com/pypi/simple/
gunicorn app:app -b 0.0.0.0:80 --log-file - --access-logfile - --workers 4 --keep-alive 0

debug-service

  • 访问 vote 服务地址,修改结果如下图所示。

debug-service

  • 点击红色按钮,确定结束开发模式,容器恢复正常。

debug-servicedebug-service

至此一个完整的本地调试流程演示完毕。

查看环境和服务

日常联调测试过程中,需要对服务进行诊断,通过 Zadig Toolkit 可以查看服务的状态,重启服务,更换服务镜像,查看服务的实时日志、登录到服务对应的 Pod 中等。

  • 右键点击服务可查看服务详情,在服务详情页面中可查看服务实时日志,点击镜像右侧的修改图标可修改服务镜像。

detail_env_info

  • 右键点击服务后,点击重启服务可以对服务进行重启。

detail_env_info

  • 右键点击服务,点击终端可登录到服务对应的 Pod 中。

detail_env_info

配置远程开发环境

  • 需要修改开发环境的基础镜像,或者修改同步的本地代码目录时,可通过点击开发模式配置按钮快速设置。

配置中各字段说明:

[
  {
    "projectName": 项目名称,
    "envName": 环境名称,
    "serviceName": 服务名称,
    "containerName": 开发环境容器名称,
    "image": 开发环境基础镜像,
    "codeDir": 同步至开发环境容器中的本地目录
  }
]

dev_env_config

  • 保存自定义的开发模式配置后,点击启动开发模式,会基于配置文件中的信息快速启动开发模式。

dev_env_config