adevinta/vulcan-stream

Vulcan Stream

镜像概述和主要用途

Vulcan Stream提供从Vulcan Persistence到Vulcan Agents的单向通信通道。Vulcan Persistence需要与Vulcan Agents进行广播通信，以管理Agent池和控制执行中的检查。由于Agent可能无法从互联网访问，Stream提供Websocket流，供Agent连接以接收来自Persistence的输入。

核心功能和特性

通信流程

!通信流程图

依赖服务

Vulcan Stream基于两个主要服务运行：

• Postgres NOTIFY/LISTEN
• https://github.com/danfaizer/gowse

Vulcan Stream利用Postgres的NOTIFY/LISTEN功能将实时消息发布到Websocket流。

为什么使用Postgres NOTIFY/LISTEN

我们曾考虑使用AWS SNS和/或SQS接收Vulcan Persistence的通知并向Websocket流发布消息。但由于AWS SNS/SQS的特性、实现的简洁性，以及Vulcan基础设施中已将Postgres作为需求，我们认为NOTIFY/LISTEN功能是实现实时广播通知的最佳方案，具备适当的弹性和可扩展性。

使用场景和适用范围

适用于Vulcan生态系统中，当Vulcan Agents可能无法从互联网访问时，需Vulcan Persistence向多个Agent广播控制信息（如管理Agent池、控制检查执行）的场景，提供可靠的单向实时通信。

详细使用方法和配置说明

构建与运行

提供两个二进制文件：

• vulcan-stream
• vulcan-stream-test-client

假设您的机器上已安装Docker，且端口5432和8080没有服务监听。

运行vulcan-stream：

bash
go get -x github.com/adevinta/vulcan-stream/cmd/vulcan-stream

docker run -d -p 5432:5432 -e POSTGRES_USER=postgres -e POSTGRES_DB=stream postgres

vulcan-stream ${GOPATH}/src/github.com/adevinta/vulcan-stream/_resources/config/local.toml

运行websocket客户端集成测试：

bash
go get -x github.com/adevinta/vulcan-stream/cmd/vulcan-stream-test-client

vulcan-stream-test-client ${GOPATH}/src/github.com/adevinta/vulcan-stream/_resources/config/local.toml

连接流并发送通知消息：

bash
curl --include --no-buffer --header "Connection: Upgrade" --header "Upgrade: websocket" \
        --header "Host: localhost:8080" --header "Origin: http://localhost:8080" \
        --header "Sec-WebSocket-Key: SGVsbG8sIHdvcmxkIQ==" --header "Sec-WebSocket-Version: 13" \
        "http://localhost:8080/stream" &

psql -c "NOTIFY events, '{\"action\":\"test\", \"check_id\":\"00000000-0000-0000-0000-000000000000\"}';" \
-U postgres -h localhost stream

配置说明

可查看和修改Vulcan Stream配置文件：

_resources/config/local.toml

Docker部署示例

环境变量说明

Docker命令

bash
# 构建镜像
docker build . -t vs

# 使用默认配置文件并通过环境变量自定义
docker run --env-file ./local.env vs

# 使用自定义配置文件
docker run -v `pwd`/custom.toml:/app/config.toml vs