跳转至

快速开始

一键启动

docker compose -f deploy/standalone/docker-compose.yml up -d --build

# 查看启动日志
docker logs -f cmdb

# 访问
open http://localhost:8090

首次构建约 10–20 分钟(需要网络下载 go/npm 依赖)。停止:

docker compose -f deploy/standalone/docker-compose.yml down
# 数据保存在 mongodb-data volume,down 不删数据;down -v 才会清库

默认启动仅绑定宿主机 127.0.0.1:8090,使用 development-only 的免登录(skip-login)单管理员模式,适合本机联调体验。对外暴露前请阅读安全与生产门禁。

组成

组件 说明
zookeeper:3.8 服务注册发现 + 配置中心(CMDB 自身机制)
mongo:4.4 主存储,单节点副本集(依赖 change stream)
redis:6.2 缓存 / 会话
cmdb 容器 12 个 Go 服务 + 前端静态资源,单容器多进程

核心服务清单:

cmdb_apiserver      CMDB API 统一入口     cmdb_webserver       Web/前端托管
cmdb_toposerver     拓扑/模型             cmdb_hostserver      主机服务
cmdb_procserver     进程服务              cmdb_taskserver      异步任务
cmdb_eventserver    事件服务              cmdb_adminserver     配置中心/DB初始化
cmdb_coreservice    核心原子层            cmdb_cacheservice    缓存原子层
cmdb_datacollection 数据采集              cmdb_operationserver 运营统计

服务 Profile

默认 STANDALONE_PROFILE=core 只启动核心 12 个服务;可选 cloud、sync、transfer、full profile 按需启用对应服务(需要各自业务配置,未配置时不会被默认 profile 静默启用):

# 核心服务 + 云资源服务
STANDALONE_PROFILE=cloud docker compose -f deploy/standalone/docker-compose.yml up --build

# 核心服务 + 全部可选服务
STANDALONE_PROFILE=full docker compose -f deploy/standalone/docker-compose.yml up --build

登录模式

模式 启用方式 适用
skip-login(默认) 不设置任何环境变量 本机开发体验,自动以 admin 进入
内置账号 CMDB_LOGIN_VERSION=opensource + CMDB_SESSION_USERINFO='ops:密码1,dev:密码2' 无外部 IdP 的多账号场景
OIDC 配置 webServer.oidc(Issuer/ClientId 等),secret 用 CMDB_OIDC_CLIENT_SECRET 注入 对接 Casdoor / Keycloak 等标准 IdP
API Key(机器调用) CMDB_API_KEY + CMDB_API_KEY_REQUIRED=true CI / 自动化,请求带 X-API-Key 或 Bearer

内置账号示例:

CMDB_LOGIN_VERSION=opensource \
CMDB_SESSION_USERINFO='ops:强密码1,dev:强密码2' \
docker compose -f deploy/standalone/docker-compose.yml up -d
  • 未登录访问任意页面会 302 到 /login(用户名/密码表单),登录后回跳原地址;/logout 清会话。
  • login.version 的生效值由 adminserver 刷入 ZooKeeper 的配置中心提供,单独修改容器内 web.yaml 不会生效;必须通过环境变量在容器启动阶段注入并整体重建/重启。
  • shared/production 启动门禁强制要求:非 skip-login 登录模式、显式 CMDB_SESSION_USERINFO 且禁止默认 admin:admin。

关键环境变量

变量 作用
STANDALONE_ENV development(默认)/ shared / production,后两档启用启动门禁
CMDB_LOGIN_VERSION skip-login / opensource / oidc
CMDB_SESSION_USERINFO 内置账号列表 用户名:密码,逗号分隔
CMDB_SESSION_SECRET 随机会话密钥(shared/production 必填)
CMDB_API_KEY 机器调用 API Key
CMDB_API_KEY_REQUIRED true 时缺失 Key 的机器请求 fail-closed
CMDB_API_USER API Key 映射的 CMDB 用户(默认 admin)
CMDB_OIDC_CLIENT_SECRET OIDC client secret 覆盖

配置与目录

deploy/standalone/configs/ 下:

  • migrate.yaml:admin_server 本地引导配置(指向 ZK)
  • mongodb.yaml / redis.yaml / common.yaml / extra.yaml:admin_server 启动时刷入 ZK,其余服务从 ZK 拉取
  • web.yaml:web_server 本地读取(登录模式、权限模式、前端路径等)

容器内目录布局:

/data/cmdb/
├── cmdb_adminserver/          # 二进制 + configures/
├── cmdb_webserver/            # 二进制 + web.yaml + web/(前端产物)
├── cmdb_apiserver/ ...        # 其余服务,每服务一个目录
├── resources/{errors,language}/   # 错误码/多语言资源
└── logs/                      # 运行日志

更多细节见仓库 deploy/standalone/README.md。