CN112600931A - 一种api网关部署方法及装置 - Google Patents

Abstract

本申请涉及微服务技术领域，特别涉及一种API网关部署方法及装置。该方法包括：基于容器化应用管理平台的helm，创建包括用于部署Kong实例所需的清单文件模板的应用包；轮询预设的针对每一待部署Kong实例配置的参数列表，采用所述应用包中各清单文件模板，分别生成该待部署Kong实例对应的部署文件，其中，一个待部署Kong实例对应的部署文件至少包括针对该待部署Kong实例配置的各参数值；基于各部署文件，分别生成对应的Kong实例。

Description

一种API网关部署方法及装置

技术领域

本申请涉及微服务技术领域，特别涉及一种API网关部署方法及装置。

背景技术

API服务最基本的作用是接受来自客户端的请求并返回响应。然而，在当今蓬勃发展的微服务架构下，情况却并非如此简单。开发者们通常需要考虑API的安全防护、流量控制、分析与监控及计费等问题，而API网关便是解决这些问题的标配方案。

API网关是位于客户端与后端服务集合之间的API管理工具，为API调用者提供了统一入口，接受来自客户端的API调用，通过路由机制转发到后端服务。Kong是一款基于Nginx与Lua模块编写的高性能、易扩展的API网关项目，它通过插件的形式提供身份验证，速率限制，负载均衡，日志记录，协议转换等功能。

单实例的Kong网关很可能会成为***的性能瓶颈。因此，如何实现一个多实例分布式的高性能高可用的API网关方案，是一个重要的问题。Kong官方给出的一种基于Docker容器技术的部署方案，Kong与PostgreSQL以容器的形式部署在docker环境之中。要实现Kong的集群部署，只需在官方方案的基础上部署多个Kong容器即可。所有的Kong节点均连接至同一个PostgreSQL数据库，以实现API网关配置的数据同步。

然而，各Kong实例仅以容器的方式部署，在Kong实例跨服务器部署时，无法有效进行编排、管理和调度，在对Kong实例进行扩容时，需要通过docker命令或者接口来完成，实现过程较复杂。

发明内容

本申请提供了一种API网关部署方法及装置，用以解决现有技术中存在的各实例无法进行高效管理，调度和扩容的问题。

第一方面，本申请提供了API网关部署方法，所述方法包括：

基于容器化应用管理平台的helm，创建包括用于部署Kong实例所需的清单文件模板的应用包；

轮询预设的针对每一待部署Kong实例配置的参数列表，采用所述应用包中各清单文件模板，分别生成该待部署Kong实例对应的部署文件，其中，一个待部署Kong实例对应的部署文件至少包括针对该待部署Kong实例配置的各参数值；

基于各部署文件，分别生成对应的Kong实例。

可选地，一个待部署Kong实例对应的参数列表至少包括：为该待部署Kong实例配置的IP地址信息，为该待部署Kong实例配置的端口信息和用于唯一标识该待部署Kong实例的实例名称。

可选地，一个待部署Kong实例对应的参数列表还包括：集群中用于部署Kong实例的节点信息，该待部署Kong实例的CPU及内存的启动限制和运行限制。

可选地，基于各部署文件，分别生成对应的Kong实例的步骤包括：

在接收到Kong实例部署请求时，确定集群中用于部署Kong实例的目标节点；

根据各部署文件，分别在所述目标节点上部署对应Kong实例。

可选地，所述方法还包括：

将部署至目标节点上的各Kong实例的IP地址添加至所述目标节点的网卡中，以使得该Kong实例启动时，基于所述网卡中的对应的IP地址与外部设备进行通信。

第二方面，本申请提供了一种API网关部署装置，所述装置包括：

创建单元，用于基于容器化应用管理平台的helm，创建包括用于部署Kong实例所需的清单文件模板的应用包；

第一生成单元，用于轮询预设的针对每一待部署Kong实例配置的参数列表，采用所述应用包中各清单文件模板，分别生成该待部署Kong实例对应的部署文件，其中，一个待部署Kong实例对应的部署文件至少包括针对该待部署Kong实例配置的各参数值；

第二生成单元，用于基于各部署文件，分别生成对应的Kong实例。

可选地，一个待部署Kong实例对应的参数列表至少包括：为该待部署Kong实例配置的IP地址信息，为该待部署Kong实例配置的端口信息和用于唯一标识该待部署Kong实例的实例名称。

可选地，一个待部署Kong实例对应的参数列表还包括：集群中用于部署Kong实例的节点信息，该待部署Kong实例的CPU及内存的启动限制和运行限制。

可选地，基于各部署文件，分别生成对应的Kong实例时，所述第二生成单元具体用于：

在接收到Kong实例部署请求时，确定集群中用于部署Kong实例的目标节点；

根据各部署文件，分别在所述目标节点上部署对应Kong实例。

可选地，所述装置还包括：

添加单元，用于将部署至目标节点上的各Kong实例的IP地址添加至所述目标节点的网卡中，以使得该Kong实例启动时，基于所述网卡中的对应的IP地址与外部设备进行通信。

第三方面，本申请实施例提供了一种API网关部署装置，该API网关部署装置包括：

存储器，用于存储程序指令；

处理器，用于调用所述存储器中存储的程序指令，按照获得的程序指令执行如上述第一方面中任一项所述的方法的步骤。

第四方面，本申请实施例还提供了一种计算机可读存储介质，所述计算机可读存储介质存储有计算机可执行指令，所述计算机可执行指令用于使所述计算机执行如上述第一方面中任一项所述方法的步骤。

综上可知，本申请实施例提供的API网关部署方法，基于容器化应用管理平台的helm，创建包括用于部署Kong实例所需的清单文件模板的应用包；轮询预设的针对每一待部署Kong实例配置的参数列表，采用所述应用包中各清单文件模板，分别生成该待部署Kong实例对应的部署文件，其中，一个待部署Kong实例对应的部署文件至少包括针对该待部署Kong实例配置的各参数值；基于各部署文件，分别生成对应的Kong实例。

采用本申请实施例提供的API网关部署方法，通过helm工具自动部署Kong实例集群，Kong实例以集群的方式管理，调度Kong实例，Kong实例的扩展操作简单灵活，提升了API网关的高可用性。

附图说明

为了更加清楚地说明本申请实施例或者现有技术中的技术方案，下面将对本申请实施例或者现有技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本申请中记载的一些实施例，对于本领域普通技术人员来讲，还可以根据本申请实施例的这些附图获得其他的附图。

图1为本申请实施例提供的一种API网关部署方法的详细流程图；

图2为本申请实施例提供的一种API网关部署装置的结构示意图；

图3为本申请实施例提供的另一种API网关部署装置的结构示意图。

具体实施方式

在本申请实施例使用的术语仅仅是出于描述特定实施例的目的，而非限制本申请。本申请和权利要求书中所使用的单数形式的“一种”、“所述”和“该”也旨在包括多数形式，除非上下文清楚地表示其它含义。还应当理解，本文中使用的术语“和/或”是指包含一个或多个相关联的列出项目的任何或所有可能组合。

应当理解，尽管在本申请实施例可能采用术语第一、第二、第三等来描述各种信息，但这些信息不应限于这些术语。这些术语仅用来将同一类型的信息彼此区分开。例如，在不脱离本申请范围的情况下，第一信息也可以被称为第二信息，类似地，第二信息也可以被称为第一信息。取决于语境，此外，所使用的词语“如果”可以被解释成为“在……时”或“当……时”或“响应于确定”。

下面结合具体用于场景对本申请实施例提供的云桌面***进行详细说明，示例性的，参阅图1所示，为本申请实施例提供的一种API网关部署方法的详细流程图，该方法包括以下步骤：

步骤100：基于容器化应用管理平台的helm，创建包括用于部署Kong实例所需的清单文件模板的应用包。

实际应用中，Helm是Kubernetes的包管理工具，每个包称为一个Chart，一个Chart中会包含一些模板化的Kubernetes清单文件，它们位于templates目录中。这些模板是一些YAML文件，它们经渲染后会被提交给Kubernetes，从而生成期望的Kubernetes资源，如Service，Deployment(部署文件)，Statefulset，Job等。

本申请实施例中，容器化应用管理平台可以是Kubernetes，那么，即可基于Kubernetes的Helm，创建一个Helm Chart，该Helm Chart包含一些位于templates目录的模板化的Kubernetes清单文件，如，kong.yaml，values.yaml文件等。

步骤110：轮询预设的针对每一待部署Kong实例配置的参数列表，采用上述应用包中各清单文件模板，分别生成该待部署Kong实例对应的部署文件，其中，一个待部署Kong实例对应的部署文件至少包括针对该待部署Kong实例配置的各参数值。

本申请实施例中，一种较佳的实现方式为，一个待部署Kong实例对应的参数列表至少包括：为该待部署Kong实例配置的IP地址信息，为该待部署Kong实例配置的端口信息和用于唯一标识该待部署Kong实例的实例名称。

例如，待部署Kong实例包括Kong实例1，Kong实例2和Kong实例3，那么，Kong实例1对应的参数包括：Kong1，KongIP1，kongHttpAdminPort1，kongHttpsAdminPort2，kongHttpProxyPort1，kongHttpsProxyPort2，其中，Kong1用于唯一标识Kong实例1，KongIP1表示Kong实例1的IP地址，kongHttpAdminPort1与kongHttpsAdminPort2分别表示Admin的HTTP与HTTPS端口；kongHttpProxyPort1与kongHttpsProxyPort2分别表示Proxy的HTTP与HTTPS端口。

本申请实施例中，提供了一种Kong实例名称的简单生成规则：将Kong实例的IPV4地址转换成十六进制作为Kong实例名称的值，如IP为“192.168.1.100”的Kong实例，其Kong实例名称的值为“c0a80164”。那么，Kong实例名称的生成规则可与IP地址相关，从而在删除指定IP的Kong实例或添加Kong实例时，可以方便地实现目标Deployment的增加与删除。

当然，本申请实施例中，上述Kong实例名称生成规则只是用于示例，而并非用于限定本申请。

进一步地，一个待部署Kong实例对应的参数列表还包括：集群中用于部署Kong实例的节点信息，该待部署Kong实例的CPU及内存的启动限制和运行限制。

例如，假设集群包括9个节点，节点1-节点3划分为区域1，节点4-节点6划分为区域2，节点7-节点9划分为区域3，配置的用于部署API网关的区域为区域3，那么，一个待部署Kong实例对应的参数列表中则可以携带用于部署Kong实例的节点信息(如，在节点7-节点9中部署API网关)。

进一步地，本申请实施例中，所谓CPU启动限制(limits)指的是：对应Kong实例最少可使用的CPU资源值，CPU运行限制(requests)指的是：对应Kong实例最多可使用的CPU资源值；内存启动限制指的是：对应Kong实例最少可使用的内存资源，内存运行限制指的是：对应Kong实例最多可使用的内存资源值。

具体地，上述Helm Chart包括的kong.yaml文件配置了与kong相关的Kubernetes资源模板，通过它可以生成Kong的Deployment，进而控制多实例Pod的生成。在kong.yaml中是通过一段循环语句来灵活控制Deployment的配置的。在进行参数配置时，将各待部署Kong实例的参数值下发至Values.yaml文件中，Values.yaml文件中的Values.kongNodes是自定义配置的Kong实例参数列表，循环遍历该列表，记每个元素为kongNode，它包含了各待部署的Kong实例的IP地址信息，端口信息，实例name等值，这些值分别作用于每个待部署Kong实例对应的Deployment。

Deployment中的参数replicas，是Pod中Kong实例的副本数，在本申请实施例中设置为1，每个kong实例都有一个单独的Deployment来控制。

需要说明的是，Deployment中的环境变量KONG_ADMIN_LISTEN与KONG_PROXY_LISTEN，是用来配置Kong实例Admin与Proxy的监听参数。Proxy端口用于代理后端服务，Admin端口用于管理Kong配置，对Kong的配置进行增、删、改、查操作。

步骤120：基于各部署文件，分别生成对应的Kong实例。

本申请实施例中，在基于各部署文件，分别生成对应的Kong实例时，一种较佳的实现方式为，在接收到Kong实例部署请求时，确定集群中用于部署Kong实例的目标节点；根据各部署文件，分别在所述目标节点上部署对应Kong实例。

由于一个待部署Kong实例对应的参数列表中携带有用于部署Kong实例的节点信息，那么，即可确定集群中用于部署Kong实例的目标节点，然后，基于预设规则，在目标节点上部署Kong实例。

例如，在生成各待部署Kong实例分别对应的部署文件之后，就可以向Helm服务端发送部署请求了。具体地，Tiller Server是Helm的服务端，它使用gRPC与客户端进行通信。当Tiller监听到客户端的“helm install”请求之后，基于各待部署Kong实例的部署文件，与Kubernetes API服务进行交互，完成各Kong实例的部署。

进一步地，将部署至目标节点上的各Kong实例的IP地址添加至所述目标节点的网卡中，以使得该Kong实例启动时，基于所述网卡中的对应的IP地址与外部设备进行通信。

例如，为了使得外部设备能通过指定的IP地址访问API网关，这里将hostNetwork配置为true，这样Pod就可以使用宿主机节点的网络设备了。在Kong实例启动之前，先将待绑定的IP地址(待启动的Kong实例的IP地址)写入到Pod所在宿主机网卡中，从而Kong实例启动的时候就可正常使用此IP地址了。写入的操作可以在Kong镜像里的entrypoint脚本中添加“ip addr add”命令来实现。另外，在Pod终止前调用PreStop回调执行“ip addr del”命令，以完成IP的删除操作。

进一步地，当Kong集群需要添加或删减Kong实例时，就需要对Kong集群进行升级了。升级的步骤与部署基本一致，只需要修改参数配置，在升级时发送“'helm upgrade”请求即可。

基于与上述发明实施例同样的发明构思，示例性的，参阅图2所示，为本申请实施例提供的一种API网关部署装置的结构示意图，该装置包括：

创建单元20，用于基于容器化应用管理平台的helm，创建包括用于部署Kong实例所需的清单文件模板的应用包；

第一生成单元21，用于轮询预设的针对每一待部署Kong实例配置的参数列表，采用所述应用包中各清单文件模板，分别生成该待部署Kong实例对应的部署文件，其中，一个待部署Kong实例对应的部署文件至少包括针对该待部署Kong实例配置的各参数值；

第二生成单元22，用于基于各部署文件，分别生成对应的Kong实例。

可选地，一个待部署Kong实例对应的参数列表至少包括：为该待部署Kong实例配置的IP地址信息，为该待部署Kong实例配置的端口信息和用于唯一标识该待部署Kong实例的实例名称。

可选地，一个待部署Kong实例对应的参数列表还包括：集群中用于部署Kong实例的节点信息，该待部署Kong实例的CPU及内存的启动限制和运行限制。

可选地，基于各部署文件，分别生成对应的Kong实例时，所述第二生成单元具体用于：

在接收到Kong实例部署请求时，确定集群中用于部署Kong实例的目标节点；

根据各部署文件，分别在所述目标节点上部署对应Kong实例。

可选地，所述装置还包括：

添加单元，用于将部署至目标节点上的各Kong实例的IP地址添加至所述目标节点的网卡中，以使得该Kong实例启动时，基于所述网卡中的对应的IP地址与外部设备进行通信。

以上这些单元可以是被配置成实施以上方法的一个或多个集成电路，例如：一个或多个特定集成电路(Application Specific Integrated Circuit，简称ASIC)，或，一个或多个微处理器(digital singnal processor，简称DSP)，或，一个或者多个现场可编程门阵列(Field Programmable Gate Array，简称FPGA)等。再如，当以上某个单元通过处理元件调度程序代码的形式实现时，该处理元件可以是通用处理器，例如中央处理器(CentralProcessing Unit，简称CPU)或其它可以调用程序代码的处理器。再如，这些单元可以集成在一起，以片上***(system-on-a-chip，简称SOC)的形式实现。

进一步地，本申请实施例提供的API网关部署装置，从硬件层面而言，所述API网关部署装置的硬件架构示意图可以参见图3所示，所述API网关部署装置可以包括：存储器30和处理器31，

存储器30用于存储程序指令；处理器31调用存储器30中存储的程序指令，按照获得的程序指令执行上述方法实施例。具体实现方式和技术效果类似，这里不再赘述。

可选地，本申请还提供一种API网关部署设备，包括用于执行上述方法实施例的至少一个处理元件(或芯片)。

可选地，本申请还提供一种程序产品，例如计算机可读存储介质，该计算机可读存储介质存储有计算机可执行指令，该计算机可执行指令用于使该计算机执行上述方法实施例。

这里，机器可读存储介质可以是任何电子、磁性、光学或其它物理存储装置，可以包含或存储信息，如可执行指令、数据，等等。例如，机器可读存储介质可以是：RAM(RadomAccess Memory，随机存取存储器)、易失存储器、非易失性存储器、闪存、存储驱动器(如硬盘驱动器)、固态硬盘、任何类型的存储盘(如光盘、dvd等)，或者类似的存储介质，或者它们的组合。

上述实施例阐明的***、装置、模块或单元，具体可以由计算机芯片或实体实现，或者由具有某种功能的产品来实现。一种典型的实现设备为计算机，计算机的具体形式可以是个人计算机、膝上型计算机、蜂窝电话、相机电话、智能电话、个人数字助理、媒体播放器、导航设备、电子邮件收发设备、游戏控制台、平板计算机、可穿戴设备或者这些设备中的任意几种设备的组合。

为了描述的方便，描述以上装置时以功能分为各种单元分别描述。当然，在实施本申请时可以把各单元的功能在同一个或多个软件和/或硬件中实现。

本领域内的技术人员应明白，本申请的实施例可提供为方法、***、或计算机程序产品。因此，本申请可采用完全硬件实施例、完全软件实施例、或结合软件和硬件方面的实施例的形式。而且，本申请实施例可采用在一个或多个其中包含有计算机可用程序代码的计算机可用存储介质(包括但不限于磁盘存储器、CD-ROM、光学存储器等)上实施的计算机程序产品的形式。

本申请是参照根据本申请实施例的方法、设备(***)、和计算机程序产品的流程图和/或方框图来描述的。应理解可以由计算机程序指令实现流程图和/或方框图中的每一流程和/或方框、以及流程图和/或方框图中的流程和/或方框的结合。可提供这些计算机程序指令到通用计算机、专用计算机、嵌入式处理机或其它可编程数据处理设备的处理器以产生一个机器，使得通过计算机或其它可编程数据处理设备的处理器执行的指令产生用于实现在流程图一个流程或多个流程和/或方框图一个方框或多个方框中指定的功能的装置。

而且，这些计算机程序指令也可以存储在能引导计算机或其它可编程数据处理设备以特定方式工作的计算机可读存储器中，使得存储在该计算机可读存储器中的指令产生包括指令装置的制造品，该指令装置实现在流程图一个流程或者多个流程和/或方框图一个方框或者多个方框中指定的功能。

这些计算机程序指令也可装载到计算机或其它可编程数据处理设备上，使得在计算机或者其它可编程设备上执行一系列操作步骤以产生计算机实现的处理，从而在计算机或其它可编程设备上执行的指令提供用于实现在流程图一个流程或多个流程和/或方框图一个方框或多个方框中指定的功能的步骤。

以上所述仅为本申请的较佳实施例而已，并不用以限制本申请，凡在本申请的精神和原则之内，所做的任何修改、等同替换、改进等，均应包含在本申请保护的范围之内。

Claims (10)

1.一种API网关部署方法，其特征在于，所述方法包括：

基于容器化应用管理平台的helm，创建包括用于部署Kong实例所需的清单文件模板的应用包；

轮询预设的针对每一待部署Kong实例配置的参数列表，采用所述应用包中各清单文件模板，分别生成该待部署Kong实例对应的部署文件，其中，一个待部署Kong实例对应的部署文件至少包括针对该待部署Kong实例配置的各参数值；

基于各部署文件，分别生成对应的Kong实例。

2.如权利要求1所述的方法，其特征在于，一个待部署Kong实例对应的参数列表至少包括：为该待部署Kong实例配置的IP地址信息，为该待部署Kong实例配置的端口信息和用于唯一标识该待部署Kong实例的实例名称。

3.如权利要求2所述的方法，其特征在于，一个待部署Kong实例对应的参数列表还包括：集群中用于部署Kong实例的节点信息，该待部署Kong实例的CPU及内存的启动限制和运行限制。

4.如权利要求1-3任一项所述的方法，其特征在于，基于各部署文件，分别生成对应的Kong实例的步骤包括：

在接收到Kong实例部署请求时，确定集群中用于部署Kong实例的目标节点；

根据各部署文件，分别在所述目标节点上部署对应Kong实例。

5.如权利要求4所述的方法，其特征在于，所述方法还包括：

将部署至目标节点上的各Kong实例的IP地址添加至所述目标节点的网卡中，以使得该Kong实例启动时，基于所述网卡中的对应的IP地址与外部设备进行通信。

6.一种API网关部署装置，其特征在于，所述装置包括：

创建单元，用于基于容器化应用管理平台的helm，创建包括用于部署Kong实例所需的清单文件模板的应用包；

第一生成单元，用于轮询预设的针对每一待部署Kong实例配置的参数列表，采用所述应用包中各清单文件模板，分别生成该待部署Kong实例对应的部署文件，其中，一个待部署Kong实例对应的部署文件至少包括针对该待部署Kong实例配置的各参数值；

第二生成单元，用于基于各部署文件，分别生成对应的Kong实例。

7.如权利要求6所述的装置，其特征在于，一个待部署Kong实例对应的参数列表至少包括：为该待部署Kong实例配置的IP地址信息，为该待部署Kong实例配置的端口信息和用于唯一标识该待部署Kong实例的实例名称。

8.如权利要求7所述的装置，其特征在于，一个待部署Kong实例对应的参数列表还包括：集群中用于部署Kong实例的节点信息，该待部署Kong实例的CPU及内存的启动限制和运行限制。

9.如权利要求6-8任一项所述的装置，其特征在于，基于各部署文件，分别生成对应的Kong实例时，所述第二生成单元具体用于：

在接收到Kong实例部署请求时，确定集群中用于部署Kong实例的目标节点；

根据各部署文件，分别在所述目标节点上部署对应Kong实例。

10.如权利要求9所述的装置，其特征在于，所述装置还包括：

添加单元，用于将部署至目标节点上的各Kong实例的IP地址添加至所述目标节点的网卡中，以使得该Kong实例启动时，基于所述网卡中的对应的IP地址与外部设备进行通信。

Images