You need to enable JavaScript to run this app.
导航
自定义组件模板
最近更新时间:2024.09.19 15:27:08首次发布时间:2023.12.28 21:22:03

应用交付提供自定义组件模板能力,您可基于系统预置的组件模板,快速创建适用本团队的模板。本文为您介绍创建、查看、使用组件模板等操作。

组件模板主要应用于 OAM 应用编排。一般由熟知 K8s YAML 的运维或技术专家,将团队常用的应用模型固化为组件模板。开发人员只需按照模板的规定填写必要的参数,即可快速完成 OAM 应用的定义和编排。

创建组件模板

基于系统预置的组件模板,快速改造适用本团队的模板。

  1. 登录模板管理页面。
    1. 登录 持续交付控制台
    2. 在左侧导航栏选择 工作区
    3. 单击目标工作区名称,进入当前工作区。
    4. 在左侧导航栏选择 应用交付 > 模板管理
  2. 模板管理 > 组件模板 页面,单击 创建组件
  3. 在创建组件模板页面,按要求配置组件模板信息。
    • 基本信息

      配置项说明

      选择模板

      支持基于系统预置的组件模板,快速创建适合本团队的组件模板。当前提供 空白模板预置 Deployment 服务模板

      • 空白模板:内容为空。适用于有明确需求,希望自行编写组件内容的场景。
      • 预置 Deployment 服务模板:系统预置的 Deployment + Service 服务模板。适用于需多次复用的任务。
      • 预置 MSE 灰度服务模板:对接火山引擎 MSE,适用于集群环境内部东西向流量的应用做灰度发布。
      • 预置 MSE 灰度服务和 Ingress 网关路由模板:对接火山引擎 MSE,适用于南北向流量第一跳的应用做灰度发布。

      组件类型

      当前仅支持创建 服务 类型的组件模板。
      服务类型的组件包含一个 Service 资源和一个 Deployment 资源,是一种基本的应用部署方式。

      组件名称自定义当前组件模板的名称。同一工作区下组件模板名称唯一。
      组件标识根据界面提示填写组件标识。组件标识是组件模板的唯一标识,创建后不可更改。
      描述填写当前组件模板的备注信息,可以为空。
    • 应用编排
      根据需要对组件模板内容进行编排。

      功能说明

      添加资源

      单击右上角 +,添加需要的资源。

      • 应用类型:支持 ConfigmapDeploymentService自定义 类型的资源。
      • 名称:自定义资源名称,同一组件下资源名称唯一。

      说明

      • 每个组件可由 1~10 个资源组成,每个组件只能包含 1 个 Deployment 资源。
      • 一个资源 YAML 中,仅支持一种 kind。
      修改资源名称在左侧 YAML 编辑区域,将鼠标悬浮在资源标题处。单击出现的修改图标,即可修改资源名称。

      编辑 YAML 内容

      在左侧 YAML 编辑区域,按照 YAML 规范编写 YAML 内容。
      编写过程中,支持通过以下两种方式使用占位符:

      • 在左侧 YAML 编辑区域敲击{{ .AppDeliver. }}引用预置占位符,敲击{{ .Values. }}引用自定义占位符。单击 提取占位符 ,右侧占位符管理区域同步显示新增的占位符名称。设置占位符的显示名、类型、默认值及描述信息。
      • 在右侧占位符管理区域,单击 添加,新增一个占位符。设置占位符的名称、显示名、类型、默认值及描述信息。之后在左侧 YAML 编辑区域引用该占位符。

      说明

      占位符是模板中的变量。您可将组件中需要开发人员关注的参数配置成占位符,并填充默认值。方便开发人员引用,快速完成 OAM 应用编排。

      删除资源在左侧 YAML 编辑区域,找到需要删除的资源卡片,单击标题旁边的 ×,即可删除不需要的资源。
  4. 单击 确定,完成组件模板创建。

查看组件模板

支持在组件模板页面查看本工作区下所有的组件模板,包括预置组件模板和自定义组件模板。

  1. 模板管理 > 组件模板 页面,查看当前工作区下所有组件模板。
  2. 单击目标组件名称,进入组件详情页面,查看组件的 YAML 详情。

使用组件模板

创建组件模板后,可前往 OAM 应用编排页面。引用组件模板,快速编排 OAM 应用的组成组件及部署顺序。

  1. 登录当前应用。
    1. 登录 持续交付控制台
    2. 在左侧导航栏选择 工作区
    3. 单击目标工作区名称,进入当前工作区。
    4. 在左侧导航栏选择 应用交付 > 应用管理
    5. 单击目标应用卡片,进入当前应用。
  2. 切换至应用编排页签,单击 添加组件,选择组件模板并进行编排。

同步组件配置

通过同步组件配置功能,可将该模板的最新配置一键同步至所有关联的组件。

  1. 模板管理 > 组件模板 页面,选择目标组件模板,单击 操作 列的 同步组件配置
  2. 在弹出的二次确认框中,单击 确定。该模板的最新配置将同步至所有引用该模板的组件。

复制组件模板

通过复制组件模板功能,可基于已有模板,快速创建新的组件模板。

  1. 模板管理 > 组件模板 页面,选择目标组件模板,单击 操作 列的 复制
  2. 在复制模板页面,修改组件的基本信息和应用编排内容。

    注意

    同一工作区下的组件模板名称和组件标识唯一。请务必修改组件模板名称和组件标识。

  3. 修改完成后,单击 确定,生成新的组件模板。

编辑组件模板

支持对自定义组件模板的组件名称、描述及应用编排内容进行修改。

  1. 模板管理 > 组件模板 页面,选择目标组件模板,单击 操作 列的 编辑
  2. 在更新组件模板页面,根据需要对内容进行修改。
  3. 修改完成后,支持以下两种操作:
    • 单击 保存,保存当前修改,但不会对引用该模板的组件进行同步更新。
    • 单击 保存并同步配置,保存当前修改,并对引用该模板的组件进行同步更新。

删除组件模板

支持删除不再使用的自定义组件模板。删除组件模板后,已引用模板的组件不受影响。

注意

被最新应用编排版本所引用的模板,不允许被删除。

  1. 在 模板管理 > 组件模板 页面,选择目标组件模板,单击 操作 列的 ... > 删除
  2. 在弹出的二次确认框中,单击 确定,删除该组件模板。