Glossário
Os termos estão em ordem alfabética. Para conhecer as ideias por trás deles, leia Conceitos.
A
Conta
O acesso de uma pessoa ao servidor: um nome de 3 a 64 caracteres e uma senha de 12 a 128 caracteres. As concessões de grupo dão a uma conta acesso aos repositórios. Consulte Contas e acesso.
Ação
Um direito exato sobre um repositório, como upload.create ou content.read. As chaves de serviço carregam ações, e a referência da API nomeia as ações de que cada operação precisa. Consulte Autenticação.
Administrador
Uma conta que gerencia contas, grupos, atualizações e backups. Um administrador não lê os arquivos de um repositório, a menos que um grupo também conceda esse acesso. Consulte Contas e acesso.
Admissão
O limite de quantas solicitações e transferências o servidor processa ao mesmo tempo. Acima dele, uma transferência espera brevemente e então o servidor responde 503 com o código busy e um cabeçalho Retry-After. Consulte Limites de taxa e servidores ocupados.
Artefato
Um arquivo armazenado imutável, com seu SHA-256. Conteúdo novo cria um novo artefato. Consulte Conceitos.
Anexo
Um vínculo de um build com outro artefato do mesmo repositório: um manifesto, um SBOM, uma assinatura, um relatório ou outro arquivo. Um build tem até 32 anexos. Consulte Conceitos.
B
Backup
Uma cópia agendada do banco de dados e de todo o conteúdo publicado para o armazenamento de backups (vault). Consulte Backups.
Agente de backup
O serviço que faz as cópias, verifica-as e aplica a retenção aos pontos de restauração. Consulte Backups.
Token bearer
A forma como todo cliente envia uma credencial para /api/v1: o cabeçalho Authorization: Bearer <credential>. Consulte Autenticação.
Vínculo (binding)
Uma entrada de uma política de serviço: um repositório e a lista de ações permitidas nele. Uma política tem até 64 vínculos. Consulte Autenticação.
Build
A saída de uma execução de CI, armazenada como um artefato ou como uma versão de pacote. Consulte Pacotes.
C
Catálogo
A lista de artefatos de um repositório, com seus nomes, tamanhos, rótulos e estágios. Consulte Referência de artefatos.
Teto (ceiling)
O limite de uma delegação: as ações de repositório que um operador pode incluir nas políticas e chaves das contas que administra. O operador não pode ultrapassar seu teto. Consulte Autenticação.
Soma de verificação (checksum)
O SHA-256 que comprova que os bytes são os esperados. Os uploads o declaram antes de os bytes chegarem, e o servidor e os clientes o verificam. Consulte Transferências.
Limpeza física (cleanup)
Também chamada de limpeza física. Ela libera o espaço em disco do conteúdo excluído em segundo plano, em pequenos lotes. Consulte Armazenamento.
Coleção
Um conjunto nomeado de artefatos. Uma coleção faz parte das anotações de um artefato. Consulte Conceitos.
Comparação e troca (compare-and-swap)
Uma alteração que nomeia a revisão que espera, como expectedRevision. Se outra alteração veio primeiro, o servidor responde 409 com o motivo revision_mismatch e não altera nada. Consulte Visão geral da API HTTP.
Tarefa de conclusão
Uma tarefa em segundo plano do worker que verifica e publica um upload grande. Você a acompanha com GET /api/v1/jobs/{id}. Seu estado é queued, running, completed ou failed. Consulte Referência de uploads.
Console
A interface web do Arkvory, servida em /console/. Consulte O console web.
CORS
A regra do navegador para páginas que chamam uma API em outro endereço. Uma página de outra origem só funciona se o administrador listar essa origem em ARKVORY_CORS_ORIGINS. Consulte Variáveis de ambiente.
Cursor
O valor next em uma página de resultados. Envie-o de volta como after para ler a próxima página; quando next é null, a lista está completa. Consulte Visão geral da API HTTP.
D
Delegação
Uma concessão da chave de recuperação a uma chave de operador: ela pode administrar contas de serviço nomeadas, com ações de administração nomeadas, dentro de um teto. Consulte Autenticação.
Digest
O endereço de conteúdo de uma imagem de contêiner, escrito sha256:…. Consulte Imagens de contêiner.
Link de download
Um link com prazo limitado que baixa um artefato sem chave. Ele dura de 60 segundos a 24 horas (1 hora por padrão), e ninguém pode revogá-lo antes de expirar. Consulte Autenticação.
E
ETag
O validador de um download: o valor forte "sha256:<hex>" do artefato. Use-o com If-Range para retomar com segurança e com If-None-Match para pular um download repetido. Consulte Visão geral da API HTTP.
F
Failover
Mover clientes para um espelho quando a origem é perdida. O operador desanexa o espelho, e ele se torna um repositório comum que aceita alterações. Nada muda por conta própria. Consulte Espelhos.
Feedback
Um relatório com capturas de tela e logs que um usuário conectado envia à ProAnimaStudio pelo console. O console mostra o que está anexado antes de enviar qualquer coisa. Consulte O console web.
Arquivo por caminho
Um arquivo endereçado por um caminho no repositório, como builds/game/Setup.exe, que mantém suas revisões anteriores. Consulte Arquivos e caminhos.
Chave de arquivo
Um segredo cujo SHA-256 está listado no arquivo de chaves do servidor (ARKVORY_KEYS_FILE). A chave de recuperação é uma chave de arquivo. Consulte Autenticação.
G
Período de carência
O tempo que o conteúdo excluído permanece no disco antes de a limpeza física removê-lo: 24 horas por padrão. Consulte Armazenamento.
Grupo
Um conjunto de contas que compartilham acesso a repositórios. Um grupo recebe acesso read ou write ("Ler e escrever") por repositório. Consulte Contas e acesso.
H
Histórico
As revisões anteriores de um arquivo por caminho, ou de um conjunto de anexos. Consulte Arquivos e caminhos.
Hub
O serviço da ProAnimaStudio em https://hub.proanima.net que anuncia versões estáveis e recebe feedback. Consulte Atualizações.
I
Chave de idempotência
O cabeçalho Idempotency-Key: um valor de 1 a 128 caracteres que faz uma solicitação repetida ter efeito uma única vez. Consulte Visão geral da API HTTP.
Imagem
Uma imagem de contêiner armazenada no registro integrado. Consulte Imagens de contêiner.
Raiz da instalação
A pasta com os dados, a configuração e os logs: C:\ProgramData\ProAnima\Arkvory no Windows e /opt/proanima-arkvory no Linux. Consulte Escolher uma instalação.
L
Rótulo
Um rótulo curto em um artefato, como nightly ou tested. Um artefato tem até 32 rótulos. Consulte Conceitos.
Concessão (lease)
Uma concessão que um processo mantém por um curto período e precisa renovar, para que apenas um processo execute uma tarefa. O agente de backup mantém uma concessão de 60 segundos por padrão, de modo que dois agentes nunca são executados ao mesmo tempo. Consulte Variáveis de ambiente.
Vivacidade (liveness)
A resposta de GET /health/live: o processo está em execução. É público. Consulte Referência do sistema.
Bloqueio
Um bloqueio de arquivo do Git LFS que impede duas pessoas de alterar o mesmo arquivo binário. Consulte Git LFS.
M
Hora de manutenção
A hora do dia em UTC em que as atualizações automáticas podem ser instaladas. O padrão é 03:00. Consulte Atualizações.
Metadados
Campos de texto de chave/valor de um artefato: até 32 campos, com valores de até 1.024 caracteres. Consulte Conceitos.
Espelho
Uma cópia somente leitura de um repositório que uma segunda instalação mantém ao seguir a origem. Consulte Espelhos.
Origem do espelho
A instalação de onde um espelho copia. O espelho se conecta a ela com uma chave somente leitura. Consulte Espelhos.
Movimentação
Uma promoção que também remove o build do repositório de origem. Consulte Promoção.
O
Primeiros passos
Os primeiros passos após a instalação, mostrados no console na seção Primeiros passos. Consulte Início rápido.
OpenAPI
A descrição legível por máquina da API HTTP, servida em /api/v1/openapi.json. Consulte Visão geral da API HTTP.
Proprietário
A primeira conta, criada durante a instalação. Ela é um administrador e membro do grupo arkvory-owners, que pode gravar em releases. Consulte Conceitos.
P
Pacote
Um pacote UPack versionado com um grupo, um nome e uma versão SemVer. Consulte Pacotes.
Grupo do pacote
A primeira parte do nome de um pacote. Pacotes com o mesmo nome em grupos diferentes são pacotes diferentes. Consulte Pacotes.
Parte
Um pedaço de um arquivo grande enviado como uma solicitação própria. Uma parte tem pelo menos 8 MiB, exceto a última, e no máximo 1 GiB. Consulte Transferências.
Permissão
O direito de executar uma ação. Pessoas recebem read ou write por meio de grupos; chaves de serviço recebem ações exatas. Consulte Autenticação.
Token de acesso pessoal
O segredo de uma pessoa para scripts e a linha de comando. Ele começa com pat_, expira após 90 dias por padrão (365 no máximo) e é somente leitura ou leitura e gravação. Consulte Autenticação.
Fixar
Impedir que algo seja excluído automaticamente, como um ponto de restauração. Consulte Backups.
Política
As regras salvas de uma conta de serviço (seus vínculos), de um repositório (sua política de armazenamento) ou do plano de backup. Consulte Autenticação.
Promover
O verbo da promoção: publicar um build em outro repositório ou marcá-lo com um estágio. Consulte Promoção.
Promoção
Publicar um build em outro repositório sem enviá-lo novamente. Consulte Promoção.
Q
Cota
O máximo de espaço que um repositório pode usar. Um novo upload que o ultrapassaria é recusado com 507 e o motivo storage_quota. Consulte Armazenamento.
R
Range
O cabeçalho HTTP Range: bytes=start-end que pede parte de um arquivo. Os downloads aceitam um intervalo por solicitação, que é o que a retomada precisa. Consulte Visão geral da API HTTP.
Limite de taxa
Um limite de quantas vezes algo pode ser tentado. O Arkvory limita tentativas de login, registro, senha e feedback, e responde 429 com Retry-After. Consulte Autenticação.
Gateway de leitura
Um processo extra de API somente para download no mesmo armazenamento. Ele responde a GET e HEAD e recusa alterações com 405. Consulte Gateways de leitura.
Prontidão (readiness)
Se o servidor pode fazer seu trabalho. GET /health/status é público e responde {"status":"ready"} ou unavailable; GET /health/ready exige uma credencial e fornece detalhes. Consulte Referência do sistema.
Chave de recuperação
Também chamada de chave de bootstrap. O segredo da instalação em config/bootstrap-token.txt: ela cria o proprietário, gerencia contas de serviço e recupera o acesso. Consulte Autenticação.
Registro
Um servidor para o qual clientes como Docker ou npm enviam e do qual baixam. O Arkvory tem um registro de contêineres (/v2/) e um registro npm (/npm/). Consulte Clientes e protocolos.
Repositório
Um espaço nomeado para conteúdo, com suas próprias regras de acesso e política de armazenamento. Consulte Repositórios.
ID da solicitação
O identificador de uma solicitação, devolvido no cabeçalho X-Request-Id e em todo erro. Informe-o ao suporte. Consulte Visão geral da API HTTP.
Resolver
Encontrar o build para o qual um estágio e um intervalo de versões apontam. Consulte Promoção.
Restaurar
Tornar uma revisão anterior de um arquivo atual novamente, o que adiciona uma nova revisão. Também recuperar a instalação inteira a partir de um ponto de restauração. Consulte Arquivos e caminhos e Backups.
Ponto de restauração
Um backup completo que pode ser restaurado. Consulte Backups.
Retomar
Continuar um upload ou download interrompido de onde parou. Consulte Transferências.
Retenção
As regras sobre por quanto tempo o conteúdo ou os backups são mantidos. Consulte Armazenamento.
Política de retenção
As regras de retenção salvas de um repositório: quantos builds manter, quais rótulos proteger e com que idade um build deve estar antes da remoção. Ela fica desativada até que um administrador a ative. Consulte Armazenamento.
Retry-After
O cabeçalho, e o campo retryAfterSeconds de um erro, que informa quantos segundos esperar antes de tentar de novo após um 429 ou um 503. Consulte Visão geral da API HTTP.
Revisão
Uma versão numerada de um arquivo por caminho, das anotações de um artefato ou de uma configuração. As revisões começam em 1. Consulte Visão geral da API HTTP.
Revogar
Cancelar uma chave ou um token definitivamente. Consulte Autenticação.
Rollback
Voltar à versão anterior após uma atualização que não iniciou. Consulte Atualizações.
Rotacionar
Substituir uma chave por uma nova enquanto a antiga ainda funciona. Ativar a nova chave limita a antiga a 24 horas. Consulte Autenticação.
S
SBOM
Uma lista de materiais de software (software bill of materials): a lista de componentes de um build. Você pode anexá-la a um build. Consulte Conceitos.
Autorrecuperação
Os serviços reiniciando sozinhos após uma falha ou um travamento. Consulte Autorrecuperação.
SemVer
Versionamento semântico (SemVer): MAJOR.MINOR.PATCH, com uma parte de pré-lançamento opcional, como 1.4.2 ou 2.0.0-rc.1. Consulte Pacotes.
Conta de serviço
Uma conta para CI ou automação. Ela tem uma política e se conecta com chaves. Consulte Autenticação.
Chave de serviço
O segredo com que uma conta de serviço se conecta. Ele começa com arkvory_, é mostrado uma única vez e precisa ser ativado. Consulte Autenticação.
Sessão
Uma sessão conectada do console. Ela começa com dps_ e dura 12 horas. Consulte Autenticação.
SHA-256
A função de hash que o Arkvory usa para artefatos, partes e releases. Ela é escrita como 64 dígitos hexadecimais minúsculos. Consulte Transferências.
Versão estável
Uma versão que a ProAnimaStudio aprovou para instalações no canal estável. Consulte Atualizações.
Estágio
Uma marca em um build, como qa, release ou prod. Consulte Promoção.
Superfície (surface)
Um dos seis grupos de operações da API: discovery, identity, catalog, transfers, administration e operations. Consulte Visão geral da API HTTP.
T
Tag
O nome de uma versão de uma imagem de contêiner, como latest ou 1.4. Consulte Imagens de contêiner.
U
UPack
O formato de pacote que o Arkvory registra: um arquivo com um manifesto chamado upack.json que informa o grupo, o nome e a versão. Consulte Pacotes.
Atualização
Uma versão estável mais recente do Arkvory e sua instalação. Consulte Atualizações.
Upload
O ato de enviar um arquivo ao servidor. A palavra também nomeia a sessão de upload que reserva o arquivo. Consulte Transferências.
Sessão de upload
Uma reserva para um arquivo. Ela dura 7 dias e é concluída quando todos os bytes chegam. Consulte Referência de uploads.
V
Armazenamento de backups (vault)
O armazenamento de backups: uma pasta em outro disco ou um compartilhamento de rede. Consulte Backups.
Versão
Uma versão SemVer de um pacote, como 1.4.2. Consulte Pacotes.
Intervalo de versões
Um conjunto de versões, como ^1.4. Consulte Pacotes.
W
Worker
O serviço que conclui uploads grandes e sincroniza espelhos. Consulte Escolher uma instalação.
Escritor (writer)
O processo de API que aceita alterações, em oposição a um gateway de leitura. Consulte Gateways de leitura.