stevengueguen/warp10

Warp 10 Docker镜像

快速参考

• 获取帮助的渠道：

  • 官网：[***]
  • Warp10社区Slack：[***]
  • Stack Overflow：https://stackoverflow.com/questions/tagged/warp10

• Warp10平台仓库： https://github.com/senx/warp10-platform

• Warp10 Docker仓库： https://github.com/senx/warp10-docker

• 维护方： SenX

什么是Warp10

观看Warp10演示视频

Warp10平台用于收集、存储和处理传感器数据。传感器数据以测量序列（即时间序列）形式摄入，平台支持为每个测量添加空间元数据（地理坐标和/或传感器海拔），形成Geo Time Series（GTS，地理时间序列）。

使用Docker是搭建Warp10平台的最简方式，官方镜像包含：

• Warp10平台（存储和分析GTS）
• WarpStudio（与平台交互的Web应用）
• Sensision（平台指标监控服务）
• HFStore扩展（管理历史文件HFile）

启动Warp10实例

绑定外部端口8080（Warp10）和8081（WarpStudio）启动镜像：

bash
docker run -d -p 8080:8080 -p 8081:8081 warp10io/warp10:<tag>

其中<tag>为你需要的Warp10版本标签。

挂载卷实现持久化

Docker容器删除后会丢失存储和配置，建议将容器的/data目录映射到卷：

bash
docker run -d -p 8080:8080 -p 8081:8081 --volume=mydata:/data warp10io/warp10:<tag>

示例中mydata卷会自动创建（若不存在），推荐使用Docker卷而非绑定挂载，且后续所有Warp10镜像命令需保持相同--volume参数。

内存模式运行

添加-e FLAVOR=in-memory启动内存实例（默认保留最近48小时数据，可配置）：

bash
docker run -d -p 8080:8080 -p 8081:8081 -e FLAVOR=in-memory warp10io/warp10:<tag>

禁用Sensision

默认Sensision收集实例使用指标（如GTS数量、函数调用次数）并存储在平台中，可添加-e NO_SENSISION=true禁用：

bash
docker run -d -p 8080:8080 -p 8081:8081 -e NO_SENSISION=true warp10io/warp10:<tag>

设置JVM堆大小

通过环境变量设置JVM堆大小：

• 初始堆大小（Xms）：WARP10_HEAP
• 最大堆大小（Xmx）：WARP10_HEAP_MAX 默认值为1g（WARP10_HEAP=1g，WARP10_HEAP_MAX=1g）：

bash
docker run -d -p 8080:8080 -p 8081:8081 -e WARP10_HEAP=8g -e WARP10_HEAP_MAX=8g warp10io/warp10:<tag>

持续集成（CI）版本

Docker Hub提供带ci后缀的CI版本，内置READ/WRITE令牌readTokenCI和writeTokenCI： 示例：

bash
curl -v -H 'X-Warp10-Token: writeTokenCI' --data-binary "1// test{} 42" 'http://127.0.0.1:8080/api/v0/update'

bash
[ 'readTokenCI' '~.*' {} NOW -1 ] FETCH // 获取所有GTS的最后一个数据点

获取令牌

Warp10平台采用基于数据生产者、数据所有者、应用及WRITE/READ令牌的安全模型。CI版本内置预生成令牌，其他版本需通过TokenGen生成：

1. 创建envelope文件（示例）：

warpscript
'myapp' 'applicationName' STORE
NOW 1 ADDYEARS 'expiryDate' STORE
UUID 'ownerAndProducer' STORE

{
  'id' 'TokenRead'
  'type' 'READ'
  'application' $applicationName
  'owner'  $ownerAndProducer
  'issuance' NOW
  'expiry' $expiryDate
  'labels' { }
  'attributes' { }
  'owners' [ $ownerAndProducer ]
  'producers' [ $ownerAndProducer ]
  'applications' [ $applicationName ]
}
TOKENGEN

{
  'id' 'TokenWrite'
  'type' 'WRITE'
  'application' $applicationName
  'owner'  $ownerAndProducer
  'producer' $ownerAndProducer
  'issuance' NOW
  'expiry' $expiryDate
  'labels' { }
  'attributes' { }
}
TOKENGEN

2. 执行TokenGen命令：

bash
docker exec -i <container_id> warp10-standalone.sh tokengen - < envelope.mc2

测试容器

1. 使用WRITE令牌推送数据：

bash
curl -v -H 'X-Warp10-Token: WRITE_TOKEN' --data-binary "1// test{} 42" 'http://127.0.0.1:8080/api/v0/update'

应返回HTTP 200。（注：Mac/Windows系统需替换127.0.0.1为容器实际IP，可通过docker-machine ip default获取）

2. 使用READ令牌获取数据：

bash
curl -v --data-binary "[ 'READ_TOKEN' 'test' {} NOW -1 ] FETCH" 'http://127.0.0.1:8080/api/v0/exec'

应返回HTTP 200及JSON格式数据点。

使用WarpStudio

WarpStudio是与Warp10平台交互的Web应用，镜像中内置独立版本（监听8081端口）。Linux系统可通过127.0.0.1:8081访问，Mac/Windows需替换为容器实际IP。

配置Warp10

有多种配置方式：

1. 额外配置文件：映射/config.extra目录添加自定义配置：

bash
docker run -d -p 8080:8080 -p 8081:8081 -v /custom/99-custom.conf:/config.extra/99-custom.conf warp10io/warp10:<tag>

2. 环境变量：

bash
docker run -d -p 8080:8080 -p 8081:8081 -e warpscript.maxops=100000 -e warpscript.maxfetch=1000000 warp10io/warp10:<tag>

3. 环境文件：

bash
docker run -d -p 8080:8080 -p 8081:8081 --env-file=./myconf.env warp10io/warp10:<tag>

可混合使用，示例docker-compose：

yaml
services:
  warp10:
    image: warp10io/warp10:<tag>
    volumes:
      - warp10_data:/data
      - /var/warp10/99-custom.conf:/config.extra/99-custom.conf
    ports:
      - '8080:8080'
      - '8081:8081'
    environment:
      - warpscript.maxops=100000
      - warpscript.maxfetch=1000000
    env_file: custom.env
volumes:
  warp10_data:

构建镜像

若需自定义镜像：

1. 克隆仓库：

bash
git clone https://github.com/senx/warp10-docker.git

2. 构建镜像：

bash
cd warp10-docker
docker build -t myrepo/warp10:x.y.z -f ubuntu/Dockerfile .

Windows用户指南

先安装Docker（可选DockStation），启动命令：

bash
docker run --volume=c:\\warp10:/data -p 8080:8080 -p 8081:8081 -d -i warp10io/warp10:<tag>