K8s YAML 服务

    进入项目的服务管理页面。

    系统支持以下三种方式创建 K8s YAML 服务：

    • ：在创建服务时手工输入服务的 K8s YAML 配置文件。
    • 从代码库同步：从代码库中同步服务的 K8s YAML 配置，一次同步可创建一个服务也可创建多个服务。当代码库中的服务配置有变更时，会通过 Webhook 自动更新 Zadig 平台中的服务配置。
    • 使用模板新建：使用 Zadig 平台中的服务 K8s YAML 模板来创建服务。

    点击手工输入按钮 -> 填写服务名称 -> 将服务 K8s YAML 填入编辑器 -> 点击保存按钮，即可新建服务。

    创建服务

    添加服务成功后即可对环境进行更新：点击环境更新，选择要更新的环境，将服务加入到环境中。

    从代码库同步单个服务

    提示

    1. 需要在系统中集成代码源，可参考：
    2. 目前支持从 GitLab//Gerrit/ 代码源同步服务

    服务的 YAML 配置组织在单独的文件夹中，点击从代码库同步按钮 -> 选择具体的代码库和服务配置文件所在的目录 -> 点击同步，即可从代码库同步新建服务。

    以 resultK8s YAML 服务 - 图4 (opens new window) 服务为例：

    同步后，效果如下：

    从代码库同步创建服务效果

    从代码库同步多个服务

    提示

    1. 需要在系统中集成代码源，可参考：代码源集成
    2. 目前支持从 /GitHub//Gitee 代码源同步服务

    多个服务的 YAML 配置分别组织在同一级目录的单独文件夹中，点击从代码库同步按钮 -> 选择具体的代码库和多个服务配置文件所在的目录 -> 点击同步，即可从代码库同步新建多个服务。

    以 项目中的 5 个服务为例说明，多个服务的配置文件组织：

    从代码库同步多个服务：

    从代码库批量同步创建服务

    同步后，效果如下：

    使用模板新建服务

    前提

    需要先在系统模板库里创建 K8s YAML 模板，请参考 。

    点击新建按钮 -> 选择使用模板新建 -> 填写服务名称，选择模板后填写相关配置 -> 点击新建，即可使用此模板和赋值的变量新建服务。

    • 变量配置可使用模板中的默认值，也可以在新建时重新赋值

    使用 K8s YAML 模板

    从 Kubernetes 导入

    点击新建按钮 -> 选择从 Kubernetes 导入 -> 填写以下信息后导入即可。

    • 选择集群：要导入的服务所在的 K8s 集群，其中本地集群指 Zadig 所在的集群
    • 选择命名空间：要导入的服务所在的 K8s 命名空间
    • 点击添加服务后填写服务名称，选择资源类型及对应的配置，目前支持选择 deployment/statefulset/service/ingress/secret/configmap/pvc 资源进行导入

    创建服务成功后，可点击查看服务配置的具体内容，按需对其进行修改保存。点击加入环境可将该服务加入到环境中。

    提示

    从 K8s 导入

    更新服务

    下面分别介绍如何更新使用不同方式新建的服务。

    修改服务的 K8s YAML 内容并保存即可。

    服务修改成功后即可对环境进行更新：点击环境更新，选择要更新的环境对环境中的服务进行更新。

    更新环境中的服务

    更新从代码库同步的服务

    • 提交服务配置变更到代码仓库。

    • 变更合并后，会通过 Webhook 的能力自动同步最新配置到 Zadig 系统。也可以在界面上手动同步服务配置，如下图所示。

    服务手动配置同步

    • 在环境中，查看服务配置变更，点击更新服务钮执行更新操作。

    服务更新

    更新使用模板新建的服务

    方式一：基于模板内容同步

    点击服务名右侧的同步按钮 -> 选择模板 -> 按需填写变量配置即可。

    提示

    更新服务时：

    1. 如果不切换模板，则系统会将服务中已保存过的变量和模板中的自定义变量做合并，对于在两者中都存在的 key，默认使用服务中已保存过的值。
    2. 如果切换模板，则系统会使用新模板中的自定义变量来作为服务的变量配置。

    配置变更

    方式二：直接编辑

    点击使用模板新建的服务 -> 点击预览/编辑，即可预览/编辑该服务的 K8s YAML 配置。

    更新从 Kubernetes 导入的服务

    点击从 Kubernetes 导入的服务即可预览该服务配置的详细内容，修改内容后保存即可。

    更新服务配置

    删除服务

    点击服务右侧的删除按钮即可将服务删除。

    服务组件

    可参考服务组件了解更多信息，此处相关字段说明如下：

    • 服务组件：YAML 配置文件中 container 的名称。
    • 镜像名：系统会按照仓库地址/命名空间/镜像名:标签名规则来解析 YAML 配置文件中的 image，标签名前即为镜像名。
    • 当前镜像版本：YAML 配置文件中，container 的 image 信息
    • 构建信息/操作：可为服务组件配置构建操作，定义其构建过程，参考：

    服务编排

    点击服务编排图标，按需对服务启动顺序进行拖拽组合。

    K8s 服务编排

    共享服务

    • 设置共享服务：点击服务右侧的共享按钮即可设置该服务为共享服务。

    • 使用共享服务：在共享服务列表中，点击服务右侧的+即可将该服务添加到当前项目中，且服务右侧会有共享字段标识。

    添加 K8s YAML 共享服务

    扩展阅读

    • 使用共享服务只是复用服务的定义，并不是共享服务实例。在不同项目的环境中，相同的共享服务也是独立的服务实例。
    • 使用其他项目中的共享服务时，构建过程会使用该共享服务对应的构建脚本。

    系统内置变量

    包括 $Namespace$、$Product$、$Service$、$EnvName$，可直接在 YAML 中进行引用，具体说明如下：

    • $Namespace$：项目创建的环境所在的 K8s 空间名称，不可用于容器名称和镜像信息中
    • $Product$：项目名称
    • $Service$：服务名称
    • $EnvName$：创建的环境名称，不可用于容器名称和镜像信息中

    服务的 YAML 配置文件中形如 {{.Key}} 的内容会被自动解析为全局变量。

    变量

    点击按钮并填写 Value 内容即可在平台中对变量赋予默认值，点击 Value 右侧的预览图标可查看其具体值。

    对于不同形式的默认值，在填写时需要满足一定的格式，以下述 YAML 配置中第 24 行的 envSetting 变量为例说明。

    点击查看

    1. apiVersion: apps/v1
    2. kind: Deployment
    3. metadata:
    4.   name: a
    5.   labels:
    6.     app: a
    7. spec:
    8.   selector:
    9.     matchLabels:
    10.       app: a
    11.   replicas: 1
    12.   template:
    13.     metadata:
    14.       labels:
    15.         app: a
    16.     spec:
    17.       - name: nginx-1
    18.         image: ccr.ccs.tencentyun.com/demotest/myapp-1:v0.1__linux_amd64
    19.         imagePullPolicy: Always
    20.         command: ["/myapp-1"]
    21.         args: ["--downstream-addr", "$(DOWNSTREAM_ADDR)", "--headers", "$(HEADERS)"]
    22.         env: 
    23.           {{.envSetting}}
    24.         ports:
    25.         - containerPort: 8080

    行内表示法

    envSetting 的值用一行完整表示时，直接填写符合 YAML 语法的内容即可。

    行间表示法

    envSetting 的值用多行表示时，填写符合 YAML 语法的代码段即可

    1. - name: DOWNSTREAM_ADDR
    2.   value: "b"
    3. - name: HEADERS
    4.   value: "x-request-id"

    点击全局变量右侧的效果预览，可查看对配置文件中变量值进行渲染后的效果。

    变量示例

    以下述 YAML 配置文件为例说明：

    1. 第 4、11 行引用内置变量 ，无需赋予默认值，在创建环境时内置变量会被自动渲染替换
    2. 第 7 行引用全局变量 portal_host，在创建环境时可以使用默认值也可以再次修改

    变量的使用

    创建集成环境时使用

    在创建环境时，对项目中所有服务的 YAML 和服务配置文件进行渲染。

    创建集成环境变量渲染

    环境变量更新时使用

    在环境中，对于正常运行中的服务，可以自行更新变量值，基本操作中点击更新环境变量，即可更新对应环境中的环境变量。

    策略配置

    在策略中设置部署服务的超时时间、服务配置更新后是否自动同步更新环境以及交付物命名规则。

    服务策略配置

    基本说明

    • 服务部署超时设置：将服务部署到环境中的超时时间，默认值为 10 分钟。若超出该阈值服务仍未处于 Running 状态，则视为部署超时。
    • 服务自动更新设置：开启后，若服务配置变更，Zadig 会自动对包含该服务的环境进行更新，应用最新的服务配置。
    • 交付物命名规则设置：自定义该项目中工作流构建产物的命名规则，可通过以下和常量组合的方式设置，对当前项目的所有服务都生效。其中 JENKINS 生成镜像规则适用于使用 Jenkins 构建 的服务，不可使用下述中的 REPO_* 变量。

    内置变量

    服务 YAML 样例

    概念：服务运行的实例不会在本地存储需要持久化的数据，并且多个实例对于同一个请求响应的结果是完全一致的。可以参考了解无状态服务的更多细节。

    点击查看

    1. apiVersion: apps/v1
    2. kind: Deployment
    3. metadata:
    4.   name: nginx-deployment
    5. spec:
    6.   selector:
    7.     matchLabels:
    8.       app: nginx
    9.   replicas: 2 # 2 个 Pod 实例
    10.   template:
    11.     metadata:
    12.       labels:
    13.         app: nginx
    14.     spec:
    15.       containers:
    16.       - name: nginx
    17.         image: nginx:1.14.2
    18.         ports:

    有状态服务

    概念：服务的实例可以将一部分数据随时进行备份，并且在创建一个新的有状态服务时，可以通过备份恢复这些数据，以达到数据持久化的目的。可以参考了解有状态服务的更多细节。

    点击查看