Gateway API 实践之（六）FSM Gateway 的健康检查功能

FSM Gateway 流量管理策略系列：

故障注入
黑白名单访问控制
限速
重试
会话保持
健康检查
负载均衡算法
TLS 上游
双向 TLS

网关的健康检查功能是一种自动化监控机制，用于定期检查和验证后端服务的健康状况，确保流量只被转发到那些健康且能正常处理请求的服务。这一功能在微服务或分布式系统中尤为关键，因为它通过及时识别并隔离故障或性能下降的服务，来维护系统的高可用性和弹性。

通过健康检查，网关能够保证请求负载被有效地分配到运行良好的服务上，从而提高整体系统的稳定性和响应速度。

前置条件

Kubernetes 集群
kubectl 工具

环境准备

安装 FSM Gateway

FSM Gateway 的安装，可以参考安装文档。这里选择 CLI 的方式安装。

下载 FSM CLI。

shell 复制代码

system=$(uname -s | tr '[:upper:]' '[:lower:]')
arch=$(uname -m | sed -E 's/x86_/amd/' | sed -E 's/aarch/arm/')
release=v1.2.0
curl -L https://github.com/flomesh-io/fsm/releases/download/$release/fsm-$release-$system-$arch.tar.gz | tar -vxzf -
./$system-$arch/fsm version
sudo cp ./$system-$arch/fsm /usr/local/bin/fsm

在安装 FSM 时启用 FSM Gateway，默认情况是不启用的。

shell 复制代码

fsm install \
    --set=fsm.fsmGateway.enabled=true

部署示例应用

为了验证健康检查功能，需要两个不同健康状态的端点。因此我们创建了 Service pipy，并为其创建了两个返回不同响应的端点。这两个端点使用可编程代理 Pipy 来模拟的。

shell 复制代码

kubectl create namespace server
kubectl apply -n server -f - <<EOF
apiVersion: v1
kind: Service
metadata:
  name: pipy
spec:
  selector:
    app: pipy
  ports:
    - protocol: TCP
      port: 8080
      targetPort: 8080

---
apiVersion: v1
kind: Pod
metadata:
  name: pipy-1
  labels:
    app: pipy
spec:
  containers:
  - name: pipy
    image: flomesh/pipy:0.99.0-2
    command: ["pipy", "-e", "pipy().listen(8080).serveHTTP(new Message({status: 200},'Hello, world'))"]

---
apiVersion: v1
kind: Pod
metadata:
  name: pipy-2
  labels:
    app: pipy
spec:
  containers:
  - name: pipy
    image: flomesh/pipy:0.99.0-2
    command: ["pipy", "-e", "pipy().listen(8080).serveHTTP(new Message({status: 503},'Service unavailable'))"]
EOF

创建网关和路由

接下来创建网关并为 Service pipy 创建路由。

shell 复制代码

kubectl apply -n server -f - <<EOF
apiVersion: gateway.networking.k8s.io/v1beta1
kind: Gateway
metadata:
  name: simple-fsm-gateway
spec:
  gatewayClassName: fsm-gateway-cls
  listeners:
  - protocol: HTTP
    port: 8000
    name: http
    allowedRoutes:
      namespaces:
        from: Same
---
apiVersion: gateway.networking.k8s.io/v1beta1
kind: HTTPRoute
metadata:
  name: fortio-route
spec:
  parentRefs:
  - name: simple-fsm-gateway
    port: 8000
  rules:
  - matches:
    - path:
        type: PathPrefix
        value: /
    backendRefs:
    - name: pipy
      port: 8080
EOF

检查应用是否可以正常访问。通过结果可以看到，网关将请求负载均衡到了两个端点上：一个健康端点和一个不健康端点。

shell 复制代码

export GATEWAY_IP=$(kubectl get svc -n server -l app=fsm-gateway -o jsonpath='{.items[0].status.loadBalancer.ingress[0].ip}')

curl -o /dev/null -s -w '%{http_code}' http://$GATEWAY_IP:8000/
200

 curl -o /dev/null -s -w '%{http_code}' http://$GATEWAY_IP:8000/
503

健康检查功能测试

接下来配置健康检查策略。

targetRef 指定策略作用的目标资源，在此策略中目标资源只能是 K8s core 中的 Service 。此处我们指定命名空间 server 下的 pipy。
ports` 服务的端口列表，由于服务可能暴露多个端口，可以为不同的端口这是重试策略。
- port 服务端口，设置为本示例中 pipy 服务的 8080。
- config 策略的核心配置。
  - interval：健康检查间隔，表示系统对后端服务进行健康检查的时间间隔。
  - maxFails：最大失败次数，定义了在将上游服务标记为不可用之前，可以连续失败的健康检查次数。这是一个关键参数，因为它决定了系统在决定服务不健康之前的容忍度。
  - failTimeout：失败超时，定义了一个上游服务在被标记为不健康后，将被暂时禁用的时间长度。这意味着，即使服务再次变得可用，它也会在这段时间内被代理视为不可用。
  - path：健康检查路径，用于 HTTP 健康检查的路径。
  - matches：匹配条件，用于确定 HTTP 健康检查的成功或失败。此字段可以包含多个条件，例如期望的 HTTP 状态码、响应体内容等。
    - statusCodes：匹配 HTTP 响应的状态码列表，如 [200,201,204]。
    - body：匹配 HTTP 响应的主体内容。
    - headers：匹配 HTTP 响应的头部信息。此字段是可选的。
      - name：它定义了你想在 HTTP 响应头部中匹配的具体字段名。例如，如果你想检查 Content-Type 头部的值，你会设置 name 为 Content-Type。此字段只在 Type 设置为 headers 时有效，其他情况下不应该设置。此字段是可选的。
      - value：期望的数据。定义了预期的匹配值。例如，

详细的策略配置可以参考官方文档 HealthCheckPolicy。

shell 复制代码

kubectl apply -n server -f - <<EOF
apiVersion: gateway.flomesh.io/v1alpha1
kind: HealthCheckPolicy
metadata:
  name: health-check-policy-sample
spec:
  targetRef:
    group: ""
    kind: Service
    name: pipy
    namespace: server
  ports:
  - port: 8080
    config: 
      interval: 10
      maxFails: 3
      failTimeout: 1
      path: /healthz
      matches:
      - statusCodes: 
        - 200
        - 201
EOF

此时，我们尝试多次请求可以发现都会收到 200 的响应，说明不健康的端点已经被网关隔离了。

shell 复制代码

curl -o /dev/null -s -w '%{http_code}' http://$GATEWAY_IP:8000/
200

 curl -o /dev/null -s -w '%{http_code}' http://$GATEWAY_IP:8000/
200

curl -o /dev/null -s -w '%{http_code}' http://$GATEWAY_IP:8000/
200

关于 Flomesh

Flomesh（易衡科技）成立于 2018 年，自主研发并开源了高性能可编程代理 Pipy(https://github.com/flomesh-io/pipy)。以 Pipy 为基础，Flomesh 研发了软件负载均衡、服务网格两款软件产品。为工信部认证的可信云产品、可信开源项目。

Flomesh 核心竞争力来自完全自研的核心组件 Pipy，该组件高性能、高可靠、低延迟、可编程、可扩展、低依赖，采用 C++ 开发，内置自研的 JS 引擎，支持适用 JS 脚本做扩展开发。支持包括 x86、arm、龙芯、海光等硬件 CPU 架构；支持 Linux、FreeBSD、OpenWrt 等多种核心的操作系统。

Flomesh 成立以来，以技术为根基、以客户为导向，产品被应用在头部股份制商业银行总行、大型保险公司、运营商总部以及研究院等众多客户和多个场景。