快速入门

# 快速开始

本快速入门指南介绍了金蝶Apusic负载均衡软件v2.0产品的功能和使用，为用户快速使用本产品提供指导。

# 基本介绍

金蝶Apusic负载均衡软件（Apusic Load Balance，ALB）是一款具备高性能、高可用性和可扩展性的流量治理软件。ALB能够应对大规模的集群、云平台在面向客户端提供服务时，对客户端访问请求和流量管理的需求，实现访问请求的验证、处理、转换和分发等操作，从而隔离客户端访问对提供服务的应用系统、平台以及资源的直接影响，达到对服务集群访问流量控制、访问管理和负载均衡的目的。

# 产品功能架构

ALB标准版的功能如下图所示：

# Web管制台的使用

管理控制台是一个基于Web的GUI管理和监控工具，用于网关节点、流量策略、负载均衡算法配置以及安全配置等，并支持多个环境的动态配置。

# 登录管理控制台

打开浏览器（推荐Chrome、firefox），输入地址 http://serverIP:serverPort/ 进入到管理控制台登录页面。

例如：将ALB部署在172.20.140.137端口默认为9000，登录地址则为：http://172.20.140.137:9000

输入用户名密码登录管理控制台。

用户名为： admin
初始密码为：apusic$alb

# 路由

路由（Route）是请求的入口点，它定义了客户端请求与服务之间的匹配规则。路由可以与服务（Service）、上游（Upstream）关联，一个服务可对应一组路由，一个路由可以对应一个上游对象（一组后端服务节点），因此，每个匹配到路由的请求将被网关代理到路由绑定的上游服务中。

路由列表如下图所示：

# 创建路由

可通过两种方式创建路由：

界面创建
使用编辑器创建

分为四个步骤：

定义API请求
定义API后端服务
插件配置
预览

# 界面创建路由

以界面创建为例介绍路由的创建过程

设置路由信息：

填写路由基本信息

名称：必输项，自定义路由名称，不允许配置重名路由
发布：默认开启，开启状态下路由才会生效

填写请求信息：

域名：alb服务器域名
路径：必输项，默认所有路径/*，可以是路由的详细路径或者泛路径（以/*结尾）
客户端地址：允许访问的客户端IP或IP网段
优先级：必输项，默认为0，路由配置相同时取优先级高的路由
请求改写：对客户端的请求的协议、路径、域名、请求头进行改写

# 定义API后端服务

配置上游信息：

选择上游服务：选择已经添加的上游服务时不可编辑上游，手动填写才能编辑上游服务
负载均衡算法：必选项，默认带权轮询
上游类型：必选项，默认为节点
目标节点：必输项，输入目标服务器主机名或者IP地址、端口
权重：必输项，输入上游服务器的权重，权重高的节点承受的流量多，权重配置为0时熔断该节点
协议类型：必选项，选择客户端请求的类型
超时时间：必输项，默认超时时间为6S

# 插件配置

插件配置根据自定义可选择普通方式或插件编排方式选择插件：

$C:\Users\a\Downloads\ALB1.0安装和使用手册\ALB安装和使用手册\assets\images\user-guide\plugin-create-1-1.png$

启用插件：

# 预览

# 查看路由

点击路由列表右侧【查看】操作按钮，通过JSON格式或YAML格式查看创建的路由详细信息

示例Json数据：

{
    "uri":"/\*",
    "name":"testALB",
    "methods":[
        "GET",
        "POST",
        "PUT",
        "DELETE",
        "PATCH",
        "HEAD",
        "OPTIONS",
        "CONNECT",
        "TRACE"
    ],
    "upstream":{
        "nodes":{
            "172.18.100.159":1
        },
        "timeout":{
            "connect":6,
            "send":6,
            "read":6
        },
        "type":"roundrobin",
        "scheme":"http",
        "pass_host":"pass",
        "keepalive_pool":{
            "idle_timeout":60,
            "requests":1000,
            "size":320
        }
    },
    "status":1
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

# 路由操作

在路由列表中实现对路由的发布、下线、编辑、查看、删除、复制

编辑：编辑路由基本信息或上游服务节点信息，动态生效无需重启
查看：通过JSON格式或YUML格式查看路由
复制：复制路由所有信息，名称不可与原名称相同
下线\发布：路由下线和发布动态生效，无需重启ALB
删除：删除路由信息不保存

# 上游

上游列表包含了已创建的上游服务（即后端服务），可以对上游服务的多个目标节点进行负载均衡和健康检查。

# 上游列表

# 创建上游

可以通过两种方式进行上游的创建：

界面创建
使用编辑器创建

下图是使用界面创建：

下图是使用编辑器创建：

# 服务

服务由路由中公共的插件配置、上游目标信息组合而成。服务与路由、上游关联，一个服务可对应一组上游节点、可被多条路由绑定。

服务列表

创建服务

可通过两种方式创建服务。

界面创建
使用编辑器创建

# 插件

已启用插件的列表

内置插件：
- 认证：keycloak鉴权、openID连接
- 通用：批量请求、回显、重定向、前后附加函数等
- 日志：错误日志、HTTP日志、kafka日志、阿里云日志、TCP日志等
- 监控：节点状态、prometheus、skywalking等
- 协议转换：dubbo代理
- 安全：启用CORS、ip黑白名单、referer限制、请求拦截等
- 流量控制：API熔断、限制并发连接、限制请求次数等
- 报文转换：故障注入、gPRC转码、响应信息重写等
自定义插件:

可以根据实际业务编写插件，插件允许在常见阶段进行挂载生效，例如init, rewrite，access，balancer,header filter，body filter 和 log 阶段。

插件列表