文档

管理插件

更新时间:

云原生API网关提供了插件市场,内置认证鉴权、流量管控、安全防护等多种功能扩展插件,支持您上传自定义插件,可以对网关进行灵活、个性化的能力扩展。本文主要介绍如何安装、启用、卸载插件。

插件介绍

云原生API网关插件市场中的插件,依据插件来源,主要分为以下三类:

  • 官方插件:Higress官方开放到插件市场的插件。

  • 社区插件:Higress社区贡献到插件市场的插件。

  • 自定义插件:用户上传到插件市场的插件,仅供用户自身使用。

安装并启用插件

安装插件是指将云原生API网关插件市场中的插件安装到具体的网关实例的过程,任何插件要在网关实例上生效,必须先安装插件、然后配置规则,最后启用插件。云原生API网关提供了如下两种方式安装插件:

说明
  • 路由级插件规则:作用在路由上,当请求匹配到指定路由时,规则生效。

  • 域名级插件规则:作用在域名上,特定域名的匹配优先级高于泛域名。

  • 实例级插件规则:作业在网关全局,当路由和域名级规则都没有匹配到的时候则匹配该规则。

方式一:在插件市场安装

  1. 登录云原生API网关控制台

  2. 在左侧导航栏,选择插件市场

  3. 在顶部菜单栏选择地域。

  4. 插件市场页面的快捷导航栏处,选择插件类型或者搜索插件名称,单击插件卡片上的安装,在弹出的安装插件框中选择需要使用此插件的网关实例,单击确定

  5. 配置栏中,单击目标网关实例操作列下的规则配置,在规则配置页面选择生效范围

    • 当选择路由级插件规则域名级插件规则时,单击添加规则,在添加路由级别规则添加域名级别规则页面,打开启用状态(默认开启),选择生效目标并配置插件规则,单击确定

    • 当选择实例级插件规则时,打开启用状态(默认开启)并配置插件规则,单击保存

方式二:在网关实例页面安装

  1. 登录云原生API网关控制台

  2. 在左侧导航栏,选择实例,并在顶部菜单栏选择地域。

  3. 实例页面,单击目标网关实例名称。

  4. 在左侧导航栏,选择插件。

  5. 单击安装插件,在安装插件页面的快捷导航处,选择要安装的插件类型或者搜索插件名称,单击插件卡片,在弹出的安装插件框中,单击安装并配置

  6. 在弹框添加实例级别规则页面,打开启用状态(默认开启)并配置插件规则,单击确定

  7. (可选)您可通过网关实例页面,在左侧导航栏选择插件,单击插件列表操作列中的规则配置,为所选插件配置规则并选择生效范围。

    • 当选择路由级插件规则域名级插件规则时,单击添加规则,在添加路由级别规则添加域名级别规则页面,打开启用状态(默认开启),选择生效目标并配置插件规则,单击确定

    • 当选择实例级插件规则时,打开启用状态(默认开启)并配置插件规则,单击保存

卸载插件

使用背景

当您想要将插件彻底从网关上删除时,您可以选择卸载插件。云原生API网关提供了如下两种方式卸载插件:

重要

卸载插件时,如果存在启用的插件规则,请先停用插件再卸载;如果插件未启用,卸载插件会将配置的插件规则一并删除。

方式一:在插件市场卸载

  1. 登录云原生API网关控制台

  2. 在左侧导航栏,选择插件市场

  3. 在顶部菜单栏选择地域。

  4. 插件市场页面的快捷导航栏处,选择插件类型或者搜索插件名称,单击要卸载的插件卡片。

  5. 单击配置栏,在要卸载此插件的网关实例操作栏中,单击卸载

  6. 在弹出框中,点击确认按钮,页面提示卸载插件成功。

方式二:在网关实例页面卸载

  1. 登录云原生API网关控制台

  2. 在左侧导航栏,选择实例,并在顶部菜单栏选择地域。

  3. 实例页面,单击目标网关实例名称。

  4. 在左侧导航栏,选择插件。

  5. 在插件列表中,单击所要卸载插件操作列中的卸载

  6. 在弹出框中单击确认按钮,页面提示卸载插件成功。