admin

module
v0.0.0-...-2d4ef54 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 15, 2026 License: MIT

README

moox-admin

控制面:登录认证、业务空间、服务目录、主机登记与部署、密钥、控制台终端(SSH)、系统初始化和采集发布租约;管理台 API 的唯一入口,并为各节点网关下发路由。

设计文档:管理后台

构建与测试

./scripts/build/build.sh admin
./scripts/build/build.sh admin-cli
go test -count=1 ./modules/admin/...

配置

config/trpc_go.yaml(服务与端口)、config/app.yaml、config/console.yaml(控制台);schema 在 schema/admin.sql。

离线初始化与恢复

moox-admin-cli bootstrap 不依赖运行中的服务,参数为 --topology-file、--db-path、--encryption-key-file、--pki-dir、--output-dir。拓扑输入是部署 CLI 提取的 0600 JSON(版本 1),只含 control_host_id 和 hosts;每台主机包含 host_id、address、可选的 private_address、region、description 及完整业务 components 列表。主机组件由 DAO 自动维护,不能出现在该列表中。

命令建立 schema,按与在线 API 相同的校验在一个事务内写入拓扑和全部调用方密钥,验证或生成 MooX CA,提交后发布完整的 control 网关配置、证书与签名文件。输出只有包目录、相对路径、KeyID、证书摘要和逐文件摘要等元数据,包中的 bundle.json 保存同一份清单。配置路径统一为 host-gateway/config/app.yaml。主密钥与 CA 始终留在持久目录;输出中的 operator/caller-moox-cli.key 及 operator/gateway-client.yaml 只供部署端取回,配置记录实际分配的 KeyID 与相对密钥路径。Admin 启动时将 MOOX_ADMIN_ENCRYPTION_KEY_FILE 指向同一份持久主密钥。

重跑复用 CA、主密钥和调用方密钥,保留主机与组件启停状态;每次部署重新签发叶证书。已存在加密记录却丢失主密钥,或已有网关密钥却丢失 CA 时,必须恢复原件。数据库提交后的输出错误可直接重跑,失败暂存目录不会成为可安装包。

后续主机部署先通过 SyncHostDeployments 登记,再经 control 的可信 SSH 执行 moox-admin-cli host-bundle --host-id <目标主机> --control-host-id <控制主机> --db-path <现有数据库> --encryption-key-file <持久主密钥> --pki-dir <持久CA目录> --output-dir <私密输出父目录>。该命令只使用现有数据库、主密钥和 CA,从持久拓扑读取目标地址与完整部署,事务性地生成缺少的调用方密钥、复用已有 KeyID,再为本次部署重签叶证书并发布新的 0700 包;所有文件为 0600。停用主机和组件的材料也可导出,启停状态保持不变。未登记主机、错误控制主机、丢失或损坏的身份材料均拒绝继续。

普通主机包只包含目标主机和它所部署组件的签名身份;control 才包含 console,正常重部署不导出操作员身份。包含 Access 的主机另有 secrets/access/access-verification.json 及外部调用方验证文件,保留轮换重叠期,退役后下次导出移除旧项;内部身份不进入该表。CA 私钥和 Admin 主密钥不进入任何输出包。bundle.json 的 files 覆盖全部载荷文件(自身除外),记录 SHA256 与长度,供部署端传输时核对。

离线恢复使用 host set-status 或 deployment set-status,两者均要求 --db-path、--control-host-id、--host-id、--status enabled|disabled;后者还要求 --component-id。数据库必须是已有的 0600 普通文件,恢复命令不会建表。受保护对象及目录校验规则与在线 API 相同。

原生部署 CLI 已通过 unitbootstrap、unitdeploy 和 unitinstall 接入 SSH 导出取回、摘要校验、配置身份注入及操作员身份安装;部署操作见部署与运维。代码能力不代表任一环境已经完成部署,实际状态以部署记录与就绪检查为准。

证书巡检

Admin 启动时及每天检查 MooX CA 和数据库中全部主机的公有证书清单(包括停用主机),检查有效期、CA 签名、服务端用途及主机 ID/公网/私网 SAN。证书在 90 天内到期时发出 warning;缺失、损坏、过期或不匹配时发出 critical,同轮发现按级别汇总。EventBus CA 仍独立检查。

MOOX_ADMIN_PKI_DIR 指向 bootstrap 的持久 --pki-dir;未设置时使用 Admin 主密钥文件同目录下的 pki/,未提供主密钥文件路径时默认为 ../secrets/pki。巡检只读取 ca.crt 与 hosts/<host-id>.crt,不读取私钥或签名密钥,不创建或修复文件。首次初始化时其他主机可能尚未签发证书,这类发现会告警并保留定时巡检,允许控制面启动,以便后续部署和换发证书。

Admin 的 Auth、Ssh、SpaceMgr、SecretMgr、SysDeploy、Setup、CollectorPublishLease、GatewayControl 与 ActivityLog 九个内部服务仅在 loopback 提供原生 tRPC,端口为 11100、11106~11113;Setup 启动预检同时校验此协议。Console 与健康接口继续使用 HTTP。浏览器调用由生成的 handler 在进程内分派,机器调用经主机网关校验各自身份。

Directories

Path Synopsis
cmd
cli command
e2e-console command
e2e-console 通过 Console HTTPS 入口做真实登录并调用各业务服务,用于部署后的端到端验证。
e2e-console 通过 Console HTTPS 入口做真实登录并调用各业务服务,用于部署后的端到端验证。
server command
internal
config
Package config 提供统一的配置管理
Package config 提供统一的配置管理
pki
Package pki owns the persistent MooX private CA and deployment-time host certificate issuance.
Package pki owns the persistent MooX private CA and deployment-time host certificate issuance.
privatefiles
Package privatefiles confines private credential reads and atomic writes to regular 0600 files and owned 0700 directories.
Package privatefiles confines private credential reads and atomic writes to regular 0600 files and owned 0700 directories.
service/activitylog
Package activitylog 保存各模块写入的、需要展示给用户的活动日志。
Package activitylog 保存各模块写入的、需要展示给用户的活动日志。
service/archiveproxy
Package archiveproxy 把控制台的分区副本下载与最新数据预览转给归档 worker 只听 127.0.0.1 的数据端口。
Package archiveproxy 把控制台的分区副本下载与最新数据预览转给归档 worker 只听 127.0.0.1 的数据端口。
service/garbage
Package garbage runs the daily system garbage collection.
Package garbage runs the daily system garbage collection.
service/gatewaycontrol
Package gatewaycontrol serves authenticated per-host configuration and persists runtime heartbeats.
Package gatewaycontrol serves authenticated per-host configuration and persists runtime heartbeats.
service/keys
Package keys owns the encrypted master copies of gateway signing keys.
Package keys owns the encrypted master copies of gateway signing keys.
service/secret/rpc
Package rpc 提供 secret 对外的 trpc 普通 RPC 服务实现, 承载秘钥管理 API(CRUD + 启用/禁用), 由主机网关转发原生 tRPC;控制台通过生成的 handler 在 Admin 进程内调用。
Package rpc 提供 secret 对外的 trpc 普通 RPC 服务实现, 承载秘钥管理 API(CRUD + 启用/禁用), 由主机网关转发原生 tRPC;控制台通过生成的 handler 在 Admin 进程内调用。
service/ssh/dao
Package dao 读取 SSH 连接需要的主机登记与凭据,并记录主机密钥指纹。
Package dao 读取 SSH 连接需要的主机登记与凭据,并记录主机密钥指纹。
service/ssh/model
Package model 定义 SSH 服务使用的数据结构。
Package model 定义 SSH 服务使用的数据结构。
service/ssh/rpc
Package rpc 提供 ssh 直连端点(WebSocket 终端、SFTP 流式上传/下载)的裸 HTTP 处理器, 经统一 HTTP 转发层 rawhandler 分派。
Package rpc 提供 ssh 直连端点(WebSocket 终端、SFTP 流式上传/下载)的裸 HTTP 处理器, 经统一 HTTP 转发层 rawhandler 分派。
service/sysdeploy/rpc
Package rpc exposes SysDeploy through tRPC while keeping business logic in sysdeploy.Service.
Package rpc exposes SysDeploy through tRPC while keeping business logic in sysdeploy.Service.
spacecontext
Package spacecontext 提供 space_id 在 HTTP/context 之间的注入与读取。
Package spacecontext 提供 space_id 在 HTTP/context 之间的注入与读取。
proto
admingen module
Package schema embeds the Control/Admin SQLite schema for explicit initialization flows.
Package schema embeds the Control/Admin SQLite schema for explicit initialization flows.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL