1. 运维平台
石墨办公-部署运维文档
  • 系统环境要求速查
  • 首次部署
    • 部署流程
    • 快速开始
    • 石墨办公套件
      • 办公套件资源规划建议
      • 单机部署【k8s】
      • 单机部署【k3s】
      • 集群高可用部署【k8s】
      • License授权激活
    • 石墨文档中台
      • 单机部署【k8s】
      • 单机部署【k3s】
      • 集群部署【k8s】
      • License授权激活
  • 运维平台
    • 简介
    • 办公套件
    • 文档中台
    • 运维管理
  • 常见问题
    • 安装阶段常见问题
    • 数据备份机制
  1. 运维平台

运维管理

6. 运维管理#

6.1 模块说明#

基础服务运维模块用于承载系统级配置、日志查看、运维巡检、问题查询、修复工具及系统维护等通用能力。该模块覆盖范围较广,适用于配置调整、状态核对、问题定位、排障处理及版本维护等多类场景,是日常运维过程中使用频率较高的模块。
从左侧导航结构看,基础服务运维按目录分组组织,主要包括 控制面板、服务运维、业务管控、工具集合 和 MDP 五个分组目录;其中部分页面如 中间件配置、通知渠道、多租户管理 位于分组之间单独展示。以下内容按后台导航层级展开,便于客户直接对照页面查阅。

6.2 控制面板#

控制面板是基础服务运维的入口分组,当前可见菜单包括 高级设置。该分组主要用于承载全局基础参数配置相关能力,适用于初始环境核查、系统参数调整及配置差异确认等场景。

6.2.1 高级设置#

高级设置页面用于维护基础服务运行所需的核心配置,是进行系统基础参数调整的重要入口。该页面通常适用于初始部署后的参数核对、默认配置调整及特定功能开关控制等场景。
从截图看,页面采用左右对照的配置视图形式,用于展示出厂默认配置与自定义配置内容。管理员可在此查看 YAML 或结构化配置差异,并在确认内容无误后执行发布。
image.png

6.3 中间件配置#

中间件配置页面用于维护系统运行所依赖的中间件连接与相关参数。该页面适用于数据库、消息队列、搜索、缓存或对象存储等基础依赖的统一管理。
在实际使用中,管理员通常需要结合部署架构确认各类中间件地址、端口、认证信息及启用状态。对该类配置执行调整后,建议同步核对服务可用性,避免出现配置已变更但下游依赖尚未生效的情况。以下内容按照当前页面展示顺序进行整理,便于与后台配置项逐项对照。

6.3.1 公共 S3 实例设置#

公共 S3 实例设置用于维护公共文件和资源所使用的对象存储实例。该区域适用于对象存储初始化配置、访问地址维护及资源访问规则核对等场景。
配置项说明
存储类型用于选择对象存储类型,当前页面示例为 S3(对象存储)。
子类型用于选择具体实现类型,当前页面示例为 minio。
Access Key ID用于填写对象存储访问账号。
Access Key Secret用于填写对象存储访问密钥。
区域用于填写对象存储所属区域。
高级选项用于控制附加访问选项,当前页面可ForcePathStyle与 SSL。
Endpoint用于填写对象存储服务的内部访问地址。
公共访问地址用于填写对象存储对外或公共访问地址。
地址替换规则用于填写资源地址替换规则,便于统一输出访问地址。

6.3.2 Kafka 消息队列#

Kafka 消息队列配置用于维护消息队列服务连接信息。该区域适用于事件投递、异步任务消费及消息链路接入相关场景。
配置项说明
Broker 地址用于填写 Kafka Broker 地址,支持添加多个地址项。
主题前缀用于填写消息主题统一前缀。
启用 SASL 认证用于控制是否启用 SASL 认证。
测试连接用于验证当前 Kafka 配置是否可正常连接。

6.3.3 MySQL 数据库#

MySQL 数据库配置用于维护关系型数据库连接信息。该区域适用于业务主库接入、数据库账号维护及连接测试等场景。
配置项说明
数据库类型用于选择数据库类型,当前页面示例为 MySQL。
主机地址用于填写 MySQL 服务地址。
端口用于填写 MySQL 服务端口。
用户名用于填写数据库访问用户名。
密码用于填写数据库访问密码。
测试连接用于验证当前 MySQL 配置是否可正常连接。

6.3.4 MongoDB#

MongoDB 配置用于维护文档型数据库连接信息。该区域适用于文档历史、业务记录及其他 MongoDB 数据库连接参数维护。
配置项说明
连接字符串用于填写 MongoDB 服务连接字符串。
数据库用于展示当前配置的数据库名称,例如 doc_history
、new_history。
用户名用于填写对应数据库的访问用户名。
密码用于填写对应数据库的访问密码。

6.3.5 Elasticsearch#

Elasticsearch 配置用于维护全文搜索引擎连接信息。该区域适用于搜索服务接入、索引查询能力维护及搜索依赖连通性核对等场景。
配置项说明
主机地址用于填写 Elasticsearch 服务地址。
端口用于填写 Elasticsearch 服务端口。
用户名用于填写 Elasticsearch 访问用户名。
密码用于填写 Elasticsearch 访问密码。
测试连接用于验证当前 Elasticsearch 配置是否可正常连接。

6.3.6 Redis#

Redis 配置用于维护缓存与基础键值存储服务连接信息。当前页面可见 Redis DB 与 Redis Cache 两个区域,适用于不同 Redis 用途的分别维护。
Redis DB 建议关注以下项目:
配置项说明
模式用于选择 Redis 部署模式,当前页面示例为
Standalone(单机)
。
地址用于填写 Redis 服务地址。
密码用于填写 Redis 访问密码。
Redis Cache 建议关注以下项目:
配置项说明
模式用于选择缓存 Redis 的部署模式。
密码用于填写缓存 Redis 的访问密码。
测试连接用于验证当前 Redis Cache 配置是否可正常连接。

6.4 通知渠道#

通知渠道页面用于维护系统告警、消息或事件通知的发送渠道。该页面适用于邮件、Webhook 或其他通知方式的接入与维护。
管理员可在此确认通知方式是否已正确配置,并用于支持关键事件触达、运维告警下发或业务通知联动。若通知未生效,应优先核对渠道配置与目标地址是否正确。

#

6.5 服务运维#

服务运维是基础服务运维下的运维管理分组,当前可见菜单包括 资源模板、配置中心、集群管理、系统升级、服务日志 和 实时日志。该分组主要面向服务配置维护、集群状态管理、升级操作及运行日志查看等场景。

6.5.1 资源模板#

资源模板页面用于维护系统在部署、接入或运维过程中所使用的标准化模板信息。该页面适用于统一资源规格、减少重复录入及规范配置输出等场景。
若系统支持模板复用,管理员可在此页面查看既有模板并进行后续维护。使用模板时,应先确认模板内容与当前环境需求是否一致。

6.5.2 配置中心#

配置中心页面主要用于管理各业务应用的配置文件,是进行业务参数调整、环境配置核对及配置发布的重要入口。该页面适用于应用级配置维护、业务行为调整、环境差异比对及版本发布前后的配置检查等场景。
配置中心通常按应用或服务列出对应的配置文件,页面中可查看出厂模板配置与实际生效配置,并用于比对当前配置差异。管理员在修改配置文件内容后,需要执行发布操作,发布后对应应用会重启,重启完成后新的配置才会正式生效。
使用该页面时,建议重点关注以下事项:
先确认当前修改对象是否为目标业务应用及目标配置文件。
发布前应核对修改内容是否完整、格式是否正确,以及是否符合当前环境要求。
发布操作会触发对应应用重启,应尽量在合适的维护窗口执行。
发布完成后,应结合页面状态、业务访问结果或相关日志确认新配置已经生效。
image.png

6.6.3 集群管理#

集群管理页面用于查看和维护k8s集群节点、节点状态或集群级别的运行信息。改页面集成"工作负载”、“配置”、“网络”三部分内容
在使用过程中,管理员可结合节点信息判断服务部署分布及整体运行情况,并为故障定位、扩容或变更提供参考依据。
Tips: 大部分功能只有查询功能
image.png

6.5.4 系统升级(***)#

系统升级页面用于管理石墨应用版本升级、升级包处理或升级过程中的状态确认。该页面适用于版本发布、补丁更新及系统升级前后核验等场景。
执行升级前,建议先确认当前版本、目标版本、升级窗口及回退方案,并在升级完成后结合日志与关键业务功能进行验证。
系统升级流程
a、上传石墨升级包#
image.png
b、查看升级包检验结果#
image.png
c、直接下一步#
image.png
ops.update
image.png
确认包内容
image.png
确认变更
image.png
更新应用
image.png
image.png
更新完成
image.png

6.5.5 服务日志#

服务日志页面用于查看系统服务的历史运行日志,支持管理员对异常信息、运行状态及关键事件进行追踪。该页面适用于故障定位、问题复盘及历史行为核查等场景。
使用时应结合时间范围、服务对象及异常关键词进行筛查,并重点关注服务启动失败、接口报错或关键任务异常等日志内容。
待完善

6.5.6 实时日志#

实时日志页面用于动态查看系统服务当前输出的运行日志,适合在配置发布、服务重启、问题复现或联调观察期间使用。该页面适用于实时运行观察、即时异常定位及变更后验证等场景。
使用时应结合当前操作窗口、服务对象及异常关键词进行筛查,并重点关注是否存在持续报错、重试堆积或关键依赖连接失败等现象。
待完善

6.6 业务管控#

业务管控是基础服务运维下的问题治理分组,当前可见菜单包括 协作封禁、转码事件查询、文件信息查询 和 文档修复。该分组主要用于业务异常治理、事件查询、文件问题定位及文档修复处理等场景。

6.6.1 协作封禁#

协作封禁页面主要用于处理超大文档在多人协同编辑场景下引发的协作异常问题。当某个文档体量过大,且同时存在多人协同编辑时,可能导致协作消息大量堆积,进而造成 Kafka 队列阻塞,并进一步影响其他用户的正常协作使用。该页面适用于此类单文档引发的协作流量异常处置场景。
在实际使用中,管理员可通过目标文档的 GUID 对该文档执行协作封禁,从而阻断该文档继续占用协作消息链路,降低对整体系统和其他用户的影响。该能力更适合用于应急止损和异常文档隔离,而不是常规业务限制。
执行协作封禁前,建议先确认以下内容:
当前异常是否确由单个大文档的多人协同编辑引起。
是否已定位到目标文档的 GUID。
封禁后是否会对目标文档当前在线协作者产生直接影响。
封禁完成后,是否需要结合 Kafka 队列状态、日志信息及用户反馈继续观察恢复情况。
image.png

6.6.2 转码事件查询#

转码事件查询页面用于查询系统内与转码处理相关的事件记录。该页面适用于文件处理异常、转码失败排查及任务流转状态确认等场景。
使用时,管理员可结合任务ID、类别、动作、级别、时间范围进行定位,并据此判断转码流程当前所处阶段或异常发生位置。
image.png

6.6.3 文件信息查询#

文件信息查询页面用于查询系统中单个文件或某类文件的元数据信息。该页面适用于文件问题排查、资源定位及状态核验等场景。
管理员可通过文件标识或其他检索条件进入查询结果,并结合文件信息判断是否存在资源缺失、状态异常或关联关系不一致等问题。
image.png

6.6.4 文档修复#

文档修复页面主要用于处理文档内容异常场景,例如内容丢失、内容乱码或最新版本内容异常等问题。该页面适用于单文档故障修复、异常内容回溯及修复结果核查等场景。
从页面结构看,文档修复支持两种修复方式,分别为 从加密数据修复 与 从历史数据修复(SDK)。管理员可根据文档异常类型选择对应方式提交修复任务,并在右侧执行结果区域查看任务输出与处理结果。
执行文档修复时,通常需要填写以下关键信息:
文件 GUID:用于唯一定位目标文档。
加密 Key:用于辅助执行内容修复;页面显示为可选项,未填写时系统可按规则自动生成。
使用该页面时,建议重点关注以下事项:
先确认目标问题是否属于内容丢失、乱码或版本内容异常等可修复场景。
修复前应准确获取目标文件的 GUID,避免误操作到其他文档。
若已掌握对应文档的加密信息,建议一并核对 加密 Key 后再提交任务。
提交修复后,应结合执行结果、文档实际打开效果及相关日志确认修复是否成功。
image.png

6.7 工具集合#

工具集合是基础服务运维下的运维辅助分组,当前可见菜单包括 功能巡检、通用工具、协同编辑压测、静态资源检测、中间件巡检、抓包工具、中间件工具 和 兼容性测试。该分组用于集中承载业务验证、常用辅助工具、接口压测、资源检测、中间件巡检、容器抓包及兼容性验证等能力。

6.7.1 功能巡检(***)#

功能巡检页面主要用于执行业务测试用例,以确认系统核心业务流程和关键功能是否正常可用。该页面适用于上线前验证、升级后回归、环境切换后检查及日常业务可用性巡检等场景。
image.png

6.7.2 通用工具#

通用工具页面主要用于提供日常运维和排查过程中常用的辅助功能。根据当前页面可见内容,该区域包括 JSON 格式化、格式转换、JWT Decode、时间戳转换、机器时间检查、QR Code 解析、Base64 编解码 等工具,适用于快速执行格式处理、内容解析、时间转换及基础环境核查等操作。
image.png

6.7.3 协同编辑压测#

协同编辑压测页面主要用于执行编辑接口压测功能,以验证协同编辑相关接口在并发访问下的性能表现。该页面适用于编辑链路压测、容量评估、性能瓶颈分析及问题复现场景,使用时应注意选择合适的测试窗口,避免对正式业务造成影响。
image.png

6.7.4 静态资源检测#

静态资源检测页面主要用于检测静态资源相关接口的响应情况。根据当前页面可见内容,该页面可访问指定页面地址,解析 HTML 中的 JS、CSS 资源,并检测缓存、CDN、HTTP/2 等响应特征,适用于前端资源异常、加载失败、缓存配置不一致及静态资源链路问题的快速核查。
image.png

6.7.5 中间件巡检#

中间件巡检页面主要用于巡检系统依赖的中间件连通性与读写能力。根据当前页面说明,巡检对象包括 MySQL、Redis、ES、S3、Mongo、Kafka 等中间件,并支持在失败或恢复时进行通知。该页面适用于依赖异常排查、环境交付检查及日常健康巡检。
image.png

6.7.6 抓包工具#

抓包工具页面主要用于在容器内部快速执行抓包操作。根据当前页面可见内容,管理员可从 Pod 列表中选择目标容器并发起抓包任务,适用于网络异常排查、接口调用分析、依赖链路问题定位及特定请求过程复现等场景。
使用该页面时,应先确认目标 Pod、抓包范围及抓取时段,并在完成抓包后及时结合日志与请求链路进行分析。
image.png

6.7.7 中间件工具#

中间件工具页面主要用于提供各类中间件的 UI 访问入口。根据当前菜单可见内容,该区域包括 Kafka UI、GRPC UI、MySQL UI、Redis UI、Mongo UI 和 Storage UI 等页面,便于管理员直接进入对应中间件的图形化管理界面执行查看、核查或辅助排障操作。
使用该页面时,建议先确认目标中间件类型及访问目的,并在进入相应 UI 页面后结合权限范围进行查看和操作。
KAFKA
image.png
GRPC
image.png
MySQL
image.png
Redis
image.png
Mongo
image.png
Storage
image.png

6.7.8 兼容性测试#

兼容性测试页面主要用于验证对象存储相关组件的兼容表现。该页面适用于 S3、Minio、Ceph 等对象存储场景下的接入测试、环境验收及兼容性复核。
管理员可在此执行相应测试并观察结果,以判断当前对象存储环境是否满足系统的运行要求。测试完成后,建议同步留存关键结论,用于后续交付、排障或环境对比。
image.png

6.8 系统管理#

MDP 是基础服务运维下的后台管理分组,当前可见菜单包括 用户管理 和 MDP 操作日志。该分组主要用于后台账号管理、权限归属核对及关键操作审计。

6.8.1 用户管理#

用户管理页面用于管理后台系统中的用户账号、权限与状态。该页面适用于后台账号创建、管理员身份核对、账号启停控制及运维人员账户维护等场景。
从页面结构看,用户管理通常包含统计信息区与用户列表区。统计信息区可用于查看总用户数、近 30 天活跃情况及管理员账号数量;用户列表区可用于查看用户名、联系方式、最近活动时间、注册时间及当前账号状态,并支持执行新增用户、编辑、查看详情、启停切换或删除等操作。
在实际操作时,应优先确认用户职责范围与权限边界,避免因误授予或误调整导致不必要的访问风险。对管理员账号或关键运维账号执行变更前,建议先确认影响范围,并保留必要的变更记录。
image.png

6.8.2 MDP 操作日志#

MDP 操作日志页面用于查看和追踪后台系统操作记录。该页面适用于变更复盘、责任定位、后台行为审计及高风险操作留痕检查等场景。
从页面结构看,操作日志页面通常包含统计信息区、筛选条件区与日志列表区。筛选条件区支持按事件来源、操作类型及操作用户进行查询;日志列表区可用于查看 ID、事件来源、操作类型、操作用户、对象类型、对象名称、对象 ID、操作时间等信息,并支持进一步查看对应操作详情。
管理员可依据操作时间、操作对象或执行人信息进行查询,并结合变更记录还原操作过程。对于重要配置变更、账号调整或关键运维操作,建议将操作日志与发布记录一并留存。
image.png

7. 附录说明#

7.1 截图使用说明#

本文档中的页面截图应统一采用脱敏后的测试环境或演示环境图片。所有账号、邮箱、接口地址、API Key、License 内容、机器码、内网地址及其他敏感信息均应替换为示例值或进行遮挡处理。
修改于 2026-06-30 11:13:15
上一页
文档中台
下一页
安装阶段常见问题
Built with