Pular para o conteúdo
AggregaAggrega
Selecionar língua: Português (Brasil)
Esta página foi traduzida automaticamente. Leia o original em inglês.

Esquema do arquivo de bloqueio por Release do Aggrega

Referência gerada. Não edite à mão — gere novamente a partir do JSON Schema publicado.

ID do esquema: https://aggrega.ai/schemas/lockfile-v1beta1.schema.json

Arquivo de bloqueio gerado automaticamente que fixa cada URI resolvido a partir de uma Release para builds futuros determinísticos. Fica em <release-stem>.lock ao lado de <release-stem>.yaml; produzido por aggrega pull --release <release>; consumido por aggrega build --release <release>. Duas formas de procedência registram duas relações distintas no grafo de dependências: referenced_from (lista de strings) aparece em entities, como caminhos pontilhados de locais de autoria que registram de onde, na Release / Aggregate / Manifest / .aggrega-config.yaml, cada URI foi incluído, e em plugins, como a referência de cada entidade Plugin pela qual um artefato foi alcançado; consumers (lista de registros {consumer_uri, fragments}) aparece em schema_libraries, mapping_libraries, workload_libraries e artifact_libraries para registrar qual entidade do catálogo referencia quais fragmentos <entry-name> de uma biblioteca — a forma estruturada torna rastreáveis os diffs dos consumidores afetados por um aumento de versão de uma biblioteca sem resolver a Release novamente. Disciplina de evolução do esquema: adicionar uma nova seção de nível superior é SemVer-MINOR (aditivo); adicionar um novo campo dentro de uma seção existente é SemVer-MINOR; remover uma chave ou tornar uma restrição mais rígida é SemVer-MAJOR.

Tipo de nível superior: object

Propriedades

PropriedadeTipoObrigatóriaDescrição
entitiesobject[]nãoEntidades do catálogo alcançáveis a partir desta Release: Component, Feature, Recipe, FeatureRecipe, Plugin, Aggregate, o Aggregate e o Manifest próprios da Release, e o Manifest que esse Manifest estende. Cada entrada é identificada pelo seu kind junto com o seu URI canônico, de modo que duas entidades de tipos diferentes que compartilham um nome — um Aggregate e um Manifest ambos chamados imported/flow, por exemplo — são duas entradas, cada uma conferida com o próprio digest. Cada uma registra a versão resolvida, o digest do que a entidade carrega e as origens nos locais de autoria (referenced_from) que incluíram o URI no fechamento de dependências da Release. Um lockfile cujas entradas não carregam nenhum kind está desatualizado: aggrega pull --release <release> o grava novamente. Valor padrão: []
external_inputsExternalInput[]nãoEntradas remotas fixadas no armazenamento de entradas endereçado por conteúdo no momento da aquisição — conteúdo que a renderização de um plugin de provedor consome de fora do espaço de trabalho, como documentos de esquema remotos ou dependências de chart não vendorizadas. Cada entrada fixa uma URL ao digest que nomeia seus bytes no armazenamento. O build serve as entradas fixadas a partir do armazenamento e lê esta seção sem acesso à rede. Valor padrão: []
generated_atstringsimCarimbo de data/hora RFC 3339 do pull que produziu este arquivo de bloqueio; o padrão restringe o valor a essa forma quando o arquivo de bloqueio é carregado. Procedência de diagnóstico — registra o momento da resolução segundo o relógio do sistema. Muda intencionalmente entre pulls; não faz parte da garantia de identidade byte a byte do arquivo de bloqueio. Padrão: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$.
mapping_librariesLibraryEntry[]nãoEntradas de MappingLibrary que o fechamento de dependências da Release alcança por meio de locais valuesMapping: { $import: ... } de Recipe / FeatureRecipe. A lista consumers de cada entrada registra qual entidade do catálogo referencia quais fragmentos <entry-name> da biblioteca — um registro estruturado que torna rastreáveis os diffs do impacto de um aumento de versão da biblioteca sem resolver a Release novamente. Valor padrão: []
mutatorsobject[]nãoVinculações de governança com papel de transformação resolvidas, na ordem em que foram escritas. Um plugin com papel de transformação (label-transform, que reescreve os rótulos dos nós; ou annotation-transform, que injeta anotações antes da expansão) molda os bytes da saída renderizada, de modo que o conjunto de vinculações — a lista ordenada, mais, por vinculação, o papel, a coordenada do plugin e a função exportada — é uma entrada que determina os bytes, fixada aqui. O build lê esta seção — nunca .aggrega-config.yaml — para reconstruir o conjunto, a ordem, o papel e a função exportada, de modo que a saída do build é invariante a uma alteração em plugins.governance feita após o pull (adotada apenas no pull seguinte). A ordem é SEMÂNTICA: cada executor de transformação aplica as vinculações do seu papel na ordem da lista, de modo que, ao contrário das seções plugins / providers ordenadas por URI, esta lista nunca é reordenada. O digest de conteúdo do plugin NÃO é duplicado aqui: ele tem uma única fonte nas seções plugins e entities, para as quais este registro aponta por identidade. Valor padrão: []
pluginsobject[]nãoOs plugins Wasm cujos bytes moldam a saída renderizada, cada um fixado pelo digest de conteúdo do seu .wasm: um plugin de governança vinculado em um papel de transformação (label-transform, annotation-transform) sob .aggrega-config.yaml plugins.governance, mais quaisquer URIs de plugins embutidos provenientes de Recipes / FeatureRecipes / Providers referenciados. Um plugin de governança vinculado em um papel de veredito (ir-verdict, render-verdict) e uma vinculação plugins.linter retornam um veredito e não moldam nenhum byte de saída, de modo que nenhum dos dois é fixado: nenhum aparece aqui ou sob entities, e os arquivos de regras que uma vinculação de veredito lê são registrados sob verdict_inputs. Valor padrão: []
providersobject[]nãoSeleções de provedor por capacidade resolvidas. Cada entrada fixa uma capacidade (p. ex. helm) à identidade OCI sem digest do plugin de renderização do provedor que a renderiza, resolvida no pull a partir da lista plugins.providers de .aggrega-config.yaml (quando a capacidade é servida de forma ambígua) ou a partir do único plugin que a serve (quando não há ambiguidade). O build lê esta seção — nunca .aggrega-config.yaml — para selecionar o provedor, de modo que a saída do build é invariante a alterações na configuração do espaço de trabalho feitas após o pull. O digest de conteúdo do plugin NÃO é duplicado aqui: ele tem uma única fonte nas seções plugins e entities, para as quais este registro aponta por identidade. A coexistência de versões é preservada: este registro seleciona o repositório do plugin por capacidade; as versões concretas ficam em entities (uma entrada por versão de plugin resolvida), e a fixação de versão spec.capability de cada Recipe escolhe entre elas na renderização. Valor padrão: []
releasestringsimCaminho para a Release a que este arquivo de bloqueio corresponde, resolvido em relação ao próprio diretório do arquivo de bloqueio (p. ex. ./release-prod.yaml). A convenção de nomenclatura por Release coloca <release-stem>.lock ao lado de <release-stem>.yaml; o caminho relativo torna o arquivo de bloqueio autodescritivo, sem caminhos absolutos específicos da máquina. Isto nomeia a Release; o que a Release continha quando foi resolvida é registrado em release_documents.
release_documentsobject[]nãoOs arquivos da Release que a resolução leu, cada um registrado pelo digest de conteúdo dos seus bytes: primeiro a Release à qual este arquivo de bloqueio pertence, depois cada Release que ela estende, na ordem em que a cadeia extends é percorrida. Tudo o que uma Release pede é resolvido a partir do que ela contém, de modo que uma Release editada após o pull deixa de corresponder ao seu digest registrado, e um build — ou aggrega pull --verify — é interrompido nomeando o arquivo, com aggrega pull --release <release> como correção, antes que qualquer coisa seja renderizada. O digest cobre os bytes como estão, sem nada normalizado, a mesma regra que as fixações do Aggregate e do Manifest seguem: uma edição de um comentário ou de espaços em branco conta como uma alteração. Um arquivo de bloqueio sem esta seção não registra nenhum arquivo da Release, e um build que tenha um arquivo de bloqueio assim informa a Release como não registrada. Um arquivo que a Release importa por meio de parameters não é registrado aqui.
schema_librariesLibraryEntry[]nãoEntradas de SchemaLibrary que o fechamento de dependências da Release alcança por meio de locais $ref e $import: no conteúdo schema: / usesSchema: / featuresSchema: das entidades. A lista consumers de cada entrada registra qual entidade do catálogo referencia quais fragmentos <entry-name> da biblioteca — um registro estruturado que torna rastreáveis os diffs do impacto de um aumento de versão da biblioteca sem resolver a Release novamente. Valor padrão: []
source_artifactsSourceArtifactEntry[]nãoArtefatos de fonte obtidos dos campos spec.source de Recipe / FeatureRecipe no momento do pull. Cada entrada identifica uma identidade {kind, url, chart, pinned_version} única com o digest de conteúdo, o tipo de mídia e os ponteiros de retorno estruturados referenced_by: que nomeiam cada entidade do catálogo resolvida para este artefato. url é a URL de identidade escrita pelo autor; o local resolvido do artefato para uma fonte helm de raiz do repositório é registrado separadamente em resolved_url: como procedência. Várias Recipes que fixam o mesmo chart na mesma versão são deduplicadas em uma única entrada com vários registros referenced_by:. O enum de tipos cobre os quatro tipos de fonte que são resolvidos, e terraform-module-oci, que nenhum adaptador de fonte serve: uma Recipe ou uma FeatureRecipe que o nomeie é recusada assim que é lida, de modo que nenhum pull registra uma entrada desse tipo. Valor padrão: []
toolchainobjectnãoVersões da toolchain que produziu este arquivo de bloqueio: a própria versão do compilador e a versão de cada plugin core que o compilador traz. Registradas para que um arquivo de bloqueio responda a posteriori qual compilador e quais plugins core resolveram e renderizaram um build — uma pergunta que as seções fixadas nem sempre conseguem responder, porque um plugin de provedor core servido de dentro do binário do compilador fica sem fixação e, portanto, não carrega nenhuma versão registrada própria. Somente versões: o carimbo nunca registra de onde vieram os bytes de um plugin, de modo que duas máquinas que fixaram o mesmo fechamento de dependências com o mesmo compilador escrevem o mesmo carimbo. Nada compara esta seção, emite avisos sobre ela ou recusa um build por causa dela, e sua ausência de um arquivo de bloqueio é silenciosa: a toolchain não faz parte do fechamento de dependências que o arquivo de bloqueio fixa. Pelo mesmo motivo, a seção é dispensada da comparação de identidade byte a byte entre dois pulls das mesmas entradas, em pé de igualdade com generated_at.
verdict_inputsobject[]nãoEntradas de regras externas que uma vinculação de governança com papel de veredito (ir-verdict / render-verdict) lê em tempo de compilação — um arquivo de regras Kyverno / Rego fornecido por meio do with.sources da vinculação. Registradas como um digest de conteúdo por fonte, para auditoria e para a visibilidade do desvio entre um pull e outro: o digest que determinou um veredito pode ser comparado entre pulls, de modo que um arquivo de regras alterado aparece como um diff do arquivo de bloqueio. Esta seção é PROCEDÊNCIA, não uma entrada do build: diferentemente de mutators.sources, ela não traz nenhum content, e o build NÃO a lê — um plugin de veredito é armazenado em cache em vez de fixado e lê suas entradas de regras ao vivo (o veredito não determina nenhum byte da saída, então nada do que o arquivo de bloqueio fixa para uma saída determinística o inclui). Como um plugin de veredito não é fixado, ele está ausente das seções entities / plugins; por isso este registro identifica a vinculação pelo seu URI escrito pelo autor, de forma autônoma em vez de apontar para essas seções. Registrar o digest torna as entradas que determinaram uma decisão de aceitação ou rejeição auditáveis e reproduzíveis sem fixá-las no build. Valor padrão: []
versionconst 1simVersão do esquema do arquivo de bloqueio: 1. Uma alteração SemVer-MAJOR no esquema a incrementa. Constante: 1
workload_librariesLibraryEntry[]nãoEntradas de WorkloadLibrary que o fechamento de dependências da Release alcança por meio de locais workload: { $import: ... } de Recipe. A lista consumers de cada entrada registra qual entidade do catálogo faz referência a quais fragmentos <entry-name> da biblioteca — um registro estruturado que torna rastreáveis os diffs do impacto de um aumento de versão da biblioteca sem resolver a Release novamente. Valor padrão: []
artifact_librariesLibraryEntry[]nãoEntradas de ArtifactLibrary que o fechamento de dependências da Release alcança por meio de locais artifacts.<name>: { $import: ... } de Recipe / FeatureRecipe. A lista consumers de cada entrada registra qual entidade do catálogo faz referência a quais pacotes <entry-name> da biblioteca — um registro estruturado que torna rastreáveis os diffs do impacto de um aumento de versão da biblioteca sem resolver a Release novamente. Valor padrão: []

Não são permitidas propriedades adicionais.

lockfile.entities[]

PropriedadeTipoObrigatóriaDescrição
kindstring (enum)simTipo da entidade do catálogo, lido de onde a Release, o seu Aggregate ou o seu Manifest a nomeia: component e feature para um tipo de Component ou de Feature que o Aggregate, a Release ou um mapeamento do Manifest nomeia, recipe e feature_recipe para uma realização que um mapeamento do Manifest vincula, plugin para uma entidade Plugin, aggregate para o Aggregate próprio da Release e cada Aggregate que ele inclui, e manifest para o Manifest próprio da Release e o Manifest que ele estende. Junto com uri, identifica a entrada: um build compara cada entrada com a entidade do mesmo tipo e URI, de modo que uma edição em qualquer uma de duas entidades homônimas de tipos diferentes é percebida. Valores permitidos: "aggregate", "component", "feature", "feature_recipe", "manifest", "plugin", "recipe"
uristringsimURI canônico da entidade do catálogo (por exemplo hub.aggrega.ai/component/core/compute/api-server).
resolved_versionstringsimVersão concreta que o resolvedor selecionou no momento do pull — a versão própria de uma entidade do catálogo (por exemplo 1.2.3), ou vazia para uma entidade de nível superior resolvida por caminho em vez de por versão. Registrada como um único segmento de caminho, porque nomeia um, então não contém /, nem \, nem ..: o valor forma o slot do cache a partir do qual o build relê esta entidade, e um valor que saísse do diretório do cache nomearia um local fora dele. Padrão: ^([^/\\.]|\.[^/\\.])*\.?$.
digeststringsimDigest do que uma publicação da entidade traz, no formato sha256: seguido de 64 caracteres hexadecimais minúsculos: o SHA-256 calculado sobre o documento da entidade e sobre cada arquivo que ela declara ao lado dele, ordenados por caminho, cada um contribuindo com seu caminho e o SHA-256 de seus bytes. Uma entidade que não declara nenhum arquivo conta como seu único documento. Nada mais entra nele — nem a forma como um arquivo compactado foi comprimido, nem um carimbo de tempo, nem nenhum bit de permissão, incluindo o bit de execução — de modo que a entidade registra o mesmo digest seja lida de um diretório de catálogo ou obtida de um registro, e em qualquer checkout dos mesmos arquivos, em qualquer sistema. Padrão: ^sha256:[a-f0-9]{64}$.
manifest_digeststringnãoDigest do manifesto OCI do artefato resolvido, no formato sha256: seguido de 64 caracteres hexadecimais minúsculos. A assinatura se vincula a este digest, e o manifesto nomeia o digest dos bytes publicados, contra o qual uma obtenção e uma leitura do cache são verificadas antes que a entidade seja confrontada com o seu digest acima. Presente apenas para uma entidade resolvida a partir de um registro. Padrão: ^sha256:[a-f0-9]{64}$.
referenced_fromstring[]nãoOrigens nos locais de autoria — caminhos pontilhados no YAML de Release / Aggregate / Manifest (por exemplo aggregate.spec.components.api.type) que registram por que este URI está no fechamento de dependências da Release. Valor padrão: []
signatureVerifiedSignaturenãoFato de assinatura verificada registrado quando a assinatura desta entidade foi verificada no momento do pull, em relação à política de confiança do registro que a resolveu.
deprecationDeprecationRecordnãoMarcador de descontinuação retroativo verificado, registrado quando um marcador de descontinuação assinado e confiável foi descoberto neste artefato no momento do pull. Um marcador é um referrer OCI assinado do artefato que ele descontinua, anexado após a publicação sem republicar o artefato. Registra a severidade e a mensagem do marcador, além do signatário verificado que o criou. O build lê esse fato e aplica a política de descontinuação apenas a partir do arquivo de bloqueio; ele nunca redescobre nem reverifica o marcador.

Não são permitidas propriedades adicionais.

lockfile.mutators[]

PropriedadeTipoObrigatóriaDescrição
pluginstringsimCoordenada resolvida do plugin com papel de transformação — a identidade <pluginType>/<name> de uma entidade Plugin (por exemplo governance/tag-injector). Une-se por identidade às seções plugins e entities para o digest fixado e o conjunto de versões.
rolestring (enum)simO papel de transformação ao qual esta vinculação está ligada, registrado literalmente a partir da entrada plugins.governance escrita pelo autor, de modo que um build executa a vinculação exatamente nesse papel em vez de deduzir um: label-transform reescreve os rótulos dos nós durante a construção da topologia; annotation-transform injeta anotações antes da expansão, durante a resolução. Valores permitidos: "label-transform", "annotation-transform"
functionstringnãoSubstituição da exportação que a vinculação nomeia. Quando ausente, é selecionada a exportação padrão do papel (mutate para label-transform, transform_annotations para annotation-transform).
settingsobjectnãoObjeto de configurações de formato livre que a vinculação declarou, fixado como foi escrito e entregue ao plugin literalmente. O build lê as configurações daqui — nunca da configuração em vigor — de modo que uma alteração de configurações posterior ao pull não move a saída do build. Ausente quando a vinculação não declara nenhuma.
sourcesobject[]nãoFixações endereçadas por conteúdo dos arquivos de fonte declarados pela vinculação, em ordem de nome base. O build reconstrói a fonte que o plugin lê a partir do conteúdo registrado de cada fixação em vez de uma leitura ao vivo no host, de modo que a saída do build permanece invariante a uma alteração do arquivo de fonte posterior ao pull. Ausente quando a vinculação não declara nenhum.

Não são permitidas propriedades adicionais.

lockfile.mutators[].sources[]
PropriedadeTipoObrigatóriaDescrição
contentstringsimO conteúdo do arquivo de fonte, trazido literalmente para que o build reconstrua a entrada de fonte do plugin a partir do arquivo de bloqueio.
digeststringsimO endereço de conteúdo do conteúdo registrado, no formato sha256: seguido de 64 caracteres hexadecimais minúsculos. Um novo pull compara o arquivo subjacente com este digest para detectar desvios. Padrão: ^sha256:[a-f0-9]{64}$.
pathstringsimO nome base do arquivo de fonte — nunca um caminho absoluto do host, de modo que a fixação é portável e determinística.

Não são permitidas propriedades adicionais.

lockfile.plugins[]

PropriedadeTipoObrigatóriaDescrição
uristringsimIdentidade simples do artefato .wasm do plugin Wasm — o caminho <pluginType>/<name> (por exemplo governance/aggrega-security-baseline). O primeiro segmento é o tipo do plugin (provider, linter, pipeline-step, governance, cli, parser, importer); o segmento seguinte é o nome do plugin. Tipo e nome juntos formam a identidade do plugin — o mesmo nome sob dois tipos são dois plugins. O local físico de obtenção é derivado desta identidade mais o registro configurado, e nunca é trazido no arquivo de bloqueio.
resolved_versionstringsimO digest de conteúdo para o qual o artefato Wasm foi resolvido, no formato sha256: seguido de 64 caracteres hexadecimais minúsculos. Um artefato de plugin é endereçado por conteúdo em vez de nomeado por versão — um .wasm viaja inline no manifesto do seu plugin e é fixado pelo digest dos seus bytes — então este campo registra esse digest, que é também o digest abaixo. Ele forma o slot do cache a partir do qual o build relê o artefato, então não contém /, nem \, nem .., o que o formato sha256: já exclui. Padrão: ^sha256:[a-f0-9]{64}$.
digeststringsimDigest de conteúdo do artefato Wasm resolvido, no formato sha256: seguido de 64 caracteres hexadecimais minúsculos — o formato em que o endereço de conteúdo é escrito em todo lugar onde é comparado. Padrão: ^sha256:[a-f0-9]{64}$.
manifest_digeststringnãoDigest do manifesto OCI do artefato Wasm resolvido, no formato sha256: seguido de 64 caracteres hexadecimais minúsculos. A assinatura se vincula a este digest; o digest de conteúdo acima é a identidade portável usada para a fixação no cache e a verificação de integridade. Presente apenas para um artefato resolvido a partir de um registro. Padrão: ^sha256:[a-f0-9]{64}$.
referenced_fromstring[]nãoPor que este artefato está no fechamento de dependências da Release: a referência de cada entidade Plugin pela qual ele foi alcançado, tal como a seção entities registra essa entidade (por exemplo governance/label-injector:1.0.0). Valor padrão: []
signatureVerifiedSignaturenãoFato de assinatura verificada registrado quando a assinatura deste plugin foi verificada no momento do pull, em relação à mesma política de confiança por registro aplicada às entidades do catálogo.
deprecationDeprecationRecordnãoMarcador de descontinuação retroativo verificado, registrado quando um marcador de descontinuação assinado e confiável foi descoberto neste artefato no momento do pull. Um marcador é um referrer OCI assinado do artefato que ele descontinua, anexado após a publicação sem republicar o artefato. Registra a severidade e a mensagem do marcador, além do signatário verificado que o criou. O build lê esse fato e aplica a política de descontinuação apenas a partir do arquivo de bloqueio; ele nunca redescobre nem reverifica o marcador.

Não são permitidas propriedades adicionais.

lockfile.providers[]

PropriedadeTipoObrigatóriaDescrição
capabilitystringsimA capacidade para a qual esta associação seleciona um provedor — o nome simples da capacidade que uma Recipe associa por meio de spec.capability (por exemplo helm, compose).
pluginstringsimIdentidade simples do plugin de renderização do provedor resolvido (a identidade da entidade Plugin, seus metadata.pluginType e metadata.name unidos por uma barra, por exemplo provider/helm). Une-se por identidade às seções plugins e entities para o digest fixado e o conjunto de versões.

Não são permitidas propriedades adicionais.

lockfile.release_documents[]

PropriedadeTipoObrigatóriaDescrição
digeststringsimO digest de conteúdo dos bytes do arquivo de Release no momento em que a resolução os leu, no formato sha256: seguido de 64 caracteres hexadecimais minúsculos. Padrão: ^sha256:[a-f0-9]{64}$.
pathstringsimO caminho do arquivo de Release relativo ao diretório que contém a Release à qual este arquivo de bloqueio pertence, com barras normais (por exemplo release-prod.yaml, ../shared/base-release.yaml) — nunca um caminho absoluto do host, de modo que a entrada é portável e determinística.

Não são permitidas propriedades adicionais.

lockfile.toolchain

Versões da toolchain que produziu este arquivo de bloqueio: a própria versão do compilador e a versão de cada plugin core que o compilador traz. Registradas para que um arquivo de bloqueio responda a posteriori qual compilador e quais plugins core resolveram e renderizaram um build — uma pergunta que as seções fixadas nem sempre conseguem responder, porque um plugin de provedor core servido de dentro do binário do compilador fica sem fixação e, portanto, não carrega nenhuma versão registrada própria. Somente versões: o carimbo nunca registra de onde vieram os bytes de um plugin, de modo que duas máquinas que fixaram o mesmo fechamento de dependências com o mesmo compilador escrevem o mesmo carimbo. Nada compara esta seção, emite avisos sobre ela ou recusa um build por causa dela, e sua ausência de um arquivo de bloqueio é silenciosa: a toolchain não faz parte do fechamento de dependências que o arquivo de bloqueio fixa. Pelo mesmo motivo, a seção é dispensada da comparação de identidade byte a byte entre dois pulls das mesmas entradas, em pé de igualdade com generated_at.

PropriedadeTipoObrigatóriaDescrição
compiler_versionstringsimVersão do compilador que escreveu este arquivo de bloqueio, no formato sem v que toda superfície do Aggrega informa (1.2.0, não v1.2.0). Um build carimbado com uma versão registra essa versão — um build de release com tag, sua tag — e um build sem carimbo de versão registra o marcador (devel), de modo que um arquivo de bloqueio produzido por um compilador sem carimbo não seja confundido com saída de release. Registrada como um único segmento de caminho, então não contém /, nem \, nem ... Padrão: ^([^/\\.]|\.[^/\\.])*\.?$.
core_pluginsobject[]simVersão de cada plugin core que o compilador traz, uma entrada por plugin, ordenadas pela coordenada do plugin. Um plugin core é publicado na tag própria do compilador com a mesma versão, então estas versões são lidas da mesma forma, quer o compilador tenha servido um plugin de dentro de si mesmo, quer o tenha obtido de um registro — que é o que mantém o carimbo livre de detalhes específicos da máquina. Vazio para um build que não traz plugins core. Valor padrão: []

Não são permitidas propriedades adicionais.

lockfile.toolchain.core_plugins[]
PropriedadeTipoObrigatóriaDescrição
pluginstringsimCoordenada do plugin core — a identidade <pluginType>/<name> de uma entidade Plugin (por exemplo provider/helm), a mesma identidade pela qual as seções providers e mutators nomeiam um plugin.
versionstringsimVersão deste plugin core, no formato sem v que toda superfície do Aggrega informa. Registrada como um único segmento de caminho, então não contém /, nem \, nem ... Padrão: ^([^/\\.]|\.[^/\\.])*\.?$.

Não são permitidas propriedades adicionais.

lockfile.verdict_inputs[]

PropriedadeTipoObrigatóriaDescrição
pluginstringsimO URI do plugin escrito pelo autor para a vinculação de veredito, como está escrito em .aggrega-config.yaml plugins.governance (por exemplo governance/aggrega-security-baseline:1.0.0). Identifica a qual vinculação pertencem as entradas de regras registradas; um plugin de veredito é armazenado em cache em vez de fixado, então não tem nenhuma entrada nas seções plugins / entities à qual se unir.
rolestring (enum)simO papel de veredito ao qual esta vinculação está ligada — ir-verdict (durante a análise estática, sobre o grafo IR) ou render-verdict (durante a renderização, sobre os artefatos renderizados). Distingue o mesmo plugin vinculado nas duas etapas de veredito, cada uma potencialmente com suas próprias entradas de regras. Valores permitidos: "ir-verdict", "render-verdict"
sourcesobject[]nãoDigests de conteúdo dos arquivos de entrada de regras declarados pela vinculação, em ordem de nome base. Ausente quando a vinculação não declara fontes.

Não são permitidas propriedades adicionais.

lockfile.verdict_inputs[].sources[]
PropriedadeTipoObrigatóriaDescrição
digeststringsimO endereço de conteúdo dos bytes do arquivo de entrada de regras no momento do pull, no formato sha256: seguido de 64 caracteres hexadecimais minúsculos. Um novo pull o recalcula, de modo que um arquivo de regras alterado aparece como um diff do arquivo de bloqueio. Padrão: ^sha256:[a-f0-9]{64}$.
pathstringsimO nome base do arquivo de entrada de regras — nunca um caminho absoluto do host, de modo que a entrada é portável e determinística.

Não são permitidas propriedades adicionais.

Definições

DeprecationRecord

Marcador de descontinuação retroativo verificado, registrado quando um marcador de descontinuação assinado e confiável foi descoberto neste artefato no momento do pull. Um marcador é um referrer OCI assinado do artefato que ele descontinua, anexado após a publicação sem republicar o artefato. Registra a severidade e a mensagem do marcador, além do signatário verificado que o criou. O build lê esse fato e aplica a política de descontinuação apenas a partir do arquivo de bloqueio; ele nunca redescobre nem reverifica o marcador.

PropriedadeTipoObrigatóriaDescrição
messagestringsimMensagem de descontinuação legível por pessoas trazida pelo marcador — normalmente uma indicação para a migração.
severitystring (enum)simSeveridade do marcador, ordenada warning < error < retracted. O build é interrompido quando esta severidade atinge ou excede o limiar de interrupção configurado, e emite um aviso caso contrário. Valores permitidos: "warning", "error", "retracted"
signerVerifiedSignaturenãoSignatário verificado do marcador, registrado da mesma forma que o signatário da assinatura de um artefato: o sujeito/emissor do certificado para a assinatura keyless, ou a impressão digital da chave fixada para a assinatura com chave. Um marcador é um artefato assinado por si só, então seu signatário tem o mesmo formato que a assinatura de um artefato — e o bundle_digest aqui nomeia o bundle de assinatura próprio do marcador em vez do do artefato descontinuado.

Não são permitidas propriedades adicionais.

ExternalInput

Uma única entrada externa fixada: a URL que uma renderização solicitou, a fixação SHA-256 que nomeia seus bytes no armazenamento de entradas endereçado por conteúdo (sha256/<digest>), o tamanho do payload e a procedência dos consumidores que a exigiram. A fixação é autoritativa — uma URL fixada é sempre servida a partir do armazenamento, e um novo preenchimento do armazenamento é verificado contra este digest antes que os bytes cheguem a uma renderização.

PropriedadeTipoObrigatóriaDescrição
required_bystring[]simProcedência — os locais de renderização que solicitaram esta entrada. Ordenados e desduplicados pelo gravador do arquivo de bloqueio.
sha256stringsimFixação SHA-256 em hexadecimal minúsculo. Para uma entrada https, o digest dos bytes do payload; para uma entrada oci, o digest do manifesto para o qual a referência foi resolvida. Nomeia o blob do armazenamento em sha256/<digest>. Padrão: ^[0-9a-f]{64}$.
sizeintegersimTamanho em bytes do payload fixado. Uma contagem de bytes nunca é negativa. Mínimo: 0.
urlstringsimA URL da entrada como escrita no local de renderização — a chave de busca que associa uma solicitação em tempo de renderização à sua fixação.

Não são permitidas propriedades adicionais.

LibraryEntry

Formato comum compartilhado pelas entradas de schema_libraries, mapping_libraries, workload_libraries e artifact_libraries. A lista consumers captura a relação no grafo do catálogo — qual entidade do catálogo faz referência a quais fragmentos <entry-name> desta biblioteca — e dá suporte a diffs estruturados do impacto quando o digest da biblioteca muda. Uma biblioteca é um artefato OCI como qualquer outro, então ela registra os mesmos fatos verificados que uma entidade do catálogo: o digest do manifesto ao qual sua assinatura se vincula, a própria assinatura verificada e qualquer marcador de descontinuação retroativo verificado descoberto no momento do pull.

PropriedadeTipoObrigatóriaDescrição
uristringsimURI canônico da entidade de biblioteca.
resolved_versionstringsimVersão concreta resolvida no momento do pull (seleção de versão mínima sobre o grafo de dependências entre bibliotecas) — a versão própria da biblioteca. Registrada como um único segmento de caminho, porque forma o slot do cache a partir do qual o build relê a biblioteca, então não contém /, nem \, nem ..: um valor que saísse do diretório do cache nomearia um local fora dele. Padrão: ^([^/\\.]|\.[^/\\.])*\.?$.
digeststringsimDigest de conteúdo do artefato de biblioteca resolvido, no formato sha256: seguido de 64 caracteres hexadecimais minúsculos — o formato em que o endereço de conteúdo é escrito em todo lugar onde é comparado. Padrão: ^sha256:[a-f0-9]{64}$.
manifest_digeststringnãoDigest do manifesto OCI do artefato de biblioteca resolvido, no formato sha256: seguido de 64 caracteres hexadecimais minúsculos. A assinatura se vincula a este digest; o digest de conteúdo acima é a identidade portável usada para a fixação no cache e a verificação de integridade. Presente apenas para uma biblioteca resolvida a partir de um registro. Padrão: ^sha256:[a-f0-9]{64}$.
signatureVerifiedSignaturenãoFato de assinatura verificada registrado quando a assinatura desta biblioteca foi verificada no momento do pull, em relação à mesma política de confiança por registro aplicada às entidades do catálogo.
deprecationDeprecationRecordnãoMarcador de descontinuação retroativo verificado descoberto nesta biblioteca no momento do pull. O build o informa e, onde o espaço de trabalho configurou um limiar de interrupção que a severidade registrada atinge, é interrompido — de modo que uma biblioteca retirada depois que a versão foi fixada é anunciada em todo build em vez de apenas na seleção de versão, que uma versão fixada explicitamente contorna.
consumersobject[]nãoRegistros de qual entidade do catálogo faz referência a esta biblioteca e a quais fragmentos <entry-name>. Captura o fan-in: muitos consumidores por biblioteca, cada um potencialmente fazendo referência a muitos fragmentos. Cada registro traz o URI do consumidor mais o conjunto de fragmentos que esse consumidor incorpora. Valor padrão: []

Não são permitidas propriedades adicionais.

LibraryEntry.consumers[]

PropriedadeTipoObrigatóriaDescrição
consumer_uristringsimURI canônico da entidade do catálogo que faz referência a esta biblioteca: um Component ou uma Feature para uma biblioteca de esquemas, uma Recipe ou uma FeatureRecipe para uma biblioteca de mappings, de workloads ou de artefatos, ou outra biblioteca do mesmo tipo cujas entradas fazem referência a esta.
fragmentsstring[]simConjunto de fragmentos <entry-name> aos quais este consumidor faz referência dentro da biblioteca (por exemplo ["#/schemas/PortSpec", "#/schemas/EndpointSpec"]). A ordem é canonizada lexicograficamente pelo gravador.

Não são permitidas propriedades adicionais.

SourceArtifactEntry

Uma única fixação de artefato de fonte: a identidade {kind, url, chart, module_subdir, pinned_version}, o digest de conteúdo que verifica o pull, o tipo de mídia canônico e os ponteiros de retorno estruturados para cada entidade do catálogo resolvida para este artefato. chart e module_subdir são os dois termos seletores — cada um nomeia o que a URL sozinha não nomeia, para os tipos que precisam de um.

PropriedadeTipoObrigatóriaDescrição
kindenumsimO tipo de fonte. Determina qual adaptador resolveu o artefato e qual tipo de mídia é esperado. terraform-module-oci pertence ao conjunto, e nenhum adaptador de fonte o serve: uma Recipe ou uma FeatureRecipe que o nomeie é recusada assim que é lida. Valores permitidos: "helm-oci-chart", "helm-https-chart", "compose-https-fragment", "git-repository", "terraform-module-oci"
urlstringsimA URL escrita pelo autor — a URL de identidade como escrita em spec.source.url da Recipe. Para helm-https-chart, é a raiz do repositório (forma de raiz do repositório) ou o .tgz direto (forma direta), exatamente como escrito; o build reconstrói essa mesma URL offline, então ela é a identidade estável pela qual a fixação é indexada. Para git-repository, a URL do repositório clonável. Para helm-oci-chart, a referência do registro. Para compose-https-fragment, a URL HTTPS do fragmento. O local resolvido do artefato para uma fonte helm de raiz do repositório é registrado separadamente em resolved_url: como procedência.
chartstringnãoO nome do chart para uma fonte helm de raiz do repositório (spec.source.chart da Recipe), parte da identidade {kind, url, chart, module_subdir, pinned_version}, de modo que dois charts servidos a partir de uma mesma raiz do repositório na mesma versão são fixados em entradas distintas. Ausente para uma fonte .tgz direta, OCI, compose ou git, nenhuma das quais seleciona um chart dentro da URL.
module_subdirstringnãoO diretório, dentro de um repositório de origem git, que constitui o artefato (spec.source.module_subdir da Recipe), parte da identidade {kind, url, chart, module_subdir, pinned_version}, de modo que dois diretórios de um mesmo repositório no mesmo commit são fixados em entradas distintas. Ausente quando o repositório inteiro é o artefato, e para todo tipo que alcança seu artefato por URL em vez de descer em um clone.
pinned_versionstringsimA versão concreta fixada no momento do pull. Para os tipos helm-*, a versão do chart. Para git-repository, o commit para o qual a referência escrita pelo autor foi resolvida (NÃO a referência original de tag/branch — essa é registrada em requested_ref: em cada entrada referenced_by:, sempre que a Recipe escreveu um spec.source.ref:). Um build encontra esta entrada pelo que a Recipe escreveu: o ref: escrito pelo autor, onde houver um, comparado com o requested_ref: registrado, e, caso contrário, este valor fixado — de modo que uma Recipe que nomeia uma tag é resolvida para o commit em que essa tag foi fixada, sem que o commit jamais apareça na Recipe. Registrada como um único segmento de caminho, porque forma o slot do cache a partir do qual o build relê o artefato, então não contém /, nem \, nem ... Padrão: ^([^/\\.]|\.[^/\\.])*\.?$.
resolved_urlstringnãoApenas procedência: o local concreto do artefato para o qual a URL escrita pelo autor foi resolvida no momento do pull. Para uma fonte helm de raiz do repositório, é a URL do .tgz direto para a qual o índice do repositório resolveu chart+versão; é registrada para diagnóstico e NÃO faz parte da identidade do artefato. Ausente quando o local resolvido é igual à URL escrita pelo autor (uma fonte .tgz direta, OCI, compose ou git).
digeststringsimDigest de conteúdo do arquivo compactado .tar.gz resolvido, no formato sha256: seguido de 64 caracteres hexadecimais minúsculos. A verificação em tempo de build lê os bytes do slot do cache, recalcula o digest e o compara com este campo; uma divergência interrompe o build, informando uma divergência do digest de conteúdo. Padrão: ^sha256:[a-f0-9]{64}$.
manifest_digeststringnãoDigest do manifesto OCI do artefato resolvido, no formato sha256: seguido de 64 caracteres hexadecimais minúsculos. O manifesto é a raiz de confiança independente contra a qual o arquivo compactado em cache é verificado; o digest de conteúdo acima é a identidade portável usada para a fixação no cache e a verificação de integridade. Presente apenas para uma fonte distribuída via OCI (um helm-oci-chart). Padrão: ^sha256:[a-f0-9]{64}$.
mediatypestringsimTipo de mídia canônico anunciado pelo registro (ou o padrão do tipo para tipos sem metadados de registro). Registrado como procedência para diagnóstico.
referenced_bySourceArtifactReference[]simEntidades do catálogo resolvidas para este artefato, ordenadas por (uri, field) para uma saída determinística. Uma entrada só existe porque uma Recipe ou uma FeatureRecipe a obteve por meio de um pull, então a lista nunca está vazia. Pelo menos 1 entrada.

Não são permitidas propriedades adicionais.

SourceArtifactReference

Um único ponteiro de retorno entidade do catálogo → artefato de fonte. entity + uri juntos identificam a entidade do catálogo; field nomeia o caminho do lado da fonte dentro da spec da entidade onde o artefato foi declarado. O requested_ref: opcional preserva o spec.source.ref: escrito pelo autor da Recipe, e é escrito sempre que a Recipe escreveu um (tags/branches de git-repository → SHA do commit).

PropriedadeTipoObrigatóriaDescrição
entityenumsimO tipo de entidade do catálogo que contém este ponteiro de retorno. Valores permitidos: "recipe", "feature_recipe"
uristringsimURI canônico da Recipe ou da FeatureRecipe (por exemplo hub.aggrega.ai/recipe/helm/mariadb-bitnami:1.0.0).
fieldstringsimCaminho do lado da fonte dentro da spec da entidade onde o artefato foi declarado. O valor é spec.source.
requested_refstringnãoOpcional — o spec.source.ref: escrito pelo autor da Recipe, escrito sempre que a Recipe escreveu um. Para uma Recipe git-repository que escreve ref: v1.0.0, isto preserva "v1.0.0" enquanto pinned_version: contém o commit para o qual essa referência foi resolvida. Ausente quando a Recipe não escreve nenhum ref:, o que vale para todo tipo cujo resolvedor fixa literalmente a versão escrita pelo autor (helm-, compose-). Ele cumpre duas funções ao mesmo tempo, e registrá-lo incondicionalmente é o que impede que elas se excluam mutuamente. Um build o usa como chave de junção para encontrar esta entrada a partir de uma Recipe que nomeia a referência em vez do commit. E um pull que não é uma atualização mantém cada referência registrada em sua versão fixada: uma referência que se moveu em seu remoto interrompe a execução em vez de ser adotada.

Não são permitidas propriedades adicionais.

VerifiedSignature

Fato de assinatura verificada registrado quando a assinatura de um artefato foi verificada no momento do pull, em relação à política de confiança do registro que o resolveu. Todo artefato assinável o registra da mesma forma — uma entidade do catálogo, uma biblioteca, um plugin Wasm — porque todos são verificados por um único caminho em vez de um por tipo. Registra o modo de verificação, a identidade/o emissor keyless que correspondeu (quando keyless) e o digest endereçado por conteúdo do bundle de assinatura no cache de conteúdo. O build não executa a verificação novamente. Antes que qualquer coisa seja renderizada, ele lê este fato em cada entrada a partir da qual faz o build, em cada seção: recalcula o hash do bundle em cache e compara o resultado com bundle_digest, sendo interrompido onde o blob está ausente ou difere; e, para uma entrada servida pelo cache de conteúdo, lê desse bundle para qual artefato a assinatura foi feita, e é interrompido onde ela foi feita para um artefato diferente daquele que o build leu para a entrada — de modo que uma signature copiada de uma entrada para outra é recusada, independentemente do que diga o requisito de assinatura. Um build não verifica nenhuma assinatura, então um bundle escrito à mão no cache, emitido para o próprio artefato da entrada, não é distinguido de um que um pull verificou. E onde a configuração de confiança do espaço de trabalho exige uma assinatura para uma entrada servida pelo cache de conteúdo — o requisito que pull aplica quando obtém o artefato, de modo que as isenções e um registro advisory que permitem a um pull admitir um artefato sem assinatura permitem também ao build admitir sua entrada — uma entrada que não traz nenhum fato interrompe o build. Uma entrada lida a partir de um diretório de catálogo, da cópia dentro do binário do compilador ou de ao lado da Release nunca é submetida a esse requisito.

PropriedadeTipoObrigatóriaDescrição
bundle_digeststringsimDigest SHA-256 do blob do bundle de assinatura em cache, no formato sha256: seguido de 64 caracteres hexadecimais minúsculos. Ele nomeia o blob do cache, então forma um caminho e não contém /, nem \, nem .. — o que o formato sha256: já exclui — e, em uma entrada de qualquer seção, é aquilo contra o qual um build recalcula o hash desse blob. Padrão: ^sha256:[a-f0-9]{64}$.
identitystringnãoSignatário verificado da assinatura: o sujeito do certificado de assinatura para uma assinatura keyless, ou keyed:sha256: seguido do SHA-256 do texto PEM da chave pública fixada para uma assinatura com chave.
issuerstringnãoEmissor OIDC verificado para uma assinatura keyless. Vazio para uma assinatura com chave.
modestring (enum)simModo de verificação que admitiu a assinatura. Valores permitidos: "keyless", "keyed"

Não são permitidas propriedades adicionais.