管控台用户手册
# 前言
本文档为金蝶Apusic分布式缓存（AMDC）V2.0.5管控台产品的用户手册，详细介绍 AMDC产品Web管控台的功能使用、配置方法及管理操作等内容。
本文档基于当前
amdc-console代码及实际部署环境（http://172.17.47.213:9001/），使用 AMDC管理员 角色进行截图与功能验证；原有截图与文字主体保留，仅调整与实际菜单不符的路径说明。其他角色（系统管理员、安全管理员、审计管理员、租户管理员）的菜单范围可能不同，请以实际登录角色为准。图片若与当前界面存在差异，详见文末《待确认图片清单》。
# 适用对象
本文档适用于AMDC产品运维工程师、IT系统运维工程师、开发工程师等人员。
# 相关文档
了解更多AMDC V2.0.5产品相关的信息，请参阅以下AMDC V2.0.5产品手册文档集：
| 序号 | 手册文档 | 说明 |
|---|---|---|
| 1 | 金蝶Apusic分布式缓存 V2.0.5 快速使用手册 | 简单介绍了如何快速上手使用AMDC 。 |
| 2 | 金蝶Apusic分布式缓存 V2.0.5 安装手册 | 详细介绍如何在各操作系统上安装AMDC，以及AMDC服务启停操作，产品的注册过程。 |
| 3 | 金蝶Apusic分布式缓存 V2.0.5 缓存核心用户手册 | 详细介绍 AMDC 相关功能的使用、配置、管理及配套工具的使用方法。 |
| 4 | 金蝶Apusic分布式缓存 V2.0.5 管控台用户手册 | 详细介绍AMDC管控台相关功能的使用和操作说明。 |
| 5 | 金蝶Apusic分布式缓存 V2.0.5 开发手册 | 详细介绍基于各开发语言进行AMDC客户端应用开发的说明。 |
| 6 | 金蝶Apusic分布式缓存 V2.0.5 迁移手册 | 详细介绍AMDC历史版本迁移升级到V2.0.5版本的说明，以及Redis迁移到AMDC的说明。 |
| 7 | 金蝶Apusic分布式缓存 V2.0.5 运维手册 | 详细介绍AMDC的监控、运维、安全加固等运维说明。 |
| 8 | 金蝶Apusic分布式缓存 V2.0.5 性能优化手册 | 详细介绍AMDC性能调优的说明。 |
# 技术支持
AMDC产品提供全面的技术支持服务，您可以通过以下方式获得技术支持：
网址：www.apusic.com
电话：400-855-5800
邮箱：support@apusic.com
金蝶云社区：https://vip.kingdee.com/?productId=73&productLineId=14&lang=zh-CN
您在取得技术支持时，请提供如下信息：
您的姓名
公司信息与联系方式
操作系统及其版本
产品版本号
出现异常及错误的日志、截图等详细信息
# 简介
金蝶Apusic分布式缓存软件（Apusic In-Memory Data Cache，简称：AMDC），一款完全泛场景适用、高吞吐量、数据安全的分布式缓存软件，为大规模、高并发、高可用的关键应用提供安全可靠的缓存支撑能力；并兼容Redis协议与持久化数据文件，实现简单快捷平稳替换Redis。
# 功能清单
# 管控台
| 功能 | 功能说明 |
|---|---|
| 多租户管理 | 使用多租户模型对不同业务或者管理团体进行数据隔离。 |
| 权限控制 | 提供功能使用权限控制，提高管控台安全性。 |
| 多集群管理 | 支持多集群的集中管理、节点启停、节点弹性伸缩、配置等功能。 |
| 监控告警 | 提供缓存监控功能，检测缓存状态，并在缓存核心异常时发出告警通知。 |
| 数据分析 | 提供缓存数据big keys、hot keys、slowlog等数据分析功能。 |
| 自动部署 | 实现了AMDC数据缓存引擎的自动部署功能，系统自动完成全过程，更快更简单。 |
| 可视化扩缩容 | 提供可视化的扩容/移除节点操作，没有繁琐的命令操作。 |
| 部署任务 | 部署过程/扩缩容过程可视化，可在任务列表查看进度与状态。 |
# 相关概念
| 名词 | 含义 | 使用说明 |
|---|---|---|
| 主节点 | 存储数据，负责数据读写，负责数据同步 | AMDC的默认模式，单机模式，单机模式下，主节点为单机模式 |
| 从节点 | 从主节点复制数据，参与数据同步（只读） | 从节点参与数据同步（只读），当主节点故障时可自动切换为主节点，当主节点恢复时，从节点自动切换为从节点。 |
| 哨兵 | 监控主从节点，负责主节点故障转移，负责主从节点同步 | 哨兵模式，当主节点挂掉时，自动切换为从节点，当从节点挂掉时，自动切换为主节点。 |
| 集群 | 由多台相互独立的计算机组成的计算机服务系统 | 在本文中，主从/哨兵/集群三种模式都可以算是集群，集群模式特指多主节点数据分片存储的模式。 |
# 新服务上线完整流程
下面以 AMDC 管理员 视角，演示一条完整的服务上线、升级与迁移操作流程。按本流程操作，一名不了解管控台的实施人员也能独立完成部署、验证、升级与迁移。
# 登录控制台
- 打开浏览器，访问
http://<serverIP>:9001/，进入登录页面。 - 输入账号
amdc_admin和对应密码：- 管控台首次启动时，会自动生成所有预置管理员账号的初始密码（包括
amdc_admin、三员管理员及租户管理员），并写入安装目录下的./resource/.initial_passwords文件。 - 打开该文件，找到
amdc_admin:后的 12 位随机密码作为首次登录密码。 - 首次登录成功后，系统会强制要求按当前密码策略修改密码，修改完成后方可进入控制台主界面。密码过期后再次登录也会触发强制修改。
- 管控台首次启动时，会自动生成所有预置管理员账号的初始密码（包括
- 点击【登录】进入控制台首页。
说明：本文档后续操作均基于 AMDC 管理员 角色。其他角色（系统管理员、安全管理员、审计管理员、租户管理员）的菜单范围可能不同，请以实际登录角色为准。
# 1. 资源准备
部署服务前，必须先在【资源管理】中准备好安装包、License、机器和配置模板。
# 1.1 添加上传安装包
- 进入左侧菜单【资源管理】>【安装包管理】。
- 点击右上角【上传】按钮，选择目标版本的 AMDC 安装包文件（如
AMDC-V2.0.5-xxxx-amd64.tar.gz）。 - 点击【确定】完成上传。
# 1.2 上传 License
- 进入左侧菜单【资源管理】>【证书管理】。
- 点击【上传】按钮，选择有效的 License 文件，可同时上传多个。
- 上传后系统会自动解析，无效的 License 将无法保存。
# 1.3 添加目标机器
- 进入左侧菜单【资源管理】>【机器管理】。
- 点击左侧机器组旁的【+】按钮，先创建一个机器组。
- 选中机器组，点击左上方【添加】按钮，填写远程服务器信息：
| 参数名 | 示例值 | 说明 |
|---|---|---|
| 用户名 | root | 登录远程机器的用户名 |
| 密码 | - | 登录远程机器的密码 |
| SSH 端口 | 22 | 远程 SSH 端口 |
| Host | 172.17.47.213 | 远程机器 IP |
| 备注 | - | 可选 |
- 确认目标机器连接状态正常后再进行后续部署。
注意：同一个机器组只能添加相同架构芯片的机器；自动部署需要目标机器具备
tar、ss命令。
# 1.4 确认配置模板
- 进入左侧菜单【资源管理】>【配置模板】。
- 确认已有缓存核心配置模板和哨兵配置模板（如使用哨兵模式）。
- 若需要自定义，可在此修改；与 IP、端口相关的非公共参数不会生效。
# 2. 自动部署新服务
资源准备完成后，进入【部署管理】>【自动部署】，按 4 步向导完成服务部署。
# 2.1 基础配置
在【基础配置】步骤填写：
- 服务名称：唯一标识，仅支持英文、数字、下划线、中划线，不超过 24 个字符。
- 部署模式：选择单机 / 主从 / 哨兵 / 集群 / 预生成节点。
- 安装包：选择已上传的安装包。
- 安装目录：如
/data/looper，节点实际位于{seat}/{port}。 - AMDC 密码：缓存核心管理密码，可点击设置按钮配置复杂度规则。
- 开机自启：是否随系统启动自动运行。
- sudo：是否使用 sudo 权限执行安装命令。
# 2.2 拓扑配置
- 选择【自动】或【手动】拓扑模式：
- 自动：系统自动分配端口和节点角色，只需选择机器和授权。
- 手动：逐节点配置机器、端口、角色和授权。
- 配置端口范围（默认 6359–65535）和节点数量。
- 在【机器与授权】区域选择目标机器，并为每台机器选择 License 授权。
注意：所有机器需在同一机器组下；非哨兵节点必须选择授权。
# 2.3 配置模板
选择缓存核心配置模板；若部署模式为哨兵，还需选择哨兵配置模板。
# 2.4 确认部署
- 确认部署信息无误后，点击【执行任务】立即部署，或点击【保存任务】仅保存待后续执行。
- 部署过程中可进入【部署管理】>【部署任务】查看任务状态。
- 等待任务状态变为“完成”。
# 3. 服务验证与监控
部署完成后，进入【部署管理】>【服务列表】查看新生成的服务。
- 点击服务名称进入服务详情。
- 点击【监控】查看集群运行指标（内存、QPS、连接数等）。
- 点击【分析】进行 big keys、hot keys、slowlog 等数据分析。
- 点击顶部【命令行】按钮，可执行 AMDC 命令验证数据写入/读取。
# 4. 服务升级
当需要升级到新版本时：
- 在【资源管理】>【安装包管理】中上传新版本安装包。
- 进入目标服务详情，点击顶部【升级回退】>【升级】，打开“集群升级”抽屉。
- 仔细阅读升级说明：
- 升级会停止整个集群并替换二进制，期间集群不可用。
- 升级失败时，系统会自动从备份回滚到升级前版本。
- 仅支持同版本或更高版本升级。
- 升级前会自动备份节点数据，请确保各节点磁盘空间充足。
- 在列表中选择要升级到的安装包，点击【确认升级】。
- 等待升级任务完成，可在【部署管理】>【部署任务】或监控中心观察状态。
# 5. 平滑迁移（可选）
若需将服务迁移到新硬件或新集群：
- 进入目标服务详情，点击顶部【集群运维】>【平滑迁移】，打开“集群迁移”弹窗。
- 在【填写目标信息】步骤中，点击【创建目标节点】，通过自动部署向导创建目标节点；创建完成后系统会自动回填目标 IP/Port/密码。
- 点击【下一步】进入【确认迁移】，阅读迁移风险提示：
- 迁移过程中源集群将有短暂写入冻结（约 30 秒）。
- 迁移完成后业务访问 IP/端口会发生变更。
- 哨兵模式下哨兵节点不参与迁移，迁移后需检查哨兵配置。
- 确认信息无误后，点击【确认迁移】，系统会自动完成增量同步与切换。
- 切换完成后，及时更新客户端连接配置。
# 6. 刷新节点
升级或迁移后，若控制台展示的节点信息与实际集群不一致：
- 进入目标服务详情，点击顶部【集群运维】>【刷新节点】。
- 在弹窗中查看节点变化对比结果（当前记录节点数、实际探测节点数、变化说明）。
- 点击【确认刷新】同步节点元数据。
# 7. 日常运维
- 告警：在【告警】>【告警通道】/【告警规则】中配置通知方式与阈值。
- 日志切割：进入服务详情 >【集群运维】>【日志切割】，配置日志保留天数和单文件大小限制。
- 备份恢复：进入服务详情 >【数据管理】，定期执行数据备份，必要时执行恢复。
- 扩容/缩容：进入服务详情，点击【扩容】增加节点；选中节点后通过【节点操作】>【移除】减少节点。
# 环境准备与资源管理
在创建或运维 AMDC 服务之前，需要先在【资源管理】中准备好以下资源。
# 机器管理
进入【资源管理】>【机器管理】，机器管理页面提供新增、编辑、删除机器的功能入口。自动部署所需要的机器信息将在这里进行创建。
# 新增机器
进入【资源管理】>【机器管理】，需要先有机器组才能新增机器，同一个机器组只能添加相同架构芯片的机器。点击左侧机器组旁的【+】按钮新增机器组；选中机器组后，点击左上方【添加】按钮，填写机器信息。
备注：只能新增连接正常的服务器，因此请确认目标机器连接状态。
| 参数名 | 含义 |
|---|---|
| 用户名 | 登录远程机器的用户名，如：root |
| 密码 | 登录远程机器的密码 |
| ssh端口 | 登录远程机器的端口，如：22 |
| Host | 远程机器的地址，如：192.168.x.x（示例IP，请替换为实际IP） |
| 备注 | 可以为空 |
# 删除机器
点击【资源管理】>【机器管理】进入机器管理页面，勾选需要删除的机器，点击机器列表右侧【删除】按钮，即可删除当前行机器，支持批量删除。
# 编辑机器
点击【资源管理】>【机器管理】进入机器管理页面，勾选需要编辑的机器，点击机器列表右侧【编辑】按钮，即可编辑当前行机器信息。
# 资源管理
资源管理用于存放 AMDC 的安装包以及 License 文件，上传的文件会经过管控的初步校验以确定其可用性，并在自动部署中选择使用。
说明：当前 AMDC 管理员菜单中，安装包、License、机器、配置模板统一放在【资源管理】下。版本管理在当前菜单中未直接展示，若入口有变更请以实际菜单为准。
# 安装包管理
进入【资源管理】>【安装包管理】，用于上传自动部署使用的安装包。
上传安装包
点击【上传】按钮，打开上传安装包的弹窗，点击【选择文件】来选择需要上传的安装包，再点击确定即可。
每次只能上传一个安装包，可以指定安装包类型（c 或者 go）。
删除安装包
选中需要删除的安装包，点击左上角【删除】按钮即可，支持同时删除多个。
# License 管理
进入【资源管理】>【证书管理】，用于上传自动部署使用的 License，上传后 License 会被解析，无效的 License 将无法保存在管控台。
上传 License
点击【上传】按钮，打开上传 License 的弹窗，点击【选择文件】来选择需要上传的 License 文件，再点击确定即可，可同时上传多个。
删除 License
选中需要删除的 License，点击左上角【删除】按钮即可，支持同时删除多个。
# 生成授权中心文件
在 License 管理页面，点击【生成授权中心文件】按钮，可生成 acls.properties 授权中心配置文件，用于集群的 ACL 授权场景。
# 版本管理
版本管理用于查看和管理已部署 AMDC 实例的版本历史，支持对实例进行版本回退操作。当前菜单入口请以实际部署环境为准。
# 配置模板
点击【资源管理】>【配置模板】进入配置模板页面，在该页面中可以定义缓存核心、哨兵的配置模板，并在【自动部署】中使用该模板。
注意：与 IP、端口等非公共参数将不会在配置模板中生效，以保证自动部署的正常工作。
# 核心操作流程
本节按实际运维任务组织，介绍如何在控制台完成服务的全生命周期操作。
# 自动部署新服务
AMDC 管理员路径：【部署管理】>【自动部署】
进入【自动部署】页面后，按 4 步向导填写部署信息：
- 基础配置：服务名称、部署模式、安装包、安装目录、AMDC 密码、sudo、开机自启等。
- 拓扑配置：选择自动/手动拓扑，配置节点数量、端口范围、机器和 License 授权。
- 配置模板：选择缓存核心配置模板（哨兵模式还需选择哨兵配置模板）。
- 确认部署：确认信息后保存任务或直接执行。
填写完成后，可点击【保存任务】仅保存到【部署管理】>【部署任务】，或点击【执行任务】立即开始部署。部署进度和状态在【部署管理】>【部署任务】中查看。
前提条件：
- 已在【资源管理】>【机器管理】中添加目标服务器，且 SSH 连接正常。
- 已上传安装包（【资源管理】>【安装包管理】）。
- 已上传 License（【资源管理】>【证书管理】）。
- 目标服务器具备
tar、ss命令。
基础配置参数：
| 参数名 | 含义 |
|---|---|
| 服务名称 | 服务唯一标识，仅支持英文、数字、下划线、中划线，不超过 24 个字符 |
| 部署模式 | 单机 / 主从 / 哨兵 / 集群 / 预生成节点 |
| 安装包 | 选择已上传的 AMDC 安装包版本 |
| 安装目录 | 服务安装的根目录（seat），如 /data/redis；节点实际位于 {seat}/{port} |
| AMDC 密码 | 缓存核心管理密码，点击设置按钮可配置复杂度规则 |
| sudo | 是否使用 sudo 权限执行安装命令 |
| 开机自启 | 服务是否随系统启动自动运行 |
可以通过开机自启选项，实现部署完成之后服务的开机自启动
密码后面的设置进入密码格式要求设置界面，进行密码复杂度和长度的设置
拓扑配置参数：
| 参数名 | 含义 |
|---|---|
| 拓扑模式 | 自动：系统自动分配端口和角色；手动：逐节点配置机器、端口、角色和授权 |
| 可用端口范围 | 自动分配节点服务端口的起止端口，默认 6359–65535 |
| 主节点数 | 主节点数量，集群模式至少需要 3 个 |
| 从节点数 | 每个主节点对应的从节点数 |
| 哨兵节点数 | 哨兵模式专用，建议 3 个以上保证高可用 |
| 机器与授权 | 选择部署机器，并为机器（非哨兵节点）选择 License 授权；所有机器需在同一机器组下 |
# 自动部署单机模式
控制台自动部署前请确保目标服务器连接正常，目标服务器已添加至机器列表中（参考机器管理），目标服务器具备 tar 命令、ss 命令。
操作步骤：
- 在基础配置中选择【单机】模式，主节点默认为 1、从节点默认为 0。
- 在拓扑配置中选择机器并分配 License。
- 确认部署信息后点击【安装】按钮，进行一键部署。
验证自动部署结果：点击【部署管理】>【服务列表】菜单，查看集群是否生成，并且状态为健康。可以使用【命令行】做进一步的验证。
# 自动部署主从模式
控制台自动部署主从模式前请确保目标服务器连接正常，目标服务器已添加至机器列表中（参考机器管理）。
操作步骤：
- 在基础配置中选择【主从】模式，根据页面内容选择 AMDC 核心安装包和 License。
- 在拓扑配置中选择机器、配置主从节点数量并分配 License。
- 点击【安装】即可自动实现主从部署。
# 自动部署哨兵模式
控制台自动部署哨兵模式前请确保目标服务器连接正常，目标服务器已添加至机器列表中（参考机器管理）。
操作步骤：
- 在基础配置中选择【哨兵】模式。
- 在拓扑配置中选择机器、配置主从节点与哨兵节点数量并分配 License。
- 在配置模板步骤中选择哨兵配置模板。
- 点击【安装】即可自动实现哨兵部署。
# 自动部署预生成节点模式
预生成节点用于平滑迁移等场景：提前部署好集群节点但不加入集群（不执行 CLUSTER MEET），供迁移时直接切换使用。
操作步骤：
- 在基础配置中选择【预生成节点】模式。
- 按集群模式配置节点数量、机器和授权。
- 执行部署后，节点处于待用状态，后续可在【平滑迁移】中选择使用。
# 导入已有集群或单机
对于不在控制台部署的AMDC缓存核心，可以导入控制台实现在控制台进行监控、修改、执行命令等操作。进入服务列表点击【+】导入按钮，根据页面提示添加监控的集群/单机实例信息。
| 参数名 | 含义 |
|---|---|
| 集群名称 | 自定义集群名称 |
| AMDC密码 | AMDC缓存核心的密码 |
| AMDC Node | AMDC缓存核心的IP:端口 |
# 扩容节点
点击【扩容】按钮，跳转至自动扩容页面，实现扩充主从模式的从节点，或者扩展集群模式的节点。
扩容时继承原集群服务名称，不可修改；目标部署模式根据原模式限制可选范围：
- 单机 → 可扩容为主从或哨兵
- 主从 → 可扩容为主从或哨兵
- 哨兵 → 只能扩容为哨兵
- 集群 → 只能扩容为集群
扩容向导与自动部署一致，包含基础配置、拓扑配置、配置模板、确认部署 4 个步骤。拓扑配置中会预填充原集群信息，按需调整节点数量、机器和授权后执行即可。
# 移除节点（缩容）
进入服务详情 >【设置】，选中需要操作的节点，点击【节点操作】下拉菜单：
- 清空：清空当前选中节点的分布式缓存数据。确认后执行。
- 移除：将选中节点从集群中移除。确认后执行；若移除的是主节点，系统会自动进行故障转移或数据迁移（具体行为取决于部署模式）。
注意：移除节点会改变集群拓扑，建议在业务低峰期操作，操作前做好数据备份。
# 集群升级
点击【设置】页面上方【升级回退】下拉菜单中的【升级】，打开“集群升级”抽屉。
升级说明：
- 升级会停止整个集群并替换二进制，期间集群不可用。
- 升级失败时，系统会自动从备份回滚到升级前版本。
- 仅支持同版本或更高版本升级；回退版本请使用平滑迁移。
- 升级前会自动备份节点数据，请确保各节点磁盘空间充足。
在列表中选择要升级到的安装包，点击【确认升级】后，系统会创建升级任务并在后台执行。升级过程中可通过任务列表或监控中心观察集群状态。
# 版本回退
点击【设置】页面上方【升级回退】下拉菜单中的【版本回退】，打开“版本回退”抽屉。
回退说明：
- 回退会停止整个集群并恢复历史备份，期间集群不可用。
- 回退失败时，系统会自动从本次备份回滚到回退前版本。
- 回退前会自动备份当前版本，请确保各节点磁盘空间充足。
在列表中选择要回退到的历史版本（会标注“升级备份”或“回滚快照”），点击【确认回退】执行。
# 平滑迁移
点击【设置】页面上方【集群运维】下拉菜单中的【平滑迁移】，可将数据从当前集群迁移到目标集群。
迁移说明：
- 平滑迁移通过增量同步将数据从源集群迁移到目标集群，迁移期间无需停机。
- 仅在切换瞬间存在短暂写入冻结。
- 迁移完成后业务访问 IP/端口会变更，请提前更新客户端连接配置。
- 哨兵模式下哨兵节点不参与迁移，迁移后请检查哨兵配置是否指向新的主从节点。
操作步骤：
- 在弹出的“集群迁移”窗口中，根据当前模式查看迁移说明。
- 点击【创建目标节点】，在抽屉中通过自动部署向导创建目标节点；创建完成后系统会自动回填目标 IP/Port/密码。
- 集群模式下需要为每个源节点创建对应的目标节点。
- 确认目标信息无误后，点击【下一步】进入确认迁移页面。
- 阅读迁移风险提示：迁移过程中源集群将有短暂写入冻结（约 30 秒），请确保业务端可接受短暂写入中断，并提前准备好连接配置切换方案。
- 确认信息后执行迁移，系统会展示迁移进度。
# 刷新节点与关联机器
# 刷新节点
点击【设置】页面上方【集群运维】下拉菜单中的【刷新节点】，系统会重新探测集群实际节点拓扑，并与管控台当前记录进行对比。
刷新说明：
- 确认刷新后会将新增节点纳入管控、移除已脱离节点，并修正角色变化。
- 此操作仅同步节点元数据，不会停止或重启节点，也不会影响业务访问。
- 当控制台展示的节点数量、角色与实际集群不一致时，建议执行刷新节点。
刷新完成后会弹窗展示对比结果（当前记录节点数、实际探测节点数、变化说明）。
# 关联机器
进入【部署管理】>【服务列表】，点击服务名称进入服务详情，再点击【设置】进入集群设置页面。选中对应节点，点击【关联机器】按钮，将导入的节点与机器信息关联起来，这样能给节点提供完整管理功能。
# 日志切割
点击【设置】页面"更多操作"中的【日志切割】按钮，可配置集群的日志切割策略，包括日志保留天数、单文件大小限制等参数。
# 解除管控
点击【集群设置】页面"更多操作"中的【解除管控】按钮，可将该集群从管控台的纳管状态中移除。解除管控后，管控台将不再对该集群进行管理和监控，但集群本身仍会继续运行。
# agent CLI 使用说明
# 概述
agent 是 cli-http 编译后的二进制程序，通过 HTTP API 与 AMDC Console 进行交互。与直接连接缓存核心的 amdc-cli 不同，agent 面向管控台的资源、部署、任务和监控等管理操作，适用于自动化脚本、批量操作、CI/CD 集成以及无图形界面的服务器环境。
两者的主要区别如下：
| 工具 | 连接目标 | 主要能力 |
|---|---|---|
amdc-cli | AMDC 缓存核心 | 执行 Redis 协议命令、原生集群管理 |
agent | AMDC 管控台 | 执行部署、运维、任务、监控等管理操作 |
适用场景：自动化脚本、批量操作、CI/CD 集成、无图形界面环境。
# 获取 agent
agent 二进制程序随 AMDC Console 安装包一起发布，解压安装包后可在 amdc_console/agent/ 目录下找到对应平台的 agent 可执行文件（例如 Linux amd64 环境为 amdc_console/agent/agent_linux_amd64.tar.gz 解压后的 agent）。
# 接入与认证
使用 agent 前，需要配置以下两项环境变量：
AMDC_SERVER：AMDC 管控台访问地址，例如http://172.17.47.213:9001/。AMDC_CLI_TOKEN：由管理员颁发的 AI Token，用于身份认证。
Linux / macOS 环境变量配置示例：
export AMDC_SERVER="http://<server-ip>:9001/"
export AMDC_CLI_TOKEN="<your-ai-token>"
2
Windows PowerShell 环境变量配置示例：
$env:AMDC_SERVER = "http://<server-ip>:9001/"
$env:AMDC_CLI_TOKEN = "<your-ai-token>"
2
配置完成后，可通过以下命令验证连接是否正常：
agent cluster list
注意：
AMDC_CLI_TOKEN由管理员在管控台中生成并下发，请妥善保管，避免泄露。
# 全局参数
agent 支持以下全局参数，可用于覆盖环境变量或调整输出格式：
| 参数 | 说明 | 示例 |
|---|---|---|
--server | 指定 AMDC 管控台地址 | --server http://<server-ip>:9001/ |
--cli-token | 指定 AI Token | --cli-token <your-ai-token> |
--json | 以 JSON 格式输出结果 | --json |
-h / --help | 查看帮助信息 | agent --help |
# 典型场景示例
# 查看集群列表
# 列出所有集群
agent cluster list
# 查看指定集群详情
agent cluster get <cluster-id>
2
3
4
5
通过 agent cluster list 可快速获取当前租户下的所有集群概览；使用 agent cluster get <cluster-id> 可查看指定集群的节点、状态及配置详情。
# 添加机器、证书、安装包
# 创建机器组
agent machine group-create --name <machine-group-name>
# 向机器组添加机器
agent machine add --file machine.json
2
3
4
5
{
"machine_group_name": "<machine-group-name>",
"login_name": "root",
"pwd": "<rsa-encrypted-base64-password>",
"host": "<server-ip>",
"sshport": 22,
"note": "生产机器-01",
"user_id": 1
}
2
3
4
5
6
7
8
9
注意：
pwd字段需先使用 RSA 加密，再进行 Base64 编码。
# 上传 License 证书
agent document upload-license --file <license-file-path>
# 上传 AMDC 安装包
agent document upload-pkg --file <package-file-path>
2
3
4
5
上述命令完成了自动部署前的资源准备：创建机器组、添加目标机器、上传 License 与安装包。
# 执行自动部署
agent autodeploy exec --file <deploy-config.json>
通过 JSON 配置文件描述部署参数（服务名称、部署模式、节点拓扑、机器与授权等），agent 会自动向管控台提交部署任务并返回执行结果；后续可通过 agent task list 查看任务进度。
# 集群扩容
agent expand exec --file <expand-config.json>
扩容操作继承原集群服务名称，通过 --file 指定扩容配置文件，实现主从模式增加从节点或集群模式扩展分片节点。
# 查看监控大盘与慢日志
# 查看全局监控大盘
agent monitor dashboard
# 查看指定节点的慢日志
agent monitor slow-log --node-host <node-host>
2
3
4
5
agent monitor dashboard 汇总展示所有集群的运行概览；agent monitor slow-log 用于查询指定节点的慢日志记录，其中 --node-host 为目标节点地址，格式为 host:port。
# 常用命令速查
| 功能域 | 顶层命令 | 核心子命令 |
|---|---|---|
| 集群管理 | cluster | list、get、import |
| 集群运维 | cluster-manage / cm | node-info、config-get、config-update、backup、recover、flush、operate 等 |
| 机器管理 | machine | list、add、group-create、group-list 等 |
| 自动部署 | autodeploy | exec |
| 扩容缩容 | expand | exec、save、reduce |
| 部署资源 | document | pkg-list、upload-pkg、license-list、upload-license 等 |
| 任务中心 | task | list、get、exec |
| 升级任务 | upgrade-task | list、get、create、rollback |
| 集群迁移 | migration | prepare、create、list、get |
| 监控诊断 | monitor | dashboard、dynamic、static、slow-log、keys-analyse |
| 配置模板 | conftemp | list、add、update、content |
| 操作历史 | history | list、export |
| ACL | acl | list、create、update、delete |
| 密码策略 | password-policy | get、update |
更多命令及参数说明，请使用
agent <command> --help查看。
# AI 语料示例
在已配置好 AMDC_SERVER 和 AMDC_CLI_TOKEN 的环境中，可以直接将以下自然语言指令交给 AI，由其调用 agent 完成对应操作。
# 查看所有集群状态
请使用 agent CLI 查看当前租户下所有 AMDC 集群的列表，并以表格形式返回集群 ID、名称、部署模式和状态。
# 自动部署集群
请使用 agent CLI 在机器组 "prod-group" 上自动部署一个 3 主 3 从的 AMDC 集群模式服务，服务名称为 "amdc-prod-01"，安装目录为 /data/amdc，使用已上传的安装包和 License，并返回部署任务 ID。
# 扩容集群
请使用 agent CLI 对集群 ID 为 <cluster-id> 的服务进行扩容，新增 2 组主从节点，机器组为 "prod-group"，扩容完成后返回任务状态。
# 查看节点慢日志
请使用 agent CLI 查看节点 <node-host> 上最近 50 条慢日志，按耗时倒序排列。
# 批量上传资源
请使用 agent CLI 将 /data/packages/AMDC-V2.0.5.tar.gz 安装包 和 /data/licenses/amdc.lic License 文件上传到管控台，并返回上传后的资源 ID。
说明：AI 执行上述任务前，需确保当前环境已设置
AMDC_SERVER和AMDC_CLI_TOKEN，否则无法通过认证。
# 服务监控与告警
# 监控中心
路径：【监控中心】
监控中心为全局监控大盘，汇总展示当前所有集群的运行概览：
- 顶部指标卡：总集群数、健康集群、异常集群、总节点数。
- 状态分布：以环形图展示健康、部分异常、异常集群占比。
- 关键指标 Top5：内存、QPS、连接数 Top5 节点排行。
- 集群概览：展示各集群名称、部署模式、节点数、健康状态、总内存使用及操作入口。
# 服务监控
点击服务栏目下的【监控】按钮，进入集群监控页面，这里将展示当前集群的详细信息以及重要指标项。不同角色进入服务列表的路径略有差异：AMDC 管理员通过【部署管理】>【服务列表】进入；租户管理员通过【服务列表】进入。
# 分析
点击【监控】上方的【分析】按钮进入【分析】页面，在这里可以进行缓存核心的bigkeys、hotkeys、memkeys、monitor、slowlog的数据分析查询。
# 告警通道
告警通道指通知接收人的通知方式，amdc控制台提供Email形式的告警通道。
# 新增告警通道
进入【告警】>【告警通道】，点击【新增】按钮，新增告警通道。
| 参数名 | 含义 |
|---|---|
| 通道名称 | 自定义 |
| 通道类型 | |
| SMTP 地址 | 邮件传送协议服务器 |
| SMTP 端口 | 邮件服务器使用的端口 |
| 发件人邮箱 | 发送邮件的用户名 |
| 密码 | 发送人的邮箱密码 |
| 收件人 | 当前租户下的用户，可多选，同时通知多人 |
| 备注 | 备注信息 |
# 编辑告警通道
进入【告警】>【告警通道】，选择需要编辑的告警通道并点击告警通道列表右侧【编辑】按钮，编辑告警通道。
# 删除告警通道
进入【告警】>【告警通道】，勾选需要删除的告警通道，点击告警通道列表右侧【删除】按钮，在确认框中点击【确认】删除告警通道。
# 告警规则
在控制台设置告警规则，满足设置条件后将会在设置的时间内触发告警！根据设置的频率发送告警！
# 创建告警规则
告警规则分为对所有集群有效的全局告警规则和针对单个集群生效的局部告警规则，打开全局开关则针对所有集群生效。 进入【告警】>【告警规则】，点击页面右上角【创建】按钮，创建告警规则。
- 节点状态告警：节点告警开关，开关开启节点告警则开启
- 规则名称：自定义告警规则名称
- 规则：设置告警触发的条件
- 比较符：比较运算选择
- 比较值：输入告警比较数值，满足该数值后将出发告警
- 周期：规则检查的周期：5min、10min、20min、30min、45min、1h、2h
- 是否生效：开关开启告警规则生效
- 是否全局：默认否，选择全局时该条规则将应用到当前租户的所有集
# 编辑告警规则
进入【告警】>【告警规则】，勾选相应的告警规则，点击列表右侧【编辑】按钮，编辑告警规则。
# 删除告警规则
进入【告警】>【告警规则】，勾选需要删除的告警规则，点击列表右侧【删除】按钮，编辑告警规则。也可选择多条告警规则点击左上角【删除】按钮批量删除。
# 账号权限与安全
# 三员管理
管控台采用五角色体系，各角色具有不同的菜单权限和职责范围：
- 系统管理员（
sys_admin）：负责建立账号；可见【租户】> 账号管理。 - 安全管理员（
sec_admin）：负责给账号分配角色（访问权限）；可见【租户】> 授权管理、密码策略。 - 审计管理员（
audit_admin）：负责审核管控台操作日志；可见【操作历史】。 - 租户管理员（
tenant_admin）：负责管理租户内的服务、用户；可见【租户】> 账号管理、密码策略、【操作历史】。 - AMDC管理员（
amdc_admin）：负责AMDC实例的全局管理；可见【监控中心】、【部署管理】（服务列表、自动部署、部署任务）、【资源管理】（安装包管理、证书管理、机器管理、配置模板）、【告警】。
三员管理员账号（系统管理员、安全管理员、审计管理员）由系统启动时自动生成，有且仅有一个账号，不能删除。所有预置账号首次登录均强制要求修改密码。
管控台功能的实际使用者分为两类：
- 管理员账号：管理员负责给租户创建服务、维护服务；
- 租户账号：对应分配给租户服务数据，可以使用这些服务和对服务的部分管理功能。 租户表示一个独立的环境，不同租户间数据相互隔离。租户也能在管控台上管理自己的服务（通过租户账号登录），但只有使用权，没有拥有权（无法自己决定缓存核心的删改）。
# 授权管理
进入【租户】>【授权管理】进入授权管理页面（仅安全管理员、租户管理员可见）。
租户中未分配组中是没有被分配任何一个租户的用户，这些用户需要先进行租户授权。
# 修改密码
新建账号没有初始密码，无法登陆，需要在授权管理中修改一次密码才可以进行登录。
# 激活与冻结
点击【激活/冻结】，将用户账号进行激活或者冻结操作，冻结后无法登录该账号。
# 操作历史
操作历史记录所有用户在控制台上的操作历史（仅审计管理员、租户管理员可见）。
# 密码策略
进入【租户】>【密码策略】进入密码策略页面，安全管理员可在此配置密码复杂度策略，包括：
- 密码最小长度：设置密码的最小字符数要求；
- 密码复杂度：设置密码是否必须包含大小写字母、数字、特殊字符等组合要求；
- 密码过期策略：设置密码有效期，过期后强制用户修改密码；
- 历史密码限制：设置禁止重复使用的历史密码数量。
配置完成后，所有用户在修改密码时都必须符合该策略要求。
# 密码与安全
为保证系统安全，管控台采用可配置的密码策略。安全管理员可在【租户】>【密码策略】中配置密码复杂度规则，配置后所有用户在修改密码时都必须符合该策略要求。
默认策略要求密码包含：
- 最小长度：6 位
- 最大长度：9 位
- 必须包含：数字、大写字母、小写字母、特殊字符
说明：实际环境中的密码策略以控制台当前配置为准。首次登录或密码过期时，系统会强制要求按当前策略修改密码。
# 三员管理中的初始密码
三员分别指：系统管理员（账号：sys_admin）、安全管理员（账号：sec_admin）、审计管理员（账号：audit_admin）。
管控台首次启动时会自动生成三员管理员账号，初始密码为12位随机密码，写入安装目录下的 ./resource/.initial_passwords 文件中。首次登录后系统会强制要求修改密码。
注意不能删除三个账号。
# 修改当前用户密码
登录控制台，点击首页右上角【用户信息】，在用户信息界面点击【更改密码】按钮，在弹窗中修改当前用户的登录密码。
# 安全管理员修改用户密码
系统管理员可以修改“管理员”、“普通用户”的用户信息，管理员可以修改“普通用户”的信息。进入【租户】>【授权管理】，选中用户后点击【修改密码】按钮，即可修改该用户密码。