术语表
术语按字母顺序排列。关于它们背后的概念,请阅读概念。
A
账户
人在服务器上的登录身份:由 3 到 64 个字符的名称和 12 到 128 个字符的密码组成。组授权让账户获得对仓库的访问权限。参见账户与访问。
操作
仓库上的一项确切权限,例如 upload.create 或 content.read。服务密钥携带操作,API 参考会列出每个操作所需的操作。参见身份验证。
管理员
管理账户、组、更新和备份的账户。除非某个组也授予管理员访问权限,否则管理员不读取仓库中的文件。参见账户与访问。
准入
服务器同时处理的请求和传输数量限制。超过该限制时,传输会短暂等待,然后服务器以 503 响应,并附带代码 busy 和 Retry-After 请求头。参见速率限制与繁忙的服务器。
制品
一个不可变的已存储文件及其 SHA-256。新内容会产生新制品。参见概念。
附件
从一次构建指向同一仓库中另一个制品的链接:清单、SBOM、签名、报告或其他文件。一次构建最多有 32 个附件。参见概念。
B
备份
按计划把数据库和所有已发布内容复制到备份存储中的副本。参见备份。
备份代理
制作副本、验证副本并对恢复点应用保留规则的服务。参见备份。
Bearer 令牌
每个客户端向 /api/v1 发送凭据的方式:请求头 Authorization: Bearer <credential>。参见身份验证。
绑定
服务策略中的一条条目:一个仓库以及允许对它执行的操作列表。一条策略最多有 64 个绑定。参见身份验证。
构建
一次 CI 运行的输出,以制品或包版本的形式存储。参见包。
C
目录
仓库中制品的列表,包含它们的名称、大小、标签和阶段。参见制品参考。
上限
委派的限制:运维人员可以放入其所管理账户的策略和密钥中的仓库操作。运维人员不能超出自己的上限。参见身份验证。
校验和
证明字节与预期一致的 SHA-256。上传会在字节到达之前声明它,服务器和客户端都会验证它。参见传输。
物理清理
也称 physical cleanup。它在后台以小批量方式释放已删除内容占用的磁盘空间。参见存储。
集合
一组有名称的制品。集合是制品注解的一部分。参见概念。
比较并交换
一种会指明所期望修订版本的更改,例如 expectedRevision。如果已有另一项更改先行发生,服务器会以 409 响应,原因为 revision_mismatch,并且不做任何更改。参见 HTTP API 概览。
完成作业
工作进程的一个后台作业,用于检查并发布大型上传。您可以通过 GET /api/v1/jobs/{id} 跟踪它。它的状态为 queued、running、completed 或 failed。参见上传参考。
控制台
Arkvory 的 Web 界面,位于 /console/。参见 Web 控制台。
CORS
针对调用其他地址上 API 的页面的浏览器规则。来自其他源的页面只有在管理员把该源列入 ARKVORY_CORS_ORIGINS 时才能工作。参见环境变量。
游标
结果页中的 next 值。将它作为 after 发送回去即可读取下一页;当 next 为 null 时,列表已完整。参见 HTTP API 概览。
D
委派
从恢复密钥授予运维密钥的一种授权:它可以在上限范围内管理指定的服务账户,并拥有指定的管理操作。参见身份验证。
摘要(digest)
容器镜像的内容地址,写作 sha256:…。参见容器镜像。
下载链接
一种限时链接,无需密钥即可下载一个制品。它的有效期为 60 秒到 24 小时(默认 1 小时),并且在过期之前无法撤销。参见身份验证。
E
ETag
下载的验证器:制品的强校验值 "sha256:<hex>"。把它与 If-Range 一起使用可以安全续传,与 If-None-Match 一起使用可以跳过重复下载。参见 HTTP API 概览。
F
故障切换
当源丢失时将客户端转移到镜像。运维人员会分离镜像,它随即成为接受更改的普通仓库。不会自动切换。参见镜像。
反馈
已登录用户从控制台向 ProAnimaStudio 发送的带截图和日志的报告。控制台会在发送任何内容之前显示将要附加的内容。参见 Web 控制台。
路径文件
通过仓库中的路径(例如 builds/game/Setup.exe)寻址并保留其早期修订版本的文件。参见文件与路径。
文件密钥
一种机密信息,其 SHA-256 列在服务器的密钥文件(ARKVORY_KEYS_FILE)中。恢复密钥就是一种文件密钥。参见身份验证。
G
宽限期
已删除内容在物理清理将其移除之前保留在磁盘上的时间:默认 24 小时。参见存储。
组
共享仓库访问权限的一组账户。组针对每个仓库获得 read 或 write(“读取和写入”)访问权限。参见账户与访问。
H
历史记录
某个路径文件或某组附件的早期修订版本。参见文件与路径。
中心(hub)
位于 https://hub.proanima.net 的 ProAnimaStudio 服务,用于发布稳定版并接收反馈。参见更新。
I
幂等键
Idempotency-Key 请求头:一个 1 到 128 个字符的值,使重复的请求只生效一次。参见 HTTP API 概览。
容器镜像
存储在内置注册表中的容器镜像。参见容器镜像。
安装根目录
包含数据、配置和日志的文件夹:在 Windows 上为 C:\ProgramData\ProAnima\Arkvory,在 Linux 上为 /opt/proanima-arkvory。参见选择一种安装。
L
标签
制品上的短标记,例如 nightly 或 tested。一个制品最多有 32 个标签。参见概念。
租约
一种进程在短时间内持有并且必须续期的声明,从而保证同一时间只有一个进程执行某项作业。备份代理默认持有 60 秒的租约,因此两个代理绝不会同时运行。参见环境变量。
存活
GET /health/live 的应答:进程正在运行。它是公开的。参见系统参考。
锁(文件锁)
一种 Git LFS 文件锁,用于阻止两个人修改同一个二进制文件。参见 Git LFS。
M
维护时段
UTC 时区中自动更新可以安装的当天时段。默认是 03:00。参见更新。
元数据
制品的键/值文本字段:最多 32 个字段,值最长为 1,024 个字符。参见概念。
镜像(仓库镜像)
由第二个安装实例通过跟随源来保存的仓库只读副本。参见镜像。
源(源实例)
镜像所复制的源安装实例。镜像使用只读密钥登录它。参见镜像。
移动
一种晋级方式,同时会从源仓库中移除该构建。参见晋级。
O
入门
安装后的最初步骤,显示在控制台的入门部分。参见快速入门。
OpenAPI
HTTP API 的机器可读描述,位于 /api/v1/openapi.json。参见 HTTP API 概览。
所有者
在安装期间创建的第一个账户。它是一名管理员,也是 arkvory-owners 组的成员,该组可以写入 releases。参见概念。
P
包
带有包组、名称和 SemVer 版本号的版本化 UPack 包。参见包。
包组
包名称的第一部分。不同组中同名的包是不同的包。参见包。
分片
大文件的一部分,作为独立的请求发送。除最后一片外,分片至少为 8 MiB,最大为 1 GiB。参见传输。
权限
执行一项操作的权限。用户通过组获得 read 或 write;服务密钥获得确切的操作。参见身份验证。
个人访问令牌
供脚本和命令行使用的人员机密。它以 pat_ 开头,默认 90 天后过期(最长 365 天),并且要么只读,要么可读写。参见身份验证。
固定
使某样东西(例如恢复点)免于自动删除。参见备份。
策略
服务账户(其绑定)、仓库(其存储策略)或备份计划的已保存规则。参见身份验证。
晋级
晋级这一动词:把构建发布到另一个仓库,或用阶段标记它。参见晋级。
晋级
在不重新上传的情况下把构建发布到另一个仓库。参见晋级。
Q
配额
一个仓库可以使用的最多空间。会使它超出的新上传会被拒绝,并返回 507 和原因 storage_quota。参见存储。
R
范围
HTTP 请求头 Range: bytes=start-end,用于请求文件的一部分。下载每次请求支持一个范围,这正是续传所需要的。参见 HTTP API 概览。
速率限制
对某项操作可以尝试的频率的限制。Arkvory 限制登录、注册、密码和反馈尝试,并以 429 和 Retry-After 响应。参见身份验证。
读取网关
同一存储上的额外只读下载 API 进程。它响应 GET 和 HEAD,并以 405 拒绝更改。参见读取网关。
就绪
服务器是否能完成其工作。GET /health/status 是公开的,会以 {"status":"ready"} 或 unavailable 响应;GET /health/ready 需要凭据并提供详细信息。参见系统参考。
恢复密钥(引导密钥)
也称引导密钥。位于 config/bootstrap-token.txt 中的安装机密:它创建所有者、管理服务账户并恢复访问。参见身份验证。
注册表(registry)
Docker 或 npm 等客户端向其推送和拉取的服务器。Arkvory 有一个容器注册表(/v2/)和一个 npm 注册表(/npm/)。参见客户端与协议。
仓库
命名的内容空间,拥有自己的访问规则和存储策略。参见仓库。
请求 ID
单个请求的标识符,通过 X-Request-Id 请求头以及每个错误中返回。请把它提供给支持人员。参见 HTTP API 概览。
解析(按阶段解析)
找出某个阶段和某个版本范围所指向的构建。参见晋级。
恢复
使文件的早期修订版本重新成为当前版本,这会新增一个修订版本。也指从恢复点恢复整个安装。参见文件与路径和备份。
恢复点
一个可恢复的完整备份。参见备份。
续传(继续上传或下载)
从中断的地方继续被中断的上传或下载。参见传输。
保留(保留规则)
内容或备份保留多长时间的规则。参见存储。
保留策略
仓库的已保存保留规则:保留多少个构建、保护哪些标签,以及构建在移除之前必须有多旧。在管理员打开它之前,它处于关闭状态。参见存储。
Retry-After
一种请求头,以及错误的 retryAfterSeconds 字段,它说明在 429 或 503 之后重试之前要等待多少秒。参见 HTTP API 概览。
修订版本
路径文件、制品注解或某项设置的编号版本。修订版本从 1 开始计数。参见 HTTP API 概览。
撤销
永久取消一个密钥或令牌。参见身份验证。
回滚
在更新未能启动之后返回到上一个版本。参见更新。
轮换
在旧密钥仍然可用的情况下用新密钥替换它。激活新密钥后,旧密钥的有效期被限制为 24 小时。参见身份验证。
S
SBOM
软件物料清单:一次构建的组件列表。您可以把它附加到构建。参见概念。
自愈
服务在崩溃或卡死之后自行重启。参见自愈。
SemVer
语义化版本:MAJOR.MINOR.PATCH,带一个可选预发布部分,例如 1.4.2 或 2.0.0-rc.1。参见包。
服务账户
供 CI 或自动化使用的账户。它有一份策略,并使用密钥登录。参见身份验证。
服务密钥
服务账户用于登录的机密。它以 arkvory_ 开头,只显示一次,并且必须被激活。参见身份验证。
会话
一个已登录的控制台会话。它以 dps_ 开头,持续 12 小时。参见身份验证。
SHA-256
Arkvory 用于制品、分片和发布的哈希函数。它写作 64 个小写十六进制数字。参见传输。
稳定版
ProAnimaStudio 已批准用于稳定通道上安装的版本。参见更新。
阶段
构建上的标记,例如 qa、release 或 prod。参见晋级。
接口分组
六组 API 操作之一:discovery、identity、catalog、transfers、administration 和 operations。参见 HTTP API 概览。
T
镜像标签(tag)
容器镜像某个版本的名称,例如 latest 或 1.4。参见容器镜像。
U
UPack
Arkvory 所注册的包格式:一个带有名为 upack.json 的清单的归档,该清单给出包组、名称和版本。参见包。
更新
Arkvory 的一个较新稳定版,以及安装它。参见更新。
上传
把文件发送到服务器的行为。该词也指预留该文件的上传会话。参见传输。
上传会话
针对一个文件的预留。它的有效期为 7 天,并在每个字节到达后完成。参见上传参考。
V
备份存储
备份的存储位置:另一块磁盘或网络共享上的文件夹。参见备份。
版本
包的 SemVer 版本,例如 1.4.2。参见包。
版本范围
一组版本,例如 ^1.4。参见包。
W
工作进程(worker)
负责完成大型上传并同步镜像的服务。参见选择一种安装。
写入进程
与读取网关相对、接受更改的 API 进程。参见读取网关。