Solo.io Gloo 网关自动发现服务配置指南

前言

在现代微服务架构中，服务发现是构建高效API网关的关键功能。Solo.io Gloo 网关提供了强大的自动发现能力，能够自动识别集群中的上游服务(Upstream)及其功能端点(Function)。本文将深入解析Gloo的自动发现机制，帮助您根据实际需求配置合适的发现模式。

自动发现服务概述

Gloo网关提供两种自动发现服务：

1. 上游发现服务(UDS)：自动发现Kubernetes集群中的服务并创建对应的上游资源
2. 功能发现服务(FDS)：自动发现服务暴露的API端点(OpenAPI/Swagger)和gRPC服务

重要提示：由于发现过程资源消耗较大，这两项服务默认都是禁用的。

上游发现服务(UDS)配置

基本工作原理

UDS会监控指定命名空间(默认为gloo-system)中的Kubernetes服务，并为每个服务端口创建对应的上游资源。上游资源的命名遵循以下格式：

<服务命名空间>-<服务名称>-<服务端口>

例如，default命名空间中的petstore服务在8080端口上运行，将生成名为default-petstore-8080的上游资源。

启用UDS

您可以通过以下三种方式启用UDS：

1. Helm Values文件配置

settings:
  create: true

discovery:
  enabled: true

2. Helm CLI参数

helm install|template ... --set settings.create=true --set discovery.enabled=true

3. 直接编辑Settings CR

kubectl edit -n gloo-system settings.gloo.solo.io

在spec部分添加：

spec:
  discovery:
    enabled: true

功能发现服务(FDS)配置

基本工作原理

FDS会尝试从上游服务中发现以下内容：

• 提供OpenAPI/Swagger文档的端点
• 启用了gRPC反射的gRPC服务

默认检查的OpenAPI端点包括：

/openapi.json
/swagger.json
/swagger/docs/v1
/swagger/docs/v2
/v1/swagger
/v2/swagger

FDS工作模式

FDS支持三种工作模式：

1. BLACKLIST模式：最宽松的策略，默认发现所有服务，除非服务或其命名空间被明确列入黑名单
2. WHITELIST模式（默认）：更严格的策略，只发现明确列入白名单的服务或命名空间中的服务
3. DISABLED模式：完全禁用FDS功能

启用和配置FDS

1. Helm Values文件配置

settings:
  create: true

discovery:
  fdsMode: BLACKLIST  # 可选值：WHITELIST, BLACKLIST, DISABLED

2. Helm CLI参数

helm install|template ... --set settings.create=true --set discovery.fdsMode=BLACKLIST

3. 直接编辑Settings CR

kubectl edit -n gloo-system settings.gloo.solo.io

在spec部分添加：

spec:
  discovery:
    fdsMode: WHITELIST
    fdsOptions:
      graphqlEnabled: true  # 企业版功能，是否启用GraphQL模式自动生成

黑名单/白名单管理

BLACKLIST模式下的排除配置

# 排除整个命名空间
kubectl label namespace default discovery.solo.io/function_discovery=disabled

# 排除特定上游
kubectl label upstream -n myapp myupstream discovery.solo.io/function_discovery=disabled

# 如果上游由UDS管理，可以直接标记服务
kubectl label service -n myapp myservice discovery.solo.io/function_discovery=disabled

WHITELIST模式下的包含配置

# 包含整个命名空间
kubectl label namespace default discovery.solo.io/function_discovery=enabled

# 包含特定上游
kubectl label upstream -n myapp myupstream discovery.solo.io/function_discovery=enabled

# 如果上游由UDS管理，可以直接标记服务
kubectl label service -n myapp myservice discovery.solo.io/function_discovery=enabled

最佳实践建议

1. 生产环境建议：在生产环境中，建议使用WHITELIST模式，只对需要被发现的服务启用FDS，减少不必要的网络探测。

2. 自定义OpenAPI位置：如果服务的OpenAPI文档不在默认路径，可以在上游资源中明确指定：

spec:
  kube:
    serviceSpec:
      rest:
        swaggerInfo:
          url: http://service.namespace:port/custom/path/swagger.json

3. 资源监控：启用发现服务后，建议监控Gloo网关的资源使用情况，特别是大型集群中。

4. 逐步启用：在大规模集群中，建议逐步启用发现服务，先使用WHITELIST模式，观察系统行为后再决定是否扩大范围。

通过合理配置Gloo的自动发现服务，您可以大幅简化API网关的管理工作，同时保持系统的稳定性和安全性。根据您的具体环境和需求选择合适的工作模式，将帮助您构建更加高效可靠的微服务架构。