jmpsec/osctrl-admin

osctrl Docker镜像文档

镜像概述和主要用途

osctrl是一个快速高效的osquery管理解决方案，实现了osquery远程API作为TLS端点。该镜像提供osctrl的核心功能，主要用于集中管理所有运行osquery的系统，包括配置分发、状态监控、日志收集和按需查询等管理任务。

核心功能和特性

• 系统监控：实时监控所有运行osquery的系统状态
• 配置分发：快速向目标系统分发osquery配置
• 日志收集：集中收集osquery生成的状态日志和查询结果日志
• 按需查询：支持对运行osquery的系统执行临时查询操作
• 高效性能：采用优化架构设计，确保管理操作快速响应

使用场景和适用范围

• 企业级系统管理：适用于需要集中管控多台运行osquery的服务器或终端设备的企业环境
• 监控平台集成：作为osquery监控架构的核心组件，与监控系统联动实现实时状态跟踪
• 日志分析场景：配合日志分析工具，集中处理osquery生成的系统日志数据
• 临时信息查询：满足对特定系统执行即时查询以获取实时数据的需求

使用方法和配置说明

基本部署

拉取镜像

bash
docker pull osctrl:latest

启动容器

基本启动命令（需配置TLS证书以支持osquery远程API）：

bash
docker run -d --name osctrl \
  -p 443:443 \
  -v /host/path/to/tls:/tls \
  -e TLS_CERT=/tls/server.crt \
  -e TLS_KEY=/tls/server.key \
  osctrl:latest

关键配置参数

数据持久化

为避免容器重启后配置和日志丢失，建议挂载数据卷：

bash
docker run -d --name osctrl \
  -p 443:443 \
  -v /host/path/to/tls:/tls \
  -v /host/path/to/data:/data \
  -e TLS_CERT=/tls/server.crt \
  -e TLS_KEY=/tls/server.key \
  -e DATA_PATH=/data \
  osctrl:latest

注意事项

• TLS证书需与osquery客户端配置匹配，确保API通信安全
• 根据管理的osquery节点数量调整容器资源（CPU/内存）配置
• 生产环境建议使用docker-compose或Kubernetes进行编排管理，确保高可用性