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

Esquema do ficheiro de bloqueio por Release do Aggrega

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

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

Ficheiro de bloqueio gerado automaticamente que fixa cada URI resolvido a partir de uma Release para compilações futuras determinísticas. Encontra-se em <release-stem>.lock junto a <release-stem>.yaml; produzido por aggrega pull --release <release>; consumido por aggrega build --release <release>. Duas formas de proveniência registam duas relações distintas no grafo de dependências: referenced_from (lista de cadeias) aparece em entities, como caminhos com pontos de locais de autoria que registam 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 através da qual um artefacto foi alcançado; consumers (lista de registos {consumer_uri, fragments}) aparece em schema_libraries, mapping_libraries, workload_libraries e artifact_libraries para registar que entidade do catálogo referencia que 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 voltar a resolver a Release. Disciplina de evolução do esquema: adicionar uma nova secção de nível superior é SemVer-MINOR (aditivo); adicionar um novo campo dentro de uma secçã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 juntamente com o seu URI canónico, pelo que duas entidades de tipos diferentes que partilham um nome — um Aggregate e um Manifest ambos chamados imported/flow, por exemplo — são duas entradas, cada uma confrontada com o seu próprio digest. Cada uma regista a versão resolvida, o digest daquilo que a entidade transporta e as origens nos locais de autoria (referenced_from) que incluíram o URI no fecho de dependências da Release. Um lockfile cujas entradas não contêm nenhum kind está desatualizado: aggrega pull --release <release> volta a escrevê-lo. Predefiniçã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 fornecedor consome de fora do espaço de trabalho, como documentos de esquema remotos ou dependências de chart não vendorizadas. Cada entrada fixa um URL ao digest que nomeia os seus bytes no armazenamento. A compilação serve as entradas fixadas a partir do armazenamento e lê esta secção sem acesso à rede. Predefinição: []
generated_atstringsimCarimbo temporal RFC 3339 do pull que produziu este ficheiro de bloqueio; o padrão restringe o valor a essa forma quando o ficheiro de bloqueio é carregado. Proveniência de diagnóstico — regista 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 ficheiro 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 fecho de dependências da Release alcança através de locais valuesMapping: { $import: ... } de Recipe / FeatureRecipe. A lista consumers de cada entrada regista que entidade do catálogo referencia que fragmentos <entry-name> da biblioteca — um registo estruturado que torna rastreáveis os diffs do impacto de um aumento de versão da biblioteca sem voltar a resolver a Release. Predefinição: []
mutatorsobject[]nãoAnexos de governação com papel de transformação resolvidos, pela ordem em que foram escritos. Um plugin com papel de transformação (label-transform, que reescreve as etiquetas dos nós; ou annotation-transform, que injeta anotações antes da expansão) molda os bytes da saída renderizada, pelo que o conjunto de anexos — a lista ordenada, mais, por anexo, o papel, a coordenada do plugin e a função exportada — é uma entrada que determina os bytes, fixada aqui. A compilação lê esta secção — nunca .aggrega-config.yaml — para reconstruir o conjunto, a ordem, o papel e a função exportada, pelo que a saída da compilação é invariante face a uma alteração a plugins.governance feita após o pull (adotada apenas no pull seguinte). A ordem é SEMÂNTICA: cada executor de transformação aplica os anexos do seu papel pela ordem da lista, pelo que, ao contrário das secções plugins / providers ordenadas por URI, esta lista nunca é reordenada. O digest de conteúdo do plugin NÃO é duplicado aqui: tem uma única fonte nas secções plugins e entities, para as quais este registo aponta por identidade. Predefiniçã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 governação anexado num papel de transformação (label-transform, annotation-transform) sob .aggrega-config.yaml plugins.governance, mais quaisquer URIs de plugins incorporados provenientes de Recipes / FeatureRecipes / Providers referenciados. Um plugin de governação anexado num papel de veredicto (ir-verdict, render-verdict) e um anexo plugins.linter devolvem um veredicto e não moldam nenhum byte de saída, pelo que nenhum dos dois é fixado: nenhum aparece aqui nem sob entities, e os ficheiros de regras que um anexo de veredicto lê são registados sob verdict_inputs. Predefinição: []
providersobject[]nãoSeleções de fornecedor por capacidade resolvidas. Cada entrada fixa uma capacidade (p. ex. helm) à identidade OCI sem digest do plugin de renderização do fornecedor 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). A compilação lê esta secção — nunca .aggrega-config.yaml — para selecionar o fornecedor, pelo que a saída da compilação é invariante face 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: tem uma única fonte nas secções plugins e entities, para as quais este registo aponta por identidade. A coexistência de versões é preservada: este registo seleciona o repositório do plugin por capacidade; as versões concretas encontram-se em entities (uma entrada por cada versão de plugin resolvida), e a fixação de versão spec.capability de cada Recipe escolhe entre elas na renderização. Predefinição: []
releasestringsimCaminho para a Release a que este ficheiro de bloqueio corresponde, resolvido em relação ao próprio diretório do ficheiro de bloqueio (p. ex. ./release-prod.yaml). A convenção de nomenclatura por Release coloca <release-stem>.lock junto a <release-stem>.yaml; o caminho relativo torna o ficheiro de bloqueio autodescritivo, sem caminhos absolutos específicos da máquina. Isto nomeia a Release; aquilo que a Release continha quando foi resolvida é registado em release_documents.
release_documentsobject[]nãoOs ficheiros da Release que a resolução leu, cada um registado pelo digest de conteúdo dos seus bytes: primeiro a Release à qual este ficheiro de bloqueio pertence, depois cada Release que ela estende, pela ordem em que a cadeia extends é percorrida. Tudo aquilo que uma Release pede é resolvido a partir do que contém, pelo que uma Release editada após o pull deixa de corresponder ao seu digest registado, e uma compilação — ou aggrega pull --verify — é interrompida nomeando o ficheiro, com aggrega pull --release <release> como correção, antes de qualquer coisa ser renderizada. O digest cobre os bytes tal 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 ficheiro de bloqueio sem esta secção não regista nenhum ficheiro da Release, e uma compilação que tenha um ficheiro de bloqueio assim indica a Release como não registada. Um ficheiro que a Release importa através de parameters não é registado aqui.
schema_librariesLibraryEntry[]nãoEntradas de SchemaLibrary que o fecho de dependências da Release alcança através de locais $ref e $import: no conteúdo schema: / usesSchema: / featuresSchema: das entidades. A lista consumers de cada entrada regista que entidade do catálogo referencia que fragmentos <entry-name> da biblioteca — um registo estruturado que torna rastreáveis os diffs do impacto de um aumento de versão da biblioteca sem voltar a resolver a Release. Predefinição: []
source_artifactsSourceArtifactEntry[]nãoArtefactos 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 artefacto. url é o URL de identidade escrito pelo autor; a localização resolvida do artefacto para uma fonte helm de raiz do repositório é registada separadamente em resolved_url: como proveniência. Várias Recipes que fixam o mesmo chart na mesma versão são deduplicadas numa única entrada com vários registos referenced_by:. O enum de tipos abrange 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, pelo que nenhum pull regista uma entrada desse tipo. Predefinição: []
toolchainobjetonãoVersões da toolchain que produziu este ficheiro de bloqueio: a própria versão do compilador e a versão de cada plugin core que o compilador inclui. Registadas para que um ficheiro de bloqueio responda a posteriori a que compilador e que plugins core resolveram e renderizaram uma compilação — uma pergunta a que as secções fixadas nem sempre conseguem responder, porque um plugin de fornecedor core servido a partir do interior do binário do compilador fica sem fixação e, portanto, não transporta nenhuma versão registada própria. Apenas versões: o carimbo nunca regista de onde vieram os bytes de um plugin, pelo que duas máquinas que fixaram o mesmo fecho de dependências com o mesmo compilador escrevem o mesmo carimbo. Nada compara esta secção, emite avisos sobre ela ou recusa uma compilação por causa dela, e a sua ausência de um ficheiro de bloqueio é silenciosa: a toolchain não faz parte do fecho de dependências que o ficheiro de bloqueio fixa. Pela mesma razão, a secçã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 um anexo de governação com papel de veredicto (ir-verdict / render-verdict) lê em tempo de compilação — um ficheiro de regras Kyverno / Rego fornecido através do with.sources do anexo. Registadas 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 veredicto pode ser comparado entre pulls, pelo que um ficheiro de regras alterado surge como um diff do ficheiro de bloqueio. Esta secção é PROVENIÊNCIA, não uma entrada da compilação: ao contrário de mutators.sources, não tem nenhum content, e a compilação NÃO a lê — um plugin de veredicto é colocado em cache em vez de fixado e lê as suas entradas de regras em direto (o veredicto não determina nenhum byte da saída, pelo que nada daquilo que o ficheiro de bloqueio fixa para uma saída determinística o inclui). Uma vez que um plugin de veredicto não é fixado, está ausente das secções entities / plugins; por isso este registo identifica o anexo pelo seu URI escrito pelo autor, de forma autónoma em vez de apontar para essas secções. Registar o digest torna as entradas que determinaram uma decisão de aceitação ou rejeição auditáveis e reproduzíveis sem as fixar na compilação. Predefinição: []
versionconst 1simVersão do esquema do ficheiro de bloqueio: 1. Uma alteração SemVer-MAJOR ao esquema incrementa-a. Constante: 1
workload_librariesLibraryEntry[]nãoEntradas de WorkloadLibrary que o fecho de dependências da Release alcança através de locais workload: { $import: ... } de Recipe. A lista consumers de cada entrada regista que entidade do catálogo faz referência a que fragmentos <entry-name> da biblioteca — um registo estruturado que torna rastreáveis os diffs do impacto de um aumento de versão da biblioteca sem voltar a resolver a Release. Predefinição: []
artifact_librariesLibraryEntry[]nãoEntradas de ArtifactLibrary que o fecho de dependências da Release alcança através de locais artifacts.<name>: { $import: ... } de Recipe / FeatureRecipe. A lista consumers de cada entrada regista que entidade do catálogo faz referência a que pacotes <entry-name> da biblioteca — um registo estruturado que torna rastreáveis os diffs do impacto de um aumento de versão da biblioteca sem voltar a resolver a Release. Predefinição: []

Não são permitidas propriedades adicionais.

lockfile.entities[]

PropriedadeTipoObrigatóriaDescrição
kindstring (enum)simTipo da entidade do catálogo, lido do local onde a Release, o seu Aggregate ou o seu Manifest a indica: component e feature para um tipo de Component ou de Feature que o Aggregate, a Release ou um mapeamento do Manifest indica, 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 este inclui, e manifest para o Manifest próprio da Release e o Manifest que este estende. Juntamente com uri, identifica a entrada: uma compilação compara cada entrada com a entidade do mesmo tipo e URI, pelo que uma edição a qualquer uma de duas entidades homónimas de tipos diferentes é detetada. 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. Registada como um único segmento de caminho, porque nomeia um, pelo que não contém /, nem \, nem ..: o valor forma o slot da cache a partir do qual a compilação volta a ler esta entidade, e um valor que saísse do diretório da cache nomearia uma localização fora dele. Padrão: ^([^/\\.]|\.[^/\\.])*\.?$.
digeststringsimDigest daquilo que uma publicação da entidade transporta, na forma sha256: seguido de 64 caracteres hexadecimais minúsculos: o SHA-256 calculado sobre o documento da entidade e sobre cada ficheiro que ela declara ao lado dele, ordenados por caminho, contribuindo cada um com o seu caminho e o SHA-256 dos seus bytes. Uma entidade que não declara nenhum ficheiro conta como o seu único documento. Nada mais entra nele — nem a forma como um arquivo foi comprimido, nem um carimbo temporal, nem nenhum bit de permissão, incluindo o bit de execução — pelo que a entidade regista o mesmo digest quer seja lida a partir de um diretório de catálogo, quer seja obtida a partir de um registo, e em qualquer checkout dos mesmos ficheiros, em qualquer sistema. Padrão: ^sha256:[a-f0-9]{64}$.
manifest_digeststringnãoDigest do manifesto OCI do artefacto resolvido, na forma sha256: seguido de 64 caracteres hexadecimais minúsculos. A assinatura vincula-se a este digest, e o manifesto nomeia o digest dos bytes publicados, face ao qual uma obtenção e uma leitura da cache são verificadas antes de a entidade ser confrontada com o seu digest acima. Presente apenas para uma entidade resolvida a partir de um registo. Padrão: ^sha256:[a-f0-9]{64}$.
referenced_fromstring[]nãoOrigens nos locais de autoria — caminhos com pontos no YAML de Release / Aggregate / Manifest (por exemplo aggregate.spec.components.api.type) que registam porque é que este URI está no fecho de dependências da Release. Predefinição: []
signatureVerifiedSignaturenãoFacto de assinatura verificada registado quando a assinatura desta entidade foi verificada no momento do pull, face à política de confiança do registo que a resolveu.
deprecationDeprecationRecordnãoMarcador de descontinuação retroativo verificado, registado quando um marcador de descontinuação assinado e de confiança foi descoberto neste artefacto no momento do pull. Um marcador é um referrer OCI assinado do artefacto que descontinua, anexado após a publicação sem voltar a publicar o artefacto. Regista a severidade e a mensagem do marcador, bem como o signatário verificado que o criou. A compilação lê este facto e aplica a política de descontinuação apenas a partir do ficheiro de bloqueio; nunca volta a descobrir nem a verificar 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). Liga-se por identidade às secções plugins e entities para o digest fixado e o conjunto de versões.
rolestring (enum)simO papel de transformação a que este anexo está ligado, registado literalmente a partir da entrada plugins.governance escrita pelo autor, pelo que uma compilação executa o anexo exatamente nesse papel em vez de deduzir um: label-transform reescreve as etiquetas 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 o anexo nomeia. Quando está ausente, é selecionada a exportação predefinida do papel (mutate para label-transform, transform_annotations para annotation-transform).
settingsobjetonãoObjeto de definições de forma livre que o anexo declarou, fixado tal como foi escrito e entregue ao plugin literalmente. A compilação lê as definições a partir daqui — nunca da configuração em vigor — pelo que uma alteração das definições posterior ao pull não altera a saída da compilação. Ausente quando o anexo não declara nenhum.
sourcesobject[]nãoFixações endereçadas por conteúdo dos ficheiros de fonte declarados pelo anexo, por ordem de nome base. A compilação reconstrói a fonte que o plugin lê a partir do conteúdo registado de cada fixação em vez de uma leitura em direto no host, pelo que a saída da compilação permanece invariante face a uma alteração do ficheiro de fonte posterior ao pull. Ausente quando o anexo não declara nenhum.

Não são permitidas propriedades adicionais.

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

Não são permitidas propriedades adicionais.

lockfile.plugins[]

PropriedadeTipoObrigatóriaDescrição
uristringsimIdentidade simples do artefacto .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 formam em conjunto a identidade do plugin — o mesmo nome sob dois tipos são dois plugins. A localização física de obtenção é derivada desta identidade mais o registo configurado, e nunca é transportada no ficheiro de bloqueio.
resolved_versionstringsimO digest de conteúdo para o qual o artefacto Wasm foi resolvido, na forma sha256: seguido de 64 caracteres hexadecimais minúsculos. Um artefacto 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 — pelo que este campo regista esse digest, que é também o digest abaixo. Forma o slot da cache a partir do qual a compilação volta a ler o artefacto, pelo que não contém /, nem \, nem .., o que a forma sha256: já exclui. Padrão: ^sha256:[a-f0-9]{64}$.
digeststringsimDigest de conteúdo do artefacto Wasm resolvido, na forma sha256: seguido de 64 caracteres hexadecimais minúsculos — a forma em que o endereço de conteúdo é escrito em todos os locais onde é comparado. Padrão: ^sha256:[a-f0-9]{64}$.
manifest_digeststringnãoDigest do manifesto OCI do artefacto Wasm resolvido, na forma sha256: seguido de 64 caracteres hexadecimais minúsculos. A assinatura vincula-se a este digest; o digest de conteúdo acima é a identidade portável usada para a fixação na cache e a verificação de integridade. Presente apenas para um artefacto resolvido a partir de um registo. Padrão: ^sha256:[a-f0-9]{64}$.
referenced_fromstring[]nãoPorque é que este artefacto está no fecho de dependências da Release: a referência de cada entidade Plugin através da qual foi alcançado, tal como a secção entities regista essa entidade (por exemplo governance/label-injector:1.0.0). Predefinição: []
signatureVerifiedSignaturenãoFacto de assinatura verificada registado quando a assinatura deste plugin foi verificada no momento do pull, face à mesma política de confiança por registo aplicada às entidades do catálogo.
deprecationDeprecationRecordnãoMarcador de descontinuação retroativo verificado, registado quando um marcador de descontinuação assinado e de confiança foi descoberto neste artefacto no momento do pull. Um marcador é um referrer OCI assinado do artefacto que descontinua, anexado após a publicação sem voltar a publicar o artefacto. Regista a severidade e a mensagem do marcador, bem como o signatário verificado que o criou. A compilação lê este facto e aplica a política de descontinuação apenas a partir do ficheiro de bloqueio; nunca volta a descobrir nem a verificar o marcador.

Não são permitidas propriedades adicionais.

lockfile.providers[]

PropriedadeTipoObrigatóriaDescrição
capabilitystringsimA capacidade para a qual esta associação seleciona um fornecedor — o nome simples da capacidade que uma Recipe associa através de spec.capability (por exemplo helm, compose).
pluginstringsimIdentidade simples do plugin de renderização do fornecedor resolvido (a identidade da entidade Plugin, os seus metadata.pluginType e metadata.name unidos por uma barra, por exemplo provider/helm). Liga-se por identidade às secçõ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 ficheiro de Release no momento em que a resolução os leu, na forma sha256: seguido de 64 caracteres hexadecimais minúsculos. Padrão: ^sha256:[a-f0-9]{64}$.
pathstringsimO caminho do ficheiro de Release relativo ao diretório que contém a Release a que este ficheiro de bloqueio pertence, com barras normais (por exemplo release-prod.yaml, ../shared/base-release.yaml) — nunca um caminho absoluto do host, pelo que a entrada é portável e determinística.

Não são permitidas propriedades adicionais.

lockfile.toolchain

Versões da toolchain que produziu este ficheiro de bloqueio: a própria versão do compilador e a versão de cada plugin core que o compilador inclui. Registadas para que um ficheiro de bloqueio responda a posteriori a que compilador e que plugins core resolveram e renderizaram uma compilação — uma pergunta a que as secções fixadas nem sempre conseguem responder, porque um plugin de fornecedor core servido a partir do interior do binário do compilador fica sem fixação e, portanto, não transporta nenhuma versão registada própria. Apenas versões: o carimbo nunca regista de onde vieram os bytes de um plugin, pelo que duas máquinas que fixaram o mesmo fecho de dependências com o mesmo compilador escrevem o mesmo carimbo. Nada compara esta secção, emite avisos sobre ela ou recusa uma compilação por causa dela, e a sua ausência de um ficheiro de bloqueio é silenciosa: a toolchain não faz parte do fecho de dependências que o ficheiro de bloqueio fixa. Pela mesma razão, a secçã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 ficheiro de bloqueio, na forma sem v que todas as superfícies do Aggrega indicam (1.2.0, não v1.2.0). Uma compilação carimbada com uma versão regista essa versão — uma compilação de release com tag, a sua tag — e uma compilação sem carimbo de versão regista o marcador (devel), pelo que um ficheiro de bloqueio produzido por um compilador sem carimbo não é confundido com saída de release. Registada como um único segmento de caminho, pelo que não contém /, nem \, nem ... Padrão: ^([^/\\.]|\.[^/\\.])*\.?$.
core_pluginsobject[]simVersão de cada plugin core que o compilador transporta, uma entrada por plugin, ordenadas pela coordenada do plugin. Um plugin core é publicado na tag própria do compilador com a mesma versão, pelo que estas versões leem-se da mesma forma, quer o compilador tenha servido um plugin a partir do seu próprio interior, quer o tenha obtido a partir de um registo — e é isso que mantém o carimbo livre de detalhes específicos da máquina. Vazio para uma compilação que não transporta plugins core. Predefiniçã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 secções providers e mutators nomeiam um plugin.
versionstringsimVersão deste plugin core, na forma sem v que todas as superfícies do Aggrega indicam. Registada como um único segmento de caminho, pelo que 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 o anexo de veredicto, tal como está escrito em .aggrega-config.yaml plugins.governance (por exemplo governance/aggrega-security-baseline:1.0.0). Identifica a que anexo pertencem as entradas de regras registadas; um plugin de veredicto é colocado em cache em vez de fixado, pelo que não tem nenhuma entrada nas secções plugins / entities a que se ligar.
rolestring (enum)simO papel de veredicto a que este anexo está ligado — ir-verdict (durante a análise estática, sobre o grafo IR) ou render-verdict (durante a renderização, sobre os artefactos renderizados). Distingue o mesmo plugin anexado nas duas etapas de veredicto, cada uma potencialmente com as suas próprias entradas de regras. Valores permitidos: "ir-verdict", "render-verdict"
sourcesobject[]nãoDigests de conteúdo dos ficheiros de entrada de regras declarados pelo anexo, por ordem de nome base. Ausente quando o anexo 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 ficheiro de entrada de regras no momento do pull, na forma sha256: seguido de 64 caracteres hexadecimais minúsculos. Um novo pull volta a calculá-lo, pelo que um ficheiro de regras alterado surge como um diff do ficheiro de bloqueio. Padrão: ^sha256:[a-f0-9]{64}$.
pathstringsimO nome base do ficheiro de entrada de regras — nunca um caminho absoluto do host, pelo que a entrada é portável e determinística.

Não são permitidas propriedades adicionais.

Definições

DeprecationRecord

Marcador de descontinuação retroativo verificado, registado quando um marcador de descontinuação assinado e de confiança foi descoberto neste artefacto no momento do pull. Um marcador é um referrer OCI assinado do artefacto que descontinua, anexado após a publicação sem voltar a publicar o artefacto. Regista a severidade e a mensagem do marcador, bem como o signatário verificado que o criou. A compilação lê este facto e aplica a política de descontinuação apenas a partir do ficheiro de bloqueio; nunca volta a descobrir nem a verificar o marcador.

PropriedadeTipoObrigatóriaDescrição
messagestringsimMensagem de descontinuação legível por pessoas transportada pelo marcador — normalmente uma indicação para a migração.
severitystring (enum)simSeveridade do marcador, ordenada warning < error < retracted. A compilação é interrompida 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, registado da mesma forma que o signatário da assinatura de um artefacto: 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 artefacto assinado por direito próprio, pelo que o seu signatário tem a mesma forma que a assinatura de um artefacto — e o bundle_digest aqui nomeia o bundle de assinatura próprio do marcador em vez do do artefacto descontinuado.

Não são permitidas propriedades adicionais.

ExternalInput

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

PropriedadeTipoObrigatóriaDescrição
required_bystring[]simProveniência — os locais de renderização que pediram esta entrada. Ordenados e sem duplicados pelo escritor do ficheiro 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.
urlstringsimO URL da entrada tal como escrito no local de renderização — a chave de pesquisa que associa um pedido em tempo de renderização à sua fixação.

Não são permitidas propriedades adicionais.

LibraryEntry

Forma comum partilhada pelas entradas de schema_libraries, mapping_libraries, workload_libraries e artifact_libraries. A lista consumers capta a relação no grafo do catálogo — que entidade do catálogo faz referência a que fragmentos <entry-name> desta biblioteca — e suporta diffs estruturados do impacto quando o digest da biblioteca muda. Uma biblioteca é um artefacto OCI como qualquer outro, pelo que regista os mesmos factos verificados que uma entidade do catálogo: o digest do manifesto a que a 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. Registada como um único segmento de caminho, porque forma o slot da cache a partir do qual a compilação volta a ler a biblioteca, pelo que não contém /, nem \, nem ..: um valor que saísse do diretório da cache nomearia uma localização fora dele. Padrão: ^([^/\\.]|\.[^/\\.])*\.?$.
digeststringsimDigest de conteúdo do artefacto de biblioteca resolvido, na forma sha256: seguido de 64 caracteres hexadecimais minúsculos — a forma em que o endereço de conteúdo é escrito em todos os locais onde é comparado. Padrão: ^sha256:[a-f0-9]{64}$.
manifest_digeststringnãoDigest do manifesto OCI do artefacto de biblioteca resolvido, na forma sha256: seguido de 64 caracteres hexadecimais minúsculos. A assinatura vincula-se a este digest; o digest de conteúdo acima é a identidade portável usada para a fixação na cache e a verificação de integridade. Presente apenas para uma biblioteca resolvida a partir de um registo. Padrão: ^sha256:[a-f0-9]{64}$.
signatureVerifiedSignaturenãoFacto de assinatura verificada registado quando a assinatura desta biblioteca foi verificada no momento do pull, face à mesma política de confiança por registo aplicada às entidades do catálogo.
deprecationDeprecationRecordnãoMarcador de descontinuação retroativo verificado descoberto nesta biblioteca no momento do pull. A compilação indica-o e, onde o espaço de trabalho configurou um limiar de interrupção que a severidade registada atinge, é interrompida — pelo que uma biblioteca retirada depois de a versão ter sido fixada é anunciada em cada compilação em vez de apenas na seleção de versão, que uma versão fixada explicitamente contorna.
consumersobject[]nãoRegistos de que entidade do catálogo faz referência a esta biblioteca e a que fragmentos <entry-name>. Capta o fan-in: muitos consumidores por biblioteca, cada um potencialmente com referências a muitos fragmentos. Cada registo transporta o URI do consumidor mais o conjunto de fragmentos que esse consumidor incorpora. Predefiniçã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 artefactos, 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 escritor.

Não são permitidas propriedades adicionais.

SourceArtifactEntry

Uma única fixação de artefacto 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 artefacto. chart e module_subdir são os dois termos seletores — cada um nomeia aquilo que o URL por si só não nomeia, para os tipos que precisam de um.

PropriedadeTipoObrigatóriaDescrição
kindenumsimO tipo de fonte. Determina que adaptador resolveu o artefacto e que 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"
urlstringsimO URL escrito pelo autor — o URL de identidade tal como está escrito 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 foi escrito; a compilação reconstrói este mesmo URL offline, pelo que é a identidade estável pela qual a fixação é indexada. Para git-repository, o URL do repositório clonável. Para helm-oci-chart, a referência do registo. Para compose-https-fragment, o URL HTTPS do fragmento. A localização resolvida do artefacto para uma fonte helm de raiz do repositório é registada separadamente em resolved_url: como proveniê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}, pelo 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 do URL.
module_subdirstringnãoO diretório, dentro de um repositório de origem git, que constitui o artefacto (spec.source.module_subdir da Recipe), parte da identidade {kind, url, chart, module_subdir, pinned_version}, pelo 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 artefacto, e para todos os tipos que chegam ao seu artefacto por URL em vez de descerem a 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 é registada em requested_ref: em cada entrada referenced_by:, sempre que a Recipe escreveu um spec.source.ref:). Uma compilação encontra esta entrada por aquilo que a Recipe escreveu: o ref: escrito pelo autor, quando existe, comparado com o requested_ref: registado, e, caso contrário, este valor fixado — pelo que uma Recipe que nomeia uma tag é resolvida para o commit em que essa tag foi fixada, sem que o commit alguma vez apareça na Recipe. Registada como um único segmento de caminho, porque forma o slot da cache a partir do qual a compilação volta a ler o artefacto, pelo que não contém /, nem \, nem ... Padrão: ^([^/\\.]|\.[^/\\.])*\.?$.
resolved_urlstringnãoApenas proveniência: a localização concreta do artefacto para a qual o URL escrito pelo autor foi resolvido no momento do pull. Para uma fonte helm de raiz do repositório, é o URL do .tgz direto para o qual o índice do repositório resolveu chart+versão; é registado para diagnóstico e NÃO faz parte da identidade do artefacto. Ausente quando a localização resolvida é igual ao URL escrito pelo autor (uma fonte .tgz direta, OCI, compose ou git).
digeststringsimDigest de conteúdo do arquivo .tar.gz resolvido, na forma sha256: seguido de 64 caracteres hexadecimais minúsculos. A verificação em tempo de compilação lê os bytes do slot da cache, volta a calcular o digest e compara-o com este campo; uma divergência interrompe a compilação, indicando uma divergência do digest de conteúdo. Padrão: ^sha256:[a-f0-9]{64}$.
manifest_digeststringnãoDigest do manifesto OCI do artefacto resolvido, na forma sha256: seguido de 64 caracteres hexadecimais minúsculos. O manifesto é a raiz de confiança independente face à qual o arquivo em cache é verificado; o digest de conteúdo acima é a identidade portável usada para a fixação na 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 media canónico anunciado pelo registo (ou a predefinição do tipo para tipos sem metadados de registo). Registado como proveniência para diagnóstico.
referenced_bySourceArtifactReference[]simEntidades do catálogo resolvidas para este artefacto, ordenadas por (uri, field) para uma saída determinística. Uma entrada só existe porque uma Recipe ou uma FeatureRecipe a obteve através de um pull, pelo que 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 → artefacto de fonte. entity + uri identificam em conjunto a entidade do catálogo; field nomeia o caminho do lado da fonte dentro da spec da entidade onde o artefacto 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 artefacto 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 acontece com todos os tipos cujo resolvedor fixa literalmente a versão escrita pelo autor (helm-, compose-). Desempenha duas funções em simultâneo, e registá-lo incondicionalmente é o que impede que se excluam mutuamente. Uma compilação usa-o 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 registada na sua versão fixada: uma referência que se moveu no seu remoto interrompe a execução em vez de ser adotada.

Não são permitidas propriedades adicionais.

VerifiedSignature

Facto de assinatura verificada registado quando a assinatura de um artefacto foi verificada no momento do pull, face à política de confiança do registo que o resolveu. Todos os artefactos assináveis o registam da mesma forma — uma entidade do catálogo, uma biblioteca, um plugin Wasm — porque todos são verificados através de um único caminho em vez de um por tipo. Regista 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 na cache de conteúdo. A compilação não volta a executar a verificação. Antes de qualquer coisa ser renderizada, lê este facto em cada entrada a partir da qual compila, em cada secção: volta a calcular o hash do bundle em cache e compara o resultado com bundle_digest, interrompendo-se onde o blob está em falta ou difere; e, para uma entrada servida pela cache de conteúdo, lê desse bundle para que artefacto a assinatura foi feita, e interrompe-se onde foi feita para um artefacto diferente daquele que a compilação leu para a entrada — pelo que uma signature copiada de uma entrada para outra é recusada, diga o que disser o requisito de assinatura. Uma compilação não verifica nenhuma assinatura, pelo que um bundle escrito à mão na cache, emitido para o próprio artefacto 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 pela cache de conteúdo — o requisito que pull aplica quando obtém o artefacto, pelo que as isenções e um registo advisory que permitem a um pull admitir um artefacto sem assinatura permitem também à compilação admitir a sua entrada — uma entrada que não transporta nenhum facto interrompe a compilação. Uma entrada lida a partir de um diretório de catálogo, da cópia dentro do binário do compilador ou de junto da Release nunca é sujeita a esse requisito.

PropriedadeTipoObrigatóriaDescrição
bundle_digeststringsimDigest SHA-256 do blob do bundle de assinatura em cache, na forma sha256: seguido de 64 caracteres hexadecimais minúsculos. Nomeia o blob da cache, pelo que forma um caminho e não contém /, nem \, nem .. — o que a forma sha256: já exclui — e, numa entrada de qualquer secção, é aquilo face ao qual uma compilação volta a calcular 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.