Глоссарий

Термины расположены в порядке английского алфавита, поэтому рядом с русским названием в скобках указано английское. Идеи, которые за ними стоят, описаны на странице Основные понятия.

A

Учётная запись (account)

Вход человека на сервер: имя из 3–64 символов и пароль из 12–128 символов. Групповые права дают учётной записи доступ к репозиториям. См. Учётные записи и доступ.

Действие (action)

Одно точное право на репозиторий, например upload.create или content.read. Ключи сервиса несут действия, а справочник API называет действия, которые нужны каждой операции. См. Аутентификация.

Администратор (administrator)

Учётная запись, которая управляет учётными записями, группами, обновлениями и резервными копиями. Администратор не читает файлы репозитория, если этот доступ не выдан ему ещё и группой. См. Учётные записи и доступ.

Допуск (admission)

Предел числа запросов и передач, которые сервер обрабатывает одновременно. Сверх него передача недолго ждёт, а затем сервер отвечает 503 с кодом busy и заголовком Retry-After. См. Лимиты и занятость сервера.

Артефакт (artifact)

Один неизменяемый сохранённый файл с его SHA-256. Новое содержимое создаёт новый артефакт. См. Основные понятия.

Вложение (attachment)

Ссылка из сборки на другой артефакт того же репозитория: манифест, SBOM, подпись, отчёт или другой файл. У сборки до 32 вложений. См. Основные понятия.

B

Резервная копия (backup)

Копия базы данных и всего опубликованного содержимого в хранилище копий, которая создаётся по расписанию. См. Резервные копии.

Агент резервного копирования (backup agent)

Служба, которая делает копии, проверяет их и применяет к точкам восстановления правила хранения. См. Резервные копии.

Bearer-токен (bearer token)

Способ, которым любой клиент передаёт учётные данные в /api/v1: заголовок Authorization: Bearer <ключ>. См. Аутентификация.

Привязка (binding)

Одна запись политики сервисной учётной записи: репозиторий и список действий, разрешённых на нём. В политике до 64 привязок. См. Аутентификация.

Сборка (build)

Результат одного запуска CI, сохранённый как артефакт или как версия пакета. См. Пакеты.

C

Каталог (catalog)

Список артефактов репозитория с их именами, размерами, метками и стадиями. См. Справочник по артефактам.

Потолок (ceiling)

Предел делегирования: действия над репозиториями, которые оператор может записывать в политики и ключи управляемых им учётных записей. Оператор не может выйти за свой потолок. См. Аутентификация.

Контрольная сумма (checksum)

SHA-256, доказывающая, что байты именно те, которых ждали. Загрузки объявляют её до того, как поступят байты, а сервер и клиенты её проверяют. См. Передачи.

Физическая очистка (cleanup)

Освобождает место на диске, занятое удалённым содержимым, в фоне, небольшими порциями. См. Хранение.

Коллекция (collection)

Именованный набор артефактов. Коллекция входит в описание артефакта вместе с метками и метаданными. См. Основные понятия.

Сравнение и замена (compare-and-swap)

Изменение, которое указывает ожидаемую версию, например expectedRevision. Если раньше прошло другое изменение, сервер отвечает 409 с причиной revision_mismatch и ничего не меняет. См. Обзор API.

Задание завершения (completion job)

Фоновое задание обработчика, которое проверяет и публикует большую загрузку. Следить за ним можно через GET /api/v1/jobs/{id}. Его статус — queued, running, completed или failed. См. Справочник по загрузкам.

Консоль (console)

Веб-интерфейс Arkvory, который доступен по адресу /console/. См. Веб-консоль.

CORS

Правило браузера для страниц, которые обращаются к API по другому адресу. Страница с другого источника работает, только если администратор перечислил этот источник в ARKVORY_CORS_ORIGINS. См. Переменные окружения.

Курсор (cursor)

Значение next на странице результатов. Отправьте его обратно как after, чтобы прочитать следующую страницу; когда next равно null, список закончился. См. Обзор API.

D

Делегирование (delegation)

Разрешение от ключа восстановления ключу оператора: оператор может управлять названными сервисными учётными записями, используя названные действия администрирования, в пределах потолка. См. Аутентификация.

Дайджест (digest)

Адрес содержимого образа контейнера в виде sha256:…. См. Образы контейнеров.

Ссылка на скачивание (download link)

Ограниченная по времени ссылка, которая скачивает один артефакт без ключа. Она действует от 60 секунд до 24 часов (по умолчанию 1 час), и до истечения срока её никто не может отозвать. См. Аутентификация.

E

ETag

Проверочное значение скачивания: строгое значение "sha256:<hex>" артефакта. Используйте его с If-Range, чтобы безопасно продолжить скачивание, и с If-None-Match, чтобы пропустить повторное скачивание. См. Обзор API.

F

Переключение на зеркало (failover)

Перевод клиентов на зеркало, когда источник потерян. Оператор отсоединяет зеркало, и оно становится обычным репозиторием, который принимает изменения. Само по себе ничего не переключается. См. Зеркала.

Обратная связь (feedback)

Сообщение со снимками экрана и журналами, которое вошедший пользователь отправляет в ProAnimaStudio из консоли. Консоль показывает, что приложено, до того как что-либо будет отправлено. См. Веб-консоль.

Файл по пути (file by path)

Файл, который адресуется путём в репозитории, например builds/game/Setup.exe, и хранит свои прежние версии. См. Файлы по пути.

Файловый ключ (file key)

Секрет, SHA-256 которого указан в файле ключей сервера (ARKVORY_KEYS_FILE). Ключ восстановления — файловый ключ. См. Аутентификация.

G

Защитный срок (grace period)

Время, в течение которого удалённое содержимое остаётся на диске, прежде чем его удалит очистка: по умолчанию 24 часа. См. Хранение.

Группа (group)

Набор учётных записей с общим доступом к репозиториям. Группа получает доступ read или write («Чтение и запись») для каждого репозитория. См. Учётные записи и доступ.

H

История (history)

Прежние версии файла по пути или набора вложений. См. Файлы по пути.

Хаб (hub)

Служба ProAnimaStudio по адресу https://hub.proanima.net, которая объявляет стабильные релизы и принимает обратную связь. См. Обновления.

I

Ключ идемпотентности (idempotency key)

Заголовок Idempotency-Key: значение из 1–128 символов, благодаря которому повторный запрос срабатывает один раз. См. Обзор API.

Образ (image)

Образ контейнера, который хранится во встроенном реестре. См. Образы контейнеров.

Корень установки (installation root)

Папка с данными, настройками и журналами: C:\ProgramData\ProAnima\Arkvory в Windows и /opt/proanima-arkvory в Linux. См. Выбор установки.

L

Метка (label)

Короткая метка артефакта, например nightly или tested. У артефакта до 32 меток. См. Основные понятия.

Аренда (lease)

Право на выполнение работы, которое процесс удерживает недолго и должен продлевать, чтобы задание выполнял только один процесс. Агент резервного копирования по умолчанию удерживает аренду 60 секунд, поэтому два агента никогда не работают одновременно. См. Переменные окружения.

Проверка живости (liveness)

Ответ GET /health/live: процесс работает. Эта проверка общедоступна. См. Справочник по системе.

Блокировка (lock)

Блокировка файла Git LFS, которая не даёт двум людям изменить один и тот же двоичный файл. См. Git LFS.

M

Час обслуживания (maintenance hour)

Час суток по UTC, в который разрешено устанавливать автоматические обновления. По умолчанию — 03:00. См. Обновления.

Метаданные (metadata)

Текстовые поля артефакта в виде «ключ — значение»: до 32 полей, значения — до 1024 символов. См. Основные понятия.

Зеркало (mirror)

Копия репозитория только для чтения, которую вторая установка поддерживает, следуя за источником. См. Зеркала.

Источник зеркала (mirror source)

Установка, с которой копирует зеркало. Зеркало входит в неё с ключом только для чтения. См. Зеркала.

Перенос (move)

Продвижение, которое ещё и удаляет сборку из исходного репозитория. См. Продвижение.

O

Первые шаги (onboarding)

Первые шаги после установки, которые консоль показывает в разделе «Начало работы». См. Быстрый старт.

OpenAPI

Машиночитаемое описание HTTP API, которое отдаётся по адресу /api/v1/openapi.json. См. Обзор API.

Владелец (owner)

Первая учётная запись, созданная при установке. Это администратор и участник группы arkvory-owners, которая может писать в releases. См. Основные понятия.

P

Пакет (package)

Пакет UPack с версией: группа, имя и версия SemVer. См. Пакеты.

Группа пакета (package group)

Первая часть имени пакета. Пакеты с одним именем в разных группах — разные пакеты. См. Пакеты.

Часть (part)

Один фрагмент большого файла, который отправляется отдельным запросом. Часть занимает не менее 8 МиБ (кроме последней) и не более 1 ГиБ. См. Передачи.

Право (permission)

Разрешение на одно действие. Люди получают read или write через группы; ключи сервиса получают точные действия. См. Аутентификация.

Персональный токен доступа (personal access token)

Секрет человека для скриптов и командной строки. Начинается с pat_, по умолчанию истекает через 90 дней (не более чем через 365) и бывает либо только для чтения, либо для чтения и записи. См. Аутентификация.

Закрепить (pin)

Защитить что-либо от автоматического удаления, например точку восстановления. См. Резервные копии.

Политика (policy)

Сохранённые правила сервисной учётной записи (её привязки), репозитория (его политика хранения) или плана резервного копирования. См. Аутентификация.

Продвинуть (promote)

Глагол от «продвижения»: опубликовать сборку в другом репозитории или отметить её стадией. См. Продвижение.

Продвижение (promotion)

Публикация сборки в другом репозитории без повторной загрузки. См. Продвижение.

Q

Квота (quota)

Наибольший объём, который может занять репозиторий. Новая загрузка, из-за которой он будет превышен, отклоняется с кодом 507 и причиной storage_quota. См. Хранение.

R

Диапазон (range)

HTTP-заголовок Range: bytes=start-end, который запрашивает часть файла. Скачивания поддерживают один диапазон на запрос — этого достаточно для продолжения. См. Обзор API.

Ограничение частоты (rate limit)

Предел того, как часто что-то можно пробовать. Arkvory ограничивает попытки входа, регистрации, смены пароля и отправки обратной связи и отвечает 429 с Retry-After. См. Аутентификация.

Шлюз чтения (read gateway)

Дополнительный процесс API только для скачивания на том же хранилище. Отвечает на GET и HEAD и отклоняет изменения кодом 405. См. Шлюзы чтения.

Готовность (readiness)

Способность сервера выполнять свою работу. GET /health/status общедоступен и отвечает {"status":"ready"} или unavailable; GET /health/ready требует учётных данных и выдаёт подробности. См. Справочник по системе.

Ключ восстановления (recovery key)

Он же ключ начальной настройки (bootstrap key). Секрет установки в config/bootstrap-token.txt: он создаёт владельца, управляет сервисными учётными записями и восстанавливает доступ. См. Аутентификация.

Реестр (registry)

Сервер, в который клиенты вроде Docker или npm отправляют данные и из которого их получают. В Arkvory есть реестр контейнеров (/v2/) и реестр npm (/npm/). См. Клиенты и протоколы.

Репозиторий (repository)

Именованное пространство для содержимого со своими правилами доступа и политикой хранения. См. Репозитории.

ID запроса (request ID)

Идентификатор одного запроса, который возвращается в заголовке X-Request-Id и в каждой ошибке. Сообщите его в поддержку. См. Обзор API.

Поиск по стадии (resolve)

Найти сборку, на которую указывают стадия и диапазон версий. См. Продвижение.

Восстановить (restore)

Сделать прежнюю версию файла снова текущей; при этом добавляется новая версия. Также — восстановить всю установку из точки восстановления. См. Файлы по пути и Резервные копии.

Точка восстановления (restore point)

Одна полная резервная копия, из которой можно восстановиться. См. Резервные копии.

Продолжить (resume)

Продолжить прерванную загрузку или скачивание с того места, где она остановилась. См. Передачи.

Хранение (retention)

Правила того, как долго хранятся содержимое или резервные копии. См. Хранение.

Политика хранения (retention policy)

Сохранённые правила хранения репозитория: сколько сборок оставлять, какие метки защищать и каким должен быть минимальный возраст сборки перед удалением. Пока администратор её не включит, она выключена. См. Хранение.

Retry-After

Заголовок и поле ошибки retryAfterSeconds, которые сообщают, сколько секунд ждать перед повторной попыткой после 429 или 503. См. Обзор API.

Версия, или ревизия (revision)

Пронумерованная версия файла по пути, описания артефакта или настройки. Номера растут с 1. В параметрах API она называется ревизией (expectedRevision). См. Обзор API.

Отозвать (revoke)

Навсегда отменить ключ или токен. См. Аутентификация.

Откатить (rollback)

Вернуться к предыдущей версии после обновления, которое не запустилось. См. Обновления.

Ротировать (rotate)

Заменить ключ новым, пока старый ещё работает. Активация нового ключа ограничивает срок действия старого 24 часами. См. Аутентификация.

S

SBOM

Software bill of materials — перечень компонентов сборки. Его можно приложить к сборке. См. Основные понятия.

Самовосстановление (self-healing)

Службы сами перезапускаются после сбоя или зависания. См. Самовосстановление.

SemVer

Семантическое версионирование (Semantic Versioning): MAJOR.MINOR.PATCH с необязательной предварительной частью, например 1.4.2 или 2.0.0-rc.1. См. Пакеты.

Сервисная учётная запись (service account)

Учётная запись для CI или автоматизации. У неё есть политика, а входит она по ключам. См. Аутентификация.

Ключ сервиса (service key)

Секрет, с которым входит сервисная учётная запись. Начинается с arkvory_, показывается один раз и требует активации. См. Аутентификация.

Сессия (session)

Сессия входа в консоль. Начинается с dps_ и длится 12 часов. См. Аутентификация.

SHA-256

Хеш-функция, которую Arkvory использует для артефактов, частей и релизов. Записывается как 64 шестнадцатеричные цифры в нижнем регистре. См. Передачи.

Стабильный релиз (stable release)

Релиз, который ProAnimaStudio одобрила для установок на стабильном канале. См. Обновления.

Стадия (stage)

Отметка на сборке, например qa, release или prod. См. Продвижение.

Область (surface)

Одна из шести групп операций API: discovery, identity, catalog, transfers, administration и operations. См. Обзор API.

T

Тег (tag)

Имя версии образа контейнера, например latest или 1.4. См. Образы контейнеров.

U

UPack

Формат пакета, который регистрирует Arkvory: архив с манифестом upack.json, где указаны группа, имя и версия. См. Пакеты.

Обновление (update)

Более новый стабильный релиз Arkvory и его установка. См. Обновления.

Загрузка (upload)

Отправка файла на сервер. Так же называется сессия загрузки, которая резервирует файл. См. Передачи.

Сессия загрузки (upload session)

Резервирование под один файл. Существует 7 дней и завершается, когда придёт каждый байт. См. Справочник по загрузкам.

V

Хранилище копий (vault)

Хранилище резервных копий: папка на другом диске или в сетевой папке. См. Резервные копии.

Версия (version)

Версия пакета по SemVer, например 1.4.2. См. Пакеты.

Диапазон версий (version range)

Набор версий, например ^1.4. См. Пакеты.

W

Обработчик (worker)

Служба, которая завершает большие загрузки и синхронизирует зеркала. См. Выбор установки.

Узел записи (writer)

Процесс API, который принимает изменения, в отличие от шлюза чтения. См. Шлюзы чтения.