首页 / 资讯中心 / 文章详情

Terminus(Olares)CLI 备份快照查询指南:`olares-cli backups snapshots` 命令全面解析

Terminus(Olares)CLI 备份快照查询指南:`olares-cli backups snapshots` 命令全面解析 ★ FEATURED ARTICLE
云原生后端运维【免费下载链接】TerminusOpen-Source Personal Cloud OS for Always-On Agents项目地址https://gitcode.com/gh_mirrors/terminus2/Terminus点击查看免费下载本文以 TerminusOlares开源项目自带的olares-cli命令行工具为对象系统讲解backups snapshots子命令的用法它用于列出指定备份仓库中的所有可用快照支持腾讯云 COS、Amazon S3、本地文件系统与 Olares Space 四种存储后端。读完本文你将掌握快照查询的完整命令语法、四种后端的认证参数配置并能结合仓库源码理解快照数据的底层结构从而高效完成备份仓库的巡检与恢复前的快照选择。命令定位备份体系中的仓库清单查看器olares-cli backups命令族提供了一组数据备份、恢复和快照管理工具官方文档 backups 将其子命令划分为五个子命令描述download下载 Restic 依赖工具region获取云名称和区域 ID仅 Olares Space 后端使用backup将数据备份到指定的存储后端restore从指定的存储后端恢复数据snapshots管理和查看备份快照从命令族的角度看snapshots承担着查看仓库里有什么的职责backup负责写入快照snapshots负责列出这些快照而restore则在拿到快照 ID 后执行恢复。三者形成完整的备份 → 查看 → 恢复闭环snapshots输出的快照 ID 正是restore --snapshot-id参数的直接来源参见 backups-restore。从源码结构看该命令族通过backups-sdk注册到 CLI在 cli/cmd/ctl/os/backup.go 中NewCmdBackup()直接返回backupssdk.NewBackupCommands()模块为olares.com/backups-sdk声明于 cli/go.mod。这意味着快照查询的具体参数解析与 Restic 调用逻辑封装在 SDK 层CLI 只负责把命令挂载到olares-cli的os即backups命令树下。前置条件必须先安装 Restic:::warning 必须先运行olares-cli backups download命令来安装 Restic否则直接运行snapshots命令将返回错误。 :::snapshots本质上是对 Restic 备份仓库的查询操作因此要求宿主机上存在可执行的restic二进制。download子命令负责完成安装olares-cli backups download [选项]其唯一可选参数--download-cdn-url用于指定 Restic 的 CDN 下载地址默认为系统内置 URL详见 backups-download。仓库中download的实际安装逻辑可以在 cli/pkg/files/file.go 中看到端倪Bzip2Cmd()会识别包含restic关键字的下载包将其从 bzip2 流解压到目标目录最后执行cp target /usr/local/bin/restic chmod x /usr/local/bin/restic把可执行文件安装到系统 PATH 中。也就是说安装成功后你可以直接验证restic version命令语法与通用选项snapshots子命令的基础语法为olares-cli backups snapshots 存储后端 --repo-name 仓库名称 [选项]其中存储后端为位置参数取值必须是cos、s3、fs、space之一--repo-name指定要查询的备份仓库名称需与 backup 创建仓库时使用的名称保持一致。以下选项适用于所有后端选项简写用途是否必需默认值--help-h显示命令帮助信息否无--repo-name设置要查询的备份仓库名称否无--repo-name在表中标注为否是 CLI 参数解析层的惯例其余参数均为可选、可为空但实际查询时仓库名称是 Restic 定位仓库目录/桶下数据的关键标识实践上应始终显式指定。存储后端配置选项snapshots需要与目标仓库的存储后端建立连接并完成身份认证各后端的配置选项如下。腾讯云对象存储cos选项简写用途是否必需默认值--access-key设置腾讯云 COS 的访问密钥否无--endpoint设置腾讯云 COS 的终端节点格式如https://cos.{region}.myqcloud.com/{bucket}/{prefix}否无--secret-access-key设置腾讯云 COS 的密钥否无--endpoint中的{region}需替换为 COS 所在地域如ap-guangzhou{bucket}为存储桶名称{prefix}为仓库所在的前缀目录。本地文件系统fs选项简写用途是否必需默认值--endpoint设置存储备份的本地目录路径否无本地后端无需任何凭据--endpoint直接指向存放备份仓库的本地目录例如外接磁盘的挂载路径适合离线备份或移动介质场景。Amazon S3s3选项简写用途是否必需默认值--access-key设置 Amazon S3 的访问密钥否无--endpoint设置 Amazon S3 的终端节点格式如https://{bucket}.{region}.amazonaws.com/{prefix}否无--secret-access-key设置 Amazon S3 的密钥否无Olares Spacespace选项简写用途是否必需默认值--access-token1设置 Olares Space 的访问令牌否无--cloud-api-mirror设置云 API 镜像地址否无--cloud-name设置 Olares Space 实例的云名称可通过region子命令获取否无--cluster-id2设置用于存储备份的集群 ID否无--olares-did1设置 Olares DID否无--region-id设置 Olares Space 实例的区域 ID可通过region子命令获取否无1. 获取访问令牌与 Olares DID请在登录 Olares Space 后检查页面网络请求的负载。token字段对应访问令牌--access-tokenuserid字段对应 Olares DID--olares-did。2. 获取集群 ID在 Olares 集群节点上执行以下命令kubectl get terminus -o jsonpath{.items[*].metadata.labels.bytetrade\.io/cluster-id}space后端是 Olares 官方云存储云名称与区域 ID 可通过region子命令先行探测olares-cli backups region space \ --access-token YOUR_ACCESS_TOKEN \ --cloud-api-mirror https://api-mirror.example.com \ --olares-did did:xyz123使用示例以下示例完整覆盖文档给出的典型场景# 列出腾讯云对象存储中的快照 olares-cli backups snapshots cos --repo-name my_repo \ --access-key YOUR_KEY \ --secret-access-key YOUR_SECRET \ --endpoint https://cos.region.myqcloud.com/bucket/prefix # 列出本地文件系统中的快照 olares-cli backups snapshots fs --repo-name my_repo --endpoint /backup_repo对应的 S3 与 Olares Space 写法如下# 列出 Amazon S3 中的快照 olares-cli backups snapshots s3 --repo-name my_repo \ --access-key YOUR_KEY \ --secret-access-key YOUR_SECRET \ --endpoint https://bucket.region.amazonaws.com/prefix # 列出 Olares Space 中的快照 olares-cli backups snapshots space --repo-name my_repo \ --access-token YOUR_ACCESS_TOKEN \ --cloud-api-mirror https://api-mirror.example.com \ --cloud-name my_cloud \ --region-id region_1 \ --cluster-id cluster_12345 \ --olares-did did:xyz123查询成功后输出中的快照 ID即可作为restore命令的--snapshot-id参数使用例如olares-cli backups restore fs --path /data_restore --repo-name my_repo \ --snapshot-id snapshot_12345 --endpoint /backup_repo快照数据的底层结构虽然backups snapshots直接驱动 Restic 读取仓库但 Olares 的备份体系在更高层面备份计划、备份服务端同样维护了一套快照元数据模型可以帮助理解快照在系统中的真实构成。在 framework/backup-server/pkg/apis/sys.bytetrade.io/v1/snapshot_types.go 中SnapshotSpec定义了快照的核心字段字段JSON 标签含义BackupIdbackupId所属备份计划的 IDLocationlocation存储位置后端标识SnapshotTypesnapshotType快照类型SnapshotIdsnapshotIdRestic 仓库中的快照 IDSizesize快照大小字节CreateAt/StartAt/EndAtcreateAt/startAt/endAt创建、开始、结束时间Progressprogress执行进度Phasephase当前阶段Messagemessage状态消息ResticPhase/ResticMessageresticPhase/resticMessageRestic 执行阶段与消息注意其中的SnapshotId字段正是 Restic 仓库中的快照标识而Size字段在网络传输时会被 framework/backup-server/pkg/handlers/helper.go 的ParseSnapshotSize统一格式化为十进制字符串fmt.Sprintf(%d, *size)。这说明在 Olares 的备份链路中快照元数据ID、大小、时间、状态、进度被持久化在 Kubernetes 自定义资源中用于支撑控制台与 CLI 的统一展示。与之对应CLI 的settings backup snapshots list子命令cli/cmd/ctl/settings/backup/snapshots.go读取的就是这套 API 数据其backupSnapshot结构体包含ID、CreateAt、Size字符串、Status、Progress五个字段并约定progress以**基点basis points**为单位0–1000010000 表示 100.00%在渲染表格时才转换为百分比size则通过humanBytes人性化为 KiB/MiB/GiB 等单位。这从侧面印证了快照查询输出中常见字段ID、状态、进度、大小、时间的数据来源与展示约定。此外Olares 集群的备份能力建立在 Velero 之上安装流程见 cli/pkg/terminus/velero.go其中以beclab/velero与beclab/velero-plugin-for-terminus镜像安装插件并创建名为terminus-cloud的 BackupStorageLocation--bucket terminus-cloud --prefix 。因此backups snapshots查询到的仓库在云原生层面对应着 Velero 备份位置所指向的存储。常见问题与排查要点1. 提示需要先安装 Restic直接运行snapshots时若返回错误按文档要求先执行olares-cli backups download完成安装再重新查询。可参考 backups-download 确认下载参数。2. 无法获取 Olares Space 的云名称 / 区域 ID--cloud-name与--region-id不是臆造的值必须先通过olares-cli backups region space携带--access-token与--olares-did查询获取详见 backups-region。3. 访问令牌过期或无效--access-token与--olares-did取自 Olares Space 页面网络请求负载中的token与userid字段重新登录后需同步更新这两个参数。4. 查询到的快照 ID 如何用于恢复snapshots输出的快照 ID 直接对应restore的--snapshot-id选项恢复前建议先用snapshots核对仓库中可用的快照时间点与数量避免指定已过期或不属于该仓库的快照 ID。小结olares-cli backups snapshots是 Olares 备份运维中最常用的只读巡查命令它不修改数据只负责把指定仓库中的快照清单呈现出来为restore提供准确的恢复依据。掌握四种后端cos、s3、fs、space的参数差异、理解--repo-name与存储位置endpoint/目录的对应关系并配合download、region、backup、restore兄弟命令使用即可在 Olares 上构建完整、可审计的数据备份与恢复工作流。赞分享云原生后端运维【免费下载链接】TerminusOpen-Source Personal Cloud OS for Always-On Agents项目地址https://gitcode.com/gh_mirrors/terminus2/Terminus点击查看免费下载相关推荐Terminus 中 olares-cli backups snapshots 命令详解查询备份仓库快照的完整指南Terminus 中 olares cli backups snapshots 命令详解查询备份仓库快照的完整指南 本篇技术指南聚焦 TerminusOla云原生后端运维TerminusOlaresolares-cli backups restore 命令完全指南从 COS/S3/本地文件系统/Olares Space 恢复备份数据TerminusOlares olares cli backups restore 命令完全指南从 COS/S3/本地文件系统/Olares Space云原生后端运维TerminusOlaresCLI backups 命令实战基于 Restic 的多后端数据备份、快照与恢复指南TerminusOlaresCLI backups 命令实战基于 Restic 的多后端数据备份、快照与恢复指南 olares cli backups 是云原生后端运维上一篇MTKClient设备修复终极指南从故障诊断到系统恢复的完整方案下一篇5步掌握XHS-Downloader高效小红书视频下载全攻略创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
阅读完成 · 觉得有帮助?
咨询建站