You need to enable JavaScript to run this app.
导航
自定义插件模板
最近更新时间:2023.03.15 22:12:50首次发布时间:2023.03.15 22:12:50

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

运维插件是一段 YAML 格式的代码片段,能够将额外的能力附加至插件中,增强应用在运行过程中的扩展能力。团队的运维或技术专家,可将应用所需的运维能力模块化为一个个运维插件,方便开发人员在编排应用时按需取用,自由组合。

创建插件模板

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

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

      配置项说明
      选择模板支持基于系统预置的插件模板,快速创建适合本团队的插件模板。当前提供以下模板:空白模板、标签、注解、资源限制、存活探针-TCP、存活探针-HTTP、就绪探针-HTTP。详细介绍可参见 预置插件模板
      插件名称自定义当前插件模板的名称。同一工作区下插件模板名称唯一。
      插件标识根据界面提示填写插件标识。插件标识是插件模板的唯一标识,创建后不可更改。
      描述填写当前插件模板的备注信息,可以为空。

      模式

      插件的作用模式。
      当前仅支持 Patch 目标对象:以 StreategyMergePatch 方式将 YAML 片段注入到服务对象中。

      目标对象类型

      限制插件作用的目标对象类型,对应 YAML 中的 kind 属性。支持选择 Deployment、Service 或自定义。

      注意

      此处设置的目标对象类型必须与 YAML 中的 kind 属性保持一致,否则后续部署时会报错。

    • 应用编排
      根据需要对插件模板内容进行编排。

      功能说明

      编辑 YAML 内容

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

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

      说明

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

  4. 单击 确定,完成插件模板创建。

查看插件模板

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

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

使用插件模板

创建插件模板后,可前往 OAM 应用编排页面,为组件按需配置运维插件。

  1. 登录当前应用。
    1. 登录 持续交付控制台
    2. 在左侧导航栏选择 工作区
    3. 单击目标工作区名称,进入当前工作区。
    4. 在左侧导航栏选择 应用交付 > 应用管理
    5. 单击目标应用卡片,进入当前应用。
  2. 切换至应用编排页签,选择目标组件,单击 编辑,为组件按需配置运维插件。

复制插件模板

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

  1. 在 模板管理 > 插件模板 页面,选择目标插件模板,单击 操作 列的 复制

  2. 在复制模板页面,修改插件的基本信息和应用编排内容。

    注意

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

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

编辑插件模板

支持对自定义插件模板的插件名称、描述、作用的目标对象类型及应用编排内容进行修改。

  1. 在 模板管理 > 插件模板 页面,选择目标插件模板,单击 操作 列的 编辑
  2. 在更新插件模板页面,根据需要对内容进行修改。
  3. 修改完成后,单击 确定

删除插件模板

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

注意

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

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