GoRules Agent 镜像文档

概述

GoRules Agent 是一个独立的微服务，作为高性能无头（Headless）规则引擎通过 REST 接口运行，无需用户界面（UI）。其核心功能是从对象存储服务拉取规则版本（Releases），在规则发生变更时自动重新加载，并高效执行决策模型评估。该服务确保规则始终保持最新状态，且仅需最小化配置即可通过 API 访问。

核心功能与特性

• 高性能规则执行：优化的决策模型评估引擎，支持高并发规则执行场景。
• REST API 接口：通过 HTTP 接口提供规则评估能力，易于集成到各类后端系统。
• 自动同步与重载：实时监控对象存储中的规则版本（Releases），变更时自动加载，无需重启服务。
• 无头架构：无需 UI 交互，专注于规则执行能力，适合后端集成场景。
• 多对象存储支持：兼容 AWS S3、Azure Storage、Google Cloud Storage（GCS）及 MinIO 等主流对象存储服务。

使用场景与适用范围

• 后端规则自动化：需通过 API 触发规则评估的后端系统（如风控决策、流程自动化、业务规则校验等）。
• 动态规则更新：规则频繁变更且需实时生效的场景（如促销规则、合规政策调整），避免服务重启。
• 微服务架构集成：作为独立规则引擎组件，嵌入微服务架构，解耦业务代码与规则逻辑。
• 无头规则执行：无需 UI 交互，仅需通过 API 调用规则引擎的场景。

使用方法与部署

前置条件

• 已安装 Docker 环境。
• 已配置目标对象存储服务（AWS S3/Azure/GCP/MinIO 等），并获取访问凭证（如密钥、连接字符串等）。

Docker 部署示例

1. 基础运行命令格式

docker run -d \
  --name gorules-agent \
  -p <host-port>:<container-port> \  # 假设默认容器端口为 8080（具体请参考官方文档）
  -e PROVIDER__TYPE=<storage-type> \
  [其他环境变量] \
  gorules/agent:latest

2. 按存储类型的部署示例

AWS S3（支持 IAM 认证）

若部署环境支持 IAM（如 AWS ECS/EKS），AWS_ACCESS_KEY_ID 和 AWS_SECRET_ACCESS_KEY 为可选：

docker run -d \
  --name gorules-agent-s3 \
  -p 8080:8080 \
  -e PROVIDER__TYPE=S3 \
  -e PROVIDER__BUCKET=my-rules-bucket \
  -e PROVIDER__REGION=us-east-1 \  # IAM 环境下可选
  -e AWS_ACCESS_KEY_ID=AKIAEXAMPLE \  # IAM 环境下可选
  -e AWS_SECRET_ACCESS_KEY=secret \  # IAM 环境下可选
  gorules/agent:latest

Azure Storage

docker run -d \
  --name gorules-agent-azure \
  -p 8080:8080 \
  -e PROVIDER__TYPE=AzureStorage \
  -e PROVIDER__CONNECTION_STRING="DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=mykey;EndpointSuffix=core.windows.net" \
  -e PROVIDER__CONTAINER=my-rules-container \
  gorules/agent:latest

Google Cloud Storage (GCS)

docker run -d \
  --name gorules-agent-gcs \
  -p 8080:8080 \
  -e PROVIDER__TYPE=GCS \
  -e PROVIDER__BUCKET=my-rules-bucket \
  -e PROVIDER__BASE64_CONTENTS="base64-encoded-gcs-credentials" \  # GCS 服务账号密钥 JSON 的 Base64 编码内容
  gorules/agent:latest

MinIO

docker run -d \
  --name gorules-agent-minio \
  -p 8080:8080 \
  -e PROVIDER__TYPE=S3 \
  -e PROVIDER__REGION=us-east-1 \
  -e PROVIDER__BUCKET=my-rules-bucket \
  -e PROVIDER__FORCE_PATH_STYLE=true \  # MinIO 需启用路径样式访问
  -e PROVIDER__ENDPOINT=[***] \  # MinIO 服务端点
  -e PROVIDER__PREFIX=rules-folder/ \  # 可选，规则文件在桶中的路径前缀
  -e AWS_ACCESS_KEY_ID=minio-access-key \
  -e AWS_SECRET_ACCESS_KEY=minio-secret-key \
  gorules/agent:latest

Docker Compose 配置示例

version: '3.8'
services:
  gorules-agent:
    image: gorules/agent:latest
    container_name: gorules-agent
    ports:
      - "8080:8080"
    environment:
      - PROVIDER__TYPE=S3  # 或 AzureStorage/GCS
      - PROVIDER__BUCKET=my-rules-bucket
      - PROVIDER__REGION=us-east-1
      # 其他存储类型所需环境变量（根据实际选择添加）
    restart: unless-stopped

配置参数说明

GoRules Agent 通过环境变量配置对象存储连接及运行参数，以下按存储类型分类说明：

通用参数

AWS S3 存储

Azure Storage 存储

Google Cloud Storage (GCS) 存储

MinIO 存储（S3 兼容）

MinIO 配置复用 S3 类型参数，需额外设置以下参数：

参考链接

• 官方网站
• 完整文档